Skip to content

Commit

Permalink
Crazyflie 2.x family naming consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
gemenerik committed Oct 16, 2024
1 parent ccf1694 commit 80cfb4c
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/functional-areas/cfloader.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Bootload the Crazyflie 2.X
title: Bootload the Crazyflie 2.x
page_id: cfloader
---

The Crazyflie as well as decks that has a firmware can be bootloaded from the command line using the
*cfloader* script.

**Note:** To enter the bootloader for the Crazyflie 2.X power off the
**Note:** To enter the bootloader for the Crazyflie 2.x power off the
platform and start it again by pressing the power button for at least
1.5 seconds, but not more than 5.

Expand Down Expand Up @@ -61,7 +61,7 @@ When flashing a .bin, the correct target needs to be specified. The followind ta
- nrf51-bootloader+softdevice: nRF51 bootloader and softdevice bundle binary
- Various decks-fw: Some deck can be flashed over the air. See the deck documentation.

## Crazyflie 2.X examples
## Crazyflie 2.x examples

Flashing new firmware for the nRF51 MCU:

Expand Down
2 changes: 1 addition & 1 deletion docs/userguides/recovery-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ a wrong firmware is flashed the process can just be started again.

![CFclient bootloading](/docs/images/bootloader-recovery.png)

To update the firmware in the Crazyflie 2.X do the following:
To update the firmware in the Crazyflie 2.x do the following:

- Make sure that the Crazyflie is disconnected from the client and
powered off.
Expand Down
14 changes: 7 additions & 7 deletions docs/userguides/userguide_client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ where the front is, so you will need to know [Crazyflie's coordinate system](htt
- When the handshake is done you can start flying the Crazyflie.
Remember the most tricky part is the thrust so start out easy\...

For more info on LED indicators etc. have a look at the [Crazyflie 2.X](https://www.bitcraze.io/documentation/tutorials/getting-started-with-crazyflie-2-x/#understanding-leds) user guide.
For more info on LED indicators etc. have a look at the [Crazyflie 2.0 and Crazyflie 2.1(+) getting started guide](https://www.bitcraze.io/documentation/tutorials/getting-started-with-crazyflie-2-x/#understanding-leds) user guide.

---

Expand Down Expand Up @@ -94,26 +94,26 @@ Crazyflie firmware upgrade process, just make sure the deck is mounted when you

![CFclient bootloading](/docs/images/firmware-upgrade.png)

To update the firmware in the Crazyflie 2.X do the following:
To update the firmware in the Crazyflie 2.x do the following:

- Make sure to have any decks you will be using attached during the update, since some of
the decks contain their own firmware which will also be updated during the firmware update. Also make sure there is a battery attached.
- Go to the menu *Connect-\>Bootloader*
- Connect to the crazyflie in this dialog, if it is not already connected in the flighttab.
- Chose what to flash
- Use the "From release" tab to automatically use an [official release](https://github.com/bitcraze/crazyflie-release/releases). Make sure to select the right platform (cf2 is the Crazyflie 2.X)
- Use the "From release" tab to automatically use an [official release](https://github.com/bitcraze/crazyflie-release/releases). Make sure to select the right platform (cf2 is the Crazyflie 2.x)
- Use the "From file" tab if you have some other release file you want to flash.
- Click \"Program\" and wait for both the STM, NRF and decks to be flashed. Note: the Crazyflie may restart multiple times during this process.
- Your crazyflie will automatically restart a couple of times.
- Do not touch or restart your crazyflie untill all flashing is done and you see \"status: idle\" at the bottom.
- To check the firmware version, under the *View* menu, open up *Tabs-\>Console* tab and look at the output when connecting to the
Crazyflie 2.X.
Crazyflie 2.x.

If you accidently restarted your crazyflie during flashing or anything else happend which caused your crazyflie to not start up properly, follow [the instructions for recovery mode](/docs/userguides/recovery-mode.md).

### Firmware configuration

It is possible to set another channel to communicate with the Crazyflie 2.X. It can be wise to do this if there exist other wireless
It is possible to set another channel to communicate with the Crazyflie 2.x. It can be wise to do this if there exist other wireless
networks that can interfere, especially WiFi. It is also possible to
permanently store the trim values for pitch and roll.

Expand All @@ -140,11 +140,11 @@ stored in a none volatile memory:
The procedure is described below and the parameters can be changed again
any time the same way.

First connect to the Crazyflie 2.X with the normal connect button. Then open "Connect->Configure 2.X" to reach the configure 2.X dialog
First connect to the Crazyflie 2.x with the normal connect button. Then open "Connect->Configure 2.x" to reach the configure 2.x dialog

![CF2 config](/docs/images/cfclient_cf2_config.png){:width="500"}

Once the settings has been made press the write button to save them permanently in the Crazyflie 2.X EEPROM. Then restart the Crazyflie and connect to the new address.
Once the settings has been made press the write button to save them permanently in the Crazyflie 2.x EEPROM. Then restart the Crazyflie and connect to the new address.

### Logging

Expand Down
2 changes: 1 addition & 1 deletion src/cfclient/ui/dialogs/cf2config.ui
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</rect>
</property>
<property name="windowTitle">
<string>Crazyflie 2.X config</string>
<string>Crazyflie 2.x config</string>
</property>
<layout class="QGridLayout" name="gridLayout_3">
<item row="0" column="0">
Expand Down
2 changes: 1 addition & 1 deletion src/cfclient/ui/main.ui
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@
<bool>false</bool>
</property>
<property name="text">
<string>Configure 2.X</string>
<string>Configure 2.x</string>
</property>
<property name="menuRole">
<enum>QAction::NoRole</enum>
Expand Down
2 changes: 1 addition & 1 deletion src/cfclient/ui/tabs/consoleTab.ui
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
<bool>false</bool>
</property>
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;&lt;span style=&quot; font-weight:600; font-style:italic;&quot;&gt;Experimental feature:&lt;/span&gt;&lt;span style=&quot; font-weight:600;&quot;&gt; Test battery (power path)&lt;/span&gt;&lt;/p&gt;&lt;p&gt;This test will very shortly spin the motors at pull power and measure the voltage drop. This voltage drop should not be to high. If it is, the battery is probably bad, but it could also be the connector or other components in the power path that adds resistance.&lt;/p&gt;&lt;p&gt;The results are printed on the console and can be read from the health.batterySag and health.batteryPass log variables.&lt;/p&gt;&lt;p&gt;This feature is meant for the Crazyflie 2.X only and should probably not be used by e.g. Crazyflie Bolt or BigQuad. For them the test could even be dangerous.&lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;&lt;span style=&quot; font-weight:600; font-style:italic;&quot;&gt;Experimental feature:&lt;/span&gt;&lt;span style=&quot; font-weight:600;&quot;&gt; Test battery (power path)&lt;/span&gt;&lt;/p&gt;&lt;p&gt;This test will very shortly spin the motors at pull power and measure the voltage drop. This voltage drop should not be to high. If it is, the battery is probably bad, but it could also be the connector or other components in the power path that adds resistance.&lt;/p&gt;&lt;p&gt;The results are printed on the console and can be read from the health.batterySag and health.batteryPass log variables.&lt;/p&gt;&lt;p&gt;This feature is meant for the Crazyflie 2.x only and should probably not be used by e.g. Crazyflie Bolt or BigQuad. For them the test could even be dangerous.&lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<property name="text">
<string>Battery test</string>
Expand Down

0 comments on commit 80cfb4c

Please sign in to comment.