From d5c3daf5ec5381a31d94103c37bec4a314fc9362 Mon Sep 17 00:00:00 2001
From: KasunThushara <73091563+KasunThushara@users.noreply.github.com>
Date: Thu, 2 May 2024 06:59:34 +0530
Subject: [PATCH 1/3] Add: N3uron and aws and Edgebox rpi 200
---
.../N3uron/Edgebox-rpi-200-n3uron-aws.md | 180 ++++++++++++++++++
sidebars.js | 1 +
2 files changed, 181 insertions(+)
create mode 100644 docs/Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron-aws.md
diff --git a/docs/Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron-aws.md b/docs/Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron-aws.md
new file mode 100644
index 000000000000..692672247bb4
--- /dev/null
+++ b/docs/Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron-aws.md
@@ -0,0 +1,180 @@
+---
+description: Connect AWS IoT Core with N3uron
+title: Connect AWS IoT Core with N3uron
+keywords:
+ - Edge Box Rpi 200
+ - Getting started
+ - IIoT
+ - Industrial
+ - N3uron
+ - AWS
+image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
+slug: /Edgebox-Rpi-200_N3uron_AWS
+last_update:
+ date: 5/2/2024
+ author: Kasun Thushara
+---
+## Introduction
+
+We have outlined the process of transmitting data from your [Edge Box RPi 200 device to AWS IoT Core using the MQTT protocol](https://wiki.seeedstudio.com/Edgebox-rpi-200-AWS/). This tutorial will seamlessly integrate with the aforementioned process. In this tutorial, we will delve into the intricacies of interfacing between the N3uron Edge IIoT platform and AWS IoT Core.
+
+## Prerequisites
+
+### Hardware
+
+
+
+
+ | Edge Box RPi 200 |
+
+ |
+
+ |
+
+ |
+
+ |
+
+
+
+
+- Step 04: The instance can be given any name but for the example we will use **MQTT**.
+- Step 05: Set the **Module Type** property to **MqttClient**. Leave the rest of the properties as their default values and click **Save**.
+
+
+
+
+## Configure N3uron’s MQTT Module within the WebUI’s Explorer Panel
+
+- Step 01: In the **Explorer** panel, select the **MQTT** instance you have just created.
+- Step 02: Click on the Model menu button and select **New Connection**.
+- Step 03: Give the New connection a name. In this example, it has been named **AWS**.
+
+
+
+- Step 04: Configure the connection properties:
+
+ - A: Select **Amazon Web Services** from the **Destination Broker** drop down menu. **Authentication mode** will be **Certificate**. Also **Client Id** is **N3uron** in this example.
+ - B: Load the **Certificate, Private key and CA certificate** you downloaded and saved when you created the Thing in the AWS IoT Console.
+ - C: In the AWS IoT console, in the left-hand menu, go to **Settings** and copy your **Device Data Endpoint**. Go back to N3uron and paste it in the **Broker URL** field.
+ - D: Leave the rest of the properties as their default values and click on **Save**.
+
+
+
+## Subscribe to a Topic Using N3uron’s MQTT Module
+
+- Step 01: In the **Model** panel, right-click on the **AWS** Connection, select **New Subscriber**, and give it a name. In this example, we will simply use **Subscriber**.
+
+
+
+- Step 02: Click on it and add a name in the Topic field. In this example, we have used device/data.(In our AWS tutorial , we have published data under this topic.)
+
+- Step 03: Set the following properties using the values shown below, leaving the rest of them as their default values:
+ - **Qos**: Qos 0.
+ - **Encoding**: UTF8
+ - **Compression**: None
+ - **Serialization**: JSON
+ - **Data parser/Type**: MqttClient JSON
+
+And Save it.
+
+
+## Create a Tag
+- Step 01: Within the **Explorer panel**, select **Tags**.
+- Step 02: In the Model menu, right-click on the folder icon, select **New Tag**, and give it a name. In this example, we will use **Subscribed_value**.
+
+
+
+
+- Step 03: In the Configuration panel, set the following properties using the values shown below, leaving the rest of them as their default values:
+ - **Type**: Number.
+ - **Source/Enabled**: Yes
+ - **Module Type**: MqttClient
+ - **Module name**: MQTT
+ - **Config/Subscriber**: AWS/Subscriber
+
+- Step 04: Click on **Save**.
+
+
+
+After you run the python script which we provide on AWS IoT and Edge Box RPi 200 and AWS IoT.
+Go back to the N3uron WebUI interface and in the left-hand panel, select **Data/Real Time**. You should now see the **Subscribed_Value** tag you created before with a value.
+
+
+
+## Visualization
+
+If you have create a webvision module you can start this steps.
+
+- Step 01: Navigate to **WebVision** in the **Config** section and click on **Open Designer**. Log in using your Administrator credentials.
+
+
+
+- Step 02: In the Templates section, create a new Container named as you wish. Then, designate this container as the startup. This will set this as our initial WebVision screen. It will appear with an asterisk symbol (*) beside it.
+
+
+
+- Step 03: Change the background color of the container.
+
+
+
+- Step 04: Inside the Main container, navigate to **Components** and add a new component. For this example, select the **Label** component.
+
+
+
+- Step 05: You can modify the properties of the label for a better appearance.
+
+
+
+- Step 06: Within the **Label component**, select the tag that will provide the values displayed on the Label component.
+
+
+
+
+
+- Step 07: Select tag Property
+
+
+
+- Step 08: Next, navigate to WebVision in the Config section and click on Open UI. Log in using your Administrator credentials.
+
+ 
+
+ Subsequently, you will witness the ultimate result, which involves updating the label values in accordance with the data subscribed from the cloud.
+
+
+
+## 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.
+
+
+
+
\ No newline at end of file
diff --git a/sidebars.js b/sidebars.js
index a1eff064e51a..296613ca6234 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -2715,6 +2715,7 @@ const sidebars = {
label: 'N3uron',
items: [
'Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron',
+ 'Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron-aws',
],
}, {
type: 'category',
From f9800ffab406626c1a6b8294f83d42e42ca1953c Mon Sep 17 00:00:00 2001
From: KasunThushara <73091563+KasunThushara@users.noreply.github.com>
Date: Thu, 2 May 2024 07:19:33 +0530
Subject: [PATCH 2/3] Update: N3uron webvision Module
---
.../N3uron/Edgebox-rpi-200-n3uron.md | 80 +++++++++++++++++++
1 file changed, 80 insertions(+)
diff --git a/docs/Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron.md b/docs/Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron.md
index 308e1f5f836e..fc6cea83ba5c 100644
--- a/docs/Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron.md
+++ b/docs/Edge/Raspberry_Pi_Devices/Edge_Box_RPi_200/N3uron/Edgebox-rpi-200-n3uron.md
@@ -186,4 +186,84 @@ Port: 1883
+
+ ### Instantiate a WebVision module
+
+**Step 1:** Open N3uron and navigate to the Config menu.
+
+**Step 2:** Click on Modules, then create a new module. This instance can be given any name (except names with special characters like ‘.’, ‘/’, etc.), although users are recommended to name instances in a similar way to the name of the module being instantiated for easy identification. In this example, the WebVision module has been selected and has also been named WebVision.
+
+
+
+**Step 3:** Navigate to the main configuration of WebVision and choose the appropriate server settings. The default settings should suffice for most use cases. For further details, please refer to the following link: [WebVision Initial Configuration](https://docs.n3uron.com/docs/web-vision-configuration).
+
+
+
+
+**Step 4:** Once the WebVision module has been instantiated, the first step is to assign permissions to the roles previously created in the Roles section of WebUI. By default, two roles exist: Administrator for administrative access and User for regular access. You can add users to these roles or create new ones as needed. Once roles are established, set permissions for Designer and Viewer roles accordingly.
+Additionally, establish a Tag filter path for each role. Tag filter path access determines which tags from the tag model will be accessible for visualization by the corresponding role. In this case, we will assign the complete path of the tag model to both roles.
+
+
+- Administrator:
+ - Designer: Edit
+ - Viewer: View
+ - TagFilterPath:
+ - Mode: Include
+ - Path: /
+ - Regex pattern: .*
+- User:
+ - Designer: None
+ - Viewer: View
+ - TagFilterPath:
+ - Mode: Include
+ - Path: /
+ - Regex pattern: .*
+
+
+
+- Useful Links
+
+ - [Users and Roles Configuration](https://docs.n3uron.com/docs/platform-security-users-and-roles)
+
+ - [Access Configuration](https://docs.n3uron.com/docs/web-vision-configuration#access-configuration)
+
+**Step 5:** To test our initial WebVision screen, let's create a tag. Go to the WebUI, select **Config**, and then click on **Tag**. In the **Model** section, click on the menu and choose **New Tag**. Name it **TestTag**, for instance, select the type as **Number**, grant it **Read-Write permission**, initialize it to 0 (optional) and then save the settings.
+
+
+
+**Step 6:** Next, navigate to WebVision in the Config section and click on **Open Designer**.
+Log in using your **Administrator credentials**.
+
+
+
+**Step 7:** In the Templates section, create a new Container named Main. Then, designate this container as the startup. This will set Main as our initial WebVision screen. It will appear with an asterisk symbol (*) beside it.
+
+
+
+**Step 8:** Change the background color of the Main container.
+
+
+
+
+**Step 9:** Inside the Main container, navigate to Components and add a new component. For this example, select the Gauge component.
+
+
+
+**Step 10:** Within the Gauge component, select the tag that will provide the values displayed on the gauge component.
+
+
+
+**Step 11:** Next, navigate to WebVision in the Config section and click on Open UI.
+Log in using your Administrator credentials.
+
+
+
+**Step 12:** To test our simple design, navigate to the WebUI and select Data > Realtime. Change the value of TestTag. Afterwards, return to the WebVision UI and verify if the value displayed by the Gauge component has been updated.
+
+
+
+
+There is much to explore about WebVision to enhance your Edge Box experience. For further details, please refer to our [Knowledge Base on WebVision](https://docs.n3uron.com/docs/web-vision-configuration).
+
+
What you've seen is just the beginning. Embrace the limitless possibilities offered by its impressive array of nearly 50 modules. Dare to dream big, innovate, and take your projects to new heights with N3uron's cutting-edge features. For a deeper dive into this powerful platform, visit [https://n3uron.com/](https://n3uron.com/) and embark on an exciting journey of discovery!
\ No newline at end of file
From 66284b8b0b38ac812601f6994ae26ac1fa8d133f Mon Sep 17 00:00:00 2001
From: KasunThushara <73091563+KasunThushara@users.noreply.github.com>
Date: Mon, 6 May 2024 10:16:12 +0530
Subject: [PATCH 3/3] Add: N3uron Mqtt and modbus with reTerminal
---
.../reTerminal_DM_N3uron_modbus_mqtt.md | 222 ++++++++++++++++++
sidebars.js | 1 +
2 files changed, 223 insertions(+)
create mode 100644 docs/Edge/Raspberry_Pi_Devices/reTerminal-DM/N3uron/reTerminal_DM_N3uron_modbus_mqtt.md
diff --git a/docs/Edge/Raspberry_Pi_Devices/reTerminal-DM/N3uron/reTerminal_DM_N3uron_modbus_mqtt.md b/docs/Edge/Raspberry_Pi_Devices/reTerminal-DM/N3uron/reTerminal_DM_N3uron_modbus_mqtt.md
new file mode 100644
index 000000000000..f4822c2e5f8f
--- /dev/null
+++ b/docs/Edge/Raspberry_Pi_Devices/reTerminal-DM/N3uron/reTerminal_DM_N3uron_modbus_mqtt.md
@@ -0,0 +1,222 @@
+---
+description: Connect N3uron with MQTT and Modbus Support Devices
+title: Connect N3uron with MQTT and Modbus Support Devices
+keywords:
+ - reTerminal DM
+ - MQTT
+ - IIoT
+ - Industrial
+ - N3uron
+ - Modbus
+image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
+slug: /reTerminalDM_N3uron_modbus_mqtt
+last_update:
+ date: 5/6/2024
+ author: Kasun Thushara and Xabier Fernández
+---
+## Introduction
+
+In industrial automation, Modbus stands out as one of the most common protocols, while MQTT dominates the wireless protocol domain. The potent pairing of ReTerminal DM and [N3uron](https://n3uron.com/) Duo facilitates efficient plant management by providing robust connectivity and data manipulation capabilities. This Wiki emphasizes the significance of Modbus TCP in industrial settings, highlighting the seamless integration of MQTT devices to further enhance connectivity.
+
+## Prerequisites
+
+### Hardware
+
+
+
+
+ | reTerminal DM |
+
+ |
+
+ |
+
+ |
+
+ |
+
+
+
+
+- Step 04: The instance can be given any name but for the example, we will use **ModbusClient**.
+- Step 05: Set the Module Type property to **ModbusClient**. Leave the rest of the properties as their default values and click **Save**.
+
+
+
+### Channel Creation and Configuration
+
+- Step 01: Under the created Modbus Client and Model, select **New Channel**. Give the channel name as **Client**.
+
+
+
+- Step 02: Now, we are going to communicate with the PLC using Modbus TCP. Please provide the **IP address** for the PLC and the **port address**.
+
+
+
+
+:::note
+ If you are using Modbus RTU, there are various configurations to consider. To do that, you need to provide details such as the COM port, baud rate, etc. For more information on configuring both Modbus RTU and TCP protocols on N3uron, refer to the provided [guide](https://docs.n3uron.com/docs/modbus-client-configuration).
+:::
+
+- Step 03: Add a device: Each channel can have one or more devices. Set a **name** for the device and proceed with the configuration. In this case, the device name is **PLC**.
+
+
+
+- Step 04: There are a few settings that you can adjust through this interface. You can find more details from this link. However, for this case, we'll keep them as they are.
+
+
+
+## Tag Configuration
+
+- Step 01: Go to the **WebUI**, select **Config**, and then click on **Tag**. In the Model section, click on the menu and choose **New Tag**. Name it Q1. Normally Q is used to indicate the output coil.
+
+
+
+
+- Step 02: Then you need to do the following configurations.
+ - Source : Enabled/Yes
+ - Module Type : ModbusClient
+ - ModuleName: ModbusClient
+ - Config: Device: Client/PLC
+ - Modbus address: 008931
+ - Data type: Boolean
+and **Save** it.
+
+
+
+:::note
+ It is advisable to refer to the PLC or device manufacturer's datasheet regarding Modbus addresses. There, you will find details about input, output, and holding addresses. According to these specifications, adjustments should be made in the Modbus address line in the tag configuration. For instance, if the manufacturer notates the output coil Q1 as 8193, the address should be configured as 008193. Similarly, if the network input is denoted as 1 and it is a coil type, the address should be set as 000001.
+:::
+
+- Step 03: Real-time simulation
+
+Once connected to the system, you can view the real-time status of output coils and input coils.
+
+
+
+:::note
+ Interaction with the PLC via the N3uron interface requires appropriate access permissions, including both read and write capabilities.
+:::
+
+## Create a MQTT Module Instance Within N3uron’s WebUI Interface
+
+- Step 01: In the Navigation panel, select **Config**.
+- Step 02: In the Explorer panel, select **Modules**.
+- Step 03: Click on the Model menu and select **New Module**.
+
+
+
+- Step 04: The instance can be given any name but for the example, we will use **MQTT**.
+- Step 05: Set the Module Type property to **MqttClient**. Leave the rest of the properties as their default values and click **Save**.
+
+
+
+## Configure N3uron’s MQTT Module
+
+
+- Step 01: In the Explorer panel, select the MQTT instance you have just created.
+- Step 02: Click on the Model menu button and select New Connection.
+- Step 03: Give the New connection a name. In this example, it has been named **MqqtClient**:
+
+ - Destination broker : Custom
+ - Authentication mode: Password
+ - Username : Your Broker Username
+ - Password: Your Broker Password
+ - Protocol:MQTT
+ - Broker URL:Broker ip
+**Save** configurations
+
+
+
+## Subscribe to a Topic Using N3uron’s MQTT Module
+
+- Step 01: In the Model panel, right-click on the AWS Connection, select New Subscriber, and give it a name. In this example, we will simply use Subscriber.
+
+
+
+- Step 02: Click on it and add a name in the Topic field. In this example, we have used device/data.
+
+
+:::note
+For testing and hands-on experience, we have provided you with an [Arduino code](https://files.seeedstudio.com/wiki/reTerminalDM/N3uron-mqtt-modbus/MQTT_N3uron.ino) that can be run on XIAO. Additionally, you will need to input your own credentials into this code before uploading it.
+:::
+
+
+- Step 03: Set the following properties using the values shown below, leaving the rest of them as their default values:
+
+ - Qos: Qos 0.
+ - Encoding: UTF8
+ - Compression: None
+ - Serialization: JSON
+ - Data parser/Type: MqttClient JSON
+And **Save** it.
+
+
+
+:::note
+ Here, we utilize a data parser configured for MQTTClient JSON format. The XIAO device publishes data to the broker in this format. If your device does not publish data in this specific format, you will need to identify the format it uses and create a custom JavaScript code snippet to handle the devices accordingly. For further guidance, please refer to the provided [guidelines](https://docs.n3uron.com/docs/mqtt-client-custom-parser).
+:::
+
+## Create a Tag
+
+- Step 01: Within the Explorer panel, select **Tags**.
+- Step 02: In the Model menu, right-click on the folder icon, select **New Tag**, and give it a name. In this example, we will use **test**.
+
+
+
+- Step 03: In the Configuration panel, set the following properties using the values shown below, leaving the rest of them as their default values:
+
+ - Type: Number.
+ - Source/Enabled: Yes
+ - Module Type: MqttClient
+ - Module name: MQTT
+ - Config/Subscriber: MqqtClient/Subscriber
+Click on **Save**.
+
+
+
+
+- Step 04: Real-time simulation
+Once connected to the system, you can view the real-time status of output from the MQTT Broker.
+
+
+
+## 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/sidebars.js b/sidebars.js
index 296613ca6234..d4521f9d30c7 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -2639,6 +2639,7 @@ const sidebars = {
items: [
'Edge/Raspberry_Pi_Devices/reTerminal-DM/N3uron/reTerminalDM_N3uron_Get_Start',
'Edge/Raspberry_Pi_Devices/reTerminal-DM/N3uron/reTerminal_DM_N3uron_AWS',
+ 'Edge/Raspberry_Pi_Devices/reTerminal-DM/N3uron/reTerminal_DM_N3uron_modbus_mqtt',
'Edge/Raspberry_Pi_Devices/reTerminal-DM/N3uron/reTerminal_DM_N3uron_Historian',
],
},
