From 033486b098482eb059d91632b857d0b9aafad4de Mon Sep 17 00:00:00 2001 From: connor rigby Date: Mon, 3 Apr 2017 08:03:19 -0700 Subject: [PATCH] update old docs --- LICENSE | 2 +- README.md | 9 +++------ docs/BUILDING.md | 2 +- docs/ENVIRONMENT.md | 5 ++--- docs/FAQ.md | 26 +++++++++++++------------- 5 files changed, 20 insertions(+), 24 deletions(-) diff --git a/LICENSE b/LICENSE index be1d84d3..1aab7964 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License -Copyright (c) 2016 Farmbot Project +Copyright (c) 2017 Farmbot Project Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.md b/README.md index b7fb75e0..68e172bd 100644 --- a/README.md +++ b/README.md @@ -23,18 +23,15 @@ Instalation should be fairly straight forward, you will need a computer for this 2. ```dd if= of=/dev/ bs=4``` or use [Etcher](https://etcher.io/). ## Running - 0. Plug your SD Card into your RPi3 - 0. Plug your Arduino into your RPi3 - 0. Plug your power into your RPi3 + 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` 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. -## Updating the firmware -To update the firmware on the Raspberry Pi simply use the "update" button on the web application. There is no need to reinstall the entire OS. - # Problems? diff --git a/docs/BUILDING.md b/docs/BUILDING.md index 3ece888d..c07db8d2 100644 --- a/docs/BUILDING.md +++ b/docs/BUILDING.md @@ -22,7 +22,7 @@ We are going to set up the environment for building Farmbot OS mkdir farmbot cd farmbot git clone https://github.com/FarmBot/farmbot_os.git os -cd os +cd farmbot_os npm install ``` diff --git a/docs/ENVIRONMENT.md b/docs/ENVIRONMENT.md index 581e2b80..5e6eaf9f 100644 --- a/docs/ENVIRONMENT.md +++ b/docs/ENVIRONMENT.md @@ -20,11 +20,10 @@ initial compile of the application and can be just generally annoying. to disabl this export `USE_WEBPACK=false` ## Configurator -The Configurator app is started by default on port `5000` and the image streamer -is on port `5050`. these can be changed by exporting in development mode only: +The Configurator app is started by default on port `5000`. +this can be changed by exporting in development mode only: ```bash CONFIGURATOR_PORT=4000 -STREAMER_PORT=4040 ``` ## Redis Server diff --git a/docs/FAQ.md b/docs/FAQ.md index dede2bf1..94ff7433 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -14,9 +14,21 @@ This could be one of a few things. These things are in order of probability. * You have a bad SD Card. * You aren't using a Raspberry Pi 3 (Porting Farmbot is relatively simple). +## Why can't i update my Arduino Firmware? + +as of version 3.8.0 we decided to bundle the arduino firmware into farmbot os. There was a couple reasons for this. +* There is no more version conflicts between the firmware and operating system. +* Applying updates during farmbot os runtime can be dangerous and was leaving peoples bot's unusable because of broken firmwares. + +Some more things to note, If you want to use a custom version of the firmware during configuration, make sure to do the following: +* open advanced settings by tap/clicking the "Configure your Farmbot" text 10 times. +* tick the "USE CUSTOM ARDUINO FIRMWARE" box. +This doesn't do anything special, it just makes sure not to overwrite the existing firmware. + ## Can I SSH into the Farmbot? Yes, starting with version `2.1.1`. The user is root and there is no password. This may change in future versions. +NOTE: Ssh is disabled by default, so you will need to enable it during configuration if you want to use it. ## Why are my SSH keys invalid? @@ -40,16 +52,4 @@ Yes. When you log into the Farmbot Configurator wifi SSID, select `Use Ethernet` **NOTE**: This can not be changed without a factory reset. ## How do I factory reset my bot? - -This is not as trivial as you would think right now. (We are working on it.) - -** EASY: ** Flash the SD card -** Via HDMI monitor / IEx: ** `Farmbot.factory_reset()` - -** Via SSH: ** - -```bash -ssh root@ -rm /data/* -rf -/usr/sbin/reboot -``` +There are now buttons for factory reset on both the web application, and configurator.