Skip to content

Commit c50dd69

Browse files
committed
Add instructions on releasing new firmware
1 parent 756404b commit c50dd69

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,27 @@ The repository includes the firmware for the three Stretch PCBA types:
1111
* hello_wacc: firmware for wrist accelerometer board (Wacc) in the wrist
1212
* hello_pimu: firmware for power and imu board (Pimu) in the base
1313

14+
## Releasing New Firmware
15+
16+
If you're a maintainer for this repo, follow these steps to release new firmware. Stretch users will be able to use the [`REx_firmware_updater.py` CLI](https://docs.hello-robot.com/0.3/software/updating_software/#firmware) to install the new release.
17+
18+
1. Review and merge a pull request into the main branch. In the PR, ensure that you increment the version/protocol of the firmwares (hello_stepper, hello_wacc, hello_pimu) that received changes. You can do this by changing `#define FIRMWARE_VERSION "Pimu.v0.0.5p0"` in the firmware's Common.h file. When updating the protocol version increment the <Minor> version as well, for example, Pimu.v0.0.5p0 --> Pimu.v0.1.0p1
19+
2. Clone the firmware locally
20+
```
21+
gh repo clone hello-robot/stretch_firmware
22+
```
23+
3. Tag with the full version name that matches Common.h , eg
24+
```
25+
git tag -a Pimu.v0.0.5p0 -m "Pimu bugfix of foo"
26+
```
27+
4. Push the tag to Github
28+
```
29+
git push origin --tags
30+
```
31+
5. Ensure the new firmware is detected by the updater CLI
32+
```
33+
REx_firmware_updater.py --recommended
34+
```
1435
1536
## License
1637
For details, see the LICENSE.md file in the root directory. All materials within this repository are licensed with the [GNU General Public License v3.0 (GNU GPLv3)](https://www.gnu.org/licenses/gpl-3.0.html) except where other third-party licenses must apply.

0 commit comments

Comments
 (0)