Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
23e9609
update mqtt documentation to the security subsection
Andry925 Oct 16, 2025
e1373fc
update includes pages
Andry925 Oct 16, 2025
f94085d
add new screenshots for mqtt connector
Andry925 Oct 16, 2025
6d12f66
rename mqtt version compatibility section, add screenshot for generat…
Andry925 Oct 16, 2025
5c86dad
update worker settings for mqtt documentation.
Andry925 Oct 16, 2025
c70f13a
rewrite mqtt documentation for security subsection.
Andry925 Oct 22, 2025
99006d5
add new screenshots for mqtt security subsection documentation
Andry925 Oct 22, 2025
fc97560
delete outdated screenshots/md files for mqtt security documentation …
Andry925 Oct 22, 2025
f7a47cc
correct errors inside mqtt documentation, retake some screenshots
Andry925 Oct 23, 2025
f08da73
fix small mistyping in mqtt documentation
Andry925 Oct 23, 2025
ea1b634
write initial data mapping section inside mqtt connector
Andry925 Nov 3, 2025
f8718e4
add screenshots for data mapping section
Andry925 Nov 3, 2025
244f50c
completed the data conversion subsection for the mqtt connector docum…
Andry925 Nov 5, 2025
dd12eff
add screenshots for usage examples and data conversion subsection
Andry925 Nov 5, 2025
b7ea290
finish data mapping section with usage examples
Andry925 Nov 6, 2025
cfd0616
add screenshots for appropriate sections
Andry925 Nov 6, 2025
535171d
delete outdated screenshots and .md files
Andry925 Nov 6, 2025
295b3ca
Write connect request section for mqtt documentation
Andry925 Nov 10, 2025
0e7bad9
add empty .md files for futher request mapping section
Andry925 Nov 10, 2025
5bf0a20
add empty .md files for futher request mapping section
Andry925 Nov 10, 2025
3164c7b
delete old connect request section files
Andry925 Nov 10, 2025
c3ad175
Rewrite disconnect request for mqtt connector
Andry925 Nov 11, 2025
9a88785
Add screenshots for disconnect request subsection
Andry925 Nov 11, 2025
58e83ec
Delete old screenshots
Andry925 Nov 11, 2025
44ad402
write documentation for attribute request subsection
Andry925 Nov 12, 2025
bf13ef5
add screenshots for attribute requests subsection
Andry925 Nov 12, 2025
7c15e6d
implement subsection for attribute updates subsection
Andry925 Nov 12, 2025
5eaec9a
add screenshots for attribute updates
Andry925 Nov 12, 2025
2cd9917
Delete outdated mqtt attribute updates part
Andry925 Nov 12, 2025
4ffb915
implement basic rpc subsection
Andry925 Nov 12, 2025
e88fd92
implement subsection for configurable RPC methods to device
Andry925 Nov 13, 2025
6582781
add screenshots for configurable RPC section
Andry925 Nov 13, 2025
5c5303a
implement documentation section for reserved rpc
Andry925 Nov 13, 2025
3d58a6a
add screenshots for reserved rpc
Andry925 Nov 13, 2025
35ebc3a
remove outdated screenshots
Andry925 Nov 13, 2025
fc11200
rewrite iot gateway features mqtt rpc get/set
Andry925 Nov 13, 2025
e29f520
correct errors in the mqtt documentation
Andry925 Nov 14, 2025
17e667c
Apply requested improvements to MQTT documentation
Andry925 Nov 19, 2025
2c29873
Add improvements to MQTT documentation
Andry925 Nov 19, 2025
108b873
fix errors in the mqtt documentation
Andry925 Nov 21, 2025
aa2be4f
retake screenshots, add note for usage examples.
Andry925 Nov 24, 2025
b375a8a
change screenshots for mqtt rpc's.
Andry925 Nov 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
37 changes: 18 additions & 19 deletions _includes/templates/iot-gateway/get-set-connector-rpc/mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ With the GET method you can subscribe to MQTT topic and receive message from it.
```bash
get requestTopicExpression=<requestTopicExpression>;responseTopicExpression=<responseTopicExpression>;value=<value>;
```
{: .copy-code}

Where:
- `<requestTopicExpression>` - the topic to publish the request;
Expand All @@ -18,54 +19,52 @@ To read the value of the room light level, run this query:
```bash
get requestTopicExpression=data/get_light_level;responseTopicExpression=data/response;value=${params};
```
{: .copy-code}

**Response:**

```json
{"result": {"success":true}}
```
Also, let's take a look at the data received from the MQTT topic **"data/response"**:

