OpenMower — Open Source RTK GPS Robotic Mower – Documentation

Docs: Compatible Mowers

Mon, 01 Jan 0001 00:00:00 +0000

Yard Force

Check out the Git Repo Here: https://github.com/xtech/hw-openmower-yardforce

The project got started on a YardForce Classic 500(B), and there are photo guides in this documentation on how to disassemble and reassemble it. From a user’s perspective, the YardForce Classic 500(B) is the “best supported” mower.

However, there are more mowers from the YardForce brand that are compatible:

In theory, every YardForce model with the Core + Outer Frame Chassis (SA, SC, LUV, N and NX Line) that has a production year of 2019+ has compatible electronics to replace the stock mainboard with an OpenMower one.

As of today the YardForce Amiro, Compact, EasyMow, MowBest, XPower and MB series models are not (yet) compatible.
The main reason is that the OpenMower mainboard does not fit in their chassis.

SABO / John Deere

There is a dedicated mainboard for SABO MOWit 500F (Series-I & II) and John Deere Tango E5 (Series-I & II) mowers.

Check out the Git Repo Here: https://github.com/xtech/hw-openmower-sabo

This Carrierboard is compatible with the following mower models:

SABO MOWit 500F (Series-I & II)
John Deere Tango E5 (Series-I & II)

Series-I Carrierboard (v0.2)	Series-II Carrierboard (v0.2)

Series-I (v0.1) @ John Deere Tango E5	Series-II (v0.1) @ Sabo MOWiT 500F

These mowers are well supported. Even the display controller was replaced by a fully functional, modern user interface!

Your browser does not support the video tag.

Universal Board

The universal board contains all features needed for an Open Mower build (e.g., three BLDC/DC motor controllers, a LiPo charger on board, connectors for GPS, emergency sensors, etc.). It has screw terminals for easy connections and can be broken into smaller modules if it doesn’t fit as a whole board.

Check out the Git Repo Here: https://github.com/xtech/hw-openmower-universal

Other Compatible Brands

The following mower brands are known to have compatible hardware with the Universal mainboard. If you want to check your specific model, ask on Discord. The probability is high that it will work:

Husqvarna: Most Husqvarna mowers
Gardena: Most Gardena mowers
Fuxtec / Redback: Fuxtec and Redback mowers

Custom Hardware

If you have a custom chassis, there is a good chance you can get it to work with the Universal board. Ask on Discord for guidance on your specific setup.

Docs: Step 2.1: Prepare the GPS

Mon, 01 Jan 0001 00:00:00 +0000

Update Firmware and configure the GPS board

Info

<p>There is a tutorial video available for this step of the process! <br/>

Check my YouTube video here: Video

(time 16:21 - 17:15)

Prerequisites

An Ardusimple F9P GPS board
A Micro USB Cable
A Windows PC
Latest v1 version of the u-center software:
🔗 https://www.u-blox.com/en/product/u-center
Don’t get u-center V2, you will need u-center v1 for the F9P.
The GPS configuration file
🔗 robot-fw-1_51.txt
This will open in a new browser tab. Use Ctrl+S to download the file.

Step 2.1.0: Update Firmware

Warning

<p>The F9P now exists in multiple variants. The firmware below is for the L1 + L2 version. Make sure that on the u-blox chip, it says one of the following: <strong>ZED-F9P-02B, ZED-F9P-04B or ZED-F9P-05B!</strong>.</p>

If it’s a different board, don’t use the linked firmware, get it from u-blox.com directly.

Update the firmware of your Ardusimple board to version ZED-F9P HPG 1.51 - link here . There’s a guide on the Ardusimple Website .

Step 2.1.1: Open u-center and connect to your GPS

After installing u-center, connect your Ardusimple board using the “Power+GPS” USB socket to your Windows computer. You should see the blue LEDs of the board come on and Windows should recognize the device as a COM port. With the module connected to your PC, open the u-center software.

In u-center, first connect to your board by selecting the appropriate COM port in the Receiver -> Connection menu.

Step 2.1.2: Transfer the configuration to the GPS

After successfully connecting to the board, you can transfer the previously downloaded configuration file robot-fw-1_51.txt by opening the window Tools -> Receiver Configuration .... In this window you open the robot-fw-1_51.txt using the ... button and then transfer the configuration to the GPS by clicking the Transfer File -> GNSS button.

Step 2.1.3: Save configuration to Flash

In order to keep the GPS configured even after powering it down, you need to save the current configuration to Flash memory. In order to do this, select View -> Configuration View. In the new window you need to select CFG (Configuration) in the list on the left side and then enable Save current configuration. Make sure that 0 - BBR and 1 - FLASH are both selected on the right side of the window. Once that’s done, click the Send button in the lower toolbar of the window.

Once successful, there will be a timer showing on the upper right side of the window. This is the timer since the last message was sent to your GPS board. It should be 0s directly after clicking Send.

Step 2.1.4: Done 🎉

Your GPS is now configured for use with the Open Mower software. You can disconnect it from your Windows PC.

Connect your UM9xx to your PC using the supplied USB-C cable
Open a serial terminal (minicom, miniterm, CuteCom, etc.) at 115200 baud
Take attention that your line-end termination has to be CR/LF
Send CONFIG↵ Enter to verify the connection. You should see readable key/value style output. If not, check cable, port, and permissions.
Reset and switch the baud rate to 921600 by entering the following commands, line by line:

FRESET↵ Enter
CONFIG COM1 921600↵ Enter

(After FRESET the module may take a few seconds to respond.)
Re-check connection with the simple CONFIG command. If you don’t get similar results than before, change your serial terminal speed to 921600 baud (re-open if necessary) and run CONFIG again, till your get a reasonable response
Apply the rover configuration by entering the following commands, line by line:

MODE ROVER UAV↵ Enter
GPGSV COM1 2↵ Enter
GPRMC COM1 1↵ Enter
GPGSA COM1 1↵ Enter
GPVTG COM1 1↵ Enter
GPGST COM1 1↵ Enter
GPGGA COM1 0.2↵ Enter
SAVECONFIG↵ Enter

Take attention to the SAVECONFIG command, which stores settings so they survive power cycles.
Unplug the USB cable from the UM9x module and mount it to the CarrierBoard (solder required headers first if required).

Continue with Step 2.2: Prepare the SD Card

Docs: Step 1: Check Compatibility

Mon, 01 Jan 0001 00:00:00 +0000

Before purchasing anything, verify your mower is compatible with the OpenMower project. Use this flowchart to check compatibility:

%%{init: { "flowchart": { "nodeSpacing": 15, "diagramPadding": 3 }, "themeVariables": { "fontSize": "12px" } }}%% flowchart TD %% Nodes Start([Start]) CheckList{"Is the mower in the
Compatible Mowers List?"} Compatible(["Compatible
Proceed with standard install"]) CheckEncoders{"Does the mower have
Wheel Encoders?"} Incompatible(["Incompatible
Ask on Discord for confirmation"]) CheckBattery{"Check Battery Voltage
(Series count 5S - 8S)"} CheckSpace{"Enough space for
Universal Mainboard?"} UniversalMainboard(["Universal Mainboard
Hardware looks good"]) AskDiscord(["Unknown Compatibility
Ask on Discord"]) %% Classes classDef decision fill:#FFF,stroke:#666,stroke-width:2px,color:#333; %% Assign class to decision nodes class CheckList,CheckEncoders,CheckBattery,CheckSpace decision; %% Styles style Start fill:#93c0f0,stroke:#333,stroke-width:2px,color:#333 style Compatible fill:#256d33,stroke:#333,stroke-width:2px,color:#fcfcfc style UniversalMainboard fill:#256d33,stroke:#333,stroke-width:2px,color:#fcfcfc style Incompatible fill:#a63a41,stroke:#333,stroke-width:2px,color:#fcfcfc style AskDiscord fill:#e19e20,stroke:#333,stroke-width:2px,color:#fcfcfc %% Logic Connections Start --> CheckList CheckList -- Yes --> Compatible CheckList -- No --> CheckEncoders CheckEncoders -- No --> Incompatible CheckEncoders -- Yes --> CheckBattery %% Voltage Calculation: %% 5S (5 * 3.6V = 18V) to 8S (8 * 4.2V = 33.6V) CheckBattery -- "Yes: 18.5V - 29.6V" --> CheckSpace CheckBattery -- "No: < 18.5V or > 29.6V" --> AskDiscord CheckSpace -- Yes --> UniversalMainboard CheckSpace -- No --> AskDiscord

Battery Voltage Explained

The voltage range 18.5V - 29.6V corresponds to 5S-8S lithium battery packs based on nominal cell voltage (3.7V per cell):

5S: 5 × 3.7V = 18.5V nominal
8S: 8 × 3.7V = 29.6V nominal

Check your mower’s battery label or manual to determine the series count.

Officially Supported Mowers

Yard Force

Check out the Git Repo Here: https://github.com/xtech/hw-openmower-yardforce

However, there are more mowers from the YardForce brand that are compatible:

As of today the YardForce Amiro, Compact, EasyMow, MowBest, XPower and MB series models are not (yet) compatible.
The main reason is that the OpenMower mainboard does not fit in their chassis.

SABO / John Deere

There is a dedicated mainboard for SABO MOWit 500F (Series-I & II) and John Deere Tango E5 (Series-I & II) mowers.

Check out the Git Repo Here: https://github.com/xtech/hw-openmower-sabo

This Carrierboard is compatible with the following mower models:

SABO MOWit 500F (Series-I & II)
John Deere Tango E5 (Series-I & II)

Series-I Carrierboard (v0.2)	Series-II Carrierboard (v0.2)

Series-I (v0.1) @ John Deere Tango E5	Series-II (v0.1) @ Sabo MOWiT 500F

These mowers are well supported. Even the display controller was replaced by a fully functional, modern user interface!

Your browser does not support the video tag.

Universal Board

Check out the Git Repo Here: https://github.com/xtech/hw-openmower-universal

Other Compatible Brands

The following mower brands are known to have compatible hardware with the Universal mainboard. If you want to check your specific model, ask on Discord. The probability is high that it will work:

Husqvarna: Most Husqvarna mowers
Gardena: Most Gardena mowers
Fuxtec / Redback: Fuxtec and Redback mowers

Custom Hardware

If you have a custom chassis, there is a good chance you can get it to work with the Universal board. Ask on Discord for guidance on your specific setup.

Docs: Step 3.1: Connect WiFi

Mon, 01 Jan 0001 00:00:00 +0000

Step 3.0: Ensure the Robot has Power

Make sure that the Robot does not drain the battery, it probably will be empty until your setup is finished. Usually this can be done by putting it into the docking station (except for the Universal board).

Step 3.1: Search the Hotspot

With the mower turned on, use your mobile device and scan for WiFi networks. OpenMowerOS will automatically create a hotspot with the name `OpenMower-`. Connect to this hotspot.

If your mobile device complains that the network does not have internet connectivity, tell it to use it anyway.

Step 3.2: Open a browser to the configuration page.

Some devices will detect that the hotspot does not provide internet connectivity and will send you to a configuration page.

If your device does not do this, open the browser on your phone and navigate to: http://10.41.0.1/ .

Step 3.3: Enter your WiFi Credentials

Once on the configuration page, select your home Wi-Fi connection and enter your password. Then click connect.

The OpenMower WiFi should disappear and the robot will connect to your home network.

Step 3.4: Check Connection

Let’s do some sanity checks, if the mower has powered on successfully.

Check the connection by using any other PC in your network and ping openmower.local. This should be working. Alternatively, you can check if the device is connected by logging into your router.
Check, if you can reach the mower via SSH (ssh openmower@openmower.local, password openmower).
Check, if you can reach the mower’s terminal in a browser. Navigate to http://openmower.local:7681/

Docs: Getting Started

Mon, 01 Jan 0001 00:00:00 +0000

Quick Facts

Build time: A weekend for a YardForce-class mower; longer for custom chassis
Estimated cost: ~€700 (excluding the mower and RTK base station)
Skill level: Intermediate electronics, Linux, and mechanical skills
Community: 2k+ members on Discord ready to help with reviews and troubleshooting

New to the project? Start with the Overview page .

Important Warnings

Read Before Starting

Ongoing Development: OpenMower is continuously evolving. Be prepared to troubleshoot and update software.
Lithium Battery Safety: You will build your own charger. Understand the risks of working with lithium batteries.
Your Responsibility: Ensure you understand each modification step before proceeding.
Read the entire documentation and gain a high-level overview: Understand each step involved in the build before starting.
Evolving Documentation: This documentation is continuously improved. If you find errors or have questions, ask on Discord.

Is Your Mower Compatible?

Before purchasing anything, verify your mower is compatible with the OpenMower project.

Officially Supported Mowers

The following mowers are fully supported with dedicated carrier boards:

YardForce Classic 500(B) - Most common, well-documented
Other YardForce Models (SA Series)
SABO MOWit 500F (Series-I & II)
John Deere Tango E5 (Series-I & II)
Many other models using the universal carrier board
If you want to build a mower from scratch, that’s also possible

See the full Compatible Mowers List for additional models and community builds.

What You Need to Know

Required Skills

Linux Basics: Comfortable with terminal commands, basic file system navigation, and text editing
Raspberry Pi Experience: Ability to set up and configure a Raspberry Pi
Electronics Knowledge: Experience with PCBs, connectors, and basic electrical safety
Mechanical Skills: Ability to disassemble and reassemble your mower

Note

While the OpenMower app simplifies configuration, you may need to debug issues via SSH or adjust settings manually.

What Parts You’ll Need

The OpenMower project requires these main components:

1. The Robot

A compatible lawn-mowing robot with its case and motors. You’ll replace the electronics with OpenMower hardware. Some people are building a custom mower chassis from scratch.

2. OpenMower Hardware

Hardware Version 2

OpenMower v2 hardware is now available and recommended for all new builds. v1 hardware is deprecated. See the v2 Announcement for details.

To purchase v2 hardware: Contact @Apehaenger on Discord.

Custom electronics consisting of:

Core Board: Universal computing module with Raspberry Pi CM4, STM32 controller, IMU
Carrier Board: Model-specific board (YardForce, SABO/John Deere, or Universal)
3x xESC Board: Advanced motor controllers which can drive BLDC or DC motors and provide position feedback as well as closed-loop speed control

3. RTK GPS System

RTK GPS enables centimeter-level accuracy by sending error corrections to the robot via Wi-Fi or radio. Therefore, you will need one or two RTK GPS receivers:

Rover (required): GPS module mounted on the robot
Base Station (optional): Fixed GPS module providing correction data OR access to an external NTRIP service which provides the corrections via the internet. Some countries have free RTK services available.

Build Overview

Follow these steps in sequence:

Ready to shop?

Check the detailed Shopping List .

Get Support

Discord Community

Join our active Discord community for:

Build guidance and troubleshooting
Hardware availability updates
Software tips and tricks
Feature discussions

🔗 Join OpenMower Discord

Documentation & Resources

This Documentation: Reviewed, official information
YouTube Channel: Video tutorials and project updates

See the Links page for all resources.

Next Steps

If you are ready to start building:

➡️ Review the Shopping List

➡️ Check the Step by Step Guide

Docs: YardForce Classic 500(B)

Mon, 01 Jan 0001 00:00:00 +0000

v2 Hardware Only!

This guide here is for OpenMower v2.x Hardware! If you have v1 Hardware, follow the legacy docs here , because for v1 hardware you will also need to modify the docking station!

You have v1 hardware, if:

You are using a full-size Raspberry Pi
Your mainboard shows version v0.xx

Prerequisites

Things you will need:

YardForce Classic 500(B)
Open Mower Mainboard with all modules installed (xCore, CM4, GPS, 3x ESCs)
Cover UI Board (optional)
GPS Holder (3d printed part), GPS Antenna, 2x M2,5x20 screws, 2x M4x16 screws for the GPS holder

Tools you will need:

XH connector set and some wires to crimp connectors for the emergency stops and the Cover UI board
Some basic screwdrivers for disassembly and assembly.

Step 2.4.1: Disassemble the Robot

The first step is to disassemble up the robot. This is a bit tricky in some parts, so I recommend you checking my YouTube video here: YouTube Video . The relevant time is: 2:25 - 5:08. Do not follow the video further than that, because it is outdated.

Alternatively, here is a picture guide of the disassembly process:

Unscrew top cover

Pry the cover

This is a bit tricky in some parts, so I recommend you checking YouTube video here: YouTube Video . The relevant time is: 2:25 - 5:08.

Unplug the cover

2 small wires on the front going to wheel sensors, and 1 wide wire from mainboard to cover UI board. Screwdriver is in the pictures for illustrative purposes, you can simply hold it with your hand.

Unplug the mainboard

Remove front PCB

Remove cover UI board

Info

This section assumes that you are completely replacing the stock UI board with a custom one. There is an option to reuse stock board by flashing it with custom firmware. If you are going to go this path - leave it in place. You can find more information in the Cover UI Repo *.

* Would be nice if someone could transfer this to the Knowledge Base on this website though.

Step 2.4.2: Remove Stock Electronics

You will need to remove these stock electronics:

Mainboard
Perimeter Sensor (slim PCB in the front of the robot).
All cables in the orange cover (emergency stop).

Keep the battery in place.

Step 2.4.3: Small Preparations

3.1 Cutting Plastic Tabs in the Lid

On some YardForce Classic 500 models, in the lid there are plastic tabs which are in the way when installing the OpenMower mainboard. We need to clip these tabs off. I have used a large side cutter, but you can also use a Dremel or whatever you have handy.

If your cover does not have tabs, you don’t need to do anything here.

3.2 Assemble GPS Antenna Holder

Take the GPS antenna holder and assemble it as shown in the picture.

3.3 Add new connectors to the Emergency Stop Cables

The Open Mower mainboard uses one JST XH connectors for each of the emergency stop sensors, whereas the original YardForce Classic 500 uses one large connector with all emergency stop buttons connected to it. In the following picture you can see the original connector cable.

We will now create four cables, one for each emergency stop sensor. To do this:

First, Cut the cable very close to the large connector as shown in the picture. You will need the whole length of the emergency stop cables.
Then, crimp XH connectors to the other end of the cable as shown in the picture below. Make sure to check the pinout! There is a twist in the connector!
Repeat this step for all four emergency stop sensors, so that each one has an XH connector at the end. The pinout is the same for all of them.

In the end you will have four cables with different lengths, but the same pinout.

3.4 Create a cable for the CoverUI

If you are going to use a custom CoverUI board, you will need to create a cable to connect it to the mainboard.

Take four wires with around 20 cm length.
Crimp XH connectors on both sides of the cables as shown in the picture. The connections are “straight through”, so pin 1 connectos to pin 1 on the other side and so on.

Step 2.4.4: Install OpenMower Electronics

Now you can install the OpenMower mainboard and the GPS antenna holder we prepared earlier.

Put the mainboard into the mower just as the original board was installed
(in the rear it sits between plastic tabs, on the front there are two screws holding it in place).
To fit the GPS holder into the mower, you need need to remove two of the white plastic cable ties by just pulling them upwards. Then plug it into the corresponding holes and fix it with one screw you saved earlier.
Connect all cables as shown in the picture and the list below.

When finished, it should look like this:

The connections are as follows:

Mower Motor Sensor
Main Motor Connector (Drive motors, mower motors, sensors)
Power Connector
Charging Contacts
Emergency Stop Button in the Lid (left / right side doesn’t matter)
Emergency Stop Button in the Lid (left / right side doesn’t matter)
USB Connector on the Rear of the Robot
Cover UI Board in the Lid (optional)
GPS Antenna
Lift Sensor (left / right side doesn’t matter)
Lift Sensor (left / right side doesn’t matter)

Step 2.4.5: Install external WiFi Antenna (optional)

If you want to use an external WiFi antenna for better reception, installation is simple.

Prerequisites

Things you will need:

WiFi Antenna Mount: 3D printed part available on Printables
Two Screws you can use the screws from the front sensor we removed earlier
WiFi Antenna with Cable You can get it from Amazon

Steps:

Mount the antenna to the holder
Mount the holder to the mower using the two screws
Connect the antenna to the CM4 board
Zip tie the cable to the corner of the PCB

Step 2.4.6: First Startup

It’s time to power the robot up by hitting the switch at the back of the robot.

Warning

If you see / smell anything unexpected, turn the switch off immediately!

This includes but is not limited to:

Smoke / Fire
Smell of hot electronics
Blown Fuses

Some battery packs don’t like the inrush current and will turn off immediately. If this happens, you can try to turn the switch off and on again and it should work.

Once turned on, LEDs should start blinking on the ESCs, the GPS, the xCore board and the mainboard. Keep the robot turned on for at least five minutes to maker sure the CM4 boots up properly. It does setup during the first boot.

Info

It’s a good idea to place the mower into the docking station, so that the battery doesn’t drain.

In this state, the battery does not charge, because the core board does not have the correct firmware installed, but the docking voltage will still be used to power the electronics, so the battery will not drain.

If everything seems healthy, proceed to the Software Setup .

Otherwise, stop here and ask for help on the Discord server.

Docs: Step 3.2: Basic Configuration (Environment, Firmware Installation, xESC configuration)

Mon, 01 Jan 0001 00:00:00 +0000

Overview:

Types of settings

There are two parts to the robot configuration:

Environment Variables: tell the system which mower model and hardware version you are using as well as which version of the ROS to use. We will need to configure these first.
ROS Parameters: Configure the ROS runtime behavior. This includes GPS settings, mowing behavior, MQTT configuration for smart-home, etc.

The `openmower` command line tool

We have created the openmower command line tool which helps you with all tasks related to running, configuring and debugging the OpenMower software stack.

The openmower tool is preinstalled on the OpenMowerOS and has the following features (and more):

Edit ROS and Environment configuration files
Install / Update Firmware on the xCore board
Start / Stop the ROS software
Show ROS logs
Enter a ROS shell for debugging

Accessing the terminal

You will need access to the terminal for all of the following steps. You can either use SSH or the browser-based terminal.

SSH can be reached using the following credentials:

username: openmower
hostname: openmower
password: openmower

The browser based terminal does not need any credentials and can be reached at: http://openmower:7681

Step 3.2.0: Basic Checks

Check, if filesystem expanded correctly

Warning

OpenMowerOS currently has an issue where sometimes the file system doesn’t expand correctly. You can see, if you have the problem by running df -h / and checking, if the Use % column is almost 100%.

If your filesystem is almost full, do the following steps to properly expand the filesystem:

Run sudo raspi-config
Select Advanced Options -> Expand Filesystem
Finish and Reboot
Run df -h / again, you should see the Use % column is now down to a low percentage (depending on your SD card size)

Update the `openmower` tool to the latest version

To make sure you have the latest version of the openmower tool, you need to update it to the latest version. The tool has an integrated update mechanism, so to update, you need to run:

sudo openmower update-self

Here is the expected output:

Example output for a successful update.

Rename your host (optional)

If you are running multiple robots, it’s a good idea to rename your host to distinguish between them.

You can do this by following the steps in the Knowledge Base: Change Hostname

Enable External WiFi Antenna (optional)

If you have added an external WiFi antenna, you need to enable it. You can do this by following the steps in the Knowledge Base: Enable External Antenna

Step 3.2.1: Setup Environment Variables

Now we can start the configuration by setting the environment variables.

Start the configuration by running openmower configure env
Select your favorite editor (e.g. nano)
Edit the environment variables, the comments tell you what to do
Save the file (Ctrl + O, Enter to save followed by Ctrl + X, Enter to exit nano)

Here is a screncast showing the whole process:

In the example a YardForce Classic 500 with v2 Hardware was used.

After this is done, the system will know which ROS version to use and which mower model is used.

The openmower tool will now fetch the selected ROS version. This will take some time (~30 minutes). Time to get some ☕.

Step 3.3.1: Install Firmware

Now that the system knows which hardware you are using, we are ready to install the firmware to the xCore board.

Warning

Early versions of the xCore board have a bug in the bootloader which sometimes prevents the board from being detected by the openmower tool.

If you encounter Timeout errors during the firmware installation process, update the bootloader by running: openmower update-bootloader and try again.

To install the firmware to the xCore board, simply run: openmower update-firmware. The openmower tool will read your environment variables, download the appropriate firmware binary and upload it to the xCore board via Ethernet.

The expected output is shown below:

Example output for openmower update-firmware command.

Step 3.3.2: Configure xESC Motor Controllers

The xESC motor controllers can be configured to work with many BLDC and DC motors. The firmware for the controllers is based on the open source VESC project and therefore, the controllers can be configured using the VESC Configuration Tool.

Prerequisites

Windows or Linux computer to run the VESC Configuration Tool
VESC Tool (https://vesc-project.com/vesc_tool ) You can download the tool for free by adding the “free” version in your cart and proceeding to checkout.
OpenMower Firmware needs to be successfully installed in the xCore board. This is needed because the xCore bridges the connection between your computer and the xESC. If you haven’t done it, follow the Firmware Update guide.
Optional (but makes your life easier):
Configuration files for the mower you are using.
Look in the OpenMower repository for the files suited for your mower.
You will need three files:
- App configuration XML (sets the baud rate, etc. Same for all three xESC controllers)
- Mower Motor configuration XML (motor parameters for the mower motor)
- Drive Motor configuration XML (motor parameters for the wheel motors)

Configuration Process

Stop ROS from interfering with the controllers

openmower stop to stop ROS from interfering with the controllers during configuration.

Expose the ESC to the network

Run openmower expose-xesc [left|right|mower] to expose the xESC controller (choose left, mower or right).
The controller is then reachable in your local network on openmower:65102 until you hit Ctrl + C.

Connect to the xESC

Open the VESC Configuration Tool and connect to the xESC controllers by clicking:

Connection -> TCP [1]
Insert the IP address of your mower or openmower into the Address field [2].
Set the port to 65102 [3]
Click Connect [4]

Information

If you encounter this warning message:

you can safely ignore it. The VESC tool is backward compatible with the firmware version used on the xESC controller.

Configure xESC

Upload the configurations

With the VESC Configuration Tool connected, you can now upload the configuration to your xESC controllers:

[Image 1]: Click File -> Load Motor Configuration XML
[Image 2]: Select the motor configuration XML file for your motor (different for mowing motor and the drive motors)
[Image 3]: Ignore the version message, if it appears
[Image 4]: Click Write Motor configuration. The green banner will appear on success.
[Image 5]: Click File -> Load App Configuration XML. Ignore the version message, if it appears
[Image 6]: Click Write App configuration. The green banner will appear on success.
Hit Ctrl + C in the openmower terminal to stop exposing the xESC controller.

Repeat these steps for all three of the three xESC controllers.

Required preparations

Remove the mower blade.
Really, remove the blade! This is a huge mower with a strong motor and large blade! 💀
Lift the mower’s rear so wheels can spin freely (use a carton, block or stand).
Unmount the mower blade!
Use battery power for calibration (not dock power), and ensure the battery has sufficient charge.
Check if you disassembled the mower blade!

Drive motor calibration (left then right)

Perform calibration for left drive first, then repeat the procedure for the right drive.

Enable realtime data: Later on, we wanna validate our calibration with a known reference value, but also during calibration it’s interesting to see the displayed values in the marked 2 window. That’s why we enable real-time data first:
Start the FOC Calibration Wizard:
Now we need to provide some specs of our motor. These are the specs for the left and right drive motors, for the mow motor, we need to use other specs:
🡆 🡆

🡆 🡆
Once calibration has been done, do not change the direction (even though the left wheel turns forward during calibration, whereas the right one backwards):
Now that the calibration succeed, lets test the result:

Test with “D 0,4” (1) and press the “Duty cycle” play button (2). If it draw <= 0.15A (3) and sound healty, it is calibrated well.
Test with some higher duty settings. It will become more loud for sure, but should always spin smooth and sound healty. If not, press the STOP sign (4).
As a last important step, load the correct ESC-App config via: File → Load App Configuration XML, choose SABO_Drive-App.xml (see SABO ESCs configs ) and finally press the ↧A icon (Write app configuration) on the right side.

Done 😆
… but not finished ✌️ … you need to do the whole procedure again, but with the right drive side.

So, Ctrl+c your openmower expose-xesc left, and do it again but with openmower expose-xesc right.

Mow Motor Calibration

For the mow motor ESC calibration, you do the same workflow, but with adapted values:

openmower expose-xesc mower
During FOC Calibration Wizard use the following values:
- Tab “Motor” = Medium Inrunner ~750g
  - Advanced: Max Power Loss = 200, Motor Poles = 8
- Tab “Battery”
  - Battery Capacity = 3.9Ah (same as before)
- Tab “Setup”
  - Gear Ratio = Check Direct Drive
  - Motor Poles = 8
  - Motor Temp. Sensor = disabled
Test with “D 0,08” which should draw <= 0.52A (without assembled blade)
Check/Adjust blade rotation direction:
We need to ensure that the blade rotate CCW (when watching from downside onto the axis). Do this with a slow rotation speed like “D 0,08”.

If it rotates CW, change direction via: Motor Settings → General → Tab General → Invert Motor Direction. Do not forget to do: “Write motor configuration” via ↧M
Load the correct ESC-App config via: File → Load App Configuration XML, choose SABO_Mower-App.xml (see SABO ESCs configs ) and finally press the ↧A icon (Write app configuration) on the right side.
Limit blade RPM:
It’s important to limit the max. RPM to the one like OEM is running it! Otherwise you risk your motor bearings or more dangerous: Your blade might fly away 💀

Choose your adventure. Your build, your rules.

Continue with Step 3.4: Configure ROS Parameters

Docs: SABO / John Deere

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Things you will need:

SABO MOWiT 500F or John Deere Tango E5
Open Mower V2 Carrier Board for SABO with all modules installed (xCore, CM4, GPS, 3x ESCs)

Tools you will need:

M10 ratchet for the cover
5mm Allen key for the blade
Torx T30 for the mainboard mount/holder
Torx T20 for the mainboard

Step 2.4.1: Open the mower and remove the OEM mainboard 🔓

Place the mower on its back and remove the six 10 mm screws from the housing.
Remove the blade with the 5mm Allen key (right‑hand thread). Use gloves and secure the blade while loosening.
Hold the housing together with both hands and place the mower back on its wheels.
Slightly open the cover on the handle (rear) side by a few centimeters.
Using a flashlight, disconnect the display ribbon cable(s):
- Series‑I: two ribbon cables going to the CoverUI. Each plug has small side locks; press to release, then unplug from the mainboard.
- Series‑II: one ribbon cable; pull it straight out from the mainboard (no release locks).
You can now open the cover further. A single cable from the cover’s charging contacts goes toward the mainboard. Before the mainboard there is a 2‑pin Molex plug; press to unlock and disconnect it. Put the cover aside for later modification and reassembly.
Disconnect all remaining cables from the OEM mainboard. Many plugs have a latch; press to release before pulling.
The OEM mainboard is mounted on a black plastic mainboard holder. On its back side are two larger Torx T30 screws. Remove them to lift out the mainboard together with the holder.
Remove the OEM mainboard from the holder by unscrewing the Torx T20 screws.

Step 2.4.2: Mount prepared parts

Assemble the previously prepared parts :

Mount your prepared UM9x GPS module to the carrier board and attach the IPEX/SMA cable (usually included with the UM9x) as shown:
Mount your xCore + CM4 (+ optional heatsink) combo to the carrier board (if not already mounted)

Step 2.4.3 (optional): Install Wi‑Fi adhesive antenna 📶

The Wi‑Fi adhesive antenna can be placed as shown:

Step 2.4.4: Assemble carrier board with mainboard 🔩

Now that all modules are prepared and mounted, fasten the carrier board to the mainboard holder.
If you have fewer screws than holes, prioritize holes close to the larger connectors!
Mount the carrier board + mainboard-holder back into the mower and fasten it with the two T30 screws.
Carefully connect all plugs. Some plugs fit into multiple counterparts, verify the labels or use this plug overview:

Series-I Plugs Series-II Plugs

Note: some plugs are rotated — do not force any connector!

Step 2.4.5: Install GPS antenna (e.g. HA/HX‑901) on the cover 🛰️

An alternative non-destructive internal holder was designed by STS . Check the Discord discussion for more details and STL files if available.

Drill a 6.5–7 mm hole in the cover approximately at the position as shown in the images.
Install the (included) 30-40cm SMA extension cable. Ensure the SMA bulkhead protrudes far enough so the HA/HX‑901 can fully engage and make good contact; if in doubt, omit one washer/spacer on the inside to gain thread length.
Seal it from the top with silicone or a similar sealant. Don’t use too much sealant, so the HA/HX‑901 can still be screwed on later.
Also seal the inside thoroughly to prevent any water ingress. On the inside use sealant rule: More is better
Allow sufficient time for the sealant to cure before proceeding.

Step 2.4.6: Close the housing ✅

Place the cover back onto the mower. Let the front engage slightly, but keep the rear open enough to:
1. Connect the GPS antenna cable to the carrier board
2. Reconnect the docking‑contact cable
3. Finally, reconnect the CoverUI ribbon cable(s)
Close the cover completely so it fits and latches evenly all around
Hold the housing together with both hands and turn the mower back onto its back
Reinstall and fasten the six 10 mm hex‑head screws
Do not install the blade yet
Put the mower back on its wheels
Finally, screw the HA/HX‑901 antenna onto the cover

Step 2.4.7: First Startup

It’s time to power the robot up by hitting the switch at the back of the robot.

Warning

If you see / smell anything unexpected, turn the switch off immediately!

This includes but is not limited to:

Smoke / Fire
Smell of hot electronics
Blown Fuses

Once turned on, it will take approximately 10 seconds before the LEDs and LCD start to show signs of life. Keep the robot turned on for at least five minutes to make sure the CM4 boots up properly. It performs setup during the first boot.

Info

It’s a good idea to place the mower into the docking station, so that the battery doesn’t drain and can charge.

If everything seems healthy, proceed to the Software Setup .

Otherwise, stop here and ask for help on the Discord server.

Docs: Step 2.2: Prepare the SD Card

Mon, 01 Jan 0001 00:00:00 +0000

We have created a Raspberry Pi image which is modified specifically for Open Mower use. The modifications include:

Networking setup for the robot’s internal network
A hotspot to make it easy to connect the robot to your home network
Docker installation for easy container management
Browser based terminal access to the robot
… and more!

In this step, we flash the image and do some basic setup for your mower.

Info

This guide is for the Lite version of the Raspberry Pi Compute module (the version without eMMC storage).

If you have a compute module with eMMC, you can safely skip this step for now and continue with preparing the mainboard.

You can flash the CM4, once your mower is powered up. Here is the guide on how to do it

Prerequisites

In order to follow this guide, you will need:

Raspberry Pi CM4 Lite (no on-board memory)
Micro SD card with at least 16 GB
A PC with the Raspberry Pi Imager Software installed:
🔗 https://www.raspberrypi.com/software/
The latest OpenMowerOS Image:
🔗 https://github.com/ClemensElflein/OpenMowerOS/releases
You can download it in the Assets section. You don’t need to unpack the image.
An SD card reader

Flash the Image to your SD Card

Start the Raspberry Pi Imager Software.
Select Raspberry Pi 4. Click Next to continue.
Then click Use Custom to open the image file you downloaded earlier. Click Next to continue.
Select your SD card from the Window. Make sure that you are really selecting the correct SD card, all data on the selected device will be erased!. Click Next to continue.
Check that everything is correct and click WRITE. You will be prompted to confirm once again, you might be prompted to enter your admin password.
Wait for the process to finish.

Configuring the Image

Older versions of the Raspberry Pi Imager software allowed the image to be configured directly in the software. In the current version, this is no longer possible.

When using an older version of the Raspberry Pi Imager, you can still configure the image as usual, but renaming the user is not possible. The user will always be named openmower.

Done 🎉

You can now remove the SD card from your PC, it is ready to be used with the Open Mower software. Set it aside and continue with preparing the mainboard. .

Docs: Step 3.3: Configure ROS

Mon, 01 Jan 0001 00:00:00 +0000

Step 3.3.1: Configure ROS Parameters

The ROS parameters can be configured using similar to the environment above. Simply run the openmower configure ros command and set the parameters as needed.

For a first setup, you can leave the default values for most parameters.

You need to set the following parameters:

gps/baud_rate: The baud rate of the GPS module. If you are using the Ardusimple GPS with the provided configuration file, leave it at 921600.
gps/protocol: The GPS protocol used. If you are using the Ardusimple GPS with the provided configuration file, leave it at “UBX”.
gps/datum_lat, gps/datum_long: Use coordinates close to where you will setup your docking station. Tip: Open Google Maps and right-click on any location to get the coordinates. It should be within a few meters of the dock, no need to be ultra precise here.
ntrip_client/*: Set the NTRIP parameters for your GPS base station.

Example ROS configuration.

Docs: Change Hostname

Mon, 01 Jan 0001 00:00:00 +0000

Changing the hostname is simple, thanks to the raspi-config tool:

Run sudo raspi-config
Select System Options -> Hostname
Enter a new hostname and press Enter`
Finish and Reboot

Docs: External Wifi Antenna

Mon, 01 Jan 0001 00:00:00 +0000

After adding the external antenna, you need to tell the Raspberry Pi CM4 to use the external antenna instead of the built-in one.

Terminal Cast

How to edit the antenna configuration

Instructions

You can do this by:

Run sudo nano /boot/firmware/config.txt
Scroll Down to the [cm4] section and:
- Comment # dtparam=ant1
- Uncomment dtparam=ant2
Save CTRL + O and Exit Nano CTRL + X
Reboot the OS by running sudo reboot

Docs: Step 2.3: Prepare the Mainboard

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

In order to follow this guide, you will need:

An OpenMower v2 Mainboard
1x xCore Board
1x Raspberry Pi 4 CM4
3x xESC Motor Controllers
1x GPS Module
Mounting Brackets for the xCore
Optional: CM4 Heat Sink

Step 2.3.1: Mount the CM4 onto the xCore

If you are using a CM4 heat sink

Place the spacer on the lower two mounting holes of the CM4 as shown in the picture. Do not place spacers on the upper two holes:

The spacers I used are 1.7 mm thick and were provided with the heat sink.

If you are not using a CM4 heat sink, you can skip this step.

Mount the CM4 onto the xCore

The next step is to mount the CM4 onto the xCore. To do so:

Align the CM4 with the xCore board as shown in the picture.
Place two fingers over the connectors of the xCore and the CM4.
Gently press down until you hear and feel both connectors click.

Step 2.3.2: Mount CM4 Heat Sink

(optional - except for the spacers in the end)

Info

This step is different, depending on which heat sink you are using. The images here show the Berry Base heat sink, but the process is similar for other heat sink models as well.

Make sure to use spacers between the PCBs, otherwise the screws will put excessive pressure onto the connectors.

The next step is to mount the heat sink onto the CM4. To do so:

Mount the spacers to the heat sink as shown in the picture.
Place all thermal pads onto the corresponding chips.
Important: The pads have clear plastic cover on the top and glue on the bottom.
Do not forget to remove the top plastic cover as well!
Align the heat sink with the CM4 as shown in the picture.
Fix the heat sink with the two screws on the bottom. Do not fix the upper two holes.
Press the 3d printed spacer between the CM4 and the xCore board as shown in the picture.
It is now a good time to insert the SD card into the CM4 (except for the version with eMMC).

Step 2.3.3: Insert the xCore into the Mainboard

Now that the xCore board is assembled, it is time to insert it into the mainboard.

Info

Before finishing this step, make sure that your SD card is inserted into the CM4 (if using the version with eMMC, skip this step). Depending on the mainboard layout, you won’t have easy access to the SD card slot later.

Follow these steps to insert the xCore into the mainboard:

Insert the xCore board into the slot on the mainboard. It is approximately a 45 degree angle.
Push the board down until it is flat with the mainboard. Make sure the arms on the side engage with the xCore.
Use two screws to secure the xCore board to the mainboard. Don’t put spacers or anything, otherwise the mainboard will not fit into the mower (at least for the YardForce Classic 500).

Step 2.3.4: Insert xESCs and GPS into the Mainboard

Finally, we can insert the remaining modules into the mainboard.

Match the pins of the xESCs as well as the GPS board to the corresponding pins on the mainboard. Don’t worry if some of the ESC pins don’t have mating connectors, they are only used for initial firmware upload after the boards are manufactured.

The resulting board will look similar to this (example shows a YardForce mainboard):

Step 2.3.5: Done 🎉

You have now finished the preparation of the mainboard. You can now proceed with the mower-specific guide .

Docs: Record Areas

Mon, 01 Jan 0001 00:00:00 +0000

In this section, we finally drive the robot around and test if everything works as expected. Then we will record a map, and you can see the magic happen.

Prerequisites

A smartphone or PC (or a USB gamepad )
Modified robot connected to your network
OpenMower software running on the robot
Docking station powered up
Mower fully charged

Step 4.1: Check the GPS

For this step, put the mower into the docking station and turn it on. It should boot up and get to a solid green status LED.

It is important that the mower is out in the open for the RTK GPS to work. Don’t try this indoors and don’t cover the mower.

Open the OpenMower web app with any device by opening a browser and going to the following URL: http://openmower.local:8080 or http://<your-openmower-IP>:8080.

Wait for the GPS to find a position. This might take some time (up to 30 minutes).

You can see the current GPS quality in the Open Mower app as shown in the graphic above.

You need to have RTK Fixed for the following to work. If you don’t get a good GPS fix, you will need to check your RTK setup and configuration.

Step 4.2: Initialize the Orientation

In addition to the position, the robot also needs to know its orientation. Since we are not using a compass, the robot’s orientation is derived from its movement. In order to initialize the orientation, you need to drive the robot.

You can either use the on-screen joystick in the Open Mower App or a gamepad connected via USB (hold the A button) to drive the robot.

Warning

Don’t pick up the mower or the orientation will be lost again!

Now drive the mower for at least 50m, do some straight lines and some figure eight patterns. Currently, the robot does not know the quality of its orientation estimate, but you can judge by driving and looking at the app.

The orientation is initialized correctly if:

When driving a straight line, the visualization also drives a straight line (no jumps)
When rotating in place, the visualization stays in place and doesn’t jump

Step 4.3: Record a Simple Map

In this step, we will record a simple map. Keep it simple for the first tests and record your map as soon as you’re confident that everything works as expected.

The map for the mower consists of three parts: the docking position, at least one mowing area and optionally navigation areas.

Mowing Areas are the areas which will be mowed. Each mowing area has a single outline and optional areas to exclude (e.g. static obstacles).
Docking Position is the position and orientation of your docking station. It needs to be close to a mowing area or navigation area. This is needed for the robot to find its way to the docking station.
Navigation Areas are areas similar to mowing areas (they consist of an outline and optionally exclusions). The mower is allowed to drive in these areas, but won’t mow. Use these areas to connect mowing areas. Also, if your docking station is not close to a mowing area, you can use a navigation area to allow the robot to drive to the docking station.

Now that the robot knows where it is located, and you know which areas we need to record, start recording your first map. In the following picture, you can see an example.

Record Outline

Drive the robot to the outline. Make sure that the robot is facing in counterclockwise direction.
Start the recording by pressing Start Recording.
Drive around the mowing area. Make sure that the GPS position stays fixed at all times.
Stop the recording using Stop Recording.
The outline should now turn green. This means it’s done recording, and you can move on to recording exclusions.

Optional: Record Exclusions

If your area has zones you want to exclude (e.g. static obstacles), you can record them like this:

Drive the robot to the edge of the exclusion zone. Make sure that the robot is facing in clockwise direction.
Start the recording by pressing Start Recording.
Drive around the area to exclude. Make sure that the GPS position stays fixed at all times.
Stop the recording using Stop Recording.
The outline should now turn red. This means it’s done recording, and you can move on to recording more exclusions.

Save Area

If you are happy with your recording, you can save the area. In order to do this, click the Finish Area button. A dialog will appear asking if you want to save the area as mowing or navigation area. Alternatively, you can also discard the recording.

As soon as the area is saved, the area will turn solid. Mowing areas will be displayed in green, navigation areas will be shown in white.

Record Docking Position

In order to record the docking position, do the following:

Drive to a location about 2 m in front of your docking station.
Make sure you have a GPS fix and press the Record Docking button.
Now drive close to the docking station. The front wheels of the robot should be at the edge of the docking station. Don’t fully drive into the docking station!.
Make sure you have a GPS fix and press the Record Docking button.
The app should move the home icon to your current location. Now you can fully drive into the docking station.

Finish Recording

Finish the process by pressing Exit Recording. Now the mower should go to IDLE mode. You should be able to start mowing by pressing the Start button. The mower will undock, wait for GPS and mow the area.

Docs: Step 4: Record Areas & Use it

Mon, 01 Jan 0001 00:00:00 +0000

In this section, we finally drive the robot around and test if everything works as expected. Then we will record a map, and you can see the magic happen.

Prerequisites

A smartphone or PC (or a USB gamepad )
Modified robot connected to your network
OpenMower software running on the robot
Docking station powered up
Mower fully charged

Step 4.1: Check the GPS

For this step, put the mower into the docking station and turn it on. It should boot up and get to a solid green status LED.

It is important that the mower is out in the open for the RTK GPS to work. Don’t try this indoors and don’t cover the mower.

Open the OpenMower web app with any device by opening a browser and going to the following URL: http://openmower.local:8080 or http://<your-openmower-IP>:8080.

Wait for the GPS to find a position. This might take some time (up to 30 minutes).

You can see the current GPS quality in the Open Mower app as shown in the graphic above.

You need to have RTK Fixed for the following to work. If you don’t get a good GPS fix, you will need to check your RTK setup and configuration.

Step 4.2: Initialize the Orientation

You can either use the on-screen joystick in the Open Mower App or a gamepad connected via USB (hold the A button) to drive the robot.

Warning

Don’t pick up the mower or the orientation will be lost again!

The orientation is initialized correctly if:

When driving a straight line, the visualization also drives a straight line (no jumps)
When rotating in place, the visualization stays in place and doesn’t jump

Step 4.3: Record a Simple Map

In this step, we will record a simple map. Keep it simple for the first tests and record your map as soon as you’re confident that everything works as expected.

The map for the mower consists of three parts: the docking position, at least one mowing area and optionally navigation areas.

Mowing Areas are the areas which will be mowed. Each mowing area has a single outline and optional areas to exclude (e.g. static obstacles).
Docking Position is the position and orientation of your docking station. It needs to be close to a mowing area or navigation area. This is needed for the robot to find its way to the docking station.
Navigation Areas are areas similar to mowing areas (they consist of an outline and optionally exclusions). The mower is allowed to drive in these areas, but won’t mow. Use these areas to connect mowing areas. Also, if your docking station is not close to a mowing area, you can use a navigation area to allow the robot to drive to the docking station.

Now that the robot knows where it is located, and you know which areas we need to record, start recording your first map. In the following picture, you can see an example.

Record Outline

Drive the robot to the outline. Make sure that the robot is facing in counterclockwise direction.
Start the recording by pressing Start Recording.
Drive around the mowing area. Make sure that the GPS position stays fixed at all times.
Stop the recording using Stop Recording.
The outline should now turn green. This means it’s done recording, and you can move on to recording exclusions.

Optional: Record Exclusions

If your area has zones you want to exclude (e.g. static obstacles), you can record them like this:

Drive the robot to the edge of the exclusion zone. Make sure that the robot is facing in clockwise direction.
Start the recording by pressing Start Recording.
Drive around the area to exclude. Make sure that the GPS position stays fixed at all times.
Stop the recording using Stop Recording.
The outline should now turn red. This means it’s done recording, and you can move on to recording more exclusions.

Save Area

As soon as the area is saved, the area will turn solid. Mowing areas will be displayed in green, navigation areas will be shown in white.

Record Docking Position

In order to record the docking position, do the following:

Drive to a location about 2 m in front of your docking station.
Make sure you have a GPS fix and press the Record Docking button.
Now drive close to the docking station. The front wheels of the robot should be at the edge of the docking station. Don’t fully drive into the docking station!.
Make sure you have a GPS fix and press the Record Docking button.
The app should move the home icon to your current location. Now you can fully drive into the docking station.

Finish Recording

Docs: v1 Hardware Guide (Legacy)

Mon, 01 Jan 0001 00:00:00 +0000

v1 Hardware Only!

Only follow the Docking and Robot Modification Guide from the old docs, you can use the current OpenMower OS! You have v1 hardware, if:

You are using a full-size Raspberry Pi
Your mainboard shows version v0.xx

The v1 guide is here .

Docs: Managing ROS Parameters

Mon, 01 Jan 0001 00:00:00 +0000

Viewing and Configuring ROS Parameters

OpenMower is built on ROS, which means much of its behavior is controlled through parameters. Understanding how to inspect and modify these parameters gives you fine-grained control over your mower’s operation.

Listing All Parameters

To see all currently active ROS parameters, open the OpenMower shell:

openmower shell

Then run:

rosparam list

This will display a full list of parameters currently loaded in the system. It’s a useful first step when debugging or trying to understand how your mower is configured.

Overwriting Parameters

All parameters can be customized using the mower_params.yaml configuration file. This file acts as the central place to override default values.

The easiest way to edit it is with:

openmower configure ros

Example

In this example we will be overwriting the speed parameter.

1. Fetch the Parameter’s current value

After discovering a parameter you want to edit using rosparam list, you can get the value using rosparam get <parameter>:

🚜 openmower@openmower-v2:~$ rosparam get /move_base_flex/FTCPlanner/speed_fast
0.4

In this case, our speed is currently at 0.4 m/sec for mowing

2. Change the value for your config

On the host system call openmower configure ros and translate the parameter name to YAML. This is done by replacing each / into indentations (2x space).

For our example it looks like this:

move_base_flex:
 FTCPlanner:
 speed_fast: 0.5

3. Save the file and check the updated value

After saving the file, ROS is automatically restarted and you can check, if the value is now updated:

🚜 openmower@openmower-v2:~$ rosparam get /move_base_flex/FTCPlanner/speed_fast
0.5

🎉 Done!

If you have issues

If some parameter isn’t overriding correctly, make sure you are on the latest version of OpenMower. If it still doesn’t work ask on Discord.

Docs: Configuring GPIO Inputs

Mon, 01 Jan 0001 00:00:00 +0000

Overview

OpenMower supports configuring GPIO pins as digital inputs that can trigger emergency stops or other events. Common use cases include:

Wheel lift sensors — detect when the mower is lifted
Stop buttons — physical emergency stop buttons on top of the mower

Step 1: Create the inputs configuration file

Create /home/openmower/params/inputs.yaml with your GPIO input definitions:

gpio:
 - name: Front left wheel lift
 line: GPIO10
 active: low
 emergency:
 reason: lift
 delay: 2500

 - name: Front right wheel lift
 line: GPIO11
 active: low
 emergency:
 reason: lift
 delay: 2500

 - name: Top stop button 1
 line: GPIO12
 active: low
 emergency:
 reason: stop
 delay: 10

 - name: Top stop button 2
 line: GPIO13
 active: low
 emergency:
 reason: stop
 delay: 10

Configuration fields

Field	Description
`name`	Human-readable label for the input
`line`	GPIO pin name (e.g. `GPIO10`)
`active`	Logic level that triggers the event — `low` or `high`
`emergency.reason`	Emergency type — `lift` for wheel lift, `stop` for stop button
`emergency.delay`	Debounce/delay in milliseconds before the emergency is triggered

GPIO Pin Mapping

The example config above uses GPIO10–GPIO13. Here is how those map to physical connectors on each board.

OpenMower Universal Board

Orientation: looking at the board with the ethernet ports facing you.

Position	GPIO
Top left	GPIO13
Top right	GPIO12
Bottom right	GPIO11
Bottom left	GPIO10

OpenMower Yardforce Board

Orientation: looking at the board with the ethernet ports at the bottom left, pins sorted top to bottom.

Position	GPIO
1st (topmost)	GPIO10
2nd	GPIO11
3rd	GPIO12
4th	GPIO13

Step 2: Enable the input service

Add the following to your mower_params.yaml (or custom_params.yaml for Universal board builds):

ll:
 services:
 input:
 config_file: /data/params/inputs.yaml

To open the file for editing:

openmower configure ros

Path mapping on OSv2

On OSv2, /home/openmower/params is mapped to /data/params inside the container. If you are on a different setup, adjust the config_file path accordingly.

Step 3: Restart OpenMower

After saving both files, restart the service to apply the changes:

openmower restart

Your GPIO inputs are now active and will trigger the configured emergency events when the specified logic level is detected.

Docs: Flashing the CM4 eMMC

Mon, 01 Jan 0001 00:00:00 +0000

CM4 with eMMC only

This guide applies only to CM4 variants with onboard eMMC storage. The CM4 Lite variant has no eMMC — it uses a microSD card instead and does not require this process.

Check your CM4 model number: variants with eMMC have the storage size in the name (e.g. CM4008032 = 32 GB eMMC). Lite variants are explicitly labelled “Lite” (e.g. CM4008000).

The CM4 with eMMC has onboard flash storage instead of a microSD slot. To flash a new image, you need to put it into USB boot mode so it appears as a mass storage device on your computer.

This guide covers the OpenMower-specific steps. For full reference, see the official Raspberry Pi documentation .

Prerequisites

A host computer (Linux, Windows, or macOS)
A micro USB cable (connected to the USB port on the xCore board)
The OS image you want to flash (e.g. OpenMower OS)

Step 1: Enter USB boot mode

The xCore board has an Rpi Boot button (left of the two buttons, label printed below the CM4 slot).

Hold the Rpi Boot button.
While holding it, connect power to the xCore board (or plug in the micro USB cable to your host computer).
Release the button once powered.

The CM4 is now in USB boot mode.

Step 2: Install rpiboot on your host computer

sudo apt install rpiboot
sudo rpiboot

Download and run the installer from the usbboot releases page .
Reboot your computer after installation.
With the CM4 in USB boot mode, open Start → rpiboot - Mass Storage Gadget.

Build rpiboot from source, then run:

rpiboot -d mass-storage-gadget64

See the usbboot repository for build instructions.

Within a few seconds the CM4’s eMMC will appear as a USB mass storage device on your computer.

Tip

If the device is not recognised, avoid USB hubs — connect the micro USB cable directly to your computer.

Step 3: Flash the image

Use Raspberry Pi Imager to write your OS image to the eMMC device. Select the eMMC as the target storage — it will appear like any other USB drive.

Alternatively, use dd on Linux/macOS:

sudo dd if=your-image.img of=/dev/sdX bs=4MiB status=progress oflag=sync

Replace /dev/sdX with the actual device path of the eMMC. Double-check this before running.

Step 4: Boot from eMMC

Once flashing is complete, disconnect the micro USB cable and power-cycle the board. The CM4 will boot from the newly flashed image.

Docs: Creating a Debug Recording

Mon, 01 Jan 0001 00:00:00 +0000

When investigating issues — especially positioning problems — a rosbag recording gives developers a full snapshot of sensor data to analyse. This guide walks you through recording one and retrieving it from your mower.

Privacy notice

A rosbag records raw sensor data, which includes the GPS position of your mower. By sharing the file you disclose the physical location of your garden. Only share it with people you trust.

Prerequisites

OpenMower is running and the mower has a GPS fix (green GPS icon in the app)
You can access the mower via SSH or the web terminal

Step 1: Start the recording

Connect to your mower via SSH or the web terminal, then enter the ROS shell:

openmower shell

Once inside, navigate to the recordings directory and start recording all topics:

cd /data/recordings
rosbag record -a

This records all active ROS topics. Leave the terminal open — the recording runs until you stop it with Ctrl+C.

Step 2: Enter area recording mode

Open the OpenMower app and activate area recording mode — the same mode you use when recording mowing areas. This ensures all relevant topics (GPS, IMU, wheel odometry) are actively publishing at full rate.

GPS fix required

Make sure the GPS icon in the app is green before driving. Recording without a fix produces data that cannot be used for analysis.

Step 3: Drive the test patterns

Drive the mower through the following patterns. Each one exercises a different aspect of positioning:

Pattern	Purpose
Straight lines	Linear odometry and GPS consistency
Figure-8	Combined turning and straight-line tracking
Rotate on the spot (clockwise)	Yaw estimation, IMU vs. GPS heading
Rotate on the spot (counter-clockwise)	Same, opposite direction

A minute or two of each pattern is sufficient. You don’t need a large area — a small open patch of lawn works fine.

Step 4: Stop the recording

Once done, go back to the terminal and press Ctrl+C, then type exit to leave the ROS shell.

The .bag file is now in ~/recordings/ on the mower. List the directory to find your filename:

ls -lh ~/recordings/

The filename includes a timestamp, e.g. 2024-06-01-12-34-56.bag.

Step 5: Retrieve the file

Copy the .bag file from ~/recordings/ on the mower to your computer.

Linux / macOS
Windows

Use scp from your local terminal:

scp openmower@<mower-ip>:recordings/<filename>.bag .

Replace <mower-ip> with your mower’s IP address and <filename> with the actual filename. The file downloads to your current directory.

Windows 10 (build 1809 or later) and Windows 11 include an OpenSSH client. Open Command Prompt or PowerShell and run:

scp openmower@<mower-ip>:recordings/<filename>.bag .

On older Windows versions, use a graphical SFTP client instead:

WinSCP — free, open source
Cyberduck — free, cross-platform

Connect with protocol SFTP, host <mower-ip>, user openmower, and navigate to /home/openmower/recordings/ to download the file.

Tip

.bag files compress very well. Zipping before sharing can reduce the file size significantly:

Once you have the file, share it with whoever is helping you debug — via Discord, a file sharing service, or any other method that works in context.

Step 6: Clean up

Once debugging is done, delete the recordings from the mower to free up disk space:

# delete a specific file
rm ~/recordings/<filename>.bag

# delete all recordings
rm ~/recordings/*.bag

Docs: Hardware Versions / Known Issues

Mon, 01 Jan 0001 00:00:00 +0000

Current Hardware (v2 Hardware Platform)

For v2 Hardware Platform, please check the corresponding repository for changes and known issues:

YardForce: https://github.com/xtech/hw-openmower-yardforce
SABO / John Deere: https://github.com/xtech/hw-openmower-sabo
Universal: https://github.com/xtech/hw-openmower-universal

0.13.0 - Red

Notable changes

Custom CoverUI added to the kit
Dropped support for dfPlayer sound module

Known issues

2.5mm screws were missing (used to fasten RPi4). Affect kits shipped before June'23.
The first batch of 0.13 boards was mistakenly labeled “latest”. No action needed.
Outdated Firmware . Affect kits shipped before May'23.
IC2 chip is wrong . Affect kits shipped before May'23.
rain sensor cable is female, but needs to be male . Affect kits shipped before May'23.

Legacy Hardware (v1 Hardware Platform)

Information

V1 hardware used a completely different architecture to v2 hardware which makes it hard to port to new mower models. If you currently own a v1 hardware kit, this is nothing to worry, the kit will continue to work with your mower, there is no real benefit of upgrading it to a v2 hardware kit. For new builds, the v2 hardware platform is recommended.

0.13.0 - Red

Notable changes

Custom CoverUI added to the kit
Dropped support for dfPlayer sound module

Known issues

2.5mm screws were missing (used to fasten RPi4). Affect kits shipped before June'23.
The first batch of 0.13 boards was mistakenly labeled “latest”. No action needed.
Outdated Firmware . Affect kits shipped before May'23.
IC2 chip is wrong . Affect kits shipped before May'23.
rain sensor cable is female, but needs to be male . Affect kits shipped before May'23.

0.12.0 - Black

Notable changes

IMU: LSM6DSO instead of WT901

Known issues

SPI tracks from Pico were misplaced, already fixed in firmware. No action needed.
Outdated Firmware
IC2 chip is wrong
rain sensor cable is female, but needs to be male

0.11.0 - Purple

Notable changes

Connected WT901 via I2C freeing pins for dfPlayer
Upgraded dock station PCB with extra holes and terminals (red)

Known issues

IC2 chip is wrong

0.10.0 - Green

Notable changes

Added dock station PCB (green)

Known issues

IC2 chip is wrong

0.9.3 - Also Green

First build. Experimental xESC2040 instead of xESC-mini (STM32).

Docs: Configuring xESC

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Windows or Linux computer to run the VESC Configuration Tool
VESC Tool (https://vesc-project.com/vesc_tool ) You can download the tool for free by adding the “free” version in your cart and proceeding to checkout.
OpenMower Firmware needs to be successfully installed in the xCore board. This is needed because the xCore bridges the connection between your computer and the xESC. If you haven’t done it, follow the Firmware Update guide.
Optional (but makes your life easier):
Configuration files for the mower you are using.
Look in the OpenMower repository for the files suited for your mower.
You will need three files:
- App configuration XML (sets the baud rate, etc. Same for all three xESC controllers)
- Mower Motor configuration XML (motor parameters for the mower motor)
- Drive Motor configuration XML (motor parameters for the wheel motors)

Configuration Process

Stop ROS from interfering with the controllers

openmower stop to stop ROS from interfering with the controllers during configuration.

Expose the ESC to the network

Connect to the xESC

Open the VESC Configuration Tool and connect to the xESC controllers by clicking:

Connection -> TCP [1]
Insert the IP address of your mower or openmower into the Address field [2].
Set the port to 65102 [3]
Click Connect [4]

Information

If you encounter this warning message:

you can safely ignore it. The VESC tool is backward compatible with the firmware version used on the xESC controller.

Configure xESC

Upload the configurations

With the VESC Configuration Tool connected, you can now upload the configuration to your xESC controllers:

[Image 1]: Click File -> Load Motor Configuration XML
[Image 2]: Select the motor configuration XML file for your motor (different for mowing motor and the drive motors)
[Image 3]: Ignore the version message, if it appears
[Image 4]: Click Write Motor configuration. The green banner will appear on success.
[Image 5]: Click File -> Load App Configuration XML. Ignore the version message, if it appears
[Image 6]: Click Write App configuration. The green banner will appear on success.
Hit Ctrl + C in the openmower terminal to stop exposing the xESC controller.

Repeat these steps for all three of the three xESC controllers.

Required preparations

Remove the mower blade.
Really, remove the blade! This is a huge mower with a strong motor and large blade! 💀
Lift the mower’s rear so wheels can spin freely (use a carton, block or stand).
Unmount the mower blade!
Use battery power for calibration (not dock power), and ensure the battery has sufficient charge.
Check if you disassembled the mower blade!

Drive motor calibration (left then right)

Perform calibration for left drive first, then repeat the procedure for the right drive.

Enable realtime data: Later on, we wanna validate our calibration with a known reference value, but also during calibration it’s interesting to see the displayed values in the marked 2 window. That’s why we enable real-time data first:
Start the FOC Calibration Wizard:
Now we need to provide some specs of our motor. These are the specs for the left and right drive motors, for the mow motor, we need to use other specs:
🡆 🡆

🡆 🡆
Once calibration has been done, do not change the direction (even though the left wheel turns forward during calibration, whereas the right one backwards):
Now that the calibration succeed, lets test the result:

Test with “D 0,4” (1) and press the “Duty cycle” play button (2). If it draw <= 0.15A (3) and sound healty, it is calibrated well.
Test with some higher duty settings. It will become more loud for sure, but should always spin smooth and sound healty. If not, press the STOP sign (4).
As a last important step, load the correct ESC-App config via: File → Load App Configuration XML, choose SABO_Drive-App.xml (see SABO ESCs configs ) and finally press the ↧A icon (Write app configuration) on the right side.

Done 😆
… but not finished ✌️ … you need to do the whole procedure again, but with the right drive side.

So, Ctrl+c your openmower expose-xesc left, and do it again but with openmower expose-xesc right.

Mow Motor Calibration

For the mow motor ESC calibration, you do the same workflow, but with adapted values:

openmower expose-xesc mower
During FOC Calibration Wizard use the following values:
- Tab “Motor” = Medium Inrunner ~750g
  - Advanced: Max Power Loss = 200, Motor Poles = 8
- Tab “Battery”
  - Battery Capacity = 3.9Ah (same as before)
- Tab “Setup”
  - Gear Ratio = Check Direct Drive
  - Motor Poles = 8
  - Motor Temp. Sensor = disabled
Test with “D 0,08” which should draw <= 0.52A (without assembled blade)
Check/Adjust blade rotation direction:
We need to ensure that the blade rotate CCW (when watching from downside onto the axis). Do this with a slow rotation speed like “D 0,08”.

If it rotates CW, change direction via: Motor Settings → General → Tab General → Invert Motor Direction. Do not forget to do: “Write motor configuration” via ↧M
Load the correct ESC-App config via: File → Load App Configuration XML, choose SABO_Mower-App.xml (see SABO ESCs configs ) and finally press the ↧A icon (Write app configuration) on the right side.
Limit blade RPM:
It’s important to limit the max. RPM to the one like OEM is running it! Otherwise you risk your motor bearings or more dangerous: Your blade might fly away 💀

Choose your adventure. Your build, your rules.

Docs: Firmware Update

Mon, 01 Jan 0001 00:00:00 +0000

Warning

Early versions of the xCore board have a bug in the bootloader which sometimes prevents the board from being detected by the openmower tool.

If you encounter Timeout errors during the firmware installation process, update the bootloader by running: openmower update-bootloader and try again.

The expected output is shown below:

Example output for openmower update-firmware command.

Docs: GPS / Coordinate System

Mon, 01 Jan 0001 00:00:00 +0000

Positioning / Coordinate System

Positioning in the Open Mower project is done in a local 2D coordinate system. This means that the robot’s current position can be described by the coordinates (X / Y) of the VRP and the current orientation.

The origin of the coordinate system can either be chosen freely by the user or can be set to the base station. If an external correction service is used, the origin has to be specified manually.

Open Mower uses a right-handed ENU coordinate system.

Docs: GPS Base Setup

Mon, 01 Jan 0001 00:00:00 +0000

This part of the documentation is work in progress. There are many ways of setting up the RTK base, here is one using RPi 0W, ZED-F9P and a web based software RTKBase. On discord you may ask karl.ranseier for support.

Prerequisites

Raspberry Pi 0W
µSD card
Power supply for RPi
Ardusimple ZED-F9P
A cable or combinatin of cables to connect micro usb male to micro usb male:
- A) Direct like this
- B) Adapter (like this ) + micro usb to usb-a cable
A windows PC
Stable internet connection (no disconnection within one hour)

Installation

If you know about RPi and have already a functional OS, you may head on to “Software”, but in my case it did not work using an older image.

Preparing sd card

Download RPi Imager for windows
Start Imager:
Choose your RPI (in my case RPi 0W, choosing wrong RPi will most probably result in many problems)
Choose Operating system “Raspberry Pi OS lite (legacy, 32bit)
Select your sd card:
Press next so this will appear:
Edit settings like the following (and use your personal WiFi settings and country), where you set a good password for your Pi account. Username and password are case sensitive!
activate SSH:
Press save to see this:
Click on YES and allow to overwrite the data on your sd card (if you are sure, that you will not miss them). It will start downloading and writing the data:
Wait until it is finished, it may take half an hour, depending on your internet connection ;-)

Start your RTKBase RPi

Put your sd card into your RPi
Connect ZED-F9P via usb to your RPi (NOT after the installation, it will be configured during installation).
Power your RPi

Connect to RPi

Get from your router the IP of your RPi
Start PuTTY and connect to RPi, where you enter the local IP of your RPi
Enter your Username Pi, press enter and than enter your password:

Software

Is your ZED-F9P connected? Do it!
We will use RTKBase
To install it, you can use the following lines, which you can copy and paste at once. The original recommendation is no sudo in front of chmod. That did not work for me.
```
cd ~
wget https://raw.githubusercontent.com/Stefal/rtkbase/master/tools/install.sh -O install.sh
sudo chmod +x install.sh
sudo ./install.sh --all release
```

A very long output should follow. It ends with:

GNSS Configuration: done
################################
STARTING SERVICES
################################
Created symlink /etc/systemd/system/multi-user.target.wants/str2str_tcp.service → /etc/systemd/system/str2str_tcp.service.
Job for gpsd.service failed because the control process exited with error code.
See "systemctl status gpsd.service" and "journalctl -xe" for details.
################################
END OF INSTALLATION
You can open your browser to http://192.168.178.34 (here the editor deleted IPV6)
################################
Pi@RTKBase:~ $

Installation finished, go on and configure your RTKBase

Configuring your RTKBase

Start a browser and enter the IP address of your RTKBase. You will get this:
Enter as password admin. On the following site press the copy symbol right to PPP.
Go to settings and press “options” right to “Main Service”, than paste your coordinates to “Base coordinates”:
Press on options again, than on options right to “Caster Service”
Here you have to enter the setting set up in your mower, standard is: username gps and password gps. Select the right mount point. I have named it like my city, in mower config and here.
Save the config
Switch on “Caster Service” and “File Service”, it should look like this:
Eventually change your password below these options.
At logs you should find at least two files:

Find the position of your RTKBase

There are several ways to find your position. To use openmower you do not need the perfect position. Therefore the first option should be your choice, if you want a fast and good result for openmower.

Easy and good way

Click on the symbol right to PPP to copy the values to the clipboard:
Enter these values to your options at MainService.
Save
ReActivate Ntrip Service
Finished!

More complicated and more exact way

You have to set up the logging of your position as mentioned above by activating “file service”. You should wait for a day to average all the values to get a high precision position.
After midnight you find a zip-file at logs. This you can convert to a Rinex file. To understand this file you may check RINEX-File , but you don’t need it.
Press on the pencil right to the zip-file:
“Create Rinex file”:
Download it when finished (may take a while, some minutes or longer)
Go to Calculator , upload your Rinex file and enter your email address. Don’t forget to enter the “no robot”-verification.
When you received the email, look at “ITRF2014” (or search for “longitude”) and see your values like LONGITUDE 6.XXXXXXXXX° LATITUDE 51.XXXXXXXXX° HELL 79.9041
You enter these values to your options at MainService. Be aware that the order of LONGITUDE and LATITUDE is switched!
Save
ReActivate Ntrip Service
Finished!

Thanks to Stefal and all the contributors of RTKBase and the used resources.

Docs: Troubleshooting GPS-RTK

Mon, 01 Jan 0001 00:00:00 +0000

We assume that you at least followed documentation of GPS setup . If mower is already assembled - open the top cover.

Get your Windows PC and connect to GPS module directly with microUSB cable (as if you were uploading the configuration).

Make sure that Protocol of received messages in bottom status bar right shows UBX, not NMEA. If not - upload configuration again. Then disconnect/connect power of GPS and make sure it stayed UBX.

Connect the antenna to the board and go outside to check if general GPS is working. If the mower is already assembled and an antenna is plugged in - just take it outside with the mower. Even indoors next to the windows with antenna connected, you should see satellites and other info start appearing in u-center. In few minutes GPS Fix led will start blinking on GPS board.

Deviation map (View -> Deviation Map, F12) should stay in a ~1m, that what you expect from average GPS. If you got some existing garbage there already, clean it via File -> Database clean.

Now let’s connect NTRIP. We assume that you either found a suitable NTRIP node somewhere nearby (<30km) or running your own base station .

Go to Receiver -> NTRIP Client... and configure your NTRIP settings. This will be the same settings that you will use in the ROS configuration file later.

NTRIP client should display green connection in the status bar. Deviation map (View -> Deviation Map, F12) should stay dead center. No RTK led will start blinking or go away completely.

Test GPS on Mainboard

We have checked that GPS works alone, let’s see if it would together with the mainboard. Plug the GPS into the mainboard. Everything should light up and start flashing.
Wait until the LED lights up GREEN or GREEN/RED.

🔋 Powering the mainboard

If you don’t have dock station assembled and want to save the power in the main mower battery, you can power it from the Pico Dev board MicroUSB port, right below the GPS board. Use a 1A+ power bank, because computer USB port’s 500mA might be not enough.

OpenMowerOS version:
0.1.0

Then SSH into your OpenMower.
In the home directory (~/) there is a scripts called start_ros_bash.sh.
Run the start_ros_bash.sh script by executing ~/start_ros_bash.sh which should take you to a bash inside the container.

There you can run rostopic list to list all topics and rostopic echo --clear -w 5 /ll/position/gps to look at the GPS data.
You will get some lines of data:

header:
 seq: 44
 stamp:
 secs: 1708328554
 nsecs: 51810942
 frame_id: "gps"
sensor_stamp: 114172000
received_stamp: 1711341013
source: 1
flags: 3
orientation_valid: 0
motion_vector_valid: 1
position_accuracy: 0.024
orientation_accuracy: 3.141
pose:
 pose:
 position:
 x: 1.975
 y: 4.819
 z: 114.9
 orientation:
 x: 0.000
 y: 0.000
 z: 0.201
 w: 0.979
 covariance: [88.21, 0.000, 0.000, 0.000, 0.000, 0.000, 0.000, 88.21, 0.000, 0.000, 0.000, 0.000, 0.000, 0.000, 0.000, 88.21, 0.000, 0.000, 0.000, 0.000, 0.000, 10000, 0.000, 0.000, 0.000, 0.000, 0.000, 0.000, 10000, 0.000, 0.000, 0.000, 0.000, 0.000, 0.000, 9.869]
motion_vector:
 x: 0.045
 y: -0.05
 z: -0.01
vehicle_heading: 1.570
motion_heading: 0.405
---

The important lines here are:

flags: 3
you want a 3 here since that means your rtk state is “fixed”
3 is “fix”, 5 is “float” and 0 is “single” (classic non-rtk GNSS gps only)

position_accuracy: 0.024
this value is in meters so the example has a accuracy of ~2,5cm and that is great.
It can be the case that this value is ok but the rtk state is not yet “fixed”

Docs: Troubleshoot mapping/recording areas

Mon, 01 Jan 0001 00:00:00 +0000

We assume that you at least followed Record a map .

Making a backup and/or removing a map.

The default location of the map can be found under

/home/openmower/ros_home/map.json

You can always back up your current map by logging in via SSH and copying the .json file.

If you want to retrieve the file, you can use an SFTP client like WinSCP or Cyberduck.

sudo cp /home/openmower/ros_home/map.json /home/openmower/ros_home/map.json.backup

To delete the map

# stop the openmower service so that it doesnt access the map anymore
openmower stop
# check, if the map file is indeed there.
ls /home/openmower/ros_home
# delete maps (both .bag and .json)
rm /home/openmower/ros_home/map.bag
rm /home/openmower/ros_home/map.json
# restart OM
openmower stop

Docs: Shopping List

Mon, 01 Jan 0001 00:00:00 +0000

If you make a purchase through the links marked with an Asterisk (*), I may earn a small commission at no extra cost to you. Thank you for supporting this project!

Warning

Read this first: Important Info

Parts for the Robot and the Charging Station

Name	Description	Quantity Required	Source Link	Notes
Mower (YardForce Classic 500(B))	The mower to modify.	1	Amazon*	Check the Compatible Mowers
Open Mower Hardware Kit	The electronics we will mount inside the robot and the charging station. Also includes goodies to make stuff easier to mount.	1	Version 2 Hardware: (see Announcement ) Contact @Apehaenger on Discord, he has Hardware available Version 1 Hardware: Vermut’s shop	Alternatively you can source and solder most of these parts yourself. Check the repositories in the Links section for PCB designs and BOMs.
Ardusimple RTK2B GPS + Antenna	Positioning system for the robot	1	ArduSimple	Some users use UM9XX chips (available from WitMotion and AliExpress ) as alternative. Compared to ArduSimple, they’re a bit cheaper and support triple-band frequencies.
Raspberry Pi Compute Module 4 with WiFi	The brain of the robot. RAM: 2GB+ for running the software 4GB+ for development 16GB+ storage (eMMC or µSD Card)	1	RPi Locator	Yes, it has to be the Raspberry Pi CM4, because we need all the UARTs and it goes into the xCore board.
µSD Card	Only for RPi CM4 Lite. The absolute minimum capacity you should buy is 16GB. But better buy a 32GB one	1	Amazon* or your local hardware store	A Gucci option would be a RasPiKey
Optional:	Optional:
USB Wi-Fi Dongle	For better Wi-Fi reception	0		Check for Linux Support
Left-Angle USB adapter	If you want to keep Wi-Fi dongle inside the mower. RPi USB is really close to the mower side wall	0	Amazon* or your local hardware store	The kit contains the wire to connect external USB port. That may be enough if Wi-Fi dongle is waterproof.

Parts for the GPS Base Station

Info

You only need a GPS base station if you don’t have access to an external NTRIP service. There are multiple free services available, so check before buying this.

Name	Description	Quantity Required	Source Link	Notes
Raspberry Pi + SD Card + Power Supply	You can basically use any Raspberry Pi for this. No special requirements.	1	e.g. Raspberry Pi 4
Ardusimple RTK2B GPS + Antenna	Positioning system for the base station	1	ArduSimple	See above

For the setup check the GPS Base Setup Guide

Docs: The Map

Mon, 01 Jan 0001 00:00:00 +0000

The Map

The most important information for the Open Mower is its map. The map tells the robot in which areas the robot is allowed to drive (= Navigation Area), which areas need to be mowed (= Mowing Area) and where the docking station is located. Using this information, the robot is able to do its work automatically.

Each area consists of one outline and multiple obstacles. The mower is allowed to drive inside the outline of all areas, except for the obstacles. This way you can exclude some parts of your lawn and prevent the mower from entering them.

The map is stored in the map.json file that is located on the mower at /home/openmower/ros_home

Docs: Unicore GPS Modules

Mon, 01 Jan 0001 00:00:00 +0000

Several users have chosen alternative GPS RTK modules with chips by Unicore:

UM960
UM980
UM982

These chips are sold in different variants. Some come with a USB-C socket (so they can be connected directly to the Raspberry Pi). Some have a different antenna socket, which requires an SMA F to MMCX M90 cable.

Compared to the ArduSimple simpleRTK2B, they are a bit cheaper and support triple-band frequencies.

Connection options

Connection	Notes
Module USB-C → RPi USB	e.g. with angle connector
Module UART → MainBoard UART	requires header connectivity

Configuration options

Method	When to use
Vendor software (UPrecise) on Windows	Before installing module into mower
Over UART bus (terminal only)	When RPi is installed and operational

Software

The vendor offers UPrecise to check all status details and configure the receiver. The UI is pleasing and has many features, but also quite some bugs. The download requires creating a free account.

Configuration via UPrecise (USB)

Receiver

Connect to the receiver via UPrecise. COM3 is used when connected via USB. Paste the following commands into UPrecise:

FRESET
CONFIG COM3 460800
MODE ROVER UAV
GPGGA 0.1
GPGSV 1
GPRMC 1
GPGSA 1
GPVTG 1
GPGST 1
SAVECONFIG

You can also connect directly to the receiver’s TTY, but make sure to send CR+LF (\r\n) line endings — otherwise commands won’t be recognized.

OpenMower (`mower_config.txt`)

export OM_GPS_PROTOCOL="NMEA"
export OM_GPS_PORT="/dev/ttyUSB0"
export OM_GPS_BAUDRATE="460800"

Configuration via UART (mainboard)

Use this method when the RPi is already installed and you want to wire the module directly to the mainboard UART header.

Prerequisites

Modified mower with replaced mainboard
RPi with openmower service running

Step 1 — Solder headers on the UM9XX

You only need the 4 middle pins from the 6 available: GND, VCC, TX, RX.

The remaining 2 pins are not needed:

EN — can be used to temporarily shut down the module
PPS — pulse-per-second signal, useful only if you need precise timing

Step 2 — Wire UM9XX to the mainboard

An adapter board is available as an alternative to manual wiring.

MainBoard	UM9XX
TXD	TXD
RXD	RXD
5V_IN	VCC
GND	GND

Step 3 — Configure UM9XX over UART

Install miniterm (part of python3-serial):

sudo apt-get install python3-serial

Stop the openmower service so it does not occupy the UART bus:

sudo systemctl stop openmower

Connect to the UART bus at the default baud rate (115200):

python -m serial.tools.miniterm /dev/ttyAMA1 115200 -e

Press Enter after each command to send it to the receiver.

Note: The following commands assume you wired to the bottom lane (COM1). If you used a different lane, replace COM1 with COM2.

Factory-reset the module and note the response:

FRESET

Expected output:

$command,FRESET,response: OK*4D
system is rebooting
..........
$devicename,COM1*67

Set the baud rate to 460800:

CONFIG COM1 460800

Exit miniterm with Ctrl+], then reconnect at the new baud rate:

python -m serial.tools.miniterm /dev/ttyAMA1 460800 -e

Note: If commands get no response, the baud rate or COM port is wrong. Reconnect at 115200, run FRESET, and try again.

Configure NMEA output. Each GP* command produces extra output — make sure SAVECONFIG completes successfully at the end:

MODE ROVER UAV
GPGSV COM1 2
GPRMC COM1 1
GPGSA COM1 1
GPVTG COM1 1
GPGGA COM1 0.5
SAVECONFIG

Expected output after SAVECONFIG:

$GNGGA,192705.50,,,,,0,00,9999.0,,,,,,*45
$command,SAVECONFIG,response: OK*55
$GNGGA,192706.00,,,,,0,00,9999.0,,,,,,*43
$GPGSA,,1,,,,,,,,,,,,,,,,*73
$GNRMC,192706.00,V,,,,,,,030625,0.0,E,N,V*7B

Exit miniterm with Ctrl+].

Step 4 — Configure OpenMower

Run openmower configure ros and set the GPS protocol to NMEA and the baud rate to 460800.

With your RTK base configured, take the mower outside and verify you get a GPS fix.

Troubleshooting — receiver resets

If the receiver cannot get a fix, a reboot may help. UPrecise provides three reset buttons. Unlike FRESET, these do not wipe the configuration:

Button	Command	Effect
Hot Start	`RESET`	Quick restart
Warm Start	`RESET EPHEM`	Clears ephemeris data
Cold Start	`RESET EPHEM ALMANAC IONUTC POSITION`	Full data reset

See section 8.3 (“Reset”) in the Unicore command reference for details.

Docs: Using a Gamepad

Mon, 01 Jan 0001 00:00:00 +0000

Using a USB gamepad is the most intuitive way to control your OpenMower during the area recording process. Instead of relying on the on-screen joystick in the web app, a physical controller gives you precise control over the mower’s movement — making it much easier to drive clean outlines around your mowing areas.

Any Xbox-compatible USB gamepad works out of the box. Simply plug it into one of the USB ports on your Raspberry Pi and OpenMower will detect it automatically. No additional configuration is needed.

Recording Mode Required

Gamepad control only works while OpenMower is in recording mode. Enter recording mode using the OpenMower app before using any of the buttons below.

If no map has been recorded yet, OpenMower will automatically start in recording mode — no action needed.

Video Tutorial

The video below walks through the entire area recording process, including how to use the gamepad to drive the mower and save mowing areas.

Button Reference

OpenMower Gamepad Controls (image licensed from shutterstock.com)

The table below covers every button used during normal operation and area recording. Most of your time will be spent holding A to drive and using B to start and stop recordings.

Driving

Input	Action
Hold A + left analog stick	Drive the mower
RB	Turbo mode (faster driving)

Recording Areas

Input	Action
B	Start / stop recording the current polygon
Y + D-PAD UP	Finish and save current area as a navigation area — the mower can drive here but will not mow
Y + D-PAD DOWN	Finish and save current area as a mowing area — at least one is required

Docking Station

Recording the docking station requires two separate position fixes that define the approach direction. The line between these two points tells the mower which way to face when returning to dock.

Drive the mower to a point roughly 1.5 m in front of the docking station, facing toward it. Press X to record the first point.
Drive the mower forward until the front wheels are just at the edge of the docking station — do not fully drive in. Press X again to record the second point.

Input	Action
X (first press)	Record approach point ~1.5 m in front of the dock
X (second press)	Record dock entry point at the edge of the station

Docs: Mounting RoboClaws wheel spikes

Mon, 01 Jan 0001 00:00:00 +0000

Author: prigor@discord, Vermut@discord

There are YardForce spikes on Amazon and other sites like Etsy. This photo guide is about RoboClaws.

In short:

remove wheels
(optionally) pre-drill holes, but people reported success even without that
attach spikes from inside
assemble back

Results:

much better traction on grass
noise on paving
probable damage to tiles

OpenMower — Open Source RTK GPS Robotic Mower – Documentation

Docs: Compatible Mowers

Yard Force

SABO / John Deere

Universal Board

Other Compatible Brands

Custom Hardware

Docs: Step 2.1: Prepare the GPS

Update Firmware and configure the GPS board

Info

Prerequisites

Step 2.1.0: Update Firmware

Warning

Step 2.1.1: Open u-center and connect to your GPS

Step 2.1.2: Transfer the configuration to the GPS

Step 2.1.3: Save configuration to Flash

Step 2.1.4: Done 🎉

Docs: Step 1: Check Compatibility

Battery Voltage Explained

Officially Supported Mowers

Yard Force

SABO / John Deere

Universal Board

Other Compatible Brands

Custom Hardware

Docs: Step 3.1: Connect WiFi

Step 3.0: Ensure the Robot has Power

Step 3.1: Search the Hotspot

Step 3.2: Open a browser to the configuration page.

Step 3.3: Enter your WiFi Credentials

Step 3.4: Check Connection

Docs: Getting Started

Table of Contents

Quick Facts

Important Warnings

Read Before Starting

Is Your Mower Compatible?

Officially Supported Mowers

What You Need to Know

Required Skills

Note

What Parts You’ll Need

1. The Robot

2. OpenMower Hardware

Hardware Version 2

3. RTK GPS System

Build Overview

Ready to shop?

Get Support

Discord Community

Documentation & Resources

Next Steps

Docs: YardForce Classic 500(B)

v2 Hardware Only!

Prerequisites

Things you will need:

Tools you will need:

Step 2.4.1: Disassemble the Robot

Unscrew top cover

Pry the cover

Unplug the cover

Unplug the mainboard

Remove front PCB

Remove cover UI board

Info

Step 2.4.2: Remove Stock Electronics

Step 2.4.3: Small Preparations

3.1 Cutting Plastic Tabs in the Lid

3.2 Assemble GPS Antenna Holder

3.3 Add new connectors to the Emergency Stop Cables

3.4 Create a cable for the CoverUI

Step 2.4.4: Install OpenMower Electronics

Step 2.4.5: Install external WiFi Antenna (optional)

Prerequisites

Things you will need:

Steps:

Step 2.4.6: First Startup

Warning

Info

Docs: Step 3.2: Basic Configuration (Environment, Firmware Installation, xESC configuration)

The `openmower` command line tool

Update the `openmower` tool to the latest version