Skip to content

Commit

Permalink
Merge branch 'staging/3.8' into release/3.8
Browse files Browse the repository at this point in the history
  • Loading branch information
@ashvayka
ashvayka committed Oct 8, 2024
2 parents 4f1f6da + e36cefc commit cdbafea
Show file tree
Hide file tree
Showing 89 changed files with 667 additions and 352 deletions.
0 .../thingsboard-chenge-entity-alias-block.md → .../thingsboard-change-entity-alias-block.md
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion ...ocs/devices-library/blocks/ready-to-go-devices/am308-sensor-check-data-block.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can download a simple dashboard for this device, it is configured to display

{% include /docs/devices-library/blocks/basic/thingsboard-upload-example-dashboard.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/am308-device-dashboard.json" %}

{% include /docs/devices-library/blocks/basic/thingsboard-chenge-entity-alias-block.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/am308-device-dashboard.json" %}
{% include /docs/devices-library/blocks/basic/thingsboard-change-entity-alias-block.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/am308-device-dashboard.json" %}

Example of the dashboard with data:

Expand Down
82 changes: 64 additions & 18 deletions .../blocks/ready-to-go-devices/thingsboard-create-device-efento-transport-block.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,41 @@ Before you add an Efento sensor to the platform you need to create a new Device

{% assign deviceProfileCreationPE = '
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile.png,
title: Log in to your administrator account and navigate to <b>Device profiles</b> section. Click on the <b>+</b> icon in the upper right corner to add a new profile. Select <b>Create new device profile</b>.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile-1-pe.png,
title: Log in to your administrator account and navigate to "Device profiles" page. Click on the "+" icon in the top right corner of the table and then select "Create new device profile" from drop-down menu;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/configure-device-profile-name.png,
title: Fill up the profile name (mandatory) and configure optional settings (Rule chain, Queue Name, Description). Once you are ready press <b>Next: Transport configuration</b> button.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile-2-pe.png,
title: Fill up the profile name (mandatory) and configure optional settings (Rule chain, Queue Name, Description). Once you are ready press "Next: Transport configuration" button;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/device-profile-select-transport.png,
title: From the dropdown menu in the <b>Transport type</b> field select <b>CoAP</b> and from the dropdown menu in <b>CoAP device type</b> field select <b>Efento NB-IoT</b>, press <b>Add</b> button to save.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile-3-pe.png,
title: From the dropdown menu in the "Transport type" field select "CoAP", and from the dropdown menu in "CoAP device type" field select "Efento NB-IoT", click "Add" button to confirm adding new device profile;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/check-device-profile-created.png,
title: Once the profile is ready you will see it on the list in the <b>Device profiles</b> section. If you plan to use your ThingsBoard instance only with Efento sensors you can set the profile as default.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile-4-pe.png,
title: Once the profile is ready you will see it on the list in the "Device profiles" section. If you plan to use your ThingsBoard instance only with Efento sensors you can set the profile as default.
'
%}

{% assign deviceProfileCreationCE = '
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile-1-ce.png,
title: Log in to your administrator account and navigate to "Device profiles" page. Click on the "+" icon in the top right corner of the table and then select "Create new device profile" from drop-down menu;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile-2-ce.png,
title: Fill up the profile name (mandatory) and configure optional settings (Rule chain, Queue Name, Description). Once you are ready press "Next: Transport configuration" button;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile-3-ce.png,
title: From the dropdown menu in the "Transport type" field select "CoAP", and from the dropdown menu in "CoAP device type" field select "Efento NB-IoT", click "Add" button to confirm adding new device profile;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-profile-4-ce.png,
title: Once the profile is ready you will see it on the list in the "Device profiles" section. If you plan to use your ThingsBoard instance only with Efento sensors you can set the profile as default.
'
%}

{% if page.docsPrefix == "pe/" or page.docsPrefix == "paas/" or docsPrefix == "pe/" or docsPrefix == "paas/" %}
{% include images-gallery.liquid showListImageTitles="true" imageCollection=deviceProfileCreationPE %}
{% else %}
{% include images-gallery.liquid showListImageTitles="true" imageCollection=deviceProfileCreationCE %}
{% endif %}

Configuration of the “Alarm rules” and “Device provisioning” tabs is optional.
If you want to learn more about these features please refer to the [documentation](/docs/getting-started-guides/helloworld/){:target="_blank"}.
Expand All @@ -27,20 +47,46 @@ If you want to learn more about these features please refer to the [documentatio

In order to save a data from the sensor we should also create a device on ThingsBoard.

{% assign deviceCreationPE = '
{% assign deviceAddingPE = '
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-1-pe.png,
title: Go to the "Devices" page of the "Entities" section. By default, you navigate to the device group "All". Click on the "+" icon in the top right corner of the table and then select "Add new device" from drop-down menu;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-2-pe.png,
title: Enter the device name. In the "Device profile" field specify the profile you have recently created for Efento sensors. Then, click "Next: Credentials" button;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-3-pe.png,
title: Leave the credential type as "Access token". Set the new access token, which will be used by a sensor to validate in the ThingsBoard platform. Note that the token must be unique for each sensor. Configuration of the token is optional. Click "Add" button to confirm adding new device;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-4-pe.png,
title: A window will open where you can check the device&#39;s connection to ThingsBoard. This step is optional. Close this window;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-5-pe.png,
title: Once added, the device appears in the "All" device group list.
'
%}

{% assign deviceAddingCE = '
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-1-ce.png,
title: Go to the "Devices" page of the "Entities" section. Click on the "+" icon in the top right corner of the table and then select "Add new device" from drop-down menu;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device.png,
title: Go to the <b>Device groups</b> section of ThingsBoard. You can either create a new device group or use the default one (<b>All</b>). Click on the <b>+</b> icon in the upper right corner to add a new device.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-2-ce.png,
title: Enter the device name. In the "Device profile" field specify the profile you have recently created for Efento sensors. Then, click "Next: Credentials" button;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/configure-device-with-transport.png,
title: Name the device, in the <b>Transport type field</b> select <b>CoAP</b>. Choose <b>Select existing profile</b> option and add the profile you have recently created for Efento sensors. Press <b>Next: Credentials</b> button.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-3-ce.png,
title: Leave the credential type as "Access token". Set the new access token, which will be used by a sensor to validate in the ThingsBoard platform. Note that the token must be unique for each sensor. Configuration of the token is optional. Click "Add" button to confirm adding new device;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/configure-device-create-credentials.png,
title: Select <b>Add credential</b> and in the <b>Access token</b> field set the new access token, which will be used by a sensor to validate in the platform. Note that the token must be unique for each sensor. Configuration of the token is optional. Press <b>Add</b> button to save.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-4-ce.png,
title: A window will open where you can check the device&#39;s connection to ThingsBoard. This step is optional. Close this window;
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/check-device-created.png,
title: Once the device is added, it appears within group <b>All</b> list in <b>Device groups</b> section.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/create-device-5-ce.png,
title: Once added, the device appears in the device list.
'
%}

{% include images-gallery.liquid showListImageTitles="true" imageCollection=deviceCreationPE %}
{% if page.docsPrefix == "pe/" or page.docsPrefix == "paas/" or docsPrefix == "pe/" or docsPrefix == "paas/" %}
{% include images-gallery.liquid showListImageTitles="true" imageCollection=deviceAddingPE %}
{% else %}
{% include images-gallery.liquid showListImageTitles="true" imageCollection=deviceAddingCE %}
{% endif %}
21 changes: 20 additions & 1 deletion ...udes/docs/devices-library/blocks/ready-to-go-devices/vs-121-check-data-block.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,26 @@ Download a simple dashboard for this device. It is configured to display a data

{% include /docs/devices-library/blocks/basic/thingsboard-upload-example-dashboard.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/vs-121-sensor-dashboard.json" %}

{% include /docs/devices-library/blocks/basic/thingsboard-chenge-entity-alias-block.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/vs-121-sensor-dashboard.json" %}
To open the imported dashboard, click on it. Then you should specify your device in entity alias of the dashboard.

To do this, follow these steps:

{% assign editAlias = '
===
image: https://img.thingsboard.io/user-guide/dashboards/alias/edit-alias-for-vs-121-sensor-1-pe.png,
title: Open the dashboard and enter edit mode. Click the "Entity aliases" icon, then in the pop-up window click the "Edit alias" icon next to the alias.
===
image: https://img.thingsboard.io/user-guide/dashboards/alias/edit-alias-for-vs-121-sensor-2-pe.png,
title: In edit alias window select your device from dropdown list and save entity alias.
===
image: https://img.thingsboard.io/user-guide/dashboards/alias/edit-alias-for-vs-121-sensor-3-pe.png,
title: Apply all changes.
'
%}

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

Now you should be able to see the data from the device.

Example of the dashboard with data:

Expand Down
21 changes: 16 additions & 5 deletions ...brary/blocks/ready-to-go-devices/wireless-open-close-logger-check-data-block.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
Trigger the transmission in order to check if the device sends the data to your ThingsBoard instance.
Click on the menu (three dots in the upper right corner -> Trigger transmission.
If everything is set correctly, you should see the data in ThingsBoard, to do this:
If everything is set correctly, you should see the data in ThingsBoard. To do this click on the device and the most recent data from the device will be visible in the "Latest telemetry" tab.

{% assign checkEfentoSensorData = '
{% assign checkEfentoSensorDataPE = '
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/check-device-data.png,
title: Click on the device and the most recent data from the device will be visible in the “Latest telemetry” tab.
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/check-device-data-1-pe.png,
title: Click on the device and the most recent data from the device will be visible in the "Latest telemetry" tab.
'
%}

{% include images-gallery.liquid showListImageTitles="false" imageCollection=checkEfentoSensorData %}
{% assign checkEfentoSensorDataCE = '
===
image: https://img.thingsboard.io/devices-library/ready-to-go-devices/wireless-open-close-sensor/check-device-data-1-ce.png,
title: Click on the device and the most recent data from the device will be visible in the "Latest telemetry" tab.
'
%}

{% if page.docsPrefix == "pe/" or page.docsPrefix == "paas/" or docsPrefix == "pe/" or docsPrefix == "paas/" %}
{% include images-gallery.liquid showListImageTitles="false" imageCollection=checkEfentoSensorDataPE %}
{% else %}
{% include images-gallery.liquid showListImageTitles="false" imageCollection=checkEfentoSensorDataCE %}
{% endif %}

{% capture effento-offer %}

Expand Down
2 changes: 1 addition & 1 deletion ...vices-library/blocks/ready-to-go-devices/ws101-smart-button-check-data-block.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can download a simple dashboard for this device, it is configured to display

{% include /docs/devices-library/blocks/basic/thingsboard-upload-example-dashboard.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/ws_101_smart_button.json" %}

{% include /docs/devices-library/blocks/basic/thingsboard-chenge-entity-alias-block.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/ws_101_smart_button.json" %}
{% include /docs/devices-library/blocks/basic/thingsboard-change-entity-alias-block.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/ws_101_smart_button.json" %}

Example of the dashboard with data:

Expand Down
2 changes: 1 addition & 1 deletion ...brary/blocks/ready-to-go-devices/ws202-pir-and-light-sensor-check-data-block.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can download a simple dashboard for this device, it is configured to display

{% include /docs/devices-library/blocks/basic/thingsboard-upload-example-dashboard.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/ws202_pir_and_light_sensor.json" %}

{% include /docs/devices-library/blocks/basic/thingsboard-chenge-entity-alias-block.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/ws202_pir_and_light_sensor.json" %}
{% include /docs/devices-library/blocks/basic/thingsboard-change-entity-alias-block.md exampleDashboardPath="/docs/devices-library/resources/dashboards/ready-to-go-devices/ws202_pir_and_light_sensor.json" %}

Example of the dashboard with data:

Expand Down
16 changes: 13 additions & 3 deletions _includes/docs/mobile/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,15 @@ Determine the Flutter {{appPrefix}} Mobile Application version according to the
</thead>
<tbody>
<tr>
<td>3.6.3+</td>
<td>3.8.0</td>
<td>1.3.0</td>
<td>1.3.0</td>
</tr>
</tr>
<tr>
<td>3.6.3+</td>
<td>1.1.0</td>
<td>1.1.0</td>
</tr>
<tr>
<td>3.6.2+</td>
<td>1.0.8</td>
Expand Down Expand Up @@ -94,10 +99,15 @@ Determine the Flutter {{appPrefix}} Mobile Application version according to the
</thead>
<tbody>
<tr>
<td>3.6.3PE+</td>
<td>3.8.0PE</td>
<td>1.3.0</td>
<td>1.3.0</td>
</tr>
<tr>
<td>3.6.3PE+</td>
<td>1.1.0</td>
<td>1.1.0</td>
</tr>
<tr>
<td>3.6.2PE+</td>
<td>1.0.9</td>
Expand Down
Loading

0 comments on commit cdbafea

Please sign in to comment.