{:refdef: style="text-align: left;"}
![image](/images/gateway/get-set-connector-rpc/mqtt-get-set-rpc-1.png)
{: refdef}

Also, let's take a look at the data received from the MQTT topic **"data/response"**:

{:refdef: style="text-align: left;"}
![image](/images/gateway/get-set-connector-rpc/mqtt-get-set-rpc-3.jpeg)
{: refdef}

### SET method

With the SET method you can publish a message to MQTT topic.

```bash
set requestTopicExpression=data/get_light_level;value=${params};
set requestTopicExpression=data/set_light_level;value=${params};
```
{: .copy-code}

Where:
- `<requestTopicExpression>` - the topic to publish request;
- `<value>` - the value to send.

For example, in our case, we know that we can set the value of the room light level to the MQTT topic
**"data/light_level"**. To set the value of the room light level, run the following query:
**"sata/light_level"**. To set the value of the room light level, run the following query:

```bash
set requestTopicExpression=data/set_light_level;value=80;
```
{: .copy-code}

**Response:**

```json
{"result": {"success":true}}
```
On the screenshot below, you can see that we have successfully sent the SET request to the MQTT topic **"data/set_light_level"**:

{:refdef: style="text-align: left;"}
![image](/images/gateway/get-set-connector-rpc/mqtt-get-set-rpc-2.png)
{: refdef}

Also, let's take a look at the result in the **"data/light_level"** MQTT topic:
Also, let's take a look at the result after SET method in the **"data/light_level"** MQTT topic by sending Two way GET RPC request.
To read the value of the room light level to make sure the room light level is really updated, run this query:

```bash
get requestTopicExpression=data/get_light_level;responseTopicExpression=data/response;value=${params};
```
{: .copy-code}

On the screenshot below, you can see that the room light level value is updated to 80 after the SET request:

{:refdef: style="text-align: left;"}
![image](/images/gateway/get-set-connector-rpc/mqtt-get-set-rpc-4.jpeg)
![image](/images/gateway/get-set-connector-rpc/mqtt-get-set-rpc-3.png)
{: refdef}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
To adding new requests mapping, navigate to the "Requests mapping" tab and click the "plus" icon.
In the open modal window, select the "Attribute request" type, set a topic filter. Fill in the fields of the "Input request parsing" and "Output request parsing" sections. Then, click "Add".
In order to add new attribute request mapping, follow these steps:

![image](/images/gateway/mqtt-connector/attribute-request-1-ce.png)
{% assign AttributesRequest = '
===
image: /images/gateway/mqtt-connector/mqtt-gateway-configuring-11-ce.png,
title: Click the "**Add mapping**" under "**Requests mapping**" section to add new attribute request mapping.
===
image: /images/gateway/mqtt-connector/mqtt-attribute-requests-1.png,
title: Select "**Attribute request**" in the **Request type** field, enter the "**Topic filter**"
===
image: /images/gateway/mqtt-connector/mqtt-attribute-requests-2.png,
title: Configure the **Device name expression**, **Response topic expression**, and **Attribute name expression** fields.
Select the source type for each field (`Message`, `Topic`, or `Constant`) and enter the corresponding values.
You can also set the **Retain** option to determine whether the attribute response message should be retained by the MQTT broker.
'
%}

{% include images-gallery.liquid showListImageTitles="true" imageCollection=AttributesRequest %}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
To adding new requests mapping, navigate to the "Requests mapping" tab and click the "plus" icon.
In the open modal window, select the "Attribute update" type, and set a device name filter, attribute filter, response value expression, and response topic expression. Then, click “Add”.
In order to add new attribute update mapping, follow these steps:

![image](/images/gateway/mqtt-connector/attribute-updates-example-basic-1-ce.png)
{% assign AttributesUpdate = '
===
image: /images/gateway/mqtt-connector/mqtt-gateway-configuring-11-ce.png,
title: Click the "**Add mapping**" under "**Requests mapping**" section to add new attribute request mapping.
===
image: /images/gateway/mqtt-connector/mqtt-attribute-updates-1.png,
title: Select "**Attribute update**" in the **Request type** field, enter the "**Device name filter**"
===
image: /images/gateway/mqtt-connector/mqtt-attribute-updates-2.png,
title: Configure the **Attribute filter**, **Response value expression**, and **Response topic expression** fields.
You can also set the **Retain** option to determine whether the attribute response message should be retained by the MQTT broker.
'
%}

{% include images-gallery.liquid showListImageTitles="true" imageCollection=AttributesUpdate %}

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading