document param settings

README.md

@@ -68,7 +68,8 @@ Pre-built releases are in the releases folder on github.
 
 ## Flashing
 
-To flash to an ESP32-S3 board use the espressif FlashTool from
+For initial firmload load, to flash to an ESP32-S3 board use the espressif FlashTool from
+
 https://www.espressif.com/en/support/download/other-tools
 
 If this is the first time flashing the board, you may need to hold the "boot" button down while attaching the USB cable to the USB connector marked "USB"
@@ -82,12 +83,86 @@ the following options, after selecting the COMM port that the board is attached:
 
 subsequent re-flashing of newer releases should not require holding the "boot" button during power-up of the board as the USB cable is attached.
 
+## DroneCAN Parameters
+
+The firmware comes with a set of DroneCAN accessible parameters which
+control the behaviour of the board.
+
+![DroneCan Parameters](images/DroneCAN-parameters.jpg)
+
+Key parameters are:
+
+ - LOCK_LEVEL: this controls the lockdown of the board. If this is set
+   to a non-zero value then all parameters updates via DroneCAN will
+   be prevented. To change parameters (including the LOCK_LEVEL) once
+   this is set you need to use a DroneCAN SecureCommand. There is an
+   example script in scripts/secure_command.py which can change any
+   parameter if you know a private key corresponding to one of the
+   public keys
+
+ - UAS_TYPE, UAS_ID_TYPE and UAS_ID: these override the IDs in the
+   RemoteID BasicID packet when they have all been set. These should
+   be set by the vendor before shipping the vehicle.
+
+ - WEBSERVER_ENABLE: this enables the building WiFi access point and
+   webserver for status monitoring and secure firmware update.
+
+ - PUBLIC_KEY1 to PUBLIC_KEY5: these are the public keys that will be
+   used to verify firmware updates and secure update of parameters
+
+## Web Server
+
+The firmware comes with a builtin web server if the parameters
+WEBSERVER_ENABLE is set. The WiFi access point will use a SSID from
+WIFI_SSID and password from WIFI_PASSWORD which you can set with
+DroneCAN parameter tools such as the DroneCAN GUI tool or
+MissionPlanner CAN tool.
+
+The web server has a secure firmware update mechanism which will only
+allow a properly signed firmware with a signature corresponding to one
+of the 5 public keys in the parameters. If no public keys are set then
+any firmware can be loaded.
+
+The web server defaults to URL http://192.168.4.1 once you connect to
+the WiFi access point.
+
+## Firmware Signing
+
+To generate public/private key pairs please use:
+
+```
+  scripts/generate_keys.py
+```
+
+the keys are compatible with the ArduPilot secure boot system. By
+default the 3 ArduPilot release public keys are included.
+
+Once you have generated a public key you can add it to the RemoteID
+node using a DroneCAN parameter editor. Make sure you keep the private
+key in a secure location.
+
+To upload a firmware via the web server you need to use an "OTA" (Over
+The Air) firmware, which is generated as OTA files in the build. You
+then need to sign it with a private key corresponding to one of the
+public keys on the RemoteID node.
+
+To sign an OTA firmware you should use a command such as this one:
+
+```
+ scripts/sign_fw.py ArduRemoteID_ESP32S3_DEV_OTA.bin MyName_private_key.dat 1
+```
+
+The '1' on the end is the BOARD_ID. See board_config.h for the board
+IDs for your board.
+
+Once signed you can upload the firmware via the web server.
+
 ## ArduPilot Support
 
-Support for OpenDroneID is in ArduPilot master and is pending for
-addition to the 4.2.x stable releases. You need to enable it on a
+Support for OpenDroneID is in ArduPilot master and is also in the
+4.2.3 stable releases and 4.3.x releases. You need to enable it on a
 board by setting "define AP_OPENDRONEID_ENABLED 1" in the hwdef.dat
-for your board.
+for your board or by using --enable-opendroneid when doing waf configure.
 
 ## Credit
 

RemoteIDModule/parameters.cpp

@@ -12,8 +12,8 @@ static nvs_handle handle;
 const Parameters::Param Parameters::params[] = {
     { "LOCK_LEVEL",        Parameters::ParamType::UINT8,  (const void*)&g.lock_level,       0, 0, 2 },
     { "CAN_NODE",          Parameters::ParamType::UINT8,  (const void*)&g.can_node,         0, 0, 127 },
-    { "UA_TYPE",           Parameters::ParamType::UINT8,  (const void*)&g.ua_type,          0, 0, 15 },
-    { "ID_TYPE",           Parameters::ParamType::UINT8,  (const void*)&g.id_type,          0, 0, 4 },
+    { "UAS_TYPE",          Parameters::ParamType::UINT8,  (const void*)&g.ua_type,          0, 0, 15 },
+    { "UAS_ID_TYPE",       Parameters::ParamType::UINT8,  (const void*)&g.id_type,          0, 0, 4 },
     { "UAS_ID",            Parameters::ParamType::CHAR20, (const void*)&g.uas_id[0],        0, 0, 0 },
     { "BAUDRATE",          Parameters::ParamType::UINT32, (const void*)&g.baudrate,         57600, 9600, 921600 },
     { "WIFI_NAN_RATE",     Parameters::ParamType::FLOAT,  (const void*)&g.wifi_nan_rate,    0, 0, 5 },