Difference between revisions of "Main Page"

From Open Mower Wiki
Jump to navigation Jump to search
m (Link to road map)
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== OpenMower Wiki ==
== The OpenMower Wiki ==


Welcome to the OpenMower Wiki!
Welcome to the OpenMower Wiki!
Line 5: Line 5:
This WIKI was only just started on 2022-04-22, but we'll collaborate on getting good information on the OpenMower project collected here.
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.
If you want to contribute to the Wiki: [https://discord.gg/jE7QNaSxW7 join the Discord], ask at the [https://discord.com/channels/958476543846412329/967345181013725194 #wiki-authors channel] for a wiki account and a wiki admin will create one.
 
Also head over to the [https://discord.com/channels/958476543846412329/967345181013725194 #wiki-authors channel] if you want talk about wiki related stuff.
 
 


== How to Get Started ==
== 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.
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.  
 
First: Check the '''[[FAQ]]'''
 
When you're ready, you can have a look at the '''[[Building the Mower]]''' section to see the Bill of Materials and steps required and check out '''[[Builder Road Map]]''' for a practical take on what to do.
 
<big>(Note this wiki is in progress and not complete yet, but we're working on it!)</big>


When you're ready, you can have a look at the '''[[Building the Mower]]''' section to see the Bill of Materials and steps required and check out '''[[Builder Road Map]]''' for a practical take on what to do. '''(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]]
==Resources==
 
===[[FAQ]]===
 
'''<big>There is a continually evolving [[FAQ]] that is a good starting point for understanding the project and getting answers to some key questions.</big>'''
 
 
 
===[[Project overview|Project overview and timeline]]===


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


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


=== Where to find more information ===
===[[System Image|Software Installation]]===
 
On this page, you can find steps how to install a basic OpenMower system image.
 
===[[Running OpenMower]]===
 
On this page, you can find steps how to run the OpenMower software.
We're doing:
- Starting the Software
- Magnetometer Calibration
- Recording a Map
- Starting the Mowing Process
 
===[[Mini HOWTOs]]===
 
On this page, you can find small HOWTOs for various things. Set [[Mini HOWTOs|here]]
 
===Where to find more information===


The entry points for more information are:
The entry points for more information are:


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


== How to contribute ==
==How to contribute==


At the moment, there are different ways 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
*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.


* 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]


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


== 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.''
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.

Revision as of 09:43, 9 September 2022

The 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: join the Discord, ask at the #wiki-authors channel for a wiki account and a wiki admin will create one.

Also head over to the #wiki-authors channel if you want talk about wiki related stuff.


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 (here) of the project that details how to assemble the bot.

First: Check the FAQ

When you're ready, you can have a look at the Building the Mower section to see the Bill of Materials and steps required and check out Builder Road Map for a practical take on what to do.

(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.


Project overview and timeline

Current status and future goals - See it here

Hardware Revisions

Open Mower hardware revisions, changelog, info: Here

Software Installation

On this page, you can find steps how to install a basic OpenMower system image.

Running OpenMower

On this page, you can find steps how to run the OpenMower software. We're doing: - Starting the Software - Magnetometer Calibration - Recording a Map - Starting the Mowing Process

Mini HOWTOs

On this page, you can find small HOWTOs for various things. Set here

Where to find more information

The entry points for more information are:

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.

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.