Skip to content

Commit 80e9708

Browse files
committed
Review firmware article
1 parent 66afb71 commit 80e9708

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

articles/firmware.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Firmware
22

3+
As Harp devices are updated, new features are added and bugs are fixed. Device-specific interfaces depend on the right firmware being installed on your device. This section details how to check and maintain the correct version of device firmware to ensure reproducible workflows.
4+
35
## Updating device firmware
46

5-
As `Harp Devices` are updated, new features are added and bugs are fixed. To ensure that your device is running the latest firmware, you can use the `Device Setup` tool available in Bonsai. This tool will be available with the `Bonsai.Harp.Design` package. To launch it, simply add a generic `Device` node to your workflow, and open its default editor (by double-clicking on the node). If an `Harp Device` is detected on the currently selected `COM port`, the following dialog will appear:
7+
To ensure that your device is running the latest firmware, you can use the **Device Setup** tool available in Bonsai. This tool is made available by installing the `Bonsai.Harp.Design` package. To launch it, simply add a generic `Device` node to your workflow, and open its default editor (by double-clicking on the node). If a Harp device is detected on the currently selected COM port, the following dialog will appear:
68

7-
![firmware update](~/images/fw-update.png)
9+
![firmware update](~/images/fw-update.png){height=200px}
810

911
To update the device's firmware version:
1012

1113
1. Click `Bootloader`;
1214
2. Click `Open`;
1315
3. Select a `.hex` file containing the new firmware. These files should be available on the device's releases page (e.g.: [Harp Behavior](https://github.com/harp-tech/device.behavior/releases) under the `fwX.Y-harpV.W` release name). Importantly, as stated in the dialog window, please ensure the the new firmware is compatible with the targeted device;
14-
4. Click `Update`
16+
4. Click `Update`.
1517

16-
![firmware update step2](~/images/fw-update_hex.png)
18+
![firmware update step2](~/images/fw-update_hex.png){height=200px}
1719

1820
If everything goes well, the device will reboot with the new firmware.

articles/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
href: intro.md
55
- name: Operators
66
href: operators.md
7-
- name: Firmware Updates
7+
- name: Firmware
88
href: firmware.md
99
- name: Logging
1010
href: logging.md

0 commit comments

Comments
 (0)