FarmBot Software

High Level Overview

Description of the FarmBot software systems

There are many software systems contributing to FarmBot's functionality. The diagram below shows the different components and how data flows between them. Read the brief descriptions of each component in the following sections to understand the system as a whole, and then dive into setting up the needed components for your FarmBot.

Everything is open-source

All of our software is licensed permissively, allowing you to contribute to, copy, modify, redistribute, and even sell FarmBot software. Want to help build new features or have a bug to report? Get involved on GitHub!.

We're here to help

Have a question or need help setting up some of the software? You can ask a question and find answers in our forum!

FarmBot cloud services

The FarmBot web app

The web app allows you to easily control and configure your FarmBot from a web browser using your laptop, tablet, or smartphone. The application features real-time manual controls and logging, a sequence builder for creating custom routines for FarmBot to execute, and a drag-and-drop farm designer so you can graphically design your garden.

Message broker

The message broker is a cloud application that acts as an intermediary for messages between the FarmBot web app, your web browser, and the FarmBot device. It handles socket connections, device identification, and authentication.

Device software

FarmBot OS

FarmBot's Raspberry Pi runs a custom operating system named FarmBot OS to maintain a connection and synchronize with the web application via the message broker. This allows FarmBot to download and execute scheduled events, be controlled in real-time, and upload logs and sensor data. The OS communicates with the Farmduino/Arduino over a USB cable or serial connection to send G and F code commands, and also receive collected data from sensors and rotary encoders.

Configurator

FarmBot OS has a built-in utility named configurator allowing you to easily enter WiFi and web app credentials from a WiFi enabled device (such as a laptop or smartphone). This is used for initial setup in order to get your FarmBot connected to your home WiFi and web app account.

Arduino firmware

The firmware that is flashed onto the Arduino or Farmduino microcontroller is responsible for physically operating FarmBot's motors, tools, sensors, and other electronics. It receives G and F codes from FarmBot OS, and then moves the motors and reads and writes pins accordingly. It also sends collected data from the rotary encoders and pin reads back to the Raspberry Pi.

External resources

OpenFarm.cc

OpenFarm is a free and open database for farming and gardening knowledge. This service provides crop and growing information to the web app for a streamlined user experienced.

OpenFarm is built by us too!

OpenFarm.cc was originally conceived as a small component of the FarmBot project. As progress was made, it became clear that OpenFarm had no reason to be tied to FarmBot, but could rather live on its own. In September of 2014, 1,605 people backed OpenFarm on Kickstarter. Today, OpenFarm is a standalone application, non-profit, and community. You can get involved with OpenFarm by joining the Slack channel, contributing on GitHub, or going to OpenFarm.cc and creating content!


What's Next

Getting Started

High Level Overview


Description of the FarmBot software systems

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.