Add document for how to start farmbot_os in development mode

pull/974/head
Connor Rigby 2019-04-29 10:48:40 -07:00
parent 58900f5a19
commit 08f1988663
No known key found for this signature in database
GPG Key ID: 29A88B24B70456E0
1 changed files with 29 additions and 0 deletions

View File

@ -0,0 +1,29 @@
# Starting FarmbotOS in `host` env.
Certain behaviour is slightly different when developing on `host` compared to
deploying on target environments such as `rpi` or `rpi3`.
## Firmware
By default, an Arduino does _not_ need to be connected to your `host` pc when
doing development. See the `FarmbotFirmware.Transport` module for more info
on this topic. If you want to use a real Arduino in `host` mode, you can
export a `FARMBOT_TTY` environment variable in your `host` environment.
```bash
$ cd farmbot_os
$ export FARMBOT_TTY=/dev/ttySomeDeviceFile
$ mix compile --force
```
If you're device moves ttys, you will have to redo this step.
## Configurator
Currently configurator does not run on the `host` enviornment. To connect to
your FarmBot account, export the following variables:
```bash
$ cd farmbot_os
$ export FARMBOT_EMAIL=test@test.com
$ export FARMBOT_PASSWORD=password123
$ export FARMBOT_SERVER=http://localhost:3000
```