docs - extended setup info

superstes · May 2, 2021 · 16bb66e · 16bb66e
1 parent 0f71b2a
commit 16bb66e
Show file tree

Hide file tree

Showing 8 changed files with 434 additions and 24 deletions.
diff --git a/docs/source/config/condition.rst b/docs/source/config/condition.rst
@@ -107,11 +107,11 @@ The **following steps are needed** to configure such a condition:
 
 ----
 
+.. _config-condition-output:
+
 Reverse
 =======
 
-.. _config-condition-output:
-
 A reverse condition is evaluated when it comes to stopping the actor.
 
 We will go through this config with the **following example**:
@@ -157,11 +157,11 @@ The **following steps are needed** to configure such a condition:
 Info
 ****
 
+.. _config-condition-link:
+
 Condition link
 ==============
 
-.. _config-condition-link:
-
 Links allow conditions to have complex structures.
 
 They are used to calculate the result of two member-items.
@@ -188,11 +188,11 @@ Processing types
 
 ----
 
+.. _config-condition-match:
+
 Condition match
 ===============
 
-.. _config-condition-match:
-
 A condition match is a single rule to match.
 
 It will compare data to some given value using an operator.

diff --git a/docs/source/config/device.rst b/docs/source/config/device.rst
@@ -20,34 +20,33 @@ How the basic device config is structured.
 
 ----
 
-Input
-*****
-
 .. _config-device-input:
 
+Input
+*****
 
 :ref:`What are input devices <device-input>`
 
 Special config for input devices.
 
 ----
 
+.. _config-device-output:
+
 Output
 ******
 
-.. _config-device-output:
-
 :ref:`What are output devices <device-output>`
 
 Special config for output devices.
 
 ----
 
+.. _config-device-connection:
+
 Connection
 **********
 
-.. _config-device-connection:
-
 :ref:`What are connection devices <device-connection>`
 
 Special config for connection devices.
