diff --git a/doc/source/V2023.rst b/doc/source/V2023.rst index 8cd2d46fa911adbe1f656b4b68e7cd81c1664771..b412f0f3bc95b5fca3bd968ddbbb2e3d3989f20d 100644 --- a/doc/source/V2023.rst +++ b/doc/source/V2023.rst @@ -309,14 +309,18 @@ node-red basic_ohmpi_flows_node-red.json These examples may require installing some additional node packages in order to work properly. This can be done in the `Palette Manager <https://nodered.org/docs/user-guide/editor/palette/manager> within Node-RED. -.. figure:: img/node-red-flow.png +.. figure:: img/node-red_flow.png Example flow in node-red to interact with an OhmPi. -.. figure:: img/node-red-interface-ui.png +.. figure:: img/node-red_interface_control.png - Example of a dashboard UI created with node-red to interact with an OhmPi. + Example of a dashboard UI created with node-red to interact with an OhmPi - control tab. + +.. figure:: img/node-red_interface_data.png + + Example of a dashboard UI created with node-red to interact with an OhmPi - data visualization tab. For more documentation dedicated to node-red, please refer to the Node-red `cookbooks <https://cookbook.nodered.org/>`_. diff --git a/doc/source/img/node-red_flow.png b/doc/source/img/node-red_flow.png new file mode 100644 index 0000000000000000000000000000000000000000..c81b1442d7cc086b41e848e579b3bd321ffde9c4 Binary files /dev/null and b/doc/source/img/node-red_flow.png differ diff --git a/doc/source/img/node-red_interface_control.png b/doc/source/img/node-red_interface_control.png new file mode 100644 index 0000000000000000000000000000000000000000..9ee028f5365758c5387ce3c1530fe3752d9e5a30 Binary files /dev/null and b/doc/source/img/node-red_interface_control.png differ diff --git a/doc/source/img/node-red_interface_data.png b/doc/source/img/node-red_interface_data.png new file mode 100644 index 0000000000000000000000000000000000000000..26db8a2f04c291b0cdbf6e5fa37a8f6c24ad9ba2 Binary files /dev/null and b/doc/source/img/node-red_interface_data.png differ diff --git a/examples/node-red_interface.json b/examples/node-red_interface.json index 32798a022d29f6249705000ed398bd8cbce9a31a..e38a95d4bb416fe6d0efffa7928125c169b98449 100644 --- a/examples/node-red_interface.json +++ b/examples/node-red_interface.json @@ -684,6 +684,26 @@ "width": 8, "height": 1 }, + { + "id": "7a4e901e7faedf6c", + "type": "ui_spacer", + "z": "b19c51e9d4d25a33", + "name": "spacer", + "group": "142ad6ae.d55e29", + "order": 1, + "width": 2, + "height": 1 + }, + { + "id": "d0da538df7da49b5", + "type": "ui_spacer", + "z": "b19c51e9d4d25a33", + "name": "spacer", + "group": "142ad6ae.d55e29", + "order": 4, + "width": 2, + "height": 1 + }, { "id": "71f435fecd185ab7", "type": "join", @@ -844,7 +864,7 @@ "z": "c3dbd6595b0256a9", "name": "", "group": "142ad6ae.d55e29", - "order": 12, + "order": 11, "width": 0, "height": 0, "passthru": false, @@ -878,7 +898,7 @@ "tooltip": "", "place": "Select option", "group": "142ad6ae.d55e29", - "order": 10, + "order": 9, "width": 0, "height": 0, "passthru": true, @@ -925,7 +945,7 @@ "label": "kwargs", "tooltip": "", "group": "142ad6ae.d55e29", - "order": 11, + "order": 10, "width": 0, "height": 0, "passthru": true, @@ -998,7 +1018,7 @@ "type": "ui_text", "z": "c3dbd6595b0256a9", "group": "142ad6ae.d55e29", - "order": 9, + "order": 8, "width": 0, "height": 0, "name": "", @@ -1152,7 +1172,7 @@ "name": "", "label": "Settings", "group": "142ad6ae.d55e29", - "order": 5, + "order": 12, "width": 0, "height": 0, "options": [ @@ -1563,7 +1583,7 @@ "type": "mqtt out", "z": "4489e1d51c9522f3", "name": "MQTT ctrl", - "topic": "ohmpi_XXXX/ctrl", + "topic": "ohmpi_0001/ctrl", "qos": "2", "retain": "false", "respTopic": "", @@ -1600,8 +1620,7 @@ "y": 540, "wires": [ [ - "6efab6f30d54c251", - "adb2ae9f61f9ee82" + "6efab6f30d54c251" ] ] }, @@ -1629,28 +1648,10 @@ "y": 600, "wires": [ [ - "6efab6f30d54c251", - "adb2ae9f61f9ee82" + "6efab6f30d54c251" ] ] }, - { - "id": "adb2ae9f61f9ee82", - "type": "ui_text", - "z": "4489e1d51c9522f3", - "group": "b0990b3c5ff3c09a", - "order": 2, - "width": 0, - "height": 0, - "name": "", - "label": "Command sent", - "format": "{{msg.payload}}", - "layout": "col-center", - "className": "", - "x": 720, - "y": 500, - "wires": [] - }, { "id": "e0f21bb5ada6c4d7", "type": "function", @@ -2023,7 +2024,7 @@ "label": "Filename", "tooltip": "", "group": "142ad6ae.d55e29", - "order": 7, + "order": 6, "width": 0, "height": 0, "passthru": true, @@ -2047,7 +2048,7 @@ "z": "753d1cb452ebd76e", "name": "", "group": "142ad6ae.d55e29", - "order": 8, + "order": 7, "width": 0, "height": 0, "passthru": false, @@ -2247,8 +2248,8 @@ "type": "ui_text", "z": "753d1cb452ebd76e", "group": "142ad6ae.d55e29", - "order": 6, - "width": 4, + "order": 5, + "width": 8, "height": 1, "name": "", "label": "<font size = 4.5>Load sequence", @@ -2264,14 +2265,14 @@ "type": "mqtt in", "z": "b19c51e9d4d25a33", "name": "", - "topic": "ohmpi_XXXX/exec", + "topic": "ohmpi_0001/exec", "qos": "2", "datatype": "auto-detect", "broker": "5a09c1ee2a3419c3", "nl": false, "rap": false, "inputs": 0, - "x": 330, + "x": 320, "y": 40, "wires": [ [ @@ -2284,14 +2285,14 @@ "type": "mqtt in", "z": "b19c51e9d4d25a33", "name": "", - "topic": "ohmpi_XXXX/data", + "topic": "ohmpi_0001/data", "qos": "2", "datatype": "auto", "broker": "5a09c1ee2a3419c3", "nl": false, "rap": false, "inputs": 0, - "x": 330, + "x": 320, "y": 140, "wires": [ [ @@ -2307,7 +2308,7 @@ "type": "mqtt out", "z": "b19c51e9d4d25a33", "name": "MQTT ctrl", - "topic": "ohmpi_XXXX/ctrl", + "topic": "ohmpi_0001/ctrl", "qos": "2", "retain": "false", "respTopic": "", @@ -2325,7 +2326,7 @@ "type": "mqtt in", "z": "b19c51e9d4d25a33", "name": "", - "topic": "ohmpi_xxxx/soh", + "topic": "ohmpi_0001/soh", "qos": "2", "datatype": "auto", "broker": "5a09c1ee2a3419c3", @@ -2403,7 +2404,7 @@ "group": "b0990b3c5ff3c09a", "order": 3, "width": 18, - "height": 6, + "height": 7, "name": "MQTT exec", "label": "Execution", "format": "{{msg.payload}}",