Merge pull request #701 from bitcraze/ataffanel/s130-documentation

Update documentation for flashing bootloader

Author: evoggy

docs/functional-areas/cfloader.md

@@ -52,6 +52,15 @@ script:
 
 python3 -m cfloader flash cf2.bin stm32-fw -w radio://0/10/2M/E7E7E7E701
 
+## Supported targets
+
+When flashing a .bin, the correct target needs to be specified. The followind targets are currently supported:
+
+ - stm32-fw: Stm32 firmware
+ - nrf51-fw: nRF51 firmware
+ - 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
 
 Flashing new firmware for the nRF51 MCU:

docs/functional-areas/client.md

@@ -12,49 +12,70 @@ firmwares are packaged together in a ZIP file that contains a manifest
 describing which files are used for what. Here\'s an example of a
 manifest, it should be called *manifest.json*:
 
-    {
-      "version": 1,
-      "files": {
-          "cflie.bin": {
-            "platform": "cf2",
-            "target": "stm32",
-            "type": "fw"
-          },
-          "nrf_cf2.bin": {
-            "platform": "cf2",
-            "target": "nrf51",
-            "type": "fw"
-          },
-          "nrf_cload.bin": {
-            "platform": "cf2",
-            "target": "nrf51",
-            "type": "bootloader"
-          },
-          "s110.bin": {
-            "platform": "cf2",
-            "target": "nrf51",
-            "type": "softdevice"
-          }
-          "cf2_lua.bin": {
-            "platform": "cf2",
-            "target": "stm32",
-            "type": "userapp",
-            "origin": 524288
-          }
-       }
-    }
+``` json
+{
+   "version":2,
+   "subversion":1,
+   "fw_platform":"cf2",
+   "release":"2024.2",
+   "files":{
+      "cf2-2023.11.bin":{
+         "platform":"cf2",
+         "target":"stm32",
+         "type":"fw",
+         "release":"2023.11",
+         "repository":"crazyflie-firmware"
+      },
+      "cf2_nrf-2024.2.bin":{
+         "platform":"cf2",
+         "target":"nrf51",
+         "type":"fw",
+         "release":"2024.2",
+         "repository":"crazyflie2-nrf-firmware",
+         "requires":[
+            "sd-s130"
+         ]
+      },
+      "sd130_bootloader-2024.2.bin":{
+         "platform":"cf2",
+         "target":"nrf51",
+         "type":"bootloader+softdevice",
+         "release":"2024.2",
+         "repository":"crazyflie2-nrf-bootloader",
+         "provides":[
+            "sd-s130"
+         ]
+      },
+      "lighthouse.bin":{
+         "platform":"deck",
+         "target":"bcLighthouse4",
+         "type":"fw",
+         "release":"V6",
+         "repository":"lighthouse-fpga"
+      },
+      "aideck_esp.bin":{
+         "platform":"deck",
+         "target":"bcAI:esp",
+         "type":"fw",
+         "release":"2023.06",
+         "repository":"aideck-esp-firmware"
+      }
+   }
+}
+```
 
 Each entry in the file describes one file, with the following
 attributes:
 
 
 |  Attribute  | Values                            |Comments|
 | --------------- | ------------------------------------- | ---------------------- |
-|  platform       | cf2, bolt, tag                        |Select the target platform (tag = Roadrunner) |
-|  target         | stm32, nrf51                          |Select the target MCU on the target platform|
-|  type           | fw, bootloader, softdevice, userapp   |Describe what\'s contained in the binary|
-|  origin         | N/A                                   |Set the address where the app should be flashed|
+|  platform       | cf2, deck                             |Select the target platform, either the main board (CF2) or a deck |
+|  target         | stm32, nrf51, <deck>:<cpu>            |Select the target MCU on the target platform|
+|  type           | fw, bootloader, bootloader+softdevice |Describe what\'s contained in the binary|
+|  release        | A version string                      | The release name of the file |
+|  repository     | A repository string                   | The binary's project git repository. If not a complete address, is on the Bitcraze's github project |
+|  requires       | A list of requirement                 | Requirement before flashing the firmware. Is used to specify a required softdevice |
+|  provices       | A requiremet provided by this file    | Used to describe what a softdevice binary provides |
 
-
-Currently only platform=cf2, target=stm32, target=nrf51 and type=fw is
-supported.
+Currently only platform=cf2, target=stm32, target=nrf51 and type=fw, type=bootloader+softdevice is supported.

docs/installation/install.md

@@ -5,9 +5,7 @@ page_id: install
 
 ## Prerequisites
 
-This project requires Python 3.7 - 3.11. 
-
-> Python 3.12 is not supported as it has issues with missing packages (see [this ticket](https://github.com/bitcraze/crazyflie-lib-python/issues/425))
+This project requires Python 3.8 - 3.12.
 
 There are a few things to sort out on your machine before you can install the client. Please see the appropriate
 section depending on your environment.