diff --git a/docs/source/setup/buy.rst b/docs/source/setup/buy.rst
@@ -0,0 +1,294 @@
+.. _setup-buy:
+
+===
+Buy
+===
+
+Description
+***********
+
+Here we will go through what we recommend to buy for a GrowAutomation project setup.
+
+The access to your/a network (*LAN/WLAN/..*) and power will not be included in this guide. You can check out the :ref:`connect guide <setup-connect>` for that.
+
+We will show you three sets of setups:
+
+* A **recommended** setup
+* A **medium** budget setup
+* And a cheaper **low** budget setup
+
+----
+
+DISCLAIMER
+**********
+
+All the links for mentioned products are from amazon.
+
+This is mainly because of convenience.
+
+You **WILL GET** those products for a **better price somewhere else**.
+
+----
+
+.. _setup-buy-recommended:
+
+Recommended
+***********
+
+Price
+=====
+
+**Full price point**:
+
+between (*around*) 430€ and 480€
+
+Raspberry
+=========
+
+**Price point**: around 110€
+
+* `Raspberry 4 <https://www.amazon.de/Raspberry-ARM-Cortex-A72-WLAN-ac-Bluetooth-Micro-HDMI-Single/dp/B07TC2BK1X>`_
+* `RPi4 power supply <https://www.amazon.de/Raspberry-Pi-official-power-supply/dp/B07TMPC9FG>`_
+* `RPi4 case <https://www.amazon.de/Geekworm-Raspberry-Aluminium-Compatible-Expansion/dp/B089CK12C6>`_
+* `SSD 2,5" 128G <https://www.amazon.de/Intenso-Performance-Internal-Drive-128gb/dp/B0093RN0PI>`_ => look into our :ref:`ssd setup-guide <setup-raspberry-ssd>`
+* `SSD USB Case <https://www.amazon.de/Case-SATA-USB3-0-Black-black/dp/B07PMWJB8P>`_
+
+Power
+=====
+
+**Price point**: 10 to 30€
+
+* If you have many sensors or just want to take the load of your raspberry:
+
+  * `3V power supply <https://www.amazon.de/BESPORTBLE-100-240V-Supply-Charger-Europe/dp/B08HJXWL8P>`_
+  * `5V power supply <https://www.amazon.de/ppadapter-13-PremiumCord-Universal-Power-Supply/dp/B07NSTVVYZ>`_ (*or you could just use a smartphone power supply*)
+
+* If you need 12V (*p.e. for motors*)
+
+  * `12V power supply <https://www.amazon.de/ppadapter-13-PremiumCord-Universal-Power-Supply/dp/B08XXYWDHV>`_
+
+Cabling
+=======
+
+**Price point**: around 110 to 140€
+
+* **Basic**
+
+  * `Electric tape <https://www.amazon.de/Electric-Insulation-Pieces-Decorating-Total/dp/B07QNMXXBN>`_
+
+* **Internal**
+
+  Interconnections inside the cabinet.
+
+  * `GPIO Breakout <https://www.amazon.de/AZDelivery-Breakout-Compatible-Ribbon-Raspberry/dp/B072R5L3QP>`_
+  * `Wires for interconnections <https://www.amazon.de/VS-ELECTRONIC-276229-stranded-assortment-coloured/dp/B001IRQRRO>`_
+  * `Breadboards <https://www.amazon.de/AZDelivery-Mini-Breadboard-400-Pin-Parent/dp/B07VFK5CRP>`_
+  * `Breadboard wires <https://www.amazon.de/WANTOUTH-Pieces-Bridges-Plastic-Breadboard/dp/B08QS6961R>`_
+  * `Wire screw connectors <https://www.amazon.de/DECARETA-Terminal-Connection-Clamps-Pieces/dp/B07PWVW321>`_
+  * `Heat shrink & solder connectors <https://www.amazon.de/FANKUNYIZHOUSHI-Connector-Waterproof-Insulated-Electrical/dp/B08RN7QX6R>`_
+
+* **External**
+
+  Connections to the sensors and actors => price will depend on the amount of sensors.
+
+  * `Outdoor network cable <https://www.amazon.de/Ethernet-Network-Outdoor-Weatherproof-Installation/dp/B07V5GG9V7>`_
+  * `RJ45 2=>2 Splitter <https://www.amazon.de/Ethernet-Connectors-Connector-Compatible-Computers/dp/B08CDMXPVG>`_
+  * `RJ45 2=>4 Splitter <https://www.amazon.de/LogiLink-MP0032-RJ45Modular-Splitter-Jacks/dp/B00J3XIAH0>`_
+
+* **Optional**
+
+  * `Electrical tube <https://www.amazon.de/40775-Unitec-Flexible-Tube/dp/B002ZHABQ4>`_
+
+    if you want to protect your external wires or just don't like the look of loose wires
+
+  * `Wire ties <https://www.amazon.de/Professional-Cable-Holders-Black-Resistant/dp/B0758TKCRD>`_
+
+    secure your wires in place
+
+Cabinet
+=======
+
+**Price point**: around 200€
+
+* `19" Slim cabinet <https://www.amazon.de/Digitus-Slimline-Opportunity-Vertical-Horizontal/dp/B01EQZA5M2>`_
+* `19" Patchpanel <https://www.amazon.de/deleyCON-Patch-Panel-Distribution-Port/dp/B07W7CBGFY>`_
+* `19" Power strip <https://www.amazon.de/DIGITUS-Inch-Power-Strip-Protection/dp/B00FHCQNP2>`_
+* `19" Shelf <https://www.amazon.de/DIGITUS-Professional-Extendible-19-inch-cabinets/dp/B002KTE870>`_
+
+----
+
+.. _setup-buy-medium:
+
+Medium
+******
+
+Price
+=====
+
+**Full price point**:
+
+between (*around*) 285€ and 300€
+
+Raspberry
+=========
+
+**Price point**: around 80€
+
+* `Raspberry 3 B+ <https://www.amazon.de/Raspberry-1373331-Pi-Model-Motherboard/dp/B07BDR5PDW>`_
+* `RPi3 power supply <https://www.amazon.de/Original-Raspberry-power-supply-versions/dp/B01IN15TRG>`_
+* `RPi3 case <https://www.amazon.de/Raspberry-Armor-Case-Integrated-Protection/dp/B07M7M53LT>`_
+* `SD Card <https://www.amazon.de/SanDisk-microSDHC-memory-adapter-performance/dp/B08GY9NYRM>`_
+
+IF you have some budget left => we would **highly recommend** using an usb-ssd as storage instead of the sd-card!
+
+
+Power
+=====
+
+**Price point**: 0-12€
+
+* 3V, 5V => just use the raspberry DC output
+* 12V => as seen in the recommended setup
+
+Cabling
+=======
+
+**Price point**: around 75€
+
+* **Basic**
+
+  * `Electric tape <https://www.amazon.de/T1510-Temflex-Electrical-Insulation-7000062272/dp/B002Z7WW48>`_
+
+* **Internal**
+
+  Interconnections inside the cabinet.
+
+  * `jumper wires <https://www.amazon.de/AZDelivery-Jumper-Arduino-Raspberry-Breadboard/dp/B074P726ZR>`_
+
+    * Instead of using a gpio breakout => you could use jumper wires to connect the gpio's directly to the breadboards
+    * Instead of breadboard wires you could just use jumper wires
+
+  * `Wires for interconnections <https://www.amazon.de/VS-ELECTRONIC-276229-stranded-assortment-coloured/dp/B001IRQRRO>`_
+  * `Breadboards <https://www.amazon.de/AZDelivery-Mini-Breadboard-400-Pin-Parent/dp/B07VFK5CRP>`_
+  * `Wire screw connectors <https://www.amazon.de/Aihasd-Terminal-Circuit-Connector-Printkl/dp/B00VGGFPZW>`_
+  * `Heat shrink & solder connectors <https://www.amazon.de/FANKUNYIZHOUSHI-Connector-Waterproof-Insulated-Electrical/dp/B08RN7QX6R>`_
+
+* **External**
+
+  Connections to the sensors and actors => price will depend on the amount of sensors.
+
+  * `Network cable <https://www.amazon.de/LogiLink-Installation-Cable-S-FTP-CPV0030/dp/B002BEN9E2>`_
+  * `RJ45 2=>2 Splitter <https://www.amazon.de/Ethernet-Connectors-Connector-Compatible-Computers/dp/B08CDMXPVG>`_
+  * `RJ45 2=>4 Splitter <https://www.amazon.de/LogiLink-MP0032-RJ45Modular-Splitter-Jacks/dp/B00J3XIAH0>`_
+
+Cabinet
+=======
+
+**Price point**: around 130€
+
+* `10" Cabinet <https://www.amazon.de/DIGITUS-RAL7035-Wall-Cabinet-Inches/dp/B00CBNY4XI>`_
+* `10" Power strip <https://www.amazon.de/EFB-Elektronik-EK631DE-11-Socket-Switch-Aluminium/dp/B07G8NDNS4>`_
+* `10" Shelf <https://www.amazon.de/DN-10-TRAY-1-Digitus-10-inch-Item/dp/B08XJXKX4R>`_
+* You can choose between the following two options for central cable management:
+
+  * `10" Patchpanel <https://www.amazon.de/DeleyCON-patch-panel-Network-Panel/dp/B07313S6DG>`_
+  * Keystone panel (*cheaper and more work*)
+
+    * `Keystone jack <https://www.amazon.de/DIGITUS-CAT-5e-KEYSTONE-Keystone-termination/dp/B001E3HYDS>`_
+    * `10" Keystone panel <https://www.amazon.de/DIGITUS-Patch-Panel-Modular-distribution/dp/B0728K2515>`_
+
+
+----
+
+.. _setup-buy-low:
+
+Low
+***
+
+This setup **IS NOT RECOMMENDED for beginners**!
+
+It will require you to do **more and complexer tasks** to set it up.
+
+In the **future** we might develop a **server-agent setup** (*Ticket #39*) which would allow you to use cheaper agent-hardware than a raspberry.
+This will lower the cost of a single setup.
+
+Price
+=====
+
+Like mentioned in the intro above => you WILL find the listed products for a lower price on other platforms than amazon!
+
+**Full price point**:
+
+between (*around*) 90€ and 110€
+
+
+Raspberry
+=========
+
+**Price point**: around 35€
+
+* `Raspberry 3 A+ <https://www.amazon.de/Raspberry-Mainboard-Cortex-1-4GHZ-11811853/dp/B07KKBCXLY>`_
+* `SD Card <https://www.amazon.de/SanDisk-microSDHC-memory-adapter-performance/dp/B08GY9NYRM>`_
+* As a power supply use a smartphone power supply => but check that it has AT LEAST a rating for 1,5A; else your raspberry might crash randomly
+* No case at all
+
+Power
+=====
+
+**Price point**: -
+
+* 3V, 5V => just use the raspberry DC output
+* 12V => get some old unused 12V DC power supply; else but the one listed in the 'medium' section
+
+Cabling
+=======
+
+**Price point**: around 30€
+
+* **Basic**
+
+  * `Electric tape <https://www.amazon.de/T1510-Temflex-Electrical-Insulation-7000062272/dp/B002Z7WW48>`_
+
+* **Internal** (*interconnections inside the cabinet*)
+
+  * `jumper wires <https://www.amazon.de/AZDelivery-Jumper-Arduino-Raspberry-Breadboard/dp/B074P726ZR>`_
+
+    * Instead of using a gpio breakout => you could use jumper wires to connect the gpio's directly to the breadboards
+    * Instead of breadboard wires you could just use jumper wire
+
+  * You can just use some left-over network cabling for internal wiring
+  * `Breadboards <https://www.amazon.de/AZDelivery-Mini-Breadboard-400-Pin-Parent/dp/B07VFK5CRP>`_
+  * `Wire screw connectors <https://www.amazon.de/Aihasd-Terminal-Circuit-Connector-Printkl/dp/B00VGGFPZW>`_
+  * Else you can use any other cable with around 0.2mm² conductor thickness
+
+* **External** (*connections to the sensors and actors*)
+
+  * `Network cable <https://www.amazon.de/LogiLink-Installation-Cable-S-FTP-CPV0030/dp/B002BEN9E2>`_
+  * If you don't want to use splitters => just wire each sensor directly
+
+Cabinet
+=======
+
+**Price point**: around 25-45€
+
+* As a cabinet for the installation you could use an electrical cabinet or just a wooden box
+
+  Then you need to:
+
+    * mount everything inside with hot glue or something like that
+    * cut-out openings for wires and so on
+
+  Is more work; but it can be nice. But it will unlikely be.
+
+  * `IP65 plastic box <https://www.amazon.de/Junction-weatherproof-adaptable-enclosure-outdoor/dp/B00U6BUE4U>`_
+  * `Wooden box <https://www.amazon.de/Zeller-13151-Purpose-Cover-Softwood/dp/B003ESGFNQ>`_
+
+
+* If you don't want to use any centralised cable management => you can just connect the network cables directly to your breadboards
+* Else you can use a keystone panel:
+
+  * `Keystone Jack <https://www.amazon.de/DIGITUS-CAT-5e-KEYSTONE-Keystone-termination/dp/B001E3HYDS>`_
+  * `Keystone Enclosure <https://www.amazon.de/Goobay-Keystone-Empty-Enclosure-White/dp/B0797L5J2J>`_
+
+* `Power strip <https://www.amazon.de/Brennenstuhl-Eco-Line-Safety-Switch-1159500015/dp/B002N6ZEFA>`_ (*if you don't have one laying around*)
+