diff --git a/docs/cfclient_zmq.md b/docs/cfclient_zmq.md index 0916b28ffa3f6c9f2ca164e6d40fd4534017a837..267969061dd433df7d23de0853efc865e22f9123 100644 --- a/docs/cfclient_zmq.md +++ b/docs/cfclient_zmq.md @@ -44,7 +44,6 @@ parameter to 4000. "value": "4000" } -\</WRAP\> \</WRAP\> LED-ring ======== @@ -63,7 +62,7 @@ Protocol | version | int | Should be set to 1| | rgbleds | array of 3 item arrays of int | R/G/B value for each LED (starting at 1)| -\</WRAP\> \<WRAP half column\> Example of setting all LEDs off: +Example of setting all LEDs off: { "version": 1, @@ -83,8 +82,6 @@ Protocol ] } -\</WRAP\> \</WRAP\> - Input device ============ diff --git a/docs/cfloader.md b/docs/cfloader.md index 61812c4da50456de4048c0ca8ebc8566b17f2ceb..9fec39d5145ec72879e1495b3fc5949127a2b518 100644 --- a/docs/cfloader.md +++ b/docs/cfloader.md @@ -33,18 +33,17 @@ you can enable the warmboot mode. To do so, edit the file After this, \'make cload\' will restart the Crazyflie in bootlader mode, flash it and restart it with the new firmware. -\<WRAP center round info\> In warmboot mode the bootloader is launched +In warmboot mode the bootloader is launched using a random address. This means that multiple Crazyflie can be -programmed at the same time without collision. \</WRAP\> \<WRAP center -round important\> ***Warning*** If the flashing operation fails or if +programmed at the same time without collision. + +**Warning:** If the flashing operation fails or if the firmware has a bug, it may be impossible to warmboot. In that case start the bootloader manually and disable warmboot temporarly by programming with: make cload CLOAD_CMDS= -\</WRAP\> - cfloader ======== diff --git a/docs/dev_info_client.md b/docs/dev_info_client.md index 618f3d7fa48a421ef8a55f2f5fdca5ff0aa0a7c1..b72b3056f400a81fe7893999bc9029c24d7fb634 100644 --- a/docs/dev_info_client.md +++ b/docs/dev_info_client.md @@ -20,7 +20,7 @@ Here\'s a quick overview: Architecture ============ -{:.align-right +{:.align-right width="600"} Input devices diff --git a/docs/inputdevices.md b/docs/inputdevices.md index 420daeed58d1659768b25cf2cc2cf516494198b0..5917b2d83e0e29df9dc849674198fbc671d8d282 100644 --- a/docs/inputdevices.md +++ b/docs/inputdevices.md @@ -125,11 +125,9 @@ Xbox 360 controller Linux using USB --------------- -\<WRAP center round tip 80%\> **INFO** - -All modern Linux distribution now have a kernel driver for the x-box +**INFO:** All modern Linux distribution now have a kernel driver for the x-box gamepad. Thus it is unlikely the *xboxdrv* user-space driver is needed. -\</WRAP\> + If you are having problems getting this to work the userspace driver `xboxdrv` might be needed. It can be installed (on Ubuntu) by running: diff --git a/docs/macports.md b/docs/macports.md index 842f05026a64c446eea641fad51664899f0fc8ef..f9dd076a991738b67b8e33e166b60cf0c4fbdebc 100644 --- a/docs/macports.md +++ b/docs/macports.md @@ -21,9 +21,9 @@ I found that installing only the command line developer tools is enough for Crazyflie client dependencies. However installing Xcode seems to be recommended. I installed the command line developer tools: - - - + + + Update mac ports @@ -43,7 +43,7 @@ Install Crazyflie client dependencies Most but not all packages are pre-compiled so this installation takes some time. It took about 12 minutes for me, YMMV. - + Now you are able to clone and run the Crazyflie client! @@ -52,7 +52,7 @@ Now you are able to clone and run the Crazyflie client! cd crazyflie-clients-python /opt/local/bin/python2.7 bin/cfclient - + Optional dependencies --------------------- @@ -64,13 +64,13 @@ lot depending on how many ports are pre-compiled): sudo port install py27-pyqtgraph - + You can now access the plotter tab: /opt/local/bin/python2.7 bin/cfclient - + Troubleshooting --------------- diff --git a/docs/raspberrypi.md b/docs/raspberrypi.md index 24616c7809178bda611eaf47aa4faac88d955c44..e2862ed3644504ee5ee94b5af092a3d6c4cbd019 100644 --- a/docs/raspberrypi.md +++ b/docs/raspberrypi.md @@ -42,9 +42,9 @@ compatible with Raspberrypi 2): ([torrent](http://tracker.bitcraze.se/torrents/cfpi-0_1.zip.torrent)) ([mega](https://mega.co.nz/#!HJpH2KDJ!bY-EdGtyxIRzOUu6xNVWnid_cco5wS-IQ6ELfc5Y1Q8)) -\<WRAP center round info \> ***Note*** Using Torrent is advised, we have +**Note:** Using Torrent is advised, we have added webseed so it is faster than direct download and guarantee the -file integrity. \</WRAP\> +file integrity. Installing in an existing Raspbian sdcard ========================================= diff --git a/docs/userguide_client.md b/docs/userguide_client.md index 653f5fac109d9fbce52aaa2b7f9b33b564c5190c..1104ee6f1ed9b126412500d8f6f069f75e7fc55b 100644 --- a/docs/userguide_client.md +++ b/docs/userguide_client.md @@ -45,7 +45,7 @@ For more info on LED indicators etc. have a look at the Main UI ======= - + 1. The window title will show the connection status 2. Connect/disconnect, scan and the drop-down connection list as well @@ -78,7 +78,7 @@ client. The bootloader mode is accessed from the menu *Crazyflie-\>Bootloader*. If there is any problem during the flashing or a wrong firmware is flashed the process can just be started again. - + To update the firmware in the Crazyflie 1.0/2.0 do the following: @@ -140,7 +140,7 @@ any time the same way. | **Crazyflie 1.0** **Crazyflie 2.0** | |-----|------------| | Click on the menu **\"Crazyflie-\>Configure 1.0\"** and then connect the bootloader by clicking on the \"cold boot\" button and by restarting the Crazyflie. | First connect to the Crazyflie 2.0 with the normal connect button. Then open **\"Crazyflie-\>Configure 2.0\"** to reach the configure 2.0 dialog | - | {:width="500"} | {:width="500"} | + | {:width="500"} | {:width="500"} | | Once the settings has been made press the program button to save them permanently in the Crazyflie flash. | Once the settings has been made press the write button to save them permanently in the Crazyflie 2.0 EEPROM. | @@ -161,7 +161,7 @@ plotted in the plotter and saved to file in the log block tab. To setup a new log block click on the menu \"settings/logging configuration\", You then see the following toolbox: -{:align-center} +{:align-center} 1. List of log variable in the Crazyflie 2. Log variables in the current log block @@ -189,7 +189,7 @@ Input devices In order to control the Crazyflie you are connected to you will need some input-device. Normally this would be a gamepad, but any input-device with at least 4 analog axis will do. Here\'s [a -list](input_devices.md) of some input-devices +list](/inputdevices/) of some input-devices that are used. In order to make sense of the input from the device a mapping has to be @@ -204,18 +204,18 @@ but if you have another input-device then it\'s quick to create your own configuration. Go to the menu *Input device -\> Configure device mapping*. -{:align-center +{:align-center width="700"} Select the device you would like to configure and press *Configure*. -{:align-center +{:align-center width="700"} For each functionality that can be mapped there\'s a *Detect* button, by pressing it the following dialog will appear. -{:align-center +{:align-center width="300"} Follow the instructions to detect the axis or button that you would like @@ -227,7 +227,7 @@ Go though all the functionality you would like to map by pressing the *Detect* button for each. To be able to save the mapping you will at least have to map roll, pitch, yaw and thrust. -{:align-center +{:align-center width="700"} Once you have mapped functionality you will be able to see the feedback @@ -270,31 +270,31 @@ For normal usage just enter the *Normal* menu, select the device you would like to use and the correct mapping. As a device is selected the list of mappings are enabled. -{:align-center +{:align-center width="700"} If more than one input device is connected then it\'s possible to switch to one of the teacher modes. -{:align-center +{:align-center width="700"} First select the device that should be used for the teacher and then it\'s mapping. -{:align-center +{:align-center width="700"} Then select the device that should be used for the student and then it\'s mapping. -{:align-center +{:align-center width="700"} Once this is done you will be able to see the open devices and configurations at the bottom of the user interface. -{:align-center +{:align-center width="700"} Tabs @@ -307,7 +307,7 @@ Flightcontrol ------------- The normal view used when flying is the one seen below. -{:align-center} +{:align-center} 1. Flight mode selector (Normal and Advanced) @@ -337,7 +337,7 @@ Plotter ------- The plotter tab can be used to visualize data logged from the Crazyflie -{:align-center +{:align-center width="700"} 1. Select logging configuration to plot. Read about how to create @@ -358,7 +358,7 @@ that can be changed in real-time. The parameter tab can be used to view and update parameters. For more information about parameters see logging and parameter frameworks LINK TO CF-FIRMWARE! -{:align-center +{:align-center width="700"} 1. Parameter information fields @@ -379,7 +379,7 @@ The log blocks tab shows all log configurations that are saved and if they are started. It\'s also possible to start/stop them as well as write the logged data to file. -{:align-center +{:align-center width="700"} 1. Fields @@ -426,7 +426,7 @@ Console The console tab will show printouts from the Crazyflie firmware as it\'s running. -{:align-center +{:align-center width="700"} 1. Console output from the Crazyflie @@ -455,7 +455,7 @@ Displays the configured anchor positions and the estimated position of the Crazyflie. Can be used to make sure the system is set up correctly and that the estimated position is reasonable. -{:align-center +{:align-center width="700"} 1. Plot for X/Y (top view) showing anchors and Crazyflie @@ -498,7 +498,7 @@ displays the configured anchor positions. When the crazyflie is close to an anchor this is indicated in the graphs by highlighting it. This mode is useful to identify anchors and verify that the system is correctly configured. -{:align-center +{:align-center width="700"} 1. Plot for X/Y (top view) showing anchors and Crazyflie