2017-12-13 12:22:30 -07:00
[![Build Status ](https://circleci.com/gh/FarmBot/farmbot_os/tree/staging.svg?style=svg )](https://circleci.com/gh/FarmBot/farmbot_os/tree/staging)
2017-12-04 15:18:26 -07:00
[![Coverage Status ](https://coveralls.io/repos/github/FarmBot/farmbot_os/badge.svg?branch=staging )](https://coveralls.io/github/FarmBot/farmbot_os?branch=staging)
2017-11-29 20:36:10 -07:00
[![Built with Nerves ](http://nerves-project.org/images/badge/nerves-badge_75x39_black.png )](http://nerves-project.org/)
2017-04-14 15:07:19 -06:00
---
2017-11-29 20:36:10 -07:00
<!-- DON'T CHANGE THE TEXT BELOW. It is used in documentation links. -->
2017-04-14 15:07:19 -06:00
# :floppy_disk: LATEST OS IMAGE DOWNLOADS
2017-11-29 20:36:10 -07:00
<!-- DON'T CHANGE THE TEXT ABOVE. It is used in documentation links. -->
2017-04-14 15:07:19 -06:00
2017-04-25 11:46:36 -06:00
## _*Important*_
For now we are only building and supporting Raspberry Pi 3. Pull Requests are very welcome
2017-07-05 09:59:34 -06:00
if you spot a bug or fix, but for now we suggest obtaining a Raspberry Pi 3 for the best support.
2017-04-25 11:46:36 -06:00
2017-04-14 15:07:19 -06:00
|Raspbery Pi Version |
|---|
2018-01-11 11:44:37 -07:00
| :star: ** [RPi 3 (Ships with FarmBot.io kits) ](https://github.com/FarmBot/farmbot_os/releases/download/v6.0.1/farmbot-rpi3-6.0.1.img )**|
2017-04-14 15:07:19 -06:00
---
2016-12-08 14:18:21 -07:00
2016-12-27 12:26:49 -07:00
# Farmbot OS
2017-11-29 20:36:10 -07:00
The "brains" of the FarmBot Project
2016-12-27 13:22:22 -07:00
2016-12-27 12:26:49 -07:00
## Installation
2017-11-29 20:36:10 -07:00
Installation should be fairly straight forward, you will need a computer for this step.
2016-12-27 12:26:49 -07:00
(everything after this can be set up on a mobile device.)
2016-12-27 13:22:22 -07:00
2016-12-27 12:26:49 -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/ ).
2017-08-09 13:35:08 -06:00
0. download the [latest release ](#floppy_disk-latest-os-image-downloads ).
0. insert an SD Card into your PC.
0. open Etcher, and select the `.img` file you just downloaded.
0. select your SD Card.
0. Burn.
2016-12-27 13:22:22 -07:00
2016-12-27 12:26:49 -07:00
### Linux/OSX
2016-12-27 13:22:22 -07:00
2017-08-09 13:35:08 -06:00
1. download the [latest release ](#floppy_disk-latest-os-image-downloads ).
0. ```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-08-09 13:35:08 -06:00
## Running
1. Plug your SD Card into your Raspberry Pi
2017-04-03 09:03:19 -06:00
0. Plug your Arduino into your Raspberry Pi
0. Plug your power into your Raspberry Pi
2017-03-14 10:37:41 -06:00
0. From a WiFi enabled device*, search for the SSID `farmbot-XXXX`
2017-12-04 15:21:08 -07:00
0. Connect to that and open a web browser to [http://192.168.25.1/ ](http://192.168.25.1 )
2017-01-12 17:16:43 -07:00
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.
2016-12-27 12:26:49 -07:00
# Problems?
2016-12-27 13:22:22 -07:00
2017-05-06 03:14:08 -06:00
See the [FAQ ](docs/FAQ.md )
2016-12-27 12:26:49 -07:00
If your problem isn't solved there please file an issue on [Github ](https://github.com/FarmBot/farmbot_os/issues/new )
2018-01-14 21:04:08 -07:00
# Security Concerns?
2018-01-14 21:20:42 -07:00
We take security seriously and value the input of independent researchers. Please see our [responsible disclosure guidelines ](https://farm.bot/responsible-disclosure-of-security-vulnerabilities/ ).
2018-01-14 21:04:08 -07:00
2016-12-27 12:26:49 -07:00
# Want to Help?
2016-12-27 13:22:22 -07:00
2016-12-27 12:26:49 -07:00
[Low Hanging Fruit ](https://github.com/FarmBot/farmbot_os/search?utf8=%E2%9C%93&q=TODO )
[Development ](CONTRIBUTING.md )