Skip to content

Commit dcbff3d

Browse files
authoredMay 10, 2022
Merge pull request #58 from bitcraze/knmcguire-patch-1
add performance tips and rewrite readme
2 parents 7000fd6 + 7a6d92a commit dcbff3d

File tree

1 file changed

+31
-25
lines changed

1 file changed

+31
-25
lines changed
 

‎README.md

+31-25
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,37 @@ Here is a non-exhaustive list of what's included:
1717
* vscode prepared for compiling/debugging/flashing the Crazyflie firmware
1818
* SDCC 3.2 for compiling of Crazyradio firmware
1919

20+
21+
Downloading
22+
-----------
23+
The Bitcraze VM can be downloaded via the [Github Release Page](https://github.com/bitcraze/bitcraze-vm/releases)
24+
25+
Installing
26+
----------
27+
The virtual appliance can be imported into [VirtualBox](https://www.virtualbox.org/ "VirtualBox"). You will need the extention package of virtual box to be able to use the USB device. Go to [Oracles download page](https://www.oracle.com/virtualization/technologies/vm/downloads/virtualbox-downloads.html?msclkid=be59f68fcf9f11ec801dcf4ea944dd1d) to install both virtual box and the expansion pack.
28+
29+
It can be used with other virtual machine manager however setting up the guest addition might be required. The following have been tested
30+
31+
* [Gnome Boxes](https://wiki.gnome.org/Apps/Boxes)
32+
* [VM Player](http://www.vmware.com/products/player/ "WM Player")
33+
34+
Using the virtual machine
35+
-------------------------
36+
After importing just run the machine. It logs in automatically but use the following credentials if needed:
37+
```
38+
User: bitcraze
39+
Pass: crazyflie
40+
```
41+
42+
Optimizing for Use
43+
-------------------------
44+
For faster USB connection with the Crazyradio PA it is advised to filter the USB device at startup of the VM. Go to *settings->USB*, make sure that USB 3.0 is enabled and add a USB device filter for the Crazyflie PA, which should be called 'Bitcraze Crazyradio PA USB Dongle [9955]'.
45+
46+
Also just to be sure, install the guest addition pack from inside the VM by typing:
47+
`sudo apt-get install virtualbox-guest-additions-iso`
48+
49+
For the rest of the performance of your VM, you can try to increase the base memory (Settings/System/Motherboard), the CPU's available (Settings/System/Processor), enable hardware acceleration and select Hyper-V (Settings/System/Acceleration) or increase the video memory with 3D acceleration enabled (Settings/Display/Screen). This requires some adjusting as this could be different per system you are running the VM from.
50+
2051
# How to build the Bitcraze VM
2152

2253
## Pre-requisites
@@ -58,30 +89,5 @@ Copy the files specified in the JSON template to the VM and run the `provision.s
5889
Please take a look at the log files ```packerlog_create.txt``` and ```packerlog_provision.txt```.
5990

6091

61-
Downloading
62-
-----------
63-
The Bitcraze VM can either be downloaded via torrent or via direct download.
64-
65-
[Bitcraze VM download page](https://wiki.bitcraze.io/projects:virtualmachine:index)
66-
67-
Installing
68-
----------
69-
The virtual appliance can be imported into [VirtualBox](https://www.virtualbox.org/ "VirtualBox").
70-
71-
It can be used with oter virtual machine manager however setting up the guest addition might be required. The following have been tested
72-
73-
* [Gnome Boxes](https://wiki.gnome.org/Apps/Boxes)
74-
* [VM Player](http://www.vmware.com/products/player/ "WM Player")
75-
76-
Using the virtual machine
77-
-------------------------
78-
After importing just run the machine. It logs in automatically but use the following credentials if needed:
79-
```
80-
User: bitcraze
81-
Pass: crazyflie
82-
```
83-
84-
For more information on debugging, building, flashing and updating to the latest version have a look at our [Documentation](https://www.bitcraze.io/documentation/tutorials/getting-started-with-crazyflie-2-x/#inst-comp "Getting started with the Crazyflie 2.X")
85-
8692
## Contribute
8793
Go to the [contribute page](https://www.bitcraze.io/contribute/) on our website to learn more.

0 commit comments

Comments
 (0)
Please sign in to comment.