Skip to content
This repository was archived by the owner on May 22, 2026. It is now read-only.

Commit 612edcf

Browse files
committed
Merge with master
2 parents 7ad743b + cd8040b commit 612edcf

67 files changed

Lines changed: 358 additions & 203 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_includes/docs/user-guide/attributes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ The user may change the attribute via UI. The script or other server-side applic
138138

139139
#### Administration UI
140140

141-
{% include images-gallery.html imageCollection="shared-attrs-ui" %}
141+
{% include images-gallery.html imageCollection="shared-attrs-ui" showListImageTitles="true" %}
142142

143143
{% include templates/info-banner.md content=bulk_provisioning %}
144144

_includes/docs/user-guide/ui/devices.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,17 @@ Tenant administrators and users with appropriate permissions can create, edit, o
3636
### Adding new device
3737

3838
To add a new device:
39-
- Navigate to **Entities** ⟶ **Devices**. {% unless docsPrefix == null %}By default, you will see the "**All**" asset group.{% endunless %}
39+
- Navigate to **Entities** ⟶ **Devices**. {% unless docsPrefix == null %}By default, you will see the "**All**" device group.{% endunless %}
4040
- Click the "**+**" icon in the upper-right corner and select "**Add new device**" from drop-down menu.
4141
- In the device creation form, fill in the required fields:
4242
- **Name** – a unique name for the device.
4343
- **[Device profile](/docs/{{docsPrefix}}user-guide/device-profiles/){:target="_blank"}** – by default, the profile is set to "**default**", but you can choose a different profile if needed.
44-
- Optional fields such as label or description can be filled in if needed.
44+
{% if (docsPrefix == "pe/") or (docsPrefix == "paas/") or (docsPrefix == "paas/eu/") %}
45+
- **Owner and groups:** Helps with organization and access control.
46+
- **Owner**: Select the owner from the dropdown list. The device will be created at that owner’s level. By default, the field is pre-filled with the Customer or Tenant name based on where you add the device. You can change it before confirming adding.
47+
- **Groups**: Optional field. Add the device to existing device groups or create a new one at the selected owner level. Note: every device is automatically added to the "**All**" group of that owner.
48+
{% endif %}
49+
- Optional fields such as **Label** or **Description** can be filled in if needed.
4550
- Click "**Add**".
4651

4752
Device successfully created and is now available in the list.
@@ -162,6 +167,11 @@ On the "<b>Devices</b>" page there is an option "<b>Include customer entities</b
162167

163168
{% include images-gallery.html imageCollection="include-customer-entities" showListImageTitles="true" %}
164169

