PIXILAB Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
blocks:drivers:delta-controls-o3 [2023-07-13 10:11]
admin [Delta Controls O3 Edge Sensor Hub] 		blocks:drivers:delta-controls-o3 [2023-07-13 11:30] (current)
admin Added minor clarifications of file locations and commands
Line 1: Line 1:
 ====== Delta Controls O3 Edge Sensor Hub ====== ====== Delta Controls O3 Edge Sensor Hub ======
  
-This guide explains how to connect the Delta Controls O3 Edge Sensor Hub to Blocks. It is assumed that the O3 Edge Sensor Hub has been set up and that the internal MQTT broker has been enabled according to the official instructions (found [[https://delta-o3.zendesk.com/hc/en-us/categories/4498059346323-How-To-Set-It-Up|here]]).+This guide explains how to connect the [[https://deltacontrols.com/products/o3-sensor-hub/|Delta Controls O3 Edge Sensor Hub]] to Blocks. It is assumed that the O3 Edge Sensor Hub has been set up and that the internal MQTT broker has been enabled according to the official instructions (found [[https://delta-o3.zendesk.com/hc/en-us/categories/4498059346323-How-To-Set-It-Up|here]]).
  
 You will need the ConfigurableMQTT driver available in the [[https://github.com/pixilab/blocks-script|PIXILAB blocks-script GitHub repo]], as well as the {{ :blocks:drivers:deltacontrols:o3edge.json | JSON configuration file for the O3 Edge}}. See [[blocks:drivers:concepts#using_a_device_driver|this wiki page]] for information on installing drivers. It is assumed that you are running a Mosquitto MQTT broker, such as the one pre-installed on our Linux server image, that has been configured according to [[blocks:server:advanced_server_configuration:mqtt|this guide]]. You will need the ConfigurableMQTT driver available in the [[https://github.com/pixilab/blocks-script|PIXILAB blocks-script GitHub repo]], as well as the {{ :blocks:drivers:deltacontrols:o3edge.json | JSON configuration file for the O3 Edge}}. See [[blocks:drivers:concepts#using_a_device_driver|this wiki page]] for information on installing drivers. It is assumed that you are running a Mosquitto MQTT broker, such as the one pre-installed on our Linux server image, that has been configured according to [[blocks:server:advanced_server_configuration:mqtt|this guide]].
Line 7: Line 7:
 ===== Configure the MQTT broker ===== ===== Configure the MQTT broker =====
  
-The O3 Edge currently only supports publishing values to its internal MQTT broker. In this guide, we will configure the Mosquitto broker (e.g., the one included on our Linux server image) to bridge MWTT topics from the O3's internal broker. This will then let us access the O3 through the regular Mosquitto broker.+The O3 Edge currently only supports publishing values to its internal MQTT broker. In this guide, we will configure the Mosquitto broker (e.g., the one included on our Linux server image) to bridge MQTT topics from the O3's internal broker. This will then let us access the O3 through the regular Mosquitto broker.
  
-  1. Open the Mosquitto configuration file in a text editor. +  - Open the Mosquitto configuration file (e.g., "/etc/mosquitto/conf.d/pixi.conf") in a text editor. 
-  2. Add the following lines: +  - Add the following lines: <code> 
-<code> +connection CONNECTIONNAME 
-     connection CONNECTIONNAME +address IPADDRESS:PORT 
-     address IPADDRESS:PORT +topic # both 0 TOPICBASE/ "" 
-     topic # both 0 TOPICBASE/ "" +cleansession false 
-     cleansession false +notifications false 
-     notifications false +remote_clientid CLIENTID 
-     remote_clientid CLIENTID +remote_password O3EDGEPASSWORD 
-     remote_password O3EDGEPASSWORD +remote_username O3EDGEUSER 
-     remote_username O3EDGEUSER +start_type automatic 
-     start_type automatic +try_private true</code> 
-     try_private true +  - Replace CONNECTIONNAME, TOPICBASE and CLIENTID with strings of your choice. The values must be unique for each O3 Edge device, if connecting multiple devices. 
-</code> +  - Replace IPADDRESS and PORT with the ip address and port number of the internal MQTT broker of the O3 Edge. 
-  3. Replace CONNECTIONNAME, TOPICBASE and CLIENTID with strings of your choice. The values must be unique for each O3 Edge device, if connecting multiple devices. +  - Replace O3EDGEUSER and O3EDGEPASSWORD with the username and password for the internal MQTT broker of the O3 Edge.  
-  4. Replace IPADDRESS and PORT with the ip address and port number of the internal MQTT broker of the O3 Edge. +  - Save the file and close the editor. Restart mosquitto (e.g., "sudo systemctl restart mosquitto").
-  5. Replace O3EDGEUSER and O3EDGEPASSWORD with the username and password for the internal MQTT broker of the O3 Edge.  +
-  6. Save the file and close the editor. Restart mosquitto.+
  
 :!: Additional configuration may be required when using encrypted connections. This is not covered in this guide. :!: Additional configuration may be required when using encrypted connections. This is not covered in this guide.
Line 34: Line 32:
 ===== Adding the O3 to Blocks ===== ===== Adding the O3 to Blocks =====
  
-  1. Add a new MQTT device on the Manage page according to the instructions in the Blocks manual, giving the device a name. +  - Add a new MQTT device on the Manage page according to the instructions in the Blocks manual, giving the device a name. 
-  2. Set the Topic Base to the TOPICBASE chosen in step 3 under Configure broker. +  - Set the Topic Base to the TOPICBASE chosen in step 3 under Configure broker. 
-  3. Select the ConfigurableMQTT driver. +  - Select the ConfigurableMQTT driver. 
-  4. Paste the configuration for the O3 Edge in the Custom Options field. +  - Paste the configuration for the O3 Edge in the Custom Options field. 
-  5. The O3 Edge has now been added to Blocks.+  - The O3 Edge has now been added to Blocks.
  
 ===== Connecting multiple O3 Edge devices ===== ===== Connecting multiple O3 Edge devices =====