Merge pull request #1399 from ackPeng/docusaurus-version

add recomputer_r1000_with_fin_use_modbus_tcp

docs/Edge/Raspberry_Pi_Devices/reComputer_R1000/Applications/Fin/recomputer_r1000_with_fin_use_modbus_tcp.md

@@ -0,0 +1,178 @@
+---
+description: This article introduces how to use the `Modbus Connector` of `FIN Framwork`.
+
+title: reComputer R1000 with FIN to use modbus TCP
+keywords:
+  - Edge Controller
+  - reComputer R1000
+  - FIN
+  - ModbusTCP
+image: https://files.seeedstudio.com/wiki/reComputer-R1000/recomputer_r_images/01.png
+slug: /reComputer_r1000_fin_modbus_tcp
+last_update:
+  date: 07/15/2024
+  author: ShuishengPeng
+---
+
+## Introduction 
+FIN Framework (FIN) is a software framework with application suites that can integrate, control, manage, analyze, visualize and connect. Its capabilities can be integrated by OEMs into a range of products and services.
+
+This article introduces how to use the `Modbus Connector` of `FIN Framwork`, which mainly includes three aspects: creating a `FIN Framwork` project, configuring the `Modbus Connector`, and adding data points to `Equip`.
+
+## Getting Start
+
+Before you start this project, you may need to prepare your hardware and software 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 Preparation
+* Regarding how to install FIN Framwork, you can refer to this [wiki](https://wiki.seeedstudio.com/reComputer_r1000_install_fin/).
+* Using [modbusmechanic](https://modbusmechanic.scifidryer.com/) on W10 PC.You can also use other modbus testing tools.
+### Hardware Configuration
+
+For ModbusTCP, we use Ethernet cables to connect the W10 PC and reComputer R1000 to a switch to ensure that they are on the same network segment.
+
+<div align="center"><img src="https://files.seeedstudio.com/wiki/reComputer-R1000/fuxa/r1000_connection.png" alt="pir" width="500" height="auto" /></div>
+
+### Create New Project
+**Step 1**: Click the `Create` button in the lower left corner of the homepage, and a new pop-up window will appear. The pop-up window mainly has three attributes that need to be filled in:
+  - NAME: the name of the new project
+  - DISPLAY NAME: displayed project name
+  - DESCRIPTION: description of the project
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_1.gif" /></center>
+
+**Step 2**: Open the project, enter `DB Builder`, click `Connectors`, you can see that there is no `Modbus` option at this time, we need to open the `Modbus Connector` of `FIN Framwork`, then `Modbus` option will appear here.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_2.gif" /></center>
+
+### Configure `Modbus Connector`
+
+**Step 1**: Open `Modbus Connector`. Click `Settrings => Ext` and find `Modbus`. At this time, `Modbus` is marked in red. Click `Enable` and you can see that the `Modbus` mark turns green, indicating that the `Modbus Connector` has been successfully opened. Enter `DB Builder` again and you can see that there is already a `Modbus` option.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_3.gif" /></center>
+
+**Step 2**: Add a new Modbus connection. Click `Modbus => Add`, the new pop-up window mainly has the following parameters to fill in:
+  - Dis: the name of the connector
+  - ModbusSlave: this would be the slave of the modbus device being connected (default is 1)
+  - Existing Register Map: If the user already configured a Modbus connector, they would see available registers here to choose from or create a new one with the next property ModbusRegMapUri.
+  - ModbusRegMapUri: this is where the user would specify the name of the register map to link with this connector. Replace "xxx" with whatever the name of the register map is.
+  - Uri: this is where the uri of the modbus connector would be specified.
+
+In our example, we specified "r1000_demo" as our register map. Then added our IP to the device in the Uri.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_4.gif" /></center>
+
+**Step 3**: Add a new `Register Maps`. Click `Register Maps => Add`, enter `Name`, which needs to be consistent with the name of `ModbusRegMapUri` in the second step, and finally click `ADD`.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_5.gif" /></center>
+
+The system will create a new `r1000_demo.csv` file in the `opt/finFramework_5.1.6.55/var/proj/recomputer_R1000_demo/data/modbus/` directory. This file describes the Modbus register information we need to read.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_register_map_addr.png" /></center>
+
+
+**Step 4**: Add the register information to be read. `Modbus Connector` exists as a Modbus master. It will read the registers of the slave. We need to configure the register information to be read. Click `r1000_demo`, you can see that there is a description of `ping` by default, this is a must. We continue to add new register information and click `Register Maps => r1000_demo => Add`. The new pop-up window mainly has the following parameters to fill in:
+
+- name(required): name of register.
+
+  - It must be unique
+
+  - It must start with a lower case letter a-z
+  - Only a-z, A-Z, 0-9 and underscores are allowed. No spaces or other special characters.
+
+- addr(required): this would be the address of the register that follows the modbus convention.
+
+  - 0xxxx - Coil (00001-065536)
+  - 1xxxx - Discrete Input (10001-165536)
+  - 3xxxx - Input Register (30001-365536)
+  - 4xxxx - Holding Register (40001-465536)
+
+- data(required): this defines the data type of the register.
+
+  - Types:
+    - bit - Bool
+    - u1 - Unsigned 8-bit Int
+    - u2 - Unsigned 16-bit Int
+    - u4 - Unsigned 32-bit Int
+    - s1 - Signed 8-bit Int
+    - s2 - Signed 16-bit Int
+    - s4 - Signed 32-bit Int
+    - s8 - Signed 64-bit Int
+    - f4 - 32-bit Float
+    - f8 - 64-bit Float
+
+- rw(required):  this would determine the read/write permissions
+
+  - rw - Register may be read and written
+  - r - Register is read-only
+  - w - Register is write-only
+
+- scale(optional): this allows the user to apply a scale factor to the registers. The format is [operator] [number] where the factor is a numeric constant.
+
+  - Examples:
+    - add: +1.5
+    - minus: -0.25
+    - mult: *10
+    - div: /1000
+
+- dis(optional): this is an optional tag that the user can specify a pretty display name for the register.
+
+- unit(optional): this would define the unit to use for the register.
+
+- tags(optional): this would be the tags to apply to the point when learned into the database.
+
+- folderPath(optional): if the user wants to organize the points, they can do so by applying a folderPath.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_6.gif" /></center>
+
+**Step 5**: Communication test. After adding the description information of the register, communication can be carried out. Here we use `ModbusMechanic` as the Modbus slave. Click `Modbus => Ping` and you can see that `Status` changes to `OK`, indicating that the communication is normal.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_7.gif" /></center>
+
+### Add data points to `Equip Tree`
+
+**Step 1**: add `Equip`. Click `Equip Tree => + => Add site`, enter `Name`, here I enter `Tower`, it can add a `site` named `Tower`; then click `Equip Tree => Tower => + => Add Floor`, enter `Name`, here I enter `Floor1`, it can add a `Floor` named `Floor1`; click `Equip Tree again => Tower => Floor1 => + => Add Equip`, enter `Name`, here I enter `ModbusEquip` to add a new `Equip`.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_8.gif" /></center>
+
+**Step 2**: Click `->` on the right side of `ModbusEquip` to make the system path under `Tower/Floor1/ModbusEquip`.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbustcp_modbusequip_path.png" /></center>
+
+**Step 3**: Add data points. Click `Modbus => Modbus Conn`, click `Discover Points` in the new window, the register information points we set will appear, select a register to be read, and click `Add`.
+
+<center><img width={600} src="https://files.seeedstudio.com/wiki/reComputer-R1000/fin/modbus_tcp_9.gif" /></center>
+
+
+## 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>

sidebars.js

@@ -2972,6 +2972,8 @@ const sidebars = {
                             label: 'FIN',
                             items: [
                                'Edge/Raspberry_Pi_Devices/reComputer_R1000/Applications/Fin/recomputer_r1000_install_fin',
+                               'Edge/Raspberry_Pi_Devices/reComputer_R1000/Applications/Fin/recomputer_r1000_with_fin_use_modbus_tcp',
+
                               ],
                             },
                             {