Open Mower Wiki - User contributions [en]

Flashing Xesc firmware

2022-07-12T16:11:06Z

Vamatis: added setting up section

== Introduction ==
''This page will guide you through the steps needed to flash and configure the XESCs for use with the OpenMower Project

This mini-HOWTO is meant to guide you through the different steps.''

'''THIS PAGE IS CONSIDERED A WORK IN PROGRESS AND WILL BE UPDATED REGULARLY'''

== Disclaimer ==
''This Wiki is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.
Please note that motors can be dangerous, especially the mowing one. Always take the blade apart when building / testing around the bot, and make sure nothing contacts any of the moving parts.

We cannot be held responsible for your actions.''

== STM32 Version ==
''In this section, we will guide you through the first flashing and configuration of your STM32 based XESC''

Only linux have been tested for now, but other OS will come.

=== Prerequisites ===
For this how-to, you will need:
- A Linux Computer with internet connection
- The XESC you want to flash
- A micro USB cable
- A ST programmer (STlink v2 or blue pill for exemple)
- Some wires to connect the XESC and the STLINK

=== Setting Up Your Machine ===

We created a script to make sure everything on your machine is setup correctly. To use it:

- Run a terminal on your computer
- run <code>wget https://github.com/vamatis/Random/blob/main/xesc-computer-setup-script.sh </code>
- then <code>chmod u+x xesc-computer-setup-script.sh</code>
- and finally <code>sudo ./xesc-computer-setup-script.sh</code>

The script will create a XESC-Setup folder with the following architecture:

- XESC-Setup
- bldc-bootloader
- xesc_firmware
- configs

The bldc-bootloader folder contains the VESC bootloader for the STM32
The xesc_firmware contains the custom firmware for the XESC
The config folder contains configurations for the drive and mower motors

Once you have that done, you're ready to proceed!

=== Connecting everything ===
Depending on the Programmer you use, you will need to connect either 3 or 4 wires between the programmer and XESC.
These wires are:
- 3V3V (not mandatory, depends on the programmer used)
- SWDIO -> the dataline
- SWDCLK -> the clockline
- GND

Looking at the XESC from the top (USB on top) and with the usb port facing towards you, the pinout is as follows:
3V3
SWDIO
GND
SWDCLK
RESET

Note that we won't use the reset line.

=== Flashing the Bootloader ===

=== Flashing the Firmware ===

=== Connection to VESC TOOL and configuration ===

== RP2040 Version ==
''In this section, we will guide you through the first flashing and configuration of your RP2040 based XESC''

Compared to the STM32 version, flashing the RP2040 XESC is pretty simple:

- Connect your XESC to your computer using the micro USB port
XESC will then appear as a mass storage device.
- Copy/Paste the firmware file to that new storage

On the RP2040 version, ROS automatically loads the necessary config for the OPENMOWER motors, so you don't need to do anything else.

Enjoy your flashed XESCs!

Flashing Xesc firmware

2022-07-12T14:59:56Z

Vamatis:

== Introduction ==
''This page will guide you through the steps needed to flash and configure the XESCs for use with the OpenMower Project

This mini-HOWTO is meant to guide you through the different steps.''

'''THIS PAGE IS CONSIDERED A WORK IN PROGRESS AND WILL BE UPDATED REGULARLY'''

== Disclaimer ==
''This Wiki is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.
Please note that motors can be dangerous, especially the mowing one. Always take the blade apart when building / testing around the bot, and make sure nothing contacts any of the moving parts.

We cannot be held responsible for your actions.''

== STM32 Version ==
''In this section, we will guide you through the first flashing and configuration of your STM32 based XESC''

=== Prerequisites ===
For this how-to, you will need:
- A Computer with internet connection
- The XESC you want to flash
- A micro USB cable
- A ST programmer (STlink v2 or blue pill for exemple)
- Some wires to connect the XESC and the STLINK

=== Setting Up Your Machine ===

=== Connecting everything ===
Depending on the Programmer you use, you will need to connect either 3 or 4 wires between the programmer and XESC.
These wires are:
- 3V3V (not mandatory, depends on the programmer used)
- SWDIO -> the dataline
- SWDCLK -> the clockline
- GND

Looking at the XESC from the top (USB on top) and with the usb port facing towards you, the pinout is as follows:
3V3
SWDIO
GND
SWDCLK
RESET

Note that we won't use the reset line.

=== Flashing the Bootloader ===

=== Flashing the Firmware ===

=== Connection to VESC TOOL and configuration ===

== RP2040 Version ==
''In this section, we will guide you through the first flashing and configuration of your RP2040 based XESC''

Compared to the STM32 version, flashing the RP2040 XESC is pretty simple:

- Connect your XESC to your computer using the micro USB port
XESC will then appear as a mass storage device.
- Copy/Paste the firmware file to that new storage

On the RP2040 version, ROS automatically loads the necessary config for the OPENMOWER motors, so you don't need to do anything else.

Enjoy your flashed XESCs!

Flashing Xesc firmware

2022-07-12T14:59:36Z

Vamatis:

== Introduction ==
''This page will guide you through the steps needed to flash and configure the XESCs for use with the OpenMower Project

This mini-HOWTO is meant to guide you through the different steps.''

'''THIS PAGE IS CONSIDERED A WORK IN PROGRESS AND WILL BE UPDATED REGULARLY'''

== Disclaimer ==
''This Wiki is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.
Please note that motors can be dangerous, especially the mowing one. Always take the blade apart when building / testing around the bot, and make sure nothing contacts any of the moving parts.

We cannot be held responsible for your actions.''

== '''STM32 Version''' ==
''In this section, we will guide you through the first flashing and configuration of your STM32 based XESC''

=== Prerequisites ===
For this how-to, you will need:
- A Computer with internet connection
- The XESC you want to flash
- A micro USB cable
- A ST programmer (STlink v2 or blue pill for exemple)
- Some wires to connect the XESC and the STLINK

=== Setting Up Your Machine ===

=== Connecting everything ===
Depending on the Programmer you use, you will need to connect either 3 or 4 wires between the programmer and XESC.
These wires are:
- 3V3V (not mandatory, depends on the programmer used)
- SWDIO -> the dataline
- SWDCLK -> the clockline
- GND

Looking at the XESC from the top (USB on top) and with the usb port facing towards you, the pinout is as follows:
3V3
SWDIO
GND
SWDCLK
RESET

Note that we won't use the reset line.

=== Flashing the Bootloader ===

=== Flashing the Firmware ===

=== Connection to VESC TOOL and configuration ===

== '''RP2040 Version''' ==
''In this section, we will guide you through the first flashing and configuration of your RP2040 based XESC''

Compared to the STM32 version, flashing the RP2040 XESC is pretty simple:

- Connect your XESC to your computer using the micro USB port
XESC will then appear as a mass storage device.
- Copy/Paste the firmware file to that new storage

On the RP2040 version, ROS automatically loads the necessary config for the OPENMOWER motors, so you don't need to do anything else.

Enjoy your flashed XESCs!

Flashing Xesc firmware

2022-07-12T14:58:51Z

Vamatis: /* STM32 Version */

== Introduction ==
This page will guide you through the steps needed to flash and configure the XESCs for use with the OpenMower Project

This mini-HOWTO is meant to guide you through the different steps.

'''THIS PAGE IS CONSIDERED A WORK IN PROGRESS AND WILL BE UPDATED REGULARLY'''

== Disclaimer ==
This Wiki is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.
Please note that motors can be dangerous, especially the mowing one. Always take the blade apart when building / testing around the bot, and make sure nothing contacts any of the moving parts.
We cannot be held responsible for your actions.

== STM32 Version ==
''In this section, we will guide you through the first flashing and configuration of your STM32 based XESC''

=== Prerequisites ===
For this how-to, you will need:
- A Computer with internet connection
- The XESC you want to flash
- A micro USB cable
- A ST programmer (STlink v2 or blue pill for exemple)
- Some wires to connect the XESC and the STLINK

=== Setting Up Your Machine ===

=== Connecting everything ===
Depending on the Programmer you use, you will need to connect either 3 or 4 wires between the programmer and XESC.
These wires are:
- 3V3V (not mandatory, depends on the programmer used)
- SWDIO -> the dataline
- SWDCLK -> the clockline
- GND

Looking at the XESC from the top (USB on top) and with the usb port facing towards you, the pinout is as follows:
3V3
SWDIO
GND
SWDCLK
RESET

Note that we won't use the reset line.

=== Flashing the Bootloader ===

=== Flashing the Firmware ===

=== Connection to VESC TOOL and configuration ===

== RP2040 Version ==
In this section, we will guide you through the first flashing and configuration of your RP2040 based XESC

Compared to the STM32 version, flashing the RP2040 XESC is pretty simple:

- Connect your XESC to your computer using the micro USB port
XESC will then appear as a mass storage device.
- Copy/Paste the firmware file to that new storage

On the RP2040 version, ROS automatically loads the necessary config for the OPENMOWER motors, so you don't need to do anything else.

Enjoy your flashed XESCs!

Flashing Xesc firmware

2022-07-12T14:49:51Z

Vamatis: /* RP2040 Version */ - added flashing instruction

== Introduction ==
This page will guide you through the steps needed to flash and configure the XESCs for use with the OpenMower Project

This mini-HOWTO is meant to guide you through the different steps.

'''THIS PAGE IS CONSIDERED A WORK IN PROGRESS AND WILL BE UPDATED REGULARLY'''

== Disclaimer ==
This Wiki is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.
Please note that motors can be dangerous, especially the mowing one. Always take the blade apart when building / testing around the bot, and make sure nothing contacts any of the moving parts.
We cannot be held responsible for your actions.

== STM32 Version ==
In this section, we will guide you through the first flashing and configuration of your STM32 based XESC

=== Prerequisites ===
For this how-to, you will need:
XXXXX

=== Setting Up Your Machine ===

=== Flashing the Bootloader ===

=== Flashing the Firmware ===

=== Connection to VESC TOOL and configuration ===

== RP2040 Version ==
In this section, we will guide you through the first flashing and configuration of your RP2040 based XESC

Compared to the STM32 version, flashing the RP2040 XESC is pretty simple:

- Connect your XESC to your computer using the micro USB port
XESC will then appear as a mass storage device.
- Copy/Paste the firmware file to that new storage

On the RP2040 version, ROS automatically loads the necessary config for the OPENMOWER motors, so you don't need to do anything else.

Enjoy your flashed XESCs!

Mini HOWTOs

2022-07-12T14:19:59Z

Vamatis: Addeed link to the XESC firmware page

Here you can find various collected instructions on how to do various tasks related to the OpenMower project. Most are rather impressionistic and are not meant to be detailed, thoroughly tested guides, but more a quick notion on how to do something rather than having to be a detective and find out entirely on your own.

'''''Disclaimer'''''

''This material is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.''

== Warning ==
Please note that this project currently is in a very early stage! So don't go buying stuff right away! You will need to order and solder your own boards, since there are no assembled boards for sale yet.

Please make sure that you're actually allowed to build this device in your area. There may be laws / patents prohibiting you of doing so!

Please just be responsible and if you're not sure what you're doing, please don't do anything.

BTW the warranty of your brand new mower will obviously be void as soon as you modify it in any way, so be aware.

== List of Mini HOWTOs ==

* [[Simple set-up of a RTK base station]]
*[[Setting up ROS on a Raspberry Pi (intended to be the Rover -- OpenMower)]] (placeholder for now)
*[[Flashing firmware on the Pi Pico]]
*[[Flashing Xesc firmware]]
*[[Running an OpenMower simulation]]

Flashing Xesc firmware

2022-07-12T14:18:00Z

Vamatis: First draft

Flashing Xesc firmware

2022-07-12T14:09:32Z

Vamatis: Creating the flashing page

temp

Builder Road Map

2022-05-30T14:15:53Z

Vamatis: fixed mistake

Note: This WIKI was only just started on 2022-04-22, but are actively working on filling it up and making a good documentation for the new builders out there!

==Warning==
Please note that this project currently is in a very early stage! So don't go buying stuff right away! You will need to order and solder your own boards, since there are no assembled boards for sale yet.

Please make sure that you're actually allowed to build this device in your area. There may be laws / patents prohibiting you of doing so!

Please just be responsible and if you're not sure what you're doing, please don't do anything.

BTW the warranty of your brand new mower will obviously be void as soon as you modify it in any way, so be aware.

== Intro ==
If you want to embark on building an OpenMower, we have collected an overview of the various parts and where find information and what to to below. Beware that this is not complete, but it gives you some navigation to how to go about making a project for yourself.

Please see the image to the right for an overview that will assist you when reading the road map description below.

You can find more information on the various parts in the page [[Building the Mower|'''Building the Mower''']]
[[File:Road map.png|thumb]]

'''''Disclaimer'''''

''This material is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.''

== Road map ==

===The Mower===

====Get a mower in a store ====
So far only the Yard Force 500 is supported. See [[FAQ]] for more about alternative mowers.

====Disassemble the mower and Remove the old mainboard====
See @c.ez's YouTube video https://www.youtube.com/watch?v=_bImqD-pQSA

Now, it is ready for a new main board.

