farmbot_os/README.md

45 lines
1.8 KiB
Markdown
Raw Normal View History

[![Build Status](https://travis-ci.org/FarmBot/farmbot_os.svg?branch=master)](https://travis-ci.org/FarmBot/farmbot_os.svg?branch=master)
2017-03-01 10:09:47 -07:00
[![Coverage Status](https://coveralls.io/repos/github/FarmBot/farmbot_os/badge.svg)](https://coveralls.io/github/FarmBot/farmbot_os)
2016-12-08 14:18:21 -07:00
# Farmbot OS
The "brains" of the Farmbot Project
2016-12-27 13:22:22 -07:00
## Installation
Instalation should be fairly straight forward, you will need a computer for this step.
(everything after this can be set up on a mobile device.)
2016-12-27 13:22:22 -07:00
### Windows users
2016-12-27 13:22:22 -07:00
2016-12-27 13:24:32 -07:00
1. download and install [Etcher](https://etcher.io/).
2. download the [latest release](https://github.com/FarmBot/farmbot_os/releases).
3. insert an SD Card into your PC.
4. open Etcher, and select the `.img` file you just downloaded.
5. select your SD Card.
6. Burn.
2016-12-27 13:22:22 -07:00
### Linux/OSX
2016-12-27 13:22:22 -07:00
2016-12-27 13:24:32 -07:00
1. download the [latest release](https://github.com/FarmBot/farmbot_os/releases).
2. ```dd if=</path/to/file> of=/dev/<sddevice> bs=4``` or use [Etcher](https://etcher.io/).
2016-10-04 10:01:23 -06:00
2017-01-12 17:16:43 -07:00
## Running
2017-04-03 09:03:19 -06:00
0. Plug your SD Card into your Raspberry Pi
0. Plug your Arduino into your Raspberry Pi
0. Plug your power into your Raspberry Pi
0. From a WiFi enabled device*, search for the SSID `farmbot-XXXX`
2017-01-12 17:16:43 -07:00
0. Connect to that and open a web browser to [http://192.168.24.1/](http://192.168.24.1)
0. Follow the on screen instructions to configure your FarmBot. Once you save your configuration FarmBot will connect to your home WiFi network and to the FarmBot web application.
\* If you are using a smartphone you may need to disable cellular data to allow your phone's browser to connect to the configurator.
# Problems?
2016-12-27 13:22:22 -07:00
2017-02-27 00:33:59 -07:00
See the [FAQ](faq.html)
If your problem isn't solved there please file an issue on [Github](https://github.com/FarmBot/farmbot_os/issues/new)
# Want to Help?
2016-12-27 13:22:22 -07:00
[Low Hanging Fruit](https://github.com/FarmBot/farmbot_os/search?utf8=%E2%9C%93&q=TODO)
[Development](CONTRIBUTING.md)