spacecruft
/
farmbot_os
1
0
Fork 0
Code Issues Pull Requests Releases Activity
farmbot_os/docs/index.md

2.3 KiB
Raw Permalink Blame History

FarmBot OS Documentation

This document will act as an index to available documentation.

Glossary

Cheat Sheet

*Create a .fw file from local repo (RPi Zero):

NERVES_SYSTEM=farmbot_system_rpi MIX_TARGET=rpi mix deps.get
NERVES_SYSTEM=farmbot_system_rpi MIX_TARGET=rpi mix firmware
sudo fwup farmbot_os/_build/rpi/rpi_dev/nerves/images/farmbot.fw

*Create a .fw file from local repo (RPi v3):

NERVES_SYSTEM=farmbot_system_rpi3 MIX_TARGET=rpi3 mix deps.get
NERVES_SYSTEM=farmbot_system_rpi3 MIX_TARGET=rpi3 mix firmware
sudo fwup farmbot_os/_build/rpi3/rpi3_dev/nerves/images/farmbot.fw

Create or Update the Nerves System:

Please see the official Nerves documentation on "Nerves Systems".

HINT: You may want to develop the system locally

Hardware specifics

Most FarmBot development/testing is done on a standard desktop PC.

CeleryScript

CeleryScript is FarmBot's native scripting language. See the below documentation for information about it as it relates to FarmBot OS.

Project structure

The FarmBot OS application is broken into several sub applications.