=== PCBs with components ===
You need to build 4 PCBs; 1 for the main board and 3 for the motor controls (ESCs). You have to get the PCBs, get the parts and solder it yourself at the current stage. Due to international parts shortage, getting parts is quite a detective task, but here, we give you some help.

The recommended process for getting parts is the following:

# There are some parts lists (BOMs) maintained in Octopart - they will be given below.
# Use the Octopart site to find out where there are parts available and order them. You will very likely have to use several vendors. We propose that you start at digikey and then move on for parts that you can not get there.
# Order the parts.
# Use the relevant Gerber files for the board that you are making to order PCBs at e.g. JLCPCB. If you plan to use a hot plate or an oven for the soldering process, consider simultaneously ordering a stencil for placing solder paste on your PCBs.

====Main board====
{| class="wikitable"
|+
!What
!Where
!Notes
|-
|Gerber files
|https://github.com/ClemensElflein/OpenMower/tree/main/dist/Mainboard
|Get the latest zip file here.
|-
|BOM .csv file
|https://github.com/ClemensElflein/OpenMower/blob/main/dist/Mainboard/OpenMowerMainboard_bom_.csv
| With a little effort can be used to create an Octpoart list or a digikey list, if you spend some time mapping fields. The file has digikey and lcsc part numbers in it already.
|-
|BOM on Octopart
|https://octopart.com/bom-tool/ODFKeG8J
|Use this to see where parts are available
|-
|Interactive BOM
|https://github.com/ClemensElflein/OpenMower/blob/main/dist/Mainboard/ibom.html
|Use this file to see where parts go, very useful when you start to assemble.
Download the file and use it locally on you workstation. It has option to save state for how far you have gotten.
|}
=====Further parts needed=====
You also need

*A Raspberry Pi 4
*An RTK Module
*A Raspberry Pi Pico

====xESC2040====

This version of the three motor drivers uses the RP2040 chip which should be available. The ESC can be produced single-sided for the OpenMower project (so it is less complicated than the STM32 version that is dual sided). xESC2040 has an option to mount some component on the underside to enable CAN interfacing, but, as said, this is not needed for the OpenMower.

{| class="wikitable"
|+
!What
!Where
!Notes
|-
|Gerber files
|https://github.com/ClemensElflein/xESC/blob/main/PCB/xESC2040/GERBER/
|Use latest zip file here
|-
|BOM .csv file
|TODO
|
|-
|BOM on Octopart
| https://octopart.com/bom-tool/p1aqUopq
|Use this to see where parts are available
Note: this BOM is ''without'' the CAN components for the underside (they are not needed for the OpenMower project).
|-
|BOM on Octopart
| https://octopart.com/bom-tool/tZ27Fd1N
|Use this to see where parts are available
Note: this BOM is ''with'' the CAN components for the underside (they are not needed for the OpenMower project).
|-
|Interactive BOM
|https://github.com/ClemensElflein/xESC/blob/main/PCB/xESC2040/BOM/ibom.html
|Use this file to see where parts go, very useful when you start to assemble.
Download the file and use it locally on you workstation. It has option to save state for how far you have gotten.
|}

====x-ESC (original STM32 version)====

This version of the three motor drivers uses the STM32 chip which is in very short supply, therefore the xESC2040 was designed and you should probably go for the xESC2040, unless you actually have access to STM32s. Also the STM32 version uses a double-sided PCB, so it is harder to solder than xESC2040.

{| class="wikitable"
|+
!What
!Where
!Notes
|-
|Gerber files
|https://github.com/ClemensElflein/xESC/tree/main/PCB/xESC2_mini_VESC/GERBER
|Zip the files in this directory
|-
|BOM .csv file
|TODO
|Use this to see where parts are available
|-
|BOM on Octopart
|https://octopart.com/bom-tool/hUY6qiSp
|Use this to see where parts are available
|-
|Interactive BOM
|https://github.com/ClemensElflein/xESC/blob/main/PCB/xESC2_mini_VESC/BOM/ibom.html
|Use this file to see where parts go, very useful when you start to assemble.
Download the file and use it locally on you workstation. It has option to save state for how far you have gotten.
|}
===Base station with the base RTK GPS module===
[TODO] @c.ez : Need info.

===Charging Station ===

=====Get a CC/CV module=====
This is currently needed to fix the charging station provided by Yard Force due to incompatibilities with the replaced main-board. It should be possible to fix this issue, but right now, it is necessary. See [[Building the Mower]] for where to get it.

====Upgrade the Charging Station ====
[TODO] @c.ez : Need info.

__FORCETOC__

Builder Road Map

2022-05-30T14:15:15Z

Vamatis: added STM32 and RP2040 with CAN boms.

Note: This WIKI was only just started on 2022-04-22, but are actively working on filling it up and making a good documentation for the new builders out there!

==Warning==
Please note that this project currently is in a very early stage! So don't go buying stuff right away! You will need to order and solder your own boards, since there are no assembled boards for sale yet.

Please make sure that you're actually allowed to build this device in your area. There may be laws / patents prohibiting you of doing so!

Please just be responsible and if you're not sure what you're doing, please don't do anything.

BTW the warranty of your brand new mower will obviously be void as soon as you modify it in any way, so be aware.

== Intro ==
If you want to embark on building an OpenMower, we have collected an overview of the various parts and where find information and what to to below. Beware that this is not complete, but it gives you some navigation to how to go about making a project for yourself.

Please see the image to the right for an overview that will assist you when reading the road map description below.

You can find more information on the various parts in the page [[Building the Mower|'''Building the Mower''']]
[[File:Road map.png|thumb]]

'''''Disclaimer'''''

''This material is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.''

== Road map ==

===The Mower===

====Get a mower in a store ====
So far only the Yard Force 500 is supported. See [[FAQ]] for more about alternative mowers.

====Disassemble the mower and Remove the old mainboard====
See @c.ez's YouTube video https://www.youtube.com/watch?v=_bImqD-pQSA

Now, it is ready for a new main board.

=== PCBs with components ===
You need to build 4 PCBs; 1 for the main board and 3 for the motor controls (ESCs). You have to get the PCBs, get the parts and solder it yourself at the current stage. Due to international parts shortage, getting parts is quite a detective task, but here, we give you some help.

The recommended process for getting parts is the following:

# There are some parts lists (BOMs) maintained in Octopart - they will be given below.
# Use the Octopart site to find out where there are parts available and order them. You will very likely have to use several vendors. We propose that you start at digikey and then move on for parts that you can not get there.
# Order the parts.
# Use the relevant Gerber files for the board that you are making to order PCBs at e.g. JLCPCB. If you plan to use a hot plate or an oven for the soldering process, consider simultaneously ordering a stencil for placing solder paste on your PCBs.

