Merge pull request #1433 from FarmBot/staging

v14.6.1 Release (Draft)

Author: RickCarlino

.gitignore

@@ -1,3 +1,4 @@
+__pycache__
 _nerves-tmp
 !/nerves/host
 !/nerves/target
@@ -11,12 +12,14 @@ _nerves-tmp
 *.db-journal
 *.db-shm
 *.db-wal
+*.db*
 *.ez
 *.img
 *.lua
 *.o
 *.pem
 *.priv
+*.pyc
 *.so
 *.sqlite3
 *.sqlite3*
@@ -43,6 +46,7 @@ _nerves-tmp
 artifacts
 auth_secret_test.exs
 auth_secret.exs
+capture_*
 erl_crash.dump
 farmbot_ext-*.tar
 farmbot_ng-*.tar

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# 14.6.1
+
+ * Remove need to download farmwares over the network (improves offline experience)
+ * Remove references to legacy components (FarmbotCore, FarmbotExt, etc..)
+ * Add new Lua functions: `detect_weeds`, `garden_size`, `measure_soil_height`
+
 # 14.6.0
 
  * Upgrade database driver.

CONTRIBUTING.md

@@ -1,3 +1,9 @@
 # Contributing
 
-Please read through the [documentation](docs/index.md)
+**NOTE:** These instructions are for **software developers only.** If you just want to run FarmBot OS on a FarmBot kit you have purchased, please [see these instructions instead](https://software.farm.bot/v14/FarmBot-OS/farmbot-os.html).
+
+1. Install the [ASDF Package Manager](https://asdf-vm.com/)
+2. Install Elixir and Erlang via ASDF. The correct version can be found in the [.tool-versions file](https://github.com/FarmBot/farmbot_os/blob/staging/.tool-versions).
+3. [Install Nerves](https://hexdocs.pm/nerves/installation.html#content)
+4. Clone this repo and run `./run-all.sh`. If the script runs to completion, you have successfully installed FBOS onto your target
+5. Run the application via `iex -S mix`.

README.md

@@ -15,37 +15,9 @@ Old versions of FarmBot OS can be found [here](https://github.com/FarmBot/farmbo
 
 ---
 
-## Installation
-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.)
+## Installing FBOS on a Device
 
-### Windows users
-
- 1. download and install [Etcher](https://www.balena.io/etcher/).
- 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.
-
-### Linux/OSX
-
- 1. download the [latest release file, available for download here](#floppy_disk-latest-os-image-downloads).
- 0. ```dd if=</path/to/file> of=/dev/<sddevice> bs=4``` or use [Etcher](https://etcher.io/).
-
----
-
-## Running
-_Refer to the [software documentation Configurator page](https://software.farm.bot/docs/configurator) for more detailed instructions._
-
- 1. 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.
+[END USERS: See the official documentation](https://software.farm.bot/v14/FarmBot-OS/farmbot-os.html)
 
 ## Problems?
 
@@ -58,5 +30,5 @@ We take security seriously and value the input of independent researchers. Pleas
 
 ## Want to Help?
 
-[Low Hanging Fruit](https://github.com/FarmBot/farmbot_os/search?utf8=%E2%9C%93&q=TODO)
-[Development](CONTRIBUTING.md)
+ * [Low Hanging Fruit](https://github.com/FarmBot/farmbot_os/search?utf8=%E2%9C%93&q=TODO)
+ * [Development](CONTRIBUTING.md)

VERSION

@@ -1 +1 @@
-14.6.0
+14.6.1

config/config.exs

@@ -2,32 +2,31 @@ use Mix.Config
 is_test? = Mix.env() == :test
 rollbar_token = System.get_env("ROLLBAR_TOKEN")
 
-config :exqlite, :json_library, FarmbotCore.JSON
-config :farmbot, ecto_repos: [FarmbotCore.Asset.Repo]
+config :exqlite, :json_library, FarmbotOS.JSON
+config :farmbot, ecto_repos: [FarmbotOS.Asset.Repo]
 config :logger, backends: [:console]
 config :nerves, :firmware, rootfs_overlay: "rootfs_overlay"
 config :tesla, adapter: Tesla.Adapter.Hackney
 
 %{
-  Elixir.FarmbotCore.AssetWorker.FarmbotCore.Asset.PublicKey => [
-    ssh_handler: FarmbotCore.PublicKeyHandler.StubSSHHandler
+  Elixir.FarmbotOS.AssetWorker.FarmbotOS.Asset.PublicKey => [
+    ssh_handler: FarmbotOS.PublicKeyHandler.StubSSHHandler
   ],
-  FarmbotCore.Asset.Repo => [
+  FarmbotOS.Asset.Repo => [
     database: "database.#{Mix.env()}.db",
     log: false
   ],
-  FarmbotCore.AssetWorker.FarmbotCore.Asset.PinBinding => [
-    gpio_handler: FarmbotCore.PinBindingWorker.StubGPIOHandler
+  FarmbotOS.AssetWorker.FarmbotOS.Asset.PinBinding => [
+    gpio_handler: FarmbotOS.PinBindingWorker.StubGPIOHandler
   ],
-  FarmbotCore.BotState.FileSystem => [root_dir: "/tmp/farmbot_state"],
-  FarmbotCore.Celery.SysCallGlue => [sys_calls: FarmbotOS.SysCalls],
-  FarmbotCore.Core.CeleryScript.RunTimeWrapper => [
-    celery_script_io_layer: FarmbotCore.Core.CeleryScript.StubIOLayer
+  FarmbotOS.BotState.FileSystem => [root_dir: "/tmp/farmbot_state"],
+  FarmbotOS.Celery.SysCallGlue => [sys_calls: FarmbotOS.SysCalls],
+  FarmbotOS.Core.CeleryScript.RunTimeWrapper => [
+    celery_script_io_layer: FarmbotOS.Core.CeleryScript.StubIOLayer
   ],
-  FarmbotCore.JSON => [json_parser: FarmbotCore.JSON.JasonParser],
-  FarmbotCore.Leds => [gpio_handler: FarmbotCore.Leds.StubHandler],
-  FarmbotExt.API.Preloader => [preloader_impl: FarmbotExt.API.Preloader.HTTP],
-  FarmbotExt.Time => [disable_timeouts: is_test?],
+  FarmbotOS.JSON => [json_parser: FarmbotOS.JSON.JasonParser],
+  FarmbotOS.Leds => [gpio_handler: FarmbotOS.Leds.StubHandler],
+  FarmbotOS.Time => [disable_timeouts: is_test?],
   FarmbotOS.Configurator => [
     network_layer: FarmbotOS.Configurator.FakeNetworkLayer
   ],

config/target.exs

@@ -39,16 +39,16 @@ config :vintage_net,
   config: [{"wlan0", %{type: VintageNet.Technology.Null}}]
 
 %{
-  FarmbotCore.Asset.Repo => [
+  FarmbotOS.Asset.Repo => [
     database: "/root/database.#{Mix.env()}.db"
   ],
-  FarmbotCore.AssetWorker.FarmbotCore.Asset.PinBinding => [
+  FarmbotOS.AssetWorker.FarmbotOS.Asset.PinBinding => [
     gpio_handler: FarmbotOS.Platform.Target.PinBindingWorker.CircuitsGPIOHandler
   ],
-  FarmbotCore.AssetWorker.FarmbotCore.Asset.PublicKey => [
+  FarmbotOS.AssetWorker.FarmbotOS.Asset.PublicKey => [
     ssh_handler: FarmbotOS.Platform.Target.SSHConsole
   ],
-  FarmbotCore.Leds => [
+  FarmbotOS.Leds => [
     gpio_handler: FarmbotOS.Platform.Target.Leds.CircuitsHandler
   ],
   FarmbotOS.Configurator => [

config/test.exs

@@ -6,8 +6,8 @@ File.mkdir_p(data_path)
 config :ex_unit, capture_logs: true
 config :farmbot, data_path: data_path
 
-config :farmbot, FarmbotCore.Celery.SysCallGlue,
-  sys_calls: FarmbotCore.Celery.SysCallGlue.Stubs
+config :farmbot, FarmbotOS.Celery.SysCallGlue,
+  sys_calls: FarmbotOS.Celery.SysCallGlue.Stubs
 
 config :farmbot, FarmbotOS.Configurator,
   data_layer: FarmbotOS.Configurator.ConfigDataLayer,
@@ -17,13 +17,13 @@ config :farmbot, platform_children: [{FarmbotOS.Platform.Host.Configurator, []}]
 config :plug, :validate_header_keys_during_test, true
 
 [
-  FarmbotCore,
-  FarmbotCore.Config.Supervisor,
-  FarmbotExt,
-  FarmbotExt.Bootstrap.Supervisor,
-  FarmbotExt.DirtyWorker.Supervisor,
-  FarmbotExt.EagerLoader.Supervisor,
-  FarmbotExt.MQTT.ChannelSupervisor,
-  FarmbotExt.MQTT.Supervisor
+  FarmbotOS,
+  FarmbotOS.Config.Supervisor,
+  FarmbotOS,
+  FarmbotOS.Bootstrap.Supervisor,
+  FarmbotOS.DirtyWorker.Supervisor,
+  FarmbotOS.EagerLoader.Supervisor,
+  FarmbotOS.MQTT.ChannelSupervisor,
+  FarmbotOS.MQTT.Supervisor
 ]
 |> Enum.map(fn mod -> config :farmbot, mod, children: [] end)

fixtures/corpus.json

@@ -119,23 +119,19 @@
         "find_home",
         "flash_firmware",
         "home",
-        "install_farmware",
-        "install_first_party_farmware",
         "move",
         "move_absolute",
         "move_relative",
         "power_off",
         "read_pin",
         "read_status",
         "reboot",
-        "remove_farmware",
         "send_message",
         "set_servo_angle",
         "set_user_env",
         "sync",
         "take_photo",
         "toggle_pin",
-        "update_farmware",
         "update_resource",
         "wait",
         "write_pin",
@@ -322,8 +318,6 @@
         "FlashFirmware",
         "Home",
         "Identifier",
-        "InstallFarmware",
-        "InstallFirstPartyFarmware",
         "InternalEntryPoint",
         "InternalFarmEvent",
         "InternalRegimen",
@@ -336,7 +330,6 @@
         "PowerOff",
         "ReadStatus",
         "Reboot",
-        "RemoveFarmware",
         "RpcError",
         "RpcOk",
         "RpcRequest",
@@ -349,7 +342,6 @@
         "TakePhoto",
         "TogglePin",
         "Tool",
-        "UpdateFarmware",
         "VariableDeclaration",
         "Wait",
         "Zero",
@@ -1121,30 +1113,6 @@
       ],
       "docs": ""
     },
-    {
-      "allowed_args": [
-        "url"
-      ],
-      "allowed_body_types": [],
-      "name": "install_farmware",
-      "tags": [
-        "function",
-        "network_user",
-        "disk_user",
-        "api_writer"
-      ],
-      "docs": ""
-    },
-    {
-      "allowed_args": [],
-      "allowed_body_types": [],
-      "name": "install_first_party_farmware",
-      "tags": [
-        "function",
-        "network_user"
-      ],
-      "docs": ""
-    },
     {
       "allowed_args": [],
       "allowed_body_types": [],
@@ -1282,17 +1250,6 @@
       ],
       "docs": ""
     },
-    {
-      "allowed_args": [
-        "package"
-      ],
-      "allowed_body_types": [],
-      "name": "remove_farmware",
-      "tags": [
-        "function"
-      ],
-      "docs": ""
-    },
     {
       "allowed_args": [
         "label"
@@ -1335,8 +1292,6 @@
         "find_home",
         "flash_firmware",
         "home",
-        "install_farmware",
-        "install_first_party_farmware",
         "_if",
         "move_absolute",
         "move_relative",
@@ -1345,15 +1300,13 @@
         "read_pin",
         "read_status",
         "reboot",
-        "remove_farmware",
         "update_resource",
         "send_message",
         "set_servo_angle",
         "set_user_env",
         "sync",
         "take_photo",
         "toggle_pin",
-        "update_farmware",
         "wait",
         "write_pin",
         "zero"
@@ -1408,8 +1361,6 @@
         "find_home",
         "flash_firmware",
         "home",
-        "install_farmware",
-        "install_first_party_farmware",
         "_if",
         "move_absolute",
         "move_relative",
@@ -1418,15 +1369,13 @@
         "read_pin",
         "read_status",
         "reboot",
-        "remove_farmware",
         "update_resource",
         "send_message",
         "set_servo_angle",
         "set_user_env",
         "sync",
         "take_photo",
         "toggle_pin",
-        "update_farmware",
         "wait",
         "write_pin",
         "zero"
@@ -1508,19 +1457,6 @@
       ],
       "docs": ""
     },
-    {
-      "allowed_args": [
-        "package"
-      ],
-      "allowed_body_types": [],
-      "name": "update_farmware",
-      "tags": [
-        "function",
-        "network_user",
-        "api_validated"
-      ],
-      "docs": ""
-    },
     {
       "allowed_args": [
         "label",
@@ -1777,4 +1713,4 @@
       "docs": ""
     }
   ]
-}
+}