hb2 docs

ogghst · Jan 3, 2022 · 528346d · 528346d
1 parent 8ec28d1
commit 528346d
Show file tree

Hide file tree

Showing 13 changed files with 226 additions and 101 deletions.
diff --git a/docs/boards.md b/docs/boards.md
@@ -6,105 +6,10 @@ Here you can find resources to make your own board starting from existing works.
 
 This is the first project done using GrowNode platform. It is basically a Water Tower with water reservoir temperature control (heating/cooling) done through a Peltier cell, and a water level measurement device done by a capacitance sensor.
 
-Here is the code to startup all the leaves:
+[Board Detail](boards_hb1.md)
 
-	gn_leaf_config_handle_t lights1in = gn_leaf_create(node, "lights1in",
-			gn_relay_config, 4096);
-	gn_leaf_param_init_double(lights1in, GN_RELAY_PARAM_GPIO, 25);
-	gn_leaf_param_init_bool(lights1in, GN_RELAY_PARAM_STATUS, false);
+##Hydroboard2
 
-	gn_leaf_config_handle_t lights2in = gn_leaf_create(node, "lights2in",
-			gn_relay_config, 4096);
-	gn_leaf_param_init_double(lights2in, GN_RELAY_PARAM_GPIO, 5);
-	gn_leaf_param_init_bool(lights2in, GN_RELAY_PARAM_STATUS, false);
-
-	gn_leaf_config_handle_t plt_a = gn_leaf_create(node, "plt_a",
-			gn_relay_config, 4096);
-	gn_leaf_param_init_double(plt_a, GN_RELAY_PARAM_GPIO, 23);
-	gn_leaf_param_init_bool(plt_a, GN_RELAY_PARAM_STATUS, false);
-
-	gn_leaf_config_handle_t plt_b = gn_leaf_create(node, "plt_b",
-			gn_relay_config, 4096);
-	gn_leaf_param_init_double(plt_b, GN_RELAY_PARAM_GPIO, 17);
-	gn_leaf_param_init_bool(plt_b, GN_RELAY_PARAM_STATUS, false);
-
-	gn_leaf_config_handle_t waterpumpin = gn_leaf_create(node, "waterpumpin",
-			gn_relay_config, 4096);
-	gn_leaf_param_init_double(waterpumpin, GN_RELAY_PARAM_GPIO, 19);
-	gn_leaf_param_init_bool(waterpumpin, GN_RELAY_PARAM_STATUS, false);
-
-	gn_leaf_config_handle_t waterlevelin = gn_leaf_create(node, "waterlevelin",
-			gn_capacitive_water_level_config, 4096);
-	gn_leaf_param_init_bool(waterlevelin, GN_CWL_PARAM_ACTIVE, true);
-	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_TOUCH_CHANNEL, 2);
-	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_UPDATE_TIME_SEC, 10);
-	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_MIN_LEVEL, 0);
-	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_MAX_LEVEL, 2048);
-
-	gn_leaf_config_handle_t hcc_speed = gn_leaf_create(node, "hcc",
-			gn_pump_hs_config, 4096);
-	gn_leaf_param_init_bool(hcc_speed, GN_PUMP_HS_PARAM_CHANNEL, 0);
-	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_GPIO_POWER, 18);
-	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_POWER, 0);
-	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_GPIO_TOGGLE, 26);
-	gn_leaf_param_init_bool(hcc_speed, GN_PUMP_HS_PARAM_TOGGLE, false);
-
-	gn_leaf_config_handle_t fan_speed = gn_leaf_create(node, "fan",
-			gn_pump_hs_config, 4096);
-	gn_leaf_param_init_bool(fan_speed, GN_PUMP_HS_PARAM_CHANNEL, 1);
-	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_GPIO_POWER, 27);
-	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_POWER, 0);
-	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_GPIO_TOGGLE, 33);
-	gn_leaf_param_init_bool(fan_speed, GN_PUMP_HS_PARAM_TOGGLE, false);
-
-	gn_leaf_config_handle_t bme280 = gn_leaf_create(node, "bme280",
-			gn_bme280_config, 8192);
-	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_SDA, 21);
-	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_SCL, 22);
-	gn_leaf_param_init_bool(bme280, GN_BME280_PARAM_ACTIVE, true);
-	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_UPDATE_TIME_SEC, 10);
-
-	gn_leaf_config_handle_t ds18b20 = gn_leaf_create(node, "ds18b20",
-			gn_ds18b20_config, 4096);
-	gn_leaf_param_init_double(ds18b20, GN_DS18B20_PARAM_GPIO, 4);
-	gn_leaf_param_init_bool(ds18b20, GN_DS18B20_PARAM_ACTIVE, true);
-	gn_leaf_param_init_double(ds18b20, GN_DS18B20_PARAM_UPDATE_TIME_SEC, 5);
-
-	gn_leaf_config_handle_t watering_control = gn_leaf_create(node,
-			"watering_control", gn_watering_control_config, 4096);
-	gn_leaf_param_init_double(watering_control,
-			GN_WAT_CTR_PARAM_WATERING_INTERVAL_SEC, 60 * 1);
-	gn_leaf_param_init_double(watering_control,
-			GN_WAT_CTR_PARAM_WATERING_TIME_SEC, 20);
-	gn_leaf_param_init_double(watering_control,
-			GN_WAT_CTR_PARAM_WATERING_TARGET_TEMP, 20);
-	gn_leaf_param_init_bool(watering_control, GN_WAT_CTR_PARAM_ACTIVE, true);
-
-The working logic is onboard, represented by the leaf `gn_watering_control`. Basically it keeps the reservoir at a controlled temperature and starts the watering periodically if the water is within admissible range.
-
-MQTT Messaging is then collected by a page in OpenHAB where I can display the status of the components.
-
-I've done a first schematic:
-
-![schematic](../resources/solutions/hydroboard1/schematic.png)
-
-And a first prototype board:
-
-![board](../resources/solutions/hydroboard1/board.jpeg)
-
-Then i've built a 3D case:
-
-![case](../resources/solutions/hydroboard1/box.jpeg)
-
-And wired up all together in a demo station:
-
-![demo](../resources/solutions/hydroboard1/prototype1.jpeg)
-
-Now i wanted now to move in a more stable circuit, here is the new schematic:
-
-![schematic2](../resources/solutions/hydroboard1/schematic2.png)
-
-And you can see a draft of the 3D layout:
-
-![schematic2_3d](../resources/solutions/hydroboard1/schematic2_3d.png)
+This is the first project done using GrowNode platform. It is basically a Water Tower with water reservoir temperature control (heating/cooling) done through a Peltier cell, and a water level measurement device done by a capacitance sensor.
 