====Main board====
{| class="wikitable"
|+
!What
!Where
!Notes
|-
|Gerber files
|https://github.com/ClemensElflein/OpenMower/tree/main/dist/Mainboard
|Get the latest zip file here.
|-
|BOM .csv file
|https://github.com/ClemensElflein/OpenMower/blob/main/dist/Mainboard/OpenMowerMainboard_bom_.csv
| With a little effort can be used to create an Octpoart list or a digikey list, if you spend some time mapping fields. The file has digikey and lcsc part numbers in it already.
|-
|BOM on Octopart
|https://octopart.com/bom-tool/ODFKeG8J
|Use this to see where parts are available
|-
|Interactive BOM
|https://github.com/ClemensElflein/OpenMower/blob/main/dist/Mainboard/ibom.html
|Use this file to see where parts go, very useful when you start to assemble.
Download the file and use it locally on you workstation. It has option to save state for how far you have gotten.
|}
=====Further parts needed=====
You also need

*A Raspberry Pi 4
*An RTK Module
*A Raspberry Pi Pico

====xESC2040====

This version of the three motor drivers uses the RP2040 chip which should be available. The ESC can be produced single-sided for the OpenMower project (so it is less complicated than the STM32 version that is dual sided). xESC2040 has an option to mount some component on the underside to enable CAN interfacing, but, as said, this is not needed for the OpenMower.

{| class="wikitable"
|+
!What
!Where
!Notes
|-
|Gerber files
|https://github.com/ClemensElflein/xESC/blob/main/PCB/xESC2040/GERBER/
|Use latest zip file here
|-
|BOM .csv file
|TODO
|
|-
|BOM on Octopart
| https://octopart.com/bom-tool/p1aqUopq
|Use this to see where parts are available
Note: this BOM is ''without'' the CAN components for the underside (they are not needed for the OpenMower project).
|-
|BOM on Octopart
| https://octopart.com/bom-tool/tZ27Fd1N
|Use this to see where parts are available
Note: this BOM is ''with'' the CAN components for the underside (they are not needed for the OpenMower project).
|-
|Interactive BOM
|https://github.com/ClemensElflein/xESC/blob/main/PCB/xESC2040/BOM/ibom.html
|Use this file to see where parts go, very useful when you start to assemble.
Download the file and use it locally on you workstation. It has option to save state for how far you have gotten.
|}

====x-ESC (original STM32 version)====

This version of the three motor drivers uses the STM32 chip which is in very short supply, therefore the xESC2040 was designed and you should probably go for the xESC2040, unless you actually have access to STM32s. Also the STM32 version uses a double-sided PCB, so it is harder to solder than xESC2040.

{| class="wikitable"
|+
!What
!Where
!Notes
|-
|Gerber files
|https://github.com/ClemensElflein/xESC/tree/main/PCB/xESC2_mini_VESC/GERBER
|Zip the files in this directory
|-
|BOM .csv file
|https://octopart.com/bom-tool/hUY6qiSp
|Use this to see where parts are available
|-
|BOM on Octopart
|https://octopart.com/bom-tool/hUY6qiSp
|Use this to see where parts are available
|-
|Interactive BOM
|https://github.com/ClemensElflein/xESC/blob/main/PCB/xESC2_mini_VESC/BOM/ibom.html
|Use this file to see where parts go, very useful when you start to assemble.
Download the file and use it locally on you workstation. It has option to save state for how far you have gotten.
|}
===Base station with the base RTK GPS module===
[TODO] @c.ez : Need info.

===Charging Station ===

=====Get a CC/CV module=====
This is currently needed to fix the charging station provided by Yard Force due to incompatibilities with the replaced main-board. It should be possible to fix this issue, but right now, it is necessary. See [[Building the Mower]] for where to get it.

====Upgrade the Charging Station ====
[TODO] @c.ez : Need info.

__FORCETOC__

Building the Mower

2022-05-30T07:26:57Z

Vamatis: added octoparts boms

Welcome to the OpenMower Building guide!

Note: This WIKI was only just started on 2022-04-22, but are actively working on filling it up and making a good documentation for the new builders out there!

== Warning ==
Please note that this project currently is in a very early stage! So don't go buying stuff right away! You will need to order and solder your own boards, since there are no assembled boards for sale yet.

Please make sure that you're actually allowed to build this device in your area. There may be laws / patents prohibiting you of doing so!

Please just be responsible and if you're not sure what you're doing, please don't do anything.

BTW the warranty of your brand new mower will obviously be void as soon as you modify it in any way, so be aware.

== Intro ==
Below you can find an overview of the major parts and components in the OpenMower.

There is a also another page with a [[Builder Road Map|'''Builder Road Map''']] that gives guide to how to go about building your own OpenMower project.

== Bill OF Materials ==

{| class="wikitable" style="margin:auto"
|+ Open Mower Bill of Materials
|-
! Name !! Description
!Optional!! Availability !! Quantity Required !! Source Link 1 !! Alternate Source
|-
| Mower (Yardforce Classic 500) || Base building block
| || Off the shelf || 1 ||https://amzn.to/3NWgIxk
| '''Note:''' Earlier, we had a reference to myrobotcenter. However, they have gone into reconstruction, so be aware of that vendor!
|-
| OpenMower Mainboard || The core of the new electronics.
| || Custom || 1 || Components Octopart BOM:
https://octopart.com/bom-tool/ODFKeG8J
| WIP
|-
| xESC || Motor drivers
| || Custom || 3 || Components Octoparts BOM:
- RP2040 no CAN version:

https://octopart.com/bom-tool/p1aqUopq

-RP2040 full:

WIP

- STM32 :

WIP
| WIP
|-
| Raspebrry Pi 4 || The brain of the robot. Also used to send RTK correction data from the base station.

For the base station the Raspberry Pi can be any model with Ethernet and USB, for the robot we need the Raspberry Pi 4 with at least 4 GB of RAM.
| || Off the shelf || 2 || WIP || WIP
|-
| Ardusimple RTK2B GPS || Positioning system for the bot
| || Off the shelf || 2 || https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/ || https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/
|-
| Raspberry Pi Pico|| Microcontroller talking to peripherals, soldered to the OpenMower mainboard
| ||Off the shelf||1||Widely available||
|-
|3D printed brackets||To hold the GPS inside the bot
| ||Custom||1||https://www.printables.com/fr/model/175826-openmower-gps-mount-for-yardforce-classic-500<nowiki/>||WIP
|-
|SMA Angle Adapter
|Needed to connect the GPS without bending the wire too much
|
|Off the shelf
|1
|https://amzn.to/3K913b1
|WIP
|-
|CC/CV Step Down module
| As charger for the docking station
|
|Off the shelf
|1
|https://amzn.to/3NUdRVL
|WIP
|-
|Docking Station Adapter PCB
|A PCB to hold the module in place.
|
|Custom
|1
| WIP
|WIP
|-
|GPS PCB
| A ground plane PCB to improve GPS reception
|
|Custom
|1
|WIP
|WIP
|-
|USB Angle Adapter
|If you want to use the Classic 500's USB port
|YES
|Off the shelf
|1
|https://amzn.to/3ukNAIj
|WIP
|}

