Skip to content

Commit 71b0a1f

Browse files
authored
Merge pull request #1420 from bitcraze/rik/docs
Several small documentation updates
2 parents 93ce175 + 2c7694f commit 71b0a1f

File tree

5 files changed

+15
-37
lines changed

5 files changed

+15
-37
lines changed

docs/building-and-flashing/build.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,15 @@ install some ARM toolchain.
1212
### Install a toolchain
1313

1414
#### Toolchain and compiler version policy
15-
Our policy for toolchain is to follow what is available in the oldest [Ubuntu Long Term Support release](https://wiki.ubuntu.com/Releases) and treat that as the oldest supported version. At the time of writing this (September 6 2021) the oldest LTS release is 18.04. And in Ubuntu 18.04 (bionic) the version of gcc-arm-none-eabi is 6.3.
15+
Our toolchain policy is to support the [oldest Ubuntu Long Term Support (LTS) release that is still within its Standard Support period](https://wiki.ubuntu.com/Releases). This means that we do not support Ubuntu releases that have reached End of Standard Support. As of October 15th, 2024, the oldest Ubuntu LTS release still receiving Standard Support is 20.04 (Focal Fossa). In Ubuntu 20.04, the version of `gcc-arm-none-eabi` available is 9.
1616

17-
This means that if the firmware can not be compiled using gcc 6.3, **or anything newer**, it should be considered a bug.
17+
This means that if the firmware can not be compiled using gcc 9, **or anything newer**, it should be considered a bug.
1818

1919
##### Ubuntu
20-
For Ubuntu 20.04 and 22.04:
2120
```
2221
$ sudo apt-get install make gcc-arm-none-eabi
2322
```
2423

25-
For Ubuntu 18.04:
26-
```
27-
$ sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa
28-
$ sudo apt-get update
29-
$ sudo apt install gcc-arm-embedded
30-
```
31-
3224
##### macOS
3325
```
3426
$ brew tap PX4/homebrew-px4
@@ -65,7 +57,7 @@ This repository uses git submodules. Clone with the `--recursive` flag
6557
$ git clone --recursive https://github.com/bitcraze/crazyflie-firmware.git
6658
```
6759

68-
**Note** Make sure there are no spaces in the folder structure leading up to the repository (example: _/a/path/with/no/spaces/crazyflie-firmware/_ vs _a/path with spaces/crazyflie-firmware/_). Our build system can not handle file system paths with spaces in them, and compilation will fail.
60+
> Note: Make sure there are no spaces in the folder structure leading up to the repository (example: _/a/path/with/no/spaces/crazyflie-firmware/_ vs _a/path with spaces/crazyflie-firmware/_). Our build system can not handle file system paths with spaces in them, and compilation will fail.
6961
7062
If you already have cloned the repo without the `--recursive` option, you need to
7163
get the submodules manually
@@ -109,7 +101,7 @@ $ make -j$(sysctl -n hw.ncpu)
109101
```
110102

111103
> Alternatively, to configure and build with the toolbelt, prepend `tb` to the make commands as follows:
112-
>
104+
>
113105
> ```
114106
> $ tb make cf2_defconfig
115107
> $ tb make

docs/development/openocd_gdb_debugging.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -101,24 +101,8 @@ You should now see WSL Ubuntu installing the VS Code Server program. Shortly aft
101101
> Note: In addition to the Arm-Cortex Debugging Extension (Version 1.2.2!), which is installed later in this instruction, you should also install Microsofts C/C++ Extension Pack and its recommended Extensions.
102102
103103
##### Attach the ST-Link V2 USB device directly to WSL
104-
In contrast to `make cload`, which uses the windows programs to interface with usb devices such as Crazyradio PA, the openocd wants to communicate directly in WSL with your ST-Link V2. So it's not sufficient to just connect it to your Windows machine, you also have to attach it to WSL. For that we need to install USBIPD on Windows.
105104

106-
In Windows Powershell(Admin), execute
107-
108-
winget install --interactive --exact dorssel.usbipd-win
109-
110-
In WSL Ubuntu, execute
111-
112-
sudo apt install linux-tools-5.4.0-77-generic hwdata -y
113-
sudo update-alternatives --install /usr/local/bin/usbip usbip /usr/lib/linux-tools/5.4.0-77-generic/usbip 20
114-
115-
After that you can use the following Commands in Windows Powershell(Admin)
116-
- List all USB Devices: ```usbipd wsl list```
117-
- Attach USB Device to WSL:
118-
- ```usbipd wsl attach -b <busid of ST-Link>```
119-
- ```usbipd wsl attach -b <busid of ST-Link> -d <Name of specific WSL Distro if you have more than one>```
120-
- Example: ```usbipd wsl attach -b 2-6 -d Ubuntu-20.04```
121-
- Detach USB Device to WSL: ```usbipd wsl detach -b <busid of ST-Link>``` (or just unplug it)
105+
Unlike make cload, which uses Windows programs to connect with USB devices like the Crazyradio PA, OpenOCD needs to communicate directly with your ST-Link V2 in WSL. Simply connecting it to your Windows machine isn’t enough; you also need to attach it to WSL. To do this, you'll need to install `USBIPD` on Windows. Follow the instructions on[ how to install USBIPD](https://github.com/dorssel/usbipd-win?tab=readme-ov-file#how-to-install) and [how to attach a device to WSL](https://github.com/dorssel/usbipd-win?tab=readme-ov-file#connecting-devices).
122106

123107
Now make sure that it is connected to WSL by listing all usb devices with ```lsusb```
124108
Currently only the Superuser has read/write access to that usb device, change that by

docs/functional-areas/crtp/crtp_platform.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,13 @@ Answer:
123123

124124
Returns a string representation of the device type the firmware is running on. The currently existing device types are:
125125

126-
| Device Type | Device type name |
127-
|-------------|------------------|
128-
| RZ10 | Crazyflie Bolt |
129-
| CF20 | Crazyflie 2.0 |
130-
| CF2.1 | Crazyflie 2.1 |
131-
| RR10 | Roadrunner 1.0 |
126+
| Device Type | Device type name |
127+
|-------------|-------------------------|
128+
| RZ10 | Crazyflie Bolt |
129+
| CF20 | Crazyflie 2.0 |
130+
| CF2.1 | Crazyflie 2.1 |
131+
| C21B | Crazyflie 2.1 Brushless |
132+
| RR10 | Roadrunner 1.0 |
132133

133134
## App channel
134135

docs/userguides/configuration/loco_tx_power.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Note that the Loco deck is only transmitting in TWR mode or when setting anchor
1818
Loco deck does not increase the space that a TDoA system covers.
1919

2020
To change to full power:
21-
1. In a terminal, run `make meuconfig`
21+
1. In a terminal, run `make menuconfig`
2222
2. Go to `Expansion deck configuration`
2323
3. Check the `Full TX power` option under the `Support the Loco positioning deck` section
2424
4. Save and exit

docs/userguides/platform.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ An identifier is stored in the physical hardware of each device, which is ued to
5050
|----------|---------------------------------------------|
5151
| Platform | Supported hardware (device type) |
5252
|----------|---------------------------------------------|
53-
| cf2 | Crazyflie 2.0 (CF20), Crazyflie 2.1 (CF21) |
53+
| cf2 | Crazyflie 2.0 (CF20), Crazyflie 2.1 (CF21) |
54+
| cf21bl | Crazyflie 2.1 Brushless (C21B) |
5455
| bolt | Crazyflie Bolt 1.0 (CB10) |
5556
| tag | Roadrunner 1.0 (RR10) |
5657
|----------|---------------------------------------------|

0 commit comments

Comments
 (0)