farmbot_os/README.md

63 lines
3.0 KiB
Markdown
Raw Permalink Normal View History

2017-11-29 20:36:10 -07:00
<!-- DON'T CHANGE THE TEXT BELOW. It is used in documentation links. -->
2019-09-06 18:57:50 -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
2020-01-29 09:34:51 -07:00
The FarmBot OS release page has moved to [my.farm.bot/os](https://my.farm.bot/os)
2019-09-06 18:57:50 -06:00
2020-01-29 09:34:51 -07:00
Old versions of FarmBot OS can be found [here](https://github.com/FarmBot/farmbot_os/releases). Please note that [FarmBot does not provide support for old versions of FBOS](https://software.farm.bot/docs/support-policy).
2019-09-06 18:57:50 -06:00
2017-04-14 15:07:19 -06:00
---
2016-12-08 14:18:21 -07:00
2020-01-21 14:57:26 -07:00
## Build status
2020-03-25 08:43:49 -06:00
| Master Build Status | Staging Build Status | Test Coverage |
| :---: | :---: | :---: |
| [![Master Build Status](https://circleci.com/gh/FarmBot/farmbot_os/tree/master.svg?style=svg)](https://circleci.com/gh/FarmBot/farmbot_os/tree/master) | [![Staging Build Status](https://circleci.com/gh/FarmBot/farmbot_os/tree/staging.svg?style=svg)](https://circleci.com/gh/FarmBot/farmbot_os/tree/staging) | [![codecov](https://codecov.io/gh/FarmBot/farmbot_os/branch/staging/graph/badge.svg)](https://codecov.io/gh/FarmBot/farmbot_os) |
2020-01-21 14:57:26 -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.
(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/).
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
### Linux/OSX
2016-12-27 13:22:22 -07:00
2019-07-03 13:20:06 -06:00
1. download the [latest release file, available for download here](#floppy_disk-latest-os-image-downloads).
2017-08-09 13:35:08 -06:00
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
2020-01-21 14:57:26 -07:00
---
2017-08-09 13:35:08 -06:00
## Running
2018-02-23 14:34:12 -07:00
_Refer to the [software documentation Configurator page](https://software.farm.bot/docs/configurator) for more detailed instructions._
2017-08-09 13:35:08 -06:00
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
0. From a WiFi enabled device*, search for the SSID `farmbot-XXXX`
2018-02-23 14:34:12 -07:00
0. Connect to that and open a web browser to [http://192.168.24.1/](http://192.168.24.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.
2018-05-16 17:00:32 -06:00
## Problems?
2016-12-27 13:22:22 -07:00
See the [FAQ](docs/target_development/target_faq.md)
If your problem isn't solved there please file an issue on [Github](https://github.com/FarmBot/farmbot_os/issues/new)
2018-05-16 17:00:32 -06:00
## Security Concerns?
2018-01-14 21:04:08 -07:00
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
2018-05-16 17:00:32 -06:00
## 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)