diff --git a/ui-ngx/src/assets/help/en_US/widget/lib/gateway/address-filter_fn.md b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/address-filter_fn.md new file mode 100644 index 0000000000..9ead0a6afd --- /dev/null +++ b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/address-filter_fn.md @@ -0,0 +1,24 @@ +### Address filter field + +It is used to filter the allowed IP addresses to connect to the connector. + +### **Examples of IP addresses filtering** + +Let’s review more examples of IP addresses filtering: + +For example, we have a device that has the following IP address: 192.168.0.120:5001. Now let's look at examples of the configuration of the field to allow the connection of different variants of IP addresses: + +1. Only one device with a specified IP address and port can connect: + + **Address filter**: 192.168.0.120:5001 +2. Allow any devices with any IP address and only port 5001: + + **Address filter:** *:5001 + +3. Allow all devices that have the IP address 192.168.0.120 with any port: + + **Address filter:** 192.168.0.120:* + +4. Allow any devices: + + **Address filter:** *:* diff --git a/ui-ngx/src/assets/help/en_US/widget/lib/gateway/attribute-name-expression_fn.md b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/attribute-name-expression_fn.md new file mode 100644 index 0000000000..424e51022f --- /dev/null +++ b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/attribute-name-expression_fn.md @@ -0,0 +1,21 @@ +### **Attribute name expression field** + +The expression that is used to get the name of the requested attribute from the received data. + +### **Examples of data converting** + +Let’s review example of data converting: + +We have a device that measures temperature and humidity. And for example, you want to send a request for a shared attribute that stores the firmware version of the device. To do this, we need to specify exactly where in the message the attribute name is located, the value of which we want to get. + +In our case, let the requested attribute name is “**FirmwareVersion**”. + +Accordingly, the field will contain the following value: + +`[16:]` + +And if the device sends a message with the following payload: + +`myShrAttrRequestFirmwareVersion` + +The connector, according to the configuration above, will take bytes starting from **16** to the **end** (from **0** to **16** is the “**Request expression**”) and send a request to the platform for the dispersed name of the shared attribute. diff --git a/ui-ngx/src/assets/help/en_US/widget/lib/gateway/byte_fn.md b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/byte_fn.md new file mode 100644 index 0000000000..c52861a592 --- /dev/null +++ b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/byte_fn.md @@ -0,0 +1,35 @@ +## Byte field + +The byte field is used to slice received data from the specific index. + +### Examples of data converting + +Let’s review more examples of data converting: +We have a device that measures temperature and humidity. Device has charasteristic that can be +read and when we receive data from her, the data combine temperature and humidity. So, data +from device have the next view:b’\x08<\x08\x00’ and in human readable format:[8, 34](first array +element is temperature and the second is humidity). + +1. We want to read only temperature value + + **“Bytes from”: “0”** + + **“Bytes to”: “1”** + + Data to platform: **8** + +2. We want to read only humidity value + + **“Bytes from”: “1”** + + **“Bytes to”: “-1”** + + Data to platform: **34** + +3. We want to read all values + + **“Bytes from”: “0”** + + **“Bytes to”: “-1”** + + Data to platform:**834** diff --git a/ui-ngx/src/assets/help/en_US/widget/lib/gateway/request-expression_fn.md b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/request-expression_fn.md new file mode 100644 index 0000000000..5f38929c66 --- /dev/null +++ b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/request-expression_fn.md @@ -0,0 +1,21 @@ +### **Request expression field** + +The expression that is used to know if the request from the device is “**Attribute Request**” or not. + +### **Examples of data converting** + +Let’s review example of data converting: + +We have a device that measures temperature and humidity. And for example, you want to send a request for a shared attribute that stores the firmware version of the device. In order for the connector to understand that the received message refers to "**Attribute request**" and not telemetry type, we must specify in the configuration what the message should begin with. + +In our case, let the beginning of the message contain “**myShrAttrRequest**”. + +Accordingly, the field will contain the following value: + +`${[0:16]==myShrAttrRequest}` + +And if the device sends a message with the following payload: + +`myShrAttrRequestFirmwareVersion` + +The connector will take the specified range from 0 to 16 bytes and see that this message belongs to the “**Attribute request**” type.