forked from Seeed-Studio/wiki-documents
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request Seeed-Studio#1505 from KasunThushara/docusaurus-ve…
…rsion ADD: Home Assistant and reComputer R1000 Modbus
- Loading branch information
Showing
3 changed files
with
206 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
202 changes: 202 additions & 0 deletions
202
...ter_R1000/Applications/Home-Assistant/recomputer-r1000-modbus-home-assistant.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| --- | ||
| description: Learn how to set up and configure Modbus TCP and Modbus RTU with Home Assistant on a reComputer R1000, a powerful Raspberry Pi-powered solution for seamless integration and control of your Modbus devices in a Building Management System (BMS). | ||
| title: reComputer R1000 and Modbus with Home Assistant | ||
| keywords: | ||
| - Home Assistant | ||
| - reComputer R1000 | ||
| - Home Automation | ||
| - BMS | ||
| - Modbus | ||
|
|
||
| image: https://files.seeedstudio.com/wiki/reComputer-R1000/recomputer_r_images/01.png | ||
| slug: /recomputer_r1000_home_assistant_modbus | ||
| last_update: | ||
| date: 08/07/2024 | ||
| author: Kasun Thushara | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| In modern building management systems (BMS), integrating various protocols and devices is crucial for efficient monitoring and control. This guide focuses on leveraging the capabilities of Modbus communication protocols (Modbus TCP and Modbus RTU) with Home Assistant OS, using the powerful reComputer R1000, a Raspberry Pi-powered solution. Whether you're setting up a new system or enhancing an existing one, this guide will walk you through the process of connecting your Modbus devices to Home Assistant, ensuring seamless integration and control. | ||
|
|
||
| ## Getting Start | ||
|
|
||
| Before you start this project, you may need to prepare your hardware in advance as described here. | ||
|
|
||
| ### Hardware Preparation | ||
|
|
||
| <div class="table-center"> | ||
| <table class="table-nobg"> | ||
| <tr class="table-trnobg"> | ||
| <th class="table-trnobg">reComputer R1000</th> | ||
| </tr> | ||
| <tr class="table-trnobg"></tr> | ||
| <tr class="table-trnobg"> | ||
| <td class="table-trnobg"><div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/recomputer_r_images/01.png" style={{width:300, height:'auto'}}/></div></td> | ||
| </tr> | ||
| <tr class="table-trnobg"></tr> | ||
| <tr class="table-trnobg"> | ||
| <td class="table-trnobg"><div class="get_one_now_container" style={{textAlign: 'center'}}><a class="get_one_now_item" href="https://www.seeedstudio.com/reComputer-R1025-10-p-5895.html"> | ||
| <strong><span><font color={'FFFFFF'} size={"4"}> Get One Now 🖱️</font></span></strong> | ||
| </a></div></td> | ||
| </tr> | ||
| </table> | ||
| </div> | ||
|
|
||
| ### Software Preperation | ||
|
|
||
| Before diving into the integration process, it's crucial to ensure that all necessary drivers and tools are installed. Proper [installation of drivers](https://wiki.seeedstudio.com/reComputer_r1000_use_rs485_modbus_rtu/) is a prerequisite for seamless communication between Modbus RTU devices and Home Assistant. It is highly recommended to thoroughly study and install the required drivers before proceeding with this guide. | ||
|
|
||
| Additionally, if you haven't installed Home Assistant yet, please follow the [Home Assistant installation guide](https://wiki.seeedstudio.com/recomputer_r1000_home_automation/) to set it up on your reComputer R1000. | ||
|
|
||
| ## File Editor Add-on | ||
|
|
||
| While you can configure most of Home Assistant directly from the user interface under Settings, some parts require you to edit files such as configuration.yaml. This file contains integrations to be loaded along with their configurations. By adding code snippets to this configuration file, you can enable specific functionalities, including Modbus integration. | ||
|
|
||
| To get started, you need to install the File Editor add-on in Home Assistant: | ||
|
|
||
| - Open Home Assistant. | ||
| - Navigate to `Settings > Add-ons`. | ||
|
|
||
| <div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/HA/settings.PNG" style={{width:600}}/></div> | ||
|
|
||
| - Click on the `Add-on Store`. | ||
|
|
||
| <div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/HA/add-ons.PNG" style={{width:600}}/></div> | ||
|
|
||
| - Search for `File Editor` and click on it. | ||
|
|
||
| <div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/HA/fileeditor.PNG" style={{width:600}}/></div> | ||
|
|
||
| - Click the Install button. | ||
| - Once installed, click on Start to launch the File Editor. | ||
| - Optionally, enable Show in Sidebar for quick access. | ||
|
|
||
| <div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/HA/fileeditor-start.PNG" style={{width:600}}/></div> | ||
|
|
||
| With the File Editor add-on, you can now edit the `configuration.yaml` file to add Modbus integration | ||
|
|
||
| <div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/HA/config.PNG" style={{width:600}}/></div> | ||
|
|
||
| ## Enabling Modbus TCP Integration | ||
|
|
||
| To enable the Modbus integration in Home Assistant, you need to add specific parameters to your configuration.yaml file. Below are the parameters and their descriptions that you will need to configure: | ||
|
|
||
| - **name**: The name of this hub. Must be unique. | ||
| - **host**: The IP address or name of your Modbus device, e.g., `192.168.1.1`. | ||
| - **port**: The network port for communication. | ||
| - **type**: The type of Modbus connection. Options are tcp or serial.Here we used `tcp` | ||
|
|
||
| To configure entities for your Modbus integration, you need to define various parameters for each entity. Below are the parameters required for setting up binary sensors: | ||
| There are several entities. You can check on [Offical modbus Home Assistant page](https://www.home-assistant.io/integrations/modbus). | ||
|
|
||
| - **binary_sensors**: A list of all binary sensors configured for this connection. | ||
| - **address**: The address of the coil/register. | ||
| - **name**: The name of the entity, which must be unique within the entity type. | ||
| - **scan_interval**: The update interval in seconds. Set scan_interval = 0 for no polling. Entities are read shortly after startup and then according to scan_interval. | ||
| - **slave**: Identical to device_address. | ||
| - **input_type**: The type of request. Options are coil, holding, or input. | ||
|
|
||
| **Example** : | ||
|
|
||
| ```bash | ||
| modbus: | ||
| - name: modbus_hub | ||
| type: tcp | ||
| host: IP_ADDRESS_of_PLC | ||
| port: 502 | ||
| binary_sensors: | ||
| - name: Relay_1 | ||
| address: 8193 | ||
| slave: 1 | ||
| input_type: coil | ||
| scan_interval: 1 | ||
| - name: Relay_2 | ||
| address: 8194 | ||
| slave: 1 | ||
| input_type: coil | ||
| scan_interval: 1 | ||
| ``` | ||
| <div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/HA/modbus-settings.PNG" style={{width:600}}/></div> | ||
|
|
||
| :::note | ||
| It is neccesary save and restart HA after changing configuration.yml file | ||
| ::: | ||
|
|
||
| ## Enabling Modbus RTU Integration | ||
|
|
||
| To enable Modbus RTU integration in Home Assistant, you need to add the following parameters to your configuration.yaml file: | ||
|
|
||
| - **name**: The name of this hub. Must be unique. | ||
| - **type**: The type of Modbus connection. Here, it should be serial. | ||
| - **port**: The serial port or USB device where your Modbus device is connected to your Home Assistant host. We found that it is `/dev/ttyAMA30` | ||
| - **baudrate**: The speed of the serial connection. | ||
| - **method**: The method of connection to Modbus. Options are rtu and ascii. | ||
| - **parity**: The parity of the data bytes. Options are E (Even), O (Odd), N (None). | ||
| - **bytesize**: The data size in bits of each byte. Typically 8. | ||
| - **stopbits**: The stop bits of the data bytes. | ||
|
|
||
| To configure entities for your Modbus RTU integration, you need to define various parameters for each sensor. Below are the parameters required for setting up sensors: | ||
|
|
||
| - **sensors**: The Modbus sensor allows you to gather data from Modbus registers. | ||
| - **name**: The name of the entity, which must be unique within the entity type. | ||
| - **address**: The address of the register. | ||
| - **slave**: Identical to device_address. | ||
| - **input_type**: The Modbus register type for the sensor. Options are holding or input. | ||
| - **scale**: The scale factor. | ||
| - **device_class**: The type/class of the sensor to set the icon in the frontend. | ||
| - **unit_of_measurement**: The unit to attach to the value. | ||
|
|
||
|
|
||
| Example: | ||
|
|
||
| ```bash | ||
| modbus: | ||
| - name: modbus_hub2 | ||
| type: serial | ||
| port: /dev/ttyAMA30 | ||
| baudrate: 9600 | ||
| bytesize: 8 | ||
| method: rtu | ||
| parity: N | ||
| stopbits: 1 | ||
| sensors: | ||
| - name: Room Temperature | ||
| address: 1 | ||
| input_type: input | ||
| slave: 1 | ||
| scale: 0.01 | ||
| device_class: temperature | ||
| unit_of_measurement: °C | ||
| - name: Room Humidity | ||
| address: 2 | ||
| input_type: input | ||
| slave: 1 | ||
| scale: 0.01 | ||
| unit_of_measurement: '%' | ||
| device_class: humidity | ||
| ``` | ||
| <div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/HA/modbus-rtu-setting.PNG" style={{width:600}}/></div> | ||
|
|
||
| :::note | ||
| It is neccesary save and restart HA after changing configuration.yml file | ||
| ::: | ||
|
|
||
| Finally you will be able to see the working phenomina. | ||
|
|
||
| <div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/HA/demo.gif" style={{width:600}}/></div> | ||
|
|
||
|
|
||
| ## Tech Support & Product Discussion | ||
|
|
||
| Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs. | ||
|
|
||
| <div class="button_tech_support_container"> | ||
| <a href="https://forum.seeedstudio.com/" class="button_forum"></a> | ||
| <a href="https://www.seeedstudio.com/contacts" class="button_email"></a> | ||
| </div> | ||
|
|
||
| <div class="button_tech_support_container"> | ||
| <a href="https://discord.gg/eWkprNDMU7" class="button_discord"></a> | ||
| <a href="https://github.com/Seeed-Studio/wiki-documents/discussions/69" class="button_discussion"></a> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters