Cheatsheet
The shortlist of commands, nomenclature, and locations to get all the FarmBot software up and running
Stay updated
In general, it is best practice to make sure your server and pi are updated. Before installing any FarmBot software or trying to troubleshoot problems, first run these commands:
sudo apt-get update
sudo apt-get upgrade
For People Using Hosted Services
Component | Location | Setup | Start Command |
---|---|---|---|
Web app frontend | my.farmbot.io | Open in browser, create an account | Open in browser, login |
Web app API/backend | my.farmbot.io | None | None |
MQTT gateway | mqtt.farmbot.io | None | None |
Controller | Raspberry Pi | None | None |
Firmware | Arduino | None | None - its always running when powered |
For Developers Running Everything Locally
Component | Location | Git Repo | Final Setup Step | Start Command |
---|---|---|---|---|
Web app frontend | localhost:8080 | farmbot-web-frontend | npm install |
npm start |
Web app API/backend | localhost:3000 | farmbot-web-API | bundle install |
MQTT_HOST=mqtt.farmbot.io rails s |
MQTT gateway | localhost:1883 for MQTT direct clients (FarmBots) localhost:3002 for WebSockets (web frontend/API) |
mqtt-gateway | ? | ? |
Controller | Raspberry Pi | farmbot_os | WiFi Configurator | None |
Firmware | Arduino | farmbot-arduino-firmware | ino build ino upload |
None - its always running when powered |