+[Board Detail](boards_hb2.md)
diff --git a/docs/boards_hb1.md b/docs/boards_hb1.md
@@ -0,0 +1,110 @@
+# Boards
+
+Here you can find resources to make your own board starting from existing works.
+
+##Hydroboard1
+
+This is the first project done using GrowNode platform. It is basically a Water Tower with water reservoir temperature control (heating/cooling) done through a Peltier cell, and a water level measurement device done by a capacitance sensor.
+
+Here is the code to startup all the leaves:
+
+	gn_leaf_config_handle_t lights1in = gn_leaf_create(node, "lights1in",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(lights1in, GN_RELAY_PARAM_GPIO, 25);
+	gn_leaf_param_init_bool(lights1in, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t lights2in = gn_leaf_create(node, "lights2in",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(lights2in, GN_RELAY_PARAM_GPIO, 5);
+	gn_leaf_param_init_bool(lights2in, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t plt_a = gn_leaf_create(node, "plt_a",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(plt_a, GN_RELAY_PARAM_GPIO, 23);
+	gn_leaf_param_init_bool(plt_a, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t plt_b = gn_leaf_create(node, "plt_b",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(plt_b, GN_RELAY_PARAM_GPIO, 17);
+	gn_leaf_param_init_bool(plt_b, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t waterpumpin = gn_leaf_create(node, "waterpumpin",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(waterpumpin, GN_RELAY_PARAM_GPIO, 19);
+	gn_leaf_param_init_bool(waterpumpin, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t waterlevelin = gn_leaf_create(node, "waterlevelin",
+			gn_capacitive_water_level_config, 4096);
+	gn_leaf_param_init_bool(waterlevelin, GN_CWL_PARAM_ACTIVE, true);
+	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_TOUCH_CHANNEL, 2);
+	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_UPDATE_TIME_SEC, 10);
+	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_MIN_LEVEL, 0);
+	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_MAX_LEVEL, 2048);
+
+	gn_leaf_config_handle_t hcc_speed = gn_leaf_create(node, "hcc",
+			gn_pump_hs_config, 4096);
+	gn_leaf_param_init_bool(hcc_speed, GN_PUMP_HS_PARAM_CHANNEL, 0);
+	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_GPIO_POWER, 18);
+	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_POWER, 0);
+	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_GPIO_TOGGLE, 26);
+	gn_leaf_param_init_bool(hcc_speed, GN_PUMP_HS_PARAM_TOGGLE, false);
+
+	gn_leaf_config_handle_t fan_speed = gn_leaf_create(node, "fan",
+			gn_pump_hs_config, 4096);
+	gn_leaf_param_init_bool(fan_speed, GN_PUMP_HS_PARAM_CHANNEL, 1);
+	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_GPIO_POWER, 27);
+	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_POWER, 0);
+	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_GPIO_TOGGLE, 33);
+	gn_leaf_param_init_bool(fan_speed, GN_PUMP_HS_PARAM_TOGGLE, false);
+
+	gn_leaf_config_handle_t bme280 = gn_leaf_create(node, "bme280",
+			gn_bme280_config, 8192);
+	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_SDA, 21);
+	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_SCL, 22);
+	gn_leaf_param_init_bool(bme280, GN_BME280_PARAM_ACTIVE, true);
+	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_UPDATE_TIME_SEC, 10);
+
+	gn_leaf_config_handle_t ds18b20 = gn_leaf_create(node, "ds18b20",
+			gn_ds18b20_config, 4096);
+	gn_leaf_param_init_double(ds18b20, GN_DS18B20_PARAM_GPIO, 4);
+	gn_leaf_param_init_bool(ds18b20, GN_DS18B20_PARAM_ACTIVE, true);
+	gn_leaf_param_init_double(ds18b20, GN_DS18B20_PARAM_UPDATE_TIME_SEC, 5);
+
+	gn_leaf_config_handle_t watering_control = gn_leaf_create(node,
+			"watering_control", gn_watering_control_config, 4096);
+	gn_leaf_param_init_double(watering_control,
+			GN_WAT_CTR_PARAM_WATERING_INTERVAL_SEC, 60 * 1);
+	gn_leaf_param_init_double(watering_control,
+			GN_WAT_CTR_PARAM_WATERING_TIME_SEC, 20);
+	gn_leaf_param_init_double(watering_control,
+			GN_WAT_CTR_PARAM_WATERING_TARGET_TEMP, 20);
+	gn_leaf_param_init_bool(watering_control, GN_WAT_CTR_PARAM_ACTIVE, true);
+
+The working logic is onboard, represented by the leaf `gn_watering_control`. Basically it keeps the reservoir at a controlled temperature and starts the watering periodically if the water is within admissible range.
+
+MQTT Messaging is then collected by a page in OpenHAB where I can display the status of the components.
+
+I've done a first schematic:
+
+![schematic](../resources/solutions/hydroboard1/schematic.png)
+
+And a first prototype board:
+
+![board](../resources/solutions/hydroboard1/board.jpeg)
+
+Then i've built a 3D case:
+
+![case](../resources/solutions/hydroboard1/box.jpeg)
+
+And wired up all together in a demo station:
+
+![demo](../resources/solutions/hydroboard1/prototype1.jpeg)
+
+Now i wanted now to move in a more stable circuit, here is the new schematic:
+
+![schematic2](../resources/solutions/hydroboard1/schematic2.png)
+
+And you can see a draft of the 3D layout:
+
+![schematic2_3d](../resources/solutions/hydroboard1/schematic2_3d.png)
+
diff --git a/docs/boards_hb2.md b/docs/boards_hb2.md
@@ -0,0 +1,110 @@
+# Boards
+
+Here you can find resources to make your own board starting from existing works.
+
+##Hydroboard1
+
+This is the first project done using GrowNode platform. It is basically a Water Tower with water reservoir temperature control (heating/cooling) done through a Peltier cell, and a water level measurement device done by a capacitance sensor.
+
+Here is the code to startup all the leaves:
+
+	gn_leaf_config_handle_t lights1in = gn_leaf_create(node, "lights1in",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(lights1in, GN_RELAY_PARAM_GPIO, 25);
+	gn_leaf_param_init_bool(lights1in, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t lights2in = gn_leaf_create(node, "lights2in",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(lights2in, GN_RELAY_PARAM_GPIO, 5);
+	gn_leaf_param_init_bool(lights2in, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t plt_a = gn_leaf_create(node, "plt_a",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(plt_a, GN_RELAY_PARAM_GPIO, 23);
+	gn_leaf_param_init_bool(plt_a, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t plt_b = gn_leaf_create(node, "plt_b",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(plt_b, GN_RELAY_PARAM_GPIO, 17);
+	gn_leaf_param_init_bool(plt_b, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t waterpumpin = gn_leaf_create(node, "waterpumpin",
+			gn_relay_config, 4096);
+	gn_leaf_param_init_double(waterpumpin, GN_RELAY_PARAM_GPIO, 19);
+	gn_leaf_param_init_bool(waterpumpin, GN_RELAY_PARAM_STATUS, false);
+
+	gn_leaf_config_handle_t waterlevelin = gn_leaf_create(node, "waterlevelin",
+			gn_capacitive_water_level_config, 4096);
+	gn_leaf_param_init_bool(waterlevelin, GN_CWL_PARAM_ACTIVE, true);
+	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_TOUCH_CHANNEL, 2);
+	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_UPDATE_TIME_SEC, 10);
+	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_MIN_LEVEL, 0);
+	gn_leaf_param_init_double(waterlevelin, GN_CWL_PARAM_MAX_LEVEL, 2048);
+
+	gn_leaf_config_handle_t hcc_speed = gn_leaf_create(node, "hcc",
+			gn_pump_hs_config, 4096);
+	gn_leaf_param_init_bool(hcc_speed, GN_PUMP_HS_PARAM_CHANNEL, 0);
+	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_GPIO_POWER, 18);
+	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_POWER, 0);
+	gn_leaf_param_init_double(hcc_speed, GN_PUMP_HS_PARAM_GPIO_TOGGLE, 26);
+	gn_leaf_param_init_bool(hcc_speed, GN_PUMP_HS_PARAM_TOGGLE, false);
+
+	gn_leaf_config_handle_t fan_speed = gn_leaf_create(node, "fan",
+			gn_pump_hs_config, 4096);
+	gn_leaf_param_init_bool(fan_speed, GN_PUMP_HS_PARAM_CHANNEL, 1);
+	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_GPIO_POWER, 27);
+	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_POWER, 0);
+	gn_leaf_param_init_double(fan_speed, GN_PUMP_HS_PARAM_GPIO_TOGGLE, 33);
+	gn_leaf_param_init_bool(fan_speed, GN_PUMP_HS_PARAM_TOGGLE, false);
+
+	gn_leaf_config_handle_t bme280 = gn_leaf_create(node, "bme280",
+			gn_bme280_config, 8192);
+	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_SDA, 21);
+	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_SCL, 22);
+	gn_leaf_param_init_bool(bme280, GN_BME280_PARAM_ACTIVE, true);
+	gn_leaf_param_init_double(bme280, GN_BME280_PARAM_UPDATE_TIME_SEC, 10);
+
+	gn_leaf_config_handle_t ds18b20 = gn_leaf_create(node, "ds18b20",
+			gn_ds18b20_config, 4096);
+	gn_leaf_param_init_double(ds18b20, GN_DS18B20_PARAM_GPIO, 4);
+	gn_leaf_param_init_bool(ds18b20, GN_DS18B20_PARAM_ACTIVE, true);
+	gn_leaf_param_init_double(ds18b20, GN_DS18B20_PARAM_UPDATE_TIME_SEC, 5);
+
+	gn_leaf_config_handle_t watering_control = gn_leaf_create(node,
+			"watering_control", gn_watering_control_config, 4096);
+	gn_leaf_param_init_double(watering_control,
+			GN_WAT_CTR_PARAM_WATERING_INTERVAL_SEC, 60 * 1);
+	gn_leaf_param_init_double(watering_control,
+			GN_WAT_CTR_PARAM_WATERING_TIME_SEC, 20);
+	gn_leaf_param_init_double(watering_control,
+			GN_WAT_CTR_PARAM_WATERING_TARGET_TEMP, 20);
+	gn_leaf_param_init_bool(watering_control, GN_WAT_CTR_PARAM_ACTIVE, true);
+
+The working logic is onboard, represented by the leaf `gn_watering_control`. Basically it keeps the reservoir at a controlled temperature and starts the watering periodically if the water is within admissible range.
+
+MQTT Messaging is then collected by a page in OpenHAB where I can display the status of the components.
+
+I've done a first schematic:
+
+![schematic](../resources/solutions/hydroboard1/schematic.png)
+
+And a first prototype board:
+
+![board](../resources/solutions/hydroboard1/board.jpeg)
+
+Then i've built a 3D case:
+
+![case](../resources/solutions/hydroboard1/box.jpeg)
+
+And wired up all together in a demo station:
+
+![demo](../resources/solutions/hydroboard1/prototype1.jpeg)
+
+Now i wanted now to move in a more stable circuit, here is the new schematic:
+
+![schematic2](../resources/solutions/hydroboard1/schematic2.png)
+
+And you can see a draft of the 3D layout:
+
+![schematic2_3d](../resources/solutions/hydroboard1/schematic2_3d.png)
+
diff --git a/docs/img/hb2_back.jpg b/docs/img/hb2_back.jpg
diff --git a/docs/img/hb2_close_1.jpg b/docs/img/hb2_close_1.jpg
diff --git a/docs/img/hb2_close_2.jpg b/docs/img/hb2_close_2.jpg
diff --git a/docs/img/hb2_front.jpg b/docs/img/hb2_front.jpg
diff --git a/docs/img/hb2_into.jpg b/docs/img/hb2_into.jpg
diff --git a/docs/img/hb2_into_2.jpg b/docs/img/hb2_into_2.jpg
diff --git a/docs/img/hb2_into_3.jpg b/docs/img/hb2_into_3.jpg
diff --git a/docs/img/hb2_side_1.jpg b/docs/img/hb2_side_1.jpg
diff --git a/docs/img/hb2_side_2.jpg b/docs/img/hb2_side_2.jpg
diff --git a/main/main.c b/main/main.c
@@ -22,7 +22,7 @@
 #include "grownode.h"
 
 //include the board you want to start here
-#include "gn_hydroboard2.h"
+#include "gn_blink.h"
 
 #define TASK_STACK_SIZE 8192*4
 
@@ -57,7 +57,7 @@ void app_main(void) {
 	//creates a new node
 	gn_node_config_handle_t node = gn_node_create(config, "node");
 
-	gn_configure_hydroboard2(node);
+	gn_configure_blink(node);
 
 	//finally, start node
 	gn_node_start(node);