https://github.com/jkaflik/omros2-firmware
A firmware for OpenMower mainboard that acts as a node using Micro-ROS
https://github.com/jkaflik/omros2-firmware
Last synced: about 2 months ago
JSON representation
A firmware for OpenMower mainboard that acts as a node using Micro-ROS
- Host: GitHub
- URL: https://github.com/jkaflik/omros2-firmware
- Owner: jkaflik
- License: apache-2.0
- Created: 2023-08-30T15:15:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-18T09:09:54.000Z (7 months ago)
- Last Synced: 2025-04-18T22:46:51.024Z (7 months ago)
- Language: C++
- Size: 109 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# omros2-firmware
## Overview
This is a [OpenMower](https://github.com/ClemensElflein/OpenMower) mainboard firmware replacement to work with [OpenMowerROS2](https://jkaflik.github.io/OpenMowerROS2/) alternative ROS software.
More details about this firmware can be found in [documentation](https://jkaflik.github.io/OpenMowerROS2/omros2-firmware.html).
## Features
- [x] ROS2 node using Micro-ROS
- [x] Auto-reconnect
- [x] Power-related publishers
- [x] IMU publisher
- [x] Charging
- [x] LED status
- [x] IMU
- [ ] Emergency mode
- [ ] Emergency publisher
- [ ] Emergency restart service
- [ ] Cover panel support
## Usage
### LED Status Indicators
The firmware uses onboard NeoPixel LED(s) to display the current system status. Multiple status conditions can be active simultaneously and will be displayed in sequence.
**LED Status Colors:**
- **Green**: ROS connected
- **Yellow**: Battery charging
- **Magenta**: Battery discharging
- **Red**: Battery low
- **Blue**: IMU sensor failure
When multiple statuses are active, each status will be shown for approximately 800ms with a 200ms black separator between them. The sequence will continue to cycle through all active statuses.
## Build
### Prepare environment
> [!IMPORTANT]
> This firmware is meant to be run on a [OpenMower](https://github.com/ClemensElflein/OpenMower) hardware or compatible.
Firmware is build against a RP2040 chip only using PlatformIO.
Default target is a remotely run OpenOCD with a Pico board as a SWD target.
Everything should work out of the box. Make sure your `--upload-port` is your Raspberry Pi host. (one used for the OpenMower)
> [!NOTE]
> Only Raspberry Pi5 is supported. OpenOCD configuration is crafted for it. If you want to use another board, see older commits in this repository.
On the hardware side, you need to connect the Raspberry Pi SWD interface to the target SWD interface. Luckily, on the OpenMower mainboard there is are circuits to do so. All you have to do is to use 4 jumpers on J22.
When executing build/debug target, along with firmware, [the bash script](utils/remote-openocd.sh) will be deployed to target Raspberry Pi and executed.
### Build (& run)
```bash
platformio run -t upload
```
(**note**: you can use `pio run` as well, so it doesn't upload to target)
## Debugging
Use your IDE integration to debug the code. You can use `pio debug` command as well.
This will run the same bash script as in the upload command, but it will not upload the firmware. You can use `pio debug -t upload` to upload the firmware and start debugging.
## Micro-ROS agent for testing
You can use the Micro-ROS agent container to test the firmware. To run it a remote RaspberryPi device run the following command:
```bash
make agent_remote
```
If you have an access to the Pico's UART0 directly on your host machine run:
```bash
make agent MICRO_ROS_DEVICE=/dev/ttyAMA0
```