170+
## Share device
171+
You can share devices by adding them to a device group and then sharing the group with a customer.
172+
173+
For detailed instructions, please see the section on how to [Share device group](#share-device-group).
174+
165175
{% endif %}
166176

167177
{% unless docsPrefix == null %}
@@ -189,7 +199,7 @@ To make the group private again, follow the same steps using the "**Make private
189199

190200
## Share device group
191201

192-
You can share an device group with one or more customers. This is useful, for example, when multiple customers need access to the same device.
202+
You can share a device group with one or more customers. This is useful, for example, when multiple customers need access to the same device.
193203

194204
> You cannot share an individual device — only the device group that contains it.
195205
@@ -201,6 +211,23 @@ To share an device group:
201211
- Confirm the action by clicking "**Share**".
202212

203213
{% include images-gallery.html imageCollection="share-device-group" %}
214+
215+
**Managing and Verifying Permissions**
216+
217+
After a device group has been shared, you can view, edit, or revoke permissions at any time.
218+
219+
1. From the "Device groups" list, click on the pencil button of the desired group to open the "Entity group details".
220+
221+
2. Navigate to the Permissions tab.
222+
223+
3. On this tab, you will see a complete list of all permissions granted for this group. Here you can:
224+
225+
- **Add** a new permission: Click the "+" icon in the top right corner of the panel. A dialog window will appear where you can select a role and a user group to grant access to.
226+
227+
- **Edit** an existing permission: Click the pencil icon next to the permission you want to modify.
228+
229+
- **Delete** a permission: Click the trash can icon to remove access for that user group.
230+
204231
{% endunless %}
205232

206233
## Device details

_includes/docs/user-guide/widgets.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -409,19 +409,19 @@ In the legend settings, you can:
409409

410410
The legend displays a label for each [data key](/docs/{{docsPrefix}}user-guide/widgets/#data-keys). When a widget contains data from multiple devices, or when several devices use the same data key name (for example, temperature), it may be difficult to determine which key value corresponds to which device in the legend or tooltip.
411411

412-
To make the legend or tooltip clearer, you should use <b>${entityName}</b> or <b>${entityLabel}</b> in the data key configuration.
412+
To make the legend clearer, you should use **${entityName}** or **${entityLabel}** in the **Label** field of the data key configuration.
413413

414-
- <b>${entityName}</b> – a variable that automatically inserts the system name of the entity in the legend or tooltip. This helps clearly identify the object, especially when its technical name or unique identifier is important.
415-
Example: If a device has the name <b>sensor-101</b>, then in the field where <b>${entityName}</b> is used, you will see <b>sensor-101</b>.
414+
- **${entityName}** – a variable that automatically inserts the system name of the entity in the legend. This helps clearly identify the object, especially when its technical name or unique identifier is important.
415+
Example: If a device has the name **sensor-101**, then in the field where **${entityName}** is used, you will see **sensor-101**.
416416

417417
{% include images-gallery.html imageCollection="entity-name-legend" %}
418418

419-
- <b>${entityLabel}</b> – a variable that inserts the entity&#39;s label in the legend or tooltip.. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.
419+
- **${entityLabel}** – a variable that inserts the entity's label in the legend. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.
420420
Example: A device has:
421-
- <b>Name</b> = <b>sensor-101</b>
422-
- <b>Label</b> = <b>Temperature Sensor, Warehouse #1</b>
421+
- **Name** = **sensor-101**
422+
- **Label** = **Temperature Sensor, Warehouse #1**
423423

424-
In the field where <b>${entityLabel}</b> is used, the operator will see the more understandable text: <b>Temperature Sensor, Warehouse #1</b>.
424+
In the field where **${entityLabel}** is used, the operator will see the more understandable text: **Temperature Sensor, Warehouse #1**.
425425

426426
{% include images-gallery.html imageCollection="entity-label-legend" %}
427427

@@ -466,7 +466,23 @@ You can change the appearance of the chart grid: customize the color of the back
466466

467467
- **Show cumulative values in stacking mode**. While stacking mode is on, you can check the box "Cumulative values" to enable your chart to display sum of all entity values.
468468

469-
**Tooltip value format function, f(value, latestData)** is used when you want to manually customize the tooltip.
469+
Tooltip value format function, **f(value, latestData)** is used when you want to manually customize the tooltip.
470+
471+
To make the tooltip clearer, you should use **${entityName}** or **${entityLabel}** in the **Label** field of the data key configuration.
472+
473+
- **${entityName}** – a variable that automatically inserts the system name of the entity in the tooltip. This helps clearly identify the object, especially when its technical name or unique identifier is important.
474+
Example: If a device has the name **Sensor 1**, then in the field where **${entityName}** is used, you will see **Sensor 1**.
475+
476+
{% include images-gallery.html imageCollection="entity-name-tooltip" %}
477+
478+
- **${entityLabel}** – a variable that inserts the entity's label in the tooltip. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.
479+
Example: A device has:
480+
- **Name** = **Sensor 1**
481+
- **Label** = **Sensor 1 Label**
482+
483+
In the field where **${entityLabel}** is used, the operator will see the more understandable text: **Sensor 1 Label**.
484+
485+
{% include images-gallery.html imageCollection="entity-label-tooltip" %}
470486

471487
You can customize the values that will be displayed in the tooltip via tooltip settings or
472488
[Advanced Data key configuration](/docs/{{docsPrefix}}user-guide/ui/advanced-data-key-configuration/#tooltip-settings){:target="_blank"}.

docs/paas/eu/user-guide/attributes.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@ title: Working with IoT device attributes
66
description: IoT device management using ThingsBoard attributes feature
77
server-side-attrs-ui:
88
0:
9-
image: https://img.thingsboard.io/user-guide/attributes/add-server-side-pe-src.png
10-
title: 'Select Device Group. Click on the particular device row to open device details. Select "Attributes" tab. Choose "Server attributes" scope. Click "+" Icon.'
9+
image: /images/user-guide/attributes/add-server-side-pe-src.png
10+
title: 'Go to Entities → Devices and open the device you want to edit by clicking its row. In the device details, open the "Attributes" tab, select the "Server attributes" scope, and click the "+" icon to add a new attribute.'
1111
1:
12-
image: https://img.thingsboard.io/user-guide/attributes/add-server-side-pe2-src.png
13-
title: 'Input new attribute name. Select attribute value type and input attribute value.'
12+
image: /images/user-guide/attributes/add-server-side-pe2-src.png
13+
title: 'In the dialog, enter the attribute key, select the value type (for example, String), and provide a value.'
1414
2:
15-
image: https://img.thingsboard.io/user-guide/attributes/add-server-side-pe3-src.png
16-
title: 'Sort using "Last update time" to quickly locate the newly created attribute.'
15+
image: /images/user-guide/attributes/add-server-side-pe3-src.png
16+
title: 'After saving, the new attribute appears in the list with its key, value, and last update time. Sort using "Last update time" to quickly locate the newly created attribute.'
1717

1818
shared-attrs-ui:
1919
0:
20-
image: https://img.thingsboard.io/user-guide/attributes/add-shared-pe-src.png
21-
title: 'Select Device Group. Click on the particular device row to open device details. Select "Attributes" tab. Choose "Shared attributes" scope. Click "+" Icon.'
20+
image: /images/user-guide/attributes/add-shared-pe-src.png
21+
title: 'Go to Entities → Devices and open the device you want to edit by clicking its row. In the device details, open the "Attributes" tab, select the "Shared attributes" scope, and click the "+" icon to add a new attribute.'
2222
1:
23-
image: https://img.thingsboard.io/user-guide/attributes/add-shared-pe2-src.png
24-
title: 'Input new attribute name. Select attribute value type and input attribute value.'
23+
image: /images/user-guide/attributes/add-shared-pe2-src.png
24+
title: 'In the dialog, enter the attribute key, select the value type (for example, Double), and provide a value.'
2525
2:
26-
image: https://img.thingsboard.io/user-guide/attributes/add-shared-pe3-src.png
27-
title: 'Observe the new attribute.'
26+
image: /images/user-guide/attributes/add-shared-pe3-src.png
27+
title: 'After saving, the new attribute appears in the list with its key, value, and last update time.'
2828

2929
---
3030

docs/paas/eu/user-guide/widgets.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,34 @@ entity-label-legend:
364364
image: https://img.thingsboard.io/user-guide/widgets/overview/appearance/entity-label-legend-3-pe.png
365365
title: 'Now, each key includes a human-readable label of the device it belongs to.'
366366

367+
entity-name-tooltip:
368+
0:
369+
image: /images/user-guide/widgets/overview/appearance/tooltipName-before-configuration-PE.png
370+
title: 'When a widget contains data from multiple devices, or when several devices use the same data key name, it may be difficult to determine which key value corresponds to which device in the tooltip.'
371+
1:
372+
image: /images/user-guide/widgets/overview/appearance/tooltipName-configuration-1-PE.png
373+
title: 'Open the data key configuration.'
374+
2:
375+
image: /images/user-guide/widgets/overview/appearance/tooltipName-configuration-2-PE.png
376+
title: 'Use the <b>${entityName}</b> variable in the key label, which automatically inserts the system name of the entity. This helps clearly identify the object, especially when its technical name or unique identifier is important.'
377+
3:
378+
image: /images/user-guide/widgets/overview/appearance/tooltipName-configuration-3-PE.png
379+
title: 'Use this variable for other data keys as well.'
380+
4:
381+
image: /images/user-guide/widgets/overview/appearance/tooltipName-after-configuration-PE.png
382+
title: 'Now, each key includes the name of the device it belongs to.'
383+
384+
entity-label-tooltip:
385+
0:
386+
image: /images/user-guide/widgets/overview/appearance/tooltipLabel-configuration-1-PE.png
387+
title: 'Use the <b>${entityLabel}</b> variable in the key label, that inserts the entity&#39;s label in the tooltip. This is often used as a human-readable label and allows you to display a more descriptive name of the device or entity.'
388+
1:
389+
image: /images/user-guide/widgets/overview/appearance/tooltipLabel-configuration-2-PE.png
390+
title: 'Use this variable for other data keys as well.'
391+
2:
392+
image: /images/user-guide/widgets/overview/appearance/tooltipLabel-after-configuration-PE.png
393+
title: 'Now, each key includes a human-readable label of the device it belongs to.'
394+
367395
appearance-vertical-axis:
368396
0:
369397
image: https://img.thingsboard.io/user-guide/widgets/overview/appearance/appearance-vertical-axis-1-pe.png

docs/paas/user-guide/attributes.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@ title: Working with IoT device attributes
66
description: IoT device management using ThingsBoard attributes feature
77
server-side-attrs-ui:
88
0:
9-
image: https://img.thingsboard.io/user-guide/attributes/add-server-side-pe-src.png
10-
title: 'Select Device Group. Click on the particular device row to open device details. Select "Attributes" tab. Choose "Server attributes" scope. Click "+" Icon.'
9+
image: /images/user-guide/attributes/add-server-side-pe-src.png
10+
title: 'Go to Entities → Devices and open the device you want to edit by clicking its row. In the device details, open the "Attributes" tab, select the "Server attributes" scope, and click the "+" icon to add a new attribute.'
1111
1:
12-
image: https://img.thingsboard.io/user-guide/attributes/add-server-side-pe2-src.png
13-
title: 'Input new attribute name. Select attribute value type and input attribute value.'
12+
image: /images/user-guide/attributes/add-server-side-pe2-src.png
13+
title: 'In the dialog, enter the attribute key, select the value type (for example, String), and provide a value.'
1414
2:
15-
image: https://img.thingsboard.io/user-guide/attributes/add-server-side-pe3-src.png
16-
title: 'Sort using "Last update time" to quickly locate the newly created attribute.'
15+
image: /images/user-guide/attributes/add-server-side-pe3-src.png
16+
title: 'After saving, the new attribute appears in the list with its key, value, and last update time. Sort using "Last update time" to quickly locate the newly created attribute.'
1717

1818
shared-attrs-ui:
1919
0:
20-
image: https://img.thingsboard.io/user-guide/attributes/add-shared-pe-src.png
21-
title: 'Select Device Group. Click on the particular device row to open device details. Select "Attributes" tab. Choose "Shared attributes" scope. Click "+" Icon.'
20+
image: /images/user-guide/attributes/add-shared-pe-src.png
21+
title: 'Go to Entities → Devices and open the device you want to edit by clicking its row. In the device details, open the "Attributes" tab, select the "Shared attributes" scope, and click the "+" icon to add a new attribute.'
2222
1:
23-
image: https://img.thingsboard.io/user-guide/attributes/add-shared-pe2-src.png
24-
title: 'Input new attribute name. Select attribute value type and input attribute value.'
23+
image: /images/user-guide/attributes/add-shared-pe2-src.png
24+
title: 'In the dialog, enter the attribute key, select the value type (for example, Double), and provide a value.'
2525
2:
26-
image: https://img.thingsboard.io/user-guide/attributes/add-shared-pe3-src.png
27-
title: 'Observe the new attribute.'
26+
image: /images/user-guide/attributes/add-shared-pe3-src.png
27+
title: 'After saving, the new attribute appears in the list with its key, value, and last update time.'
2828

2929
---
3030

0 commit comments

Comments
 (0)