==Building the bot==

We are working on providing step by step instructions on how to build the bot. At the moment, we only have Clemens's video:
https://www.youtube.com/watch?v=_bImqD-pQSA

==Setup and test==

FAQ

2022-05-11T07:17:42Z

Vamatis:

== GENERAL ==

==== What is OpenMower? ====
OpenMower is a project that modifies an existing commercial Lawn mower robot (currently the Yard Force 500) with better steering electronics to provide, among other things, GPS navigation and optimized mowing paths. See the intro video here: https://www.youtube.com/watch?v=BSF04i3zNGw

==== Can I buy an assembled OpenMower or a kit? ====
No, at present it is a DIY yourself project that will require effort and technical skill on your part. But there is a very active community, so help is available.

==== How much does it cost? ====
Approx €350 for the mower + €400 for RTK GPS + €100 (yeah, semiconductor shortage..) for a Raspberry Pi + €200 for custom hardware.

==== Who created OpenMower? ====
Clemens Elflein, known as @c.ez in the project's Discord (https://discord.com/channels/958476543846412329/958476543846412331) is the designer and creator of OpenMower. If you like what he is doing, please support him on [https://www.patreon.com/ClemensElflein/posts Patreon]

==== What is the current stage of the project ====
The OpenMower is running in prototype at @c.ez. The mainboard and ESC work fine, just the STM32 for the ESCs are currently expensive.
Therefore we're working on a cheaper motor controller alternative. A group of early builders are buying parts and getting ready to “co-build” with @c.ez to test and validate the design.

==== Where can I find more information? ====
The entry points for more information are:

* [https://discord.com/channels/958476543846412329/958476543846412331 The Discord for the project]
* [https://discord.com/channels/958476543846412329/958476543846412332 Annoncements]
* This FAQ
* [https://discord.com/channels/958476543846412329/964895268132757514 Important links to GitHub, the YouTube channel etc.]

==== What license is OpenMower based on? ====
The license is “Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License”, pls. see here: https://creativecommons.org/licenses/by-nc-sa/4.0/

== BUILDING AN OPENMOWER YOURSELF ==

====What skills do I need to build one?====

* Taking hardware apart and putting it together again
* Buying parts
* Soldering, in particular SMD techniques for making the main PCB
* Electronics, getting Linux and ROS on a Raspberry Pi, probably installing some packages etc.
* Debugging, patience, tech creativity, joy in participating

====What should I do if I want to build an OpenMower?====
Remember, we are very early stage, so don’t expect finished build instructions, rather be prepared to figure out quite a bit of stuff yourself (with the help of the community).
That said, head to the #open-mower-builds in the Discord and be part of an exciting activity.

====What can I do right now if I want to build?====
Start getting parts! Look at the preliminary BOM in https://wiki.openmower.de/index.php?title=Building_the_Mower and start getting the big chunks, like the YardForce 500, Raspberry Pis, GPS RTK modules etc.

Start following the #open-mower-builds Discord channel here

====Should I order a PCB for the main board right now?====
Not yet. @c.ez is currently awaiting a shipment of rev 0.9.1.beta of the main board. Once he has validated that, we should be able to start ordering.

====Is there a step-by-step instruction?====
Not yet. @c.ez is working on it.

====Is there a recommended place to buy parts?====
Unfortunately, no. Best EU suggestions are Farnell, Mouser, Digikey.

If anyone has better suggestions, pls. share in #open-mower-builds on the Discord and it will be included here.

====Where do I buy Raspberry Pis?====
RPIs have a serious world-wide shortage at the moment. You may check https://rpilocator.com/ if they point to anywhere that has supply.

If you find EU vendors with supply, pls. share in #open-mower-builds in the Discord.
== OPENMOWER TECH - GENERAL ==

====Can I use a different mower than the YardForce 500?====
The project is designed for the YF500, so the immediate answer is no.
The project is solely focused on making the YF500 work at the moment.
However, YF500 seems to be one branding of a Chinese robot that appears under other names, too. So likely, we’ll discover that other brands (and also other models of Yard Force) can work. Also some builders in the Discord are looking into robots from other manufacturers to see if the core OpenMower tech could be applied to those. Check #mower-dissection if you want to follow or participate. But applying to other brands will likely not happen before the YF500 based OpenMower seems to run well.

====Where can I buy the Yard Force 500?====

* https://www.myrobotcenter.eu/en/yardforce-classic-500 Note: They promise 48 hrs to delivery, but several builders have waited 7+ days and, so beware.
* Amazon.de.

If you find other good vendors, pls. share in #open-mower-builds on the Discord and it will be included here.
====Is Yard Force 500 available in the US?====
It seems not directly. You may try to import it from Amazon in the EU. Those that have it confirm that it operates on 100-240 V~, 50/60 Hz, 56 W.

If you find a consistent way to obtain a YF500 or a compatible mower in the US, pls. share in #open-mower-builds on the Discord and it will be included here.

====What is special about the OpenMower?====

* OpenMower utilizes two GPS RTK units (one on the Mower, the other in a fixed place) to allow OpenMower to have centimeter-precise location data.
* That means that you can train OpenMower on your lawn edge and it can run without a boundary wire. And you can train it on several lawn segments that it can then roam between.
* The exact location info allows OpenMower to cut along an efficient planned path rather than move chaotically around like almost every commercial mower out there.
* You build it yourself and all the soft- and hardware is open source, so if you have the skills, you can mod it further.

==== What technological platforms is OpenMower based on? ====

* The Mower
** [https://www.raspberrypi.org/ Raspberry Pi SBC] version 4 running Linux and [https://www.ros.org/ ROS 1] for the robotics; mapping and navigation etc.
** [https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/ GPS RTK module] communicating with a fixed GPS RTK module to provide cm accuracy
** [https://www.raspberrypi.com/products/raspberry-pi-pico/ Raspberry Pi Pico] (microcontroller) to operate sensors such as the IMU, battery voltage & charge current, "stop" button, lift sensor in front wheels etc...
* The GPS base station
** GPS RTK module for providing a point of reference to provide cm accuracy in conjunction with the module on the mower

== WHAT ABOUT MOWERS THAT ARE NOT YARD FORCE 500? ==

====ArduMower https://www.ardumower.de/<nowiki/>====
ArduMower is a slightly more mature but also more closed project, also using RTK GPS and no wire. You can get both an assembled mower and a full kit.

As @c.ez# writes, it depends on your preference: "So basically: If you're looking to build an robotic mower as fast as possible, I'd recommend you to go with the Ardumower. If you're in for the tech, I recommend you to follow this project instead (!!obviously biased opinion here!!)". See his full post here: https://discord.com/channels/958476543846412329/961804411112394842/963271459357204560

====Navimow https://navimow.segway.com/<nowiki/>====
Navimow is a new system that seems to be still not quite launched on the market (as per 2022-04-19). It looks to be quite full-featured and should offer a commercial out-of-the box solution with app and many features. Price point seems to be €1.300.

==== ReP_AL mowers https://repalmakershop.com/ ====
ReP_AL has a mower that that you build yourself, based on a 3D print design that you can print yourself or buy from them. You buy the kit of all parts. They say "Fully autonomous robot lawn mower with TFT Touchscreen and Smartphone APP. The mower project includes the mower itself a boundary wire control station, smartphone APP, TFT Touchscreen interface and an optional charging station." The mover control is Arduino based and the software is open source. There is some indications that they are moving towards GPS RTK.

====What do we know about the feasibility of doing OpenMower on other mowers?====
In the [https://discord.com/channels/958476543846412329/960885921174130758 #mower-dissection channel on the Discord], members are taking apart other brands/models from Yard Force 500 to assess the viability of applying the OpenMower platform to them. There is also a Google Sheet with collected notes and observations here: https://docs.google.com/spreadsheets/d/1BX0-KEs5v-VED8-RA4BLE-wRdXHtlmcKy4n9K5vJVAA/edit?usp=sharing

Ask @tinker0436 for edit permission if you want to contribute.
====A note on other mowers and future direction====

It is likely that in a later version, the OpenMower platform could be split in "core" and "specific mower" parts so that many mowers could be supported and it would be easy to hack OpenMower onto your mower. But at the current stage, the project is focused on realizing a working beta on the Yard Force 500, There are already individual builders that are experimentally trying to adapt OpenMower to their owen mower platforms.

== About the Yard Force 500 ==

==== Can the YF500 be made to mow more than 500 square meters? ====
First: The area that the producers report are highly approximate. The reason being that traditional robotic mowers cut at random, so in a given time, they eventually cover the entire lawn more or less intensively. Hence, it is all approximate. Many owners of the traditional robots cover more area than the robots are made out for, simply by having them run a lot over a week, thus with the many hours of mowing per week, covering an area larger than specified for a given mower.

That said, it is quite likely that OpenMower on YF500 has more direct capacity than 500 square meters - since it mows systematically and covers every bit of lawn only once. We still have no reports on how many square meters the YF500 can cover on one charge, but as we start having actual OpenMowers out there, we can report on that.

We might later set up the software to have the mower return and pick up again where it left off upon an empty battery - but that is not implemented yet. It should be doable in software, though, and thus be able to increase the area that it is possible to cover.

Lastly, there seems to be extra physical space for more battery in the YF500 ''under'' the battery pack, but it has not been investigated yet. Be aware, that it takes knowledge to work with the batteries. You should know what you are doing, since the batteries contain a lot of power and may explode or combust if handled incorrectly.

== OPENMOWER TECH - SPECIFICS ==

=== RTK GPS ===

==== Which RTK GPS modules are used in the basic OpenMower design? ====
These ones: https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/

==== How many RTK GPS modules are needed for OpenMower? ====
In the actual phase 1 design, 2 are needed, one at base and one on the mower. The one on the mower is mandatory to measure exact position. The one at base provides reference. Without the reference, the exact location of the mower can not be determined. See a good explanation of this here: https://www.ardusimple.com/rtk-explained/

The reference may - possibly - be provided instead by publicly available servers that can provide local correction data. One of these solutions is NTRIP. Using such a source, it should be possible to not have the RTK GPS module on the base, but instead subscribe to the correction signal from the internet. Two notes regarding that: 1) The current design does not have this out of the box, so you would have to modify the ROS code yourself for this setup. And 2) if the Internet-based correction signal becomes unavailable, your mower will lose cm-precise location and cannot navigate. With the basic design with two RTK modules, that is not a problem.

==== How do the two RTK GPS modules communicate with each other - what are the options? ====
The original OpenMower implementation has a separate process running which receives the RTK corrections from an NTRIP server via WiFi and redirects them to the GPS board. The IP is set to the base station in the local network, you can update it to an external service provider though.

This has the drawback, that you constantly need to be connected to the WiFi.

Alternatively, the ArduSimple board has a slot where you can plug an external radio as direct bridge between the robot and the base station for extended range. ArduSimple offers multiple modules for this and they will all work plug and play with the OpenMower, since the OpenMower expects corrected data and does not care how the GPS receives the corrections. If you are using this though, you might need to edit your GPS configuration (see ArduSimple manual) and disable the NTRIP receiver process in ROS.

== Maintenance of this FAQ ==
This FAQ is maintained by @tinker0436

It is a work in progress. If you have additional questions or comments or find stuff missing, use the Discord #open-mower channel and tag a @Mod so that we get a ping. Comments and suggestions are very welcome!

====Disclaimer====
This FAQ is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.

Main Page

2022-04-29T10:25:34Z

Vamatis: Small order update + link name change to make it easier for peopel (following suggestions by a wiki-author channel user)

== OpenMower Wiki ==

Welcome to the OpenMower Wiki!

This WIKI was only just started on 2022-04-22, but we'll collaborate on getting good information on the OpenMower project collected here.

If you want to contribute to the Wiki, just register and you can participate. Head to the [https://discord.com/channels/958476543846412329/967345181013725194 #wiki-authors Discord channel] if you want talk about the Wiki.

== How to Get Started ==

One of the first steps currently is to browse around the discord and understand what the project is about. You can also have a look at Clemens' second video ([https://www.youtube.com/watch?v=_bImqD-pQSA here]) of the project that details how to assemble the bot.

When you're ready, you can have a look at the '''[[Building the Mower]]''' section to see the Bill of Materials and steps required '''(Note this wiki is in progress and not complete yet, but we're working on it!)'''

== Resources ==

=== [[FAQ]] ===
There is a continually evolving [[FAQ]] that is a good starting point for understanding the project and getting answers to some key questions.

[[FAQ|See the FAQ here]]

=== [[Project overview|Project overview and timeline]] ===
Current status and future goals - [[Project overview|See it here]]

=== [[Hardware|Hardware Revisions]] ===
Open Mower hardware revisions, changelog, info: [[Hardware|Here]]

=== Where to find more information ===

The entry points for more information are:

* [https://discord.com/channels/958476543846412329/958476543846412331 The Discord for the project]
* [https://discord.com/channels/958476543846412329/958476543846412332 Annoncements in the Discord]
* [https://www.youtube.com/c/ClemensElflein/videos YouTube]
* [https://github.com/ClemensElflein/OpenMower Open Mower Main GitHub Repo - Overall and hardware]
* [https://github.com/ClemensElflein/open_mower_ros Open Mower GitHub Repo for the ROS logic in the OpenMower]
* [https://github.com/ClemensElflein/xESC xESC Motor Controller Repo (custom part for main board)]

== How to contribute ==

At the moment, there are different ways to contribute:

* Building your own mower, testing the software and reporting bugs / committing fixes on the github repository

* If you're not scared to see the inside of some mowers, please help us understand more about how they are built following instructions in the '''[[Mower Dissection]]''' page.

* And finally, [https://www.patreon.com/ClemensElflein Patreon to support Clemens' amazing work]

== Disclaimer ==
This Wiki is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.

Main Page

2022-04-23T10:48:38Z

Vamatis:

== OpenMower Wiki ==

Welcome to the OpenMower Wiki!

This WIKI was only just started on 2022-04-22, but we'll collaborate on getting good information on the OpenMower project collected here.

If you want to contribute to the Wiki, just register and you can participate. Head to the [https://discord.com/channels/958476543846412329/967345181013725194 #wiki-authors Discord channel] if you want talk about the Wiki.

== Resources ==

=== [[FAQ]] ===
There is a continually evolving [[FAQ]] that is a good starting point for understanding the project and getting answers to some key questions.

[[FAQ|See the FAQ here]]

=== [[Project overview|Project overview and timeline]] ===
Current status and future goals - [[Project overview|See it here]]

=== Where to find more information ===

The entry points for more information are:

* [https://discord.com/channels/958476543846412329/958476543846412331 The Discord for the project]
* [https://discord.com/channels/958476543846412329/958476543846412332 Annoncements in the Discord]
* [https://www.youtube.com/c/ClemensElflein/videos YouTube]
* [https://github.com/ClemensElflein/OpenMower Open Mower Main GitHub Repo - Overall and hardware]
* [https://github.com/ClemensElflein/open_mower_ros Open Mower GitHub Repo for the ROS logic in the OpenMower]
* [https://github.com/ClemensElflein/xESC xESC Motor Controller Repo (custom part for main board)]

== How to Get Started ==

One of the first steps currently is to browse around the discord and understand what the project is about. You can also have a look at Clemens second video of the project that details how to assemble the bot.

When you're ready, you can have a lookt at the '''[[Building the Mower]]''' section to see the Bill of Materials and steps required '''(Note this wiki is in progress and not complete yet, but we're working on it!)
'''

== How to contribute ==

At the moment, there are different ways to contribute:

* Building your own mower, testing the software and reporting bugs / committing fixes on the github repository

* If you're not scared to see the inside of some mowers, please help us understand more about how they are built following instructions in the '''[[Mower Dissection]]''' page.

* And finally, [https://www.patreon.com/ClemensElflein Patreon to support Clemens' amazing work]

Main Page

2022-04-23T10:48:08Z

Vamatis:

== OpenMower Wiki ==

Welcome to the OpenMower Wiki!

This WIKI was only just started on 2022-04-22, but we'll collaborate on getting good information on the OpenMower project collected here.

If you want to contribute to the Wiki, just register and you can participate. And head head to the [https://discord.com/channels/958476543846412329/967345181013725194 #wiki-authors Discord channel] if you want talk about the Wiki.

== Resources ==

=== [[FAQ]] ===
There is a continually evolving [[FAQ]] that is a good starting point for understanding the project and getting answers to some key questions.

[[FAQ|See the FAQ here]]

=== [[Project overview|Project overview and timeline]] ===
Current status and future goals - [[Project overview|See it here]]

=== Where to find more information ===

The entry points for more information are:

* [https://discord.com/channels/958476543846412329/958476543846412331 The Discord for the project]
* [https://discord.com/channels/958476543846412329/958476543846412332 Annoncements in the Discord]
* [https://www.youtube.com/c/ClemensElflein/videos YouTube]
* [https://github.com/ClemensElflein/OpenMower Open Mower Main GitHub Repo - Overall and hardware]
* [https://github.com/ClemensElflein/open_mower_ros Open Mower GitHub Repo for the ROS logic in the OpenMower]
* [https://github.com/ClemensElflein/xESC xESC Motor Controller Repo (custom part for main board)]

== How to Get Started ==

One of the first steps currently is to browse around the discord and understand what the project is about. You can also have a look at Clemens second video of the project that details how to assemble the bot.

When you're ready, you can have a lookt at the '''[[Building the Mower]]''' section to see the Bill of Materials and steps required '''(Note this wiki is in progress and not complete yet, but we're working on it!)
'''

== How to contribute ==

At the moment, there are different ways to contribute:

* Building your own mower, testing the software and reporting bugs / committing fixes on the github repository

* If you're not scared to see the inside of some mowers, please help us understand more about how they are built following instructions in the '''[[Mower Dissection]]''' page.

* And finally, [https://www.patreon.com/ClemensElflein Patreon to support Clemens' amazing work]

Building the Mower

2022-04-23T10:01:33Z

Vamatis: added availability column

Welcome to the OpenMower Building guide!

This WIKI was only just started on 2022-04-22, but are actively working on filling it up and making a good documentation for the new builders out there!

== Bill OF Materials ==

{| class="wikitable" style="margin:auto"
|+ Open Mower Bill of Materials
|-
! Name !! Description !! Availability !! Quantity Required !! Source Link 1 !! Alternate Source
|-
| Mower (Yardforce Classic 500) || Base building bloc || Off the shelf || 1 || WIP || WIP
|-
| OpenMower Mainboard || The core of the new electronics || Custom || 1 || WIP || WIP
|-
| Xesc || Motor drivers || Custom || 3 || WIP || WIP
|-
| Raspebrry pi4 || The brain of the bot. Also used to send correction data from the base station. At the moment, the base station pi can me any model as not much processing is required || Off the shelf || 2 || WIP || WIP
|-
| Ardusimple RTK2B GPS || Positioning system for the bot || Off the shelf || 2 || https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/ || https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/
|-
| 3D printed brackets || To hold the GPS into the bot || Custom || 1 || https://www.printables.com/fr/model/175826-openmower-gps-mount-for-yardforce-classic-500 || WIP
|}

== Building the bot ==

We are working on providing step by step instructions on how to build the bot. At the moment, we only have Clemens's video:
https://www.youtube.com/watch?v=_bImqD-pQSA

== Setup and test ==

Building the Mower

2022-04-23T09:58:15Z

Vamatis: added a first version BOM

Welcome to the OpenMower Building guide!

This WIKI was only just started on 2022-04-22, but are actively working on filling it up and making a good documentation for the new builders out there!

== Bill OF Materials ==

{| class="wikitable" style="margin:auto"
|+ Open Mower Bill of Materials
|-
! Name !! Description !! Quantity Required !! Source Link 1 !! Alternate Source
|-
| Mower (Yardforce Classic 500) || Base building bloc || 1 || WIP || WIP
|-
| OpenMower Mainboard || The core of the new electronics || 1 || WIP || WIP
|-
| Xesc || Motor drivers || 3 || WIP || WIP
|-
| Raspebrry pi4 || The brain of the bot. Also used to send correction data from the base station. At the moment, the base station pi can me any model as not much processing is required || 2 || WIP || WIP
|-
| Ardusimple RTK2B GPS || Positioning system for the bot || 2 || https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/ || https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/
|-
| 3D printed brackets || To hold the GPS into the bot || 1 || https://www.printables.com/fr/model/175826-openmower-gps-mount-for-yardforce-classic-500 || WIP
|}

== Building the bot ==

We are working on providing step by step instructions on how to build the bot. At the moment, we only have Clemens's video:
https://www.youtube.com/watch?v=_bImqD-pQSA

== Setup and test ==

Building the Mower

2022-04-23T09:42:10Z

Vamatis: first page draft

Main Page

2022-04-23T08:40:42Z

Vamatis: changed the "pages we need" section

== OpenMower Wiki ==

Welcome to the OpenMower Wiki! I hope that this Wiki will help us to collect all all information about the OpenMower project.

To be honest, I have no idea how to write a Wiki, but I think we can figure this out.

I'll be putting content here if I have the time, but it would be really nice if some people would like to work on this as well!

== Resources ==

=== [[FAQ]] ===
There is a continually evolving [[FAQ]] that is a good starting point for understanding the project and getting answers to some key questions.

[[FAQ|See the FAQ here]]

=== [[Project overview and timeline]] ===
Current status and future goals - [[Project overview|See it here]]

=== Where to find more information ===

The entry points for more information are:

* [https://discord.com/channels/958476543846412329/958476543846412331 The Discord for the project]
* [https://discord.com/channels/958476543846412329/958476543846412332 Annoncements in the Discord]
* [https://www.youtube.com/c/ClemensElflein/videos YouTube]
* [https://github.com/ClemensElflein/OpenMower Open Mower Main GitHub Repo - Overall and hardware]
* [https://github.com/ClemensElflein/open_mower_ros Open Mower GitHub Repo for the ROS logic in the OpenMower]
* [https://github.com/ClemensElflein/xESC xESC Motor Controller Repo (custom part for main board)]
* [https://www.patreon.com/ClemensElflein Patreon to support Clemens' amazing work]

== How to Get Started ==

One of the first steps currently is to browse around the discord and understand what the project is about. You can also have a look at Clemens second video of the project that details how to assemble the bot.

When you're ready, you can have a lookt at the '''[[Building the Mower]]''' section to see the Bill of Materials and steps required '''(Note this wiki is in progress and not complete yet, but we're working on it!)
'''

== How to contribute ==

At the moment, there are different ways to contribute:

* Building your own mower, testing the software and reporting bugs / committing fixes on the github repository

* If you're not scared to see the inside of some mowers, please help us understand more about how they are built following instructions in the '''[[Mower Dissection]]''' page.

* And finally, [https://www.patreon.com/ClemensElflein Patreon to support Clemens' amazing work]

Mower Dissection

2022-04-23T08:27:55Z

Vamatis: cosmetic changes + rephrasing

== Why a mower dissection? ==

Don't worry, no bot will be injured here!
Right now, only one mower model (the Yardforce Classic 500) is officially supported, but one of the long term goals of the OpenMower project is to be able to use more and more mowers, being of the shelf models or even custom builds.

To do that, the project relies and people willing to Open the mowers they own, (or even buy some to be dissected) and document their work for others.

== How to contribute ==

A dedicated Google Spreadsheet has been open to document the dissections and list the compatible hardware. You can find it [https://docs.google.com/spreadsheets/d/1BX0-KEs5v-VED8-RA4BLE-wRdXHtlmcKy4n9K5vJVAA/edit#gid=1041122740 here]

If you own a more and are willing to take it appart to take some pictures, please ask for editing rights and fill the page.

Project overview

2022-04-23T08:25:04Z

Vamatis:

This page will describe the project's goals and direction. It may be updated from time to time to reflect the evolution in the design choices and opportunities.

=== Software Timeline ===
Current software runs and needs to be tested by more users

Future goals:

- Integrate with Iot/ Home automation

- Additional features

=== Hardware Timeline ===

Currently the main goal is to have as many people as possible using the actual revision of everything and testing it.

Future goals are:

- new motherboard revision with better integration and external breakout boards for bot compatibility

- adding more and more commercial bots to the compatibility list (thanks to users dissections for example, plus exploded parts views..)

Mower Dissection

2022-04-23T08:23:23Z

Vamatis: Started a first draft of the page

Right now, only one mower model (the Yardforce Classic 500) is officially supported, but one of the long term goals of the OpenMower project is to be able to use more and more mowers, being of the shelf models or even custom builds.

To do that, the project relies and people willing to Open the mowers they own, (or even buy some to be dissected) and document their work for others.

A dedicated Google Spreadsheet has been open to document the dissections and list the compatible hardware. You can find it [https://docs.google.com/spreadsheets/d/1BX0-KEs5v-VED8-RA4BLE-wRdXHtlmcKy4n9K5vJVAA/edit#gid=1041122740 here]

Project overview

2022-04-23T08:13:13Z

Vamatis: Started a first draft of the page

This page will describe the project's goals and direction. It may be updated from time to time to reflect the evolution in the design choices and opportunities.

=== Software Timeline ===
Current software runs and needs to be tested by more users

Future goals:

- Integrate with Iot/ Home automation

- Additional features

=== '''Hardware Timeline''' ===

Currently the main goal is to have as many people as possible using the actual revision of everything and testing it.

Future goals are:

- new motherboard revision with better integration and external breakout boards for bot compatibility

- adding more and more commercial bots to the compatibility list (thanks to users dissections for example, plus exploded parts views..)