View source for Information about how to download and use the Virtual Machine

====== Bitcraze Virtual Machine ======
In order to easily get going with the development of Bitcraze projects we have pre-configured a virtual machine that can be imported into [[http://www.vmware.com/products/player/|WM Player]] or [[https://www.virtualbox.org/|Oracle VirtualBox]]. It contains all the pre-requisites needed for development and usage of the projects at Bitcraze.

If you would like to create your own virtual machine instead of downloading ours, then have a look at [[projects:virtualmachine:create_vm|these intructions]].

'''Please note''':All the instructions here (and on sub-pages) are always updated to match the latest available version of the VM and might not be valid for earlier versions.

====== Download ======
You can download the VM using one of the link below:
* Bitcraze VM 0.4 ([[http://tracker.bitcraze.se/torrents/Bitcraze%20VM%200.4.ova.torrent|torrent]]) ([[https://mega.co.nz/#!LMoHWILC!ZpfSmCWjt_yGdBaNYoUqUwqB6SRsAfdh6N9FUhHbxNQ|direct download]])
* Bitcraze VM 0.3 ([[http://taffanel.org/tracker/torrents/Bitcraze%20VM%200.3.ova.torrent|torrent]]) ([[https://mega.co.nz/#!ScQh1KRQ!azKj-0LhnIDyWH5mCvauZTWwLzM4lbJWi9MTBmT_nEI|direct download]])
* Bitcraze VM 0.2 ([[http://tracker.bitcraze.se/torrents/UbuntuBitcraze_0.2.ova.torrent|torrent]])

Please note that direct downloads are hosted at MEGA, so it's limited to 6 downloads at a time. Using torrents are preferred.

====== VM info ======
The latest available version of the VM is 0.4.
 OS  : Xubuntu 13.10
 HDD : ~10.0 GB (dynamically sized)
 RAM : 2 GB
 User: bitcraze
 Pass: crazyflie

===== Configuration =====
The VM comes pre-configured with the following:
* udev rules for Crazyradio and bootloader
* Pre-configured USB filters for passing Crazyradio/NRF BOOT to the VM (not enabled by default)

'''NOTE''': The USB filters in the 0.3 version of the VM specify a serial number for the radio dongle.  This means the pre-configured filter cannot be used as is.  Create your own filter by plugging in the radio and then choosing "Add Filter", the dongle should appear in the provided list. You can also edit and remove the serial number from the Filter which will make it work for all Crazyradio dongles.

===== Installed software =====
Below is a overview of what's installed in the virtual machine:
* VirtualBox guest additions (for network sharing, screen resize, etc)
* gnu-arm-none-eabi toolchain and build tools
* Mercurial
* TortoiseHG
* pyusb, pygame and pyqt
* Qt4 and QtDesigner
* KiCad
* Eclipse with compiling/debugging/flashing configured (for use with BusBlaster)
* gedit
* SDCC 3.2

===== Projects =====
The following projects are cloned into the VM:
* crazyflie-firmware
* crazyflie-bootloader
* crazyflie-pc-client
* crazyradio-firmware
* crazyradio-electronics

There are also short-cuts on the desktop to easily run the Crazyflie PC client and also to update all the projects to the latest version available on Bitbucket.

===== Development =====
The VM comes pre-installed and pre-configured for development. Here's what you can do:
* Update and build the latest versions of the Crazyflie/Crazyradio firmware
* Easily flash the Crazyflie firmware from Eclipse using the radio
* projects:virtualmachine:jtag_debug|Debug the Crazyflie firmware via JTAG (pre-configured for BusBlaster)
* View and modify the Crazyradio electronics design
* Develop for Crazyflie PC client with QtDesigner for the UI

===== HOW-TOs =====
Update all the projects 

If you would like to update to the latest version from Bitbucket for all the projects you can either use the short-cut on the desktop (//Update all projects//) or run the following command:
  /home/bitcraze/bin/update_all_projects.sh

==== Run the Crazyflie PC client ====
If you would like to fly the Crazyflie then you should to the following:
  * Insert the controller and Crazyradio and pass them to the VM. In VirtualBox this is done by right-clicking on the USB icon in the bottom left hand of the screen and selecting the Crazyradio and the controller
  * Start the cfclient either by using the short-cut on the desktop (//Crazyflie PC client latest//) or by running the following command: <code>/home/bitcraze/projects/crazyflie-pc-client/cfclient</code>
  * Press the //Connect// button and select the URI starting with //radio// and then press //Connect//

**PLEASE NOTE:** If no controller is passed to VirtualBox the default controller will be the //VirtualBox USB Tablet//. This device together with the default controller mapping will set the thrust depending on where the mouse-pointer is on the screen. Make sure to check that there's no thrust **before** connecting to the Crazyflie.