Welcome to the second part of our tutorial series!
If you missed part one, we covered the basics, including getting familiar with assets and devices, adding a dashboard, and adding your first widget.
It’s highly recommended that you check out lesson 1 if you haven’t already.
In this lesson, we’ll continue to develop our project. We will add states for buildings and offices, and implement navigation between them.
We will also continue adding widgets, including one that visualizes the placement of devices on the office plan. Let’s get started.
Adding building and office states
Dashboard states allow you to create a multi-level hierarchy within your dashboard. Think of each state as a separate page.
For instance, each building, office, and device can have its own state. We already have a default (“Buildings”) state that shows a list of buildings and their locations on a map.
We need to add a few more states to our dashboard: “building”, “office”, and individual states for each device.
In this lesson, we will focus on adding and configuring states for buildings and offices. Device states will be added in the next lesson.
Adding a state for a building
To add a new state, follow these steps:
Open the dashboard and enter its editing mode;
Click on the "Manage dashboard states" icon in the upper-left corner;
In the dialog that opens, you'll see the default state. Click the "plus" icon to add a new state;
Use ${entityName} as the name of the dashboard state. This way, during the action, you will transition to a state named after the entity involved in the action. Also change the state ID to "building". Click "Add".
Open the dashboard and enter its editing mode;
Click on the "Manage dashboard states" icon in the upper-left corner;
In the dialog that opens, you'll see the default state. Click the "plus" icon to add a new state;
Use ${entityName} as the name of the dashboard state. This way, during the action, you will transition to a state named after the entity involved in the action. Also change the state ID to "building". Click "Add".
Adding a state for an office
Repeat the steps to add a state for the office:
Click the "plus" icon again;
Again, use ${entityName} as the name of the dashboard state. Change the state ID to "office". Click "Add";
You will now see a list that includes the root state and the newly created ones. Once both states are added, click "Save" to apply your changes.
Click the "plus" icon again;
Again, use ${entityName} as the name of the dashboard state. Change the state ID to "office". Click "Add";
You will now see a list that includes the root state and the newly created ones. Once both states are added, click "Save" to apply your changes.
Now that the new states have been added, let’s set up navigation between them and the default state.
Building’s state
The state of the selected building will display complete information about it.
You will be able to view details such as the building’s address, contact information of the person responsible for leasing inquiries in this building, as well as a list of your offices in this building.
Instead of creating separate dashboard settings for each building, we will configure a single “building” state.
Each time you select a different building, the widgets will automatically fetch and display data related to that building, thanks to the “Entity from dashboard state” alias.
Let’s see how this works.
Navigation between default and building states
Navigation between states will be implemented using the action function.
The action function can be used to transition to a new state of the dashboard, navigate between dashboards, link to an external resource represented by a URL, or perform other user-configurable actions.
Adding an action for the map widget
We will add the ability to transition to the state of the selected building via a tooltip when clicking on the building marker in the OpenStreet Map widget.
For this, use the “Navigate to new dashboard state” action. Let’s get started:
While in dashboard editing mode, click on the “pencil” icon of the map widget to enter its editing mode;
Navigate to the “Actions” tab and click the “plus” icon to add an action;
Select “Tooltip tag action” as the action source, name it “building_details”, set the action type to “Navigate to new dashboard state” and specify “building” state as “Target dashboard state”. Click “Add”;
Now in the “Actions” window, you can see the configured action. All that’s left is to add the “Details” line to the popup menu for transitioning to the new state.
While on the main state in the editing mode, click on the "pencil" icon of the map widget to enter its editing mode;
Navigate to the "Actions" tab and click the "plus" icon to add an action;
Select "Tooltip tag action" as action source, name it "building_details", set the action type to "Navigate to new dashboard state" and specify "building" state as "Target dashboard state". Click "Add"
Now in the "Actions" window, you can see the configured action. Now, all that's left is to add the "Details" line to the popup menu for transitioning to the new state. Navigate to the "Appearance" tab;
Navigate to the “Appearance” tab, find the “Tooltip” section and add the following lines to the end of the existing tooltip before the ; sign:
Ensure that the name of the created action matches the name specified in the function.
Save the changes to the widget and the dashboard;
In the "Appearance" tab, find the "Tooltip" section and add a lines taken from the documentation to the existing tooltip before the ";" sign. Apply the widget settings;
Save the dashboard.
Now, when you click on any building marker of the map widget, a tooltip with “Details” line will appear. Clicking on it will navigate you to the state of the selected building.
Now, when you click on any building marker of the map widget, a tooltip with “Details” line will appear. Clicking on it will navigate you to the state of the selected building.
You will navigate to the state of the selected building.
Adding an action for the “Buildings list” widget
Now let’s add the action for the “Buildings list” widget so that clicking on a building name takes you to its state.
Go back to the default state of the dashboard by clicking the "Buildings" in the top-left corner;
Enter the editing mode of the dashboard;
Click the "pencil" icon of the "Buildings list" widget to enter its editing mode;
Scroll down to the "Actions" section of the menu and click "Add action";
In the "Actions" window, click the "plus" icon in the upper-right corner to open the "Add action" dialog box;
In the dialog, select "On row click" as the action source and give the action name. Choose "Navigate to new dashboard state" as action type. A dropdown menu for selecting the target dashboard state will appear. Choose the "building" state. Afterwards, click "Add";
Review the configured action in the "Actions" window to ensure the source and type are correct, then click "Save";
Click "Apply" to save the widget settings;
Save the dashboard by clicking "Save" in the upper-right corner of the dashboard page.
Go back to the default state of the dashboard by clicking the "Buildings" in the top-left corner;
Enter the editing mode of the dashboard;
Click the "pencil" icon of the "Buildings list" widget to enter its editing mode;
Scroll down to the "Actions" section of the menu and click "Add action";
In the "Actions" window, click the "plus" icon in the upper-right corner to open the "Add action" dialog box;
In the dialog, select "On row click" as the action source and give the action name. Choose "Navigate to new dashboard state" as action type. A dropdown menu for selecting the target dashboard state will appear. Choose the "building" state. Afterwards, click "Add";
Review the configured action in the "Actions" window to ensure the source and type are correct, then click "Save";
Click "Apply" to save the widget settings;
Save the dashboard by clicking "Save" in the upper-right corner of the dashboard page.
Transition to the “Building A” state by selecting the corresponding building in the “Buildings list” widget:
In the "Buildings List" widget, click on the "Building A" row;
You have been moved to the "Building A" state.
In the "Buildings List" widget, click on the "Building A" row;
You have been moved to the "Building A" state.
To go to the “Building B” state:
Similarly, click on the "Building B" row to navigate to its state;
You will be moved to the state of "Building B". By using ${entityName}, the state is automatically named after the entity that participated in the action.
Similarly, click on the "Building B" row to navigate to its state;
You will be moved to the state of "Building B". By using ${entityName}, the state is automatically named after the entity that participated in the action.
Adding a background image for the building state
Let’s add a background image for the new state to make it visually more attractive. You can use the image from this tutorial or upload your own image.
Switch to the "building" state and enter the dashboard editing mode.Click the "Manage layouts" button in the upper-left corner of the dashboard toolbar;
In the small window that opens, click the "gear" icon to open layout settings;
Find the "Background image" section and click "Browse from gallery";
Upload Your Image by clicking the "Upload image" button in the top-right corner of the window that opens;
Drop an image in the appropriate field, or upload it from a folder on your computer. Then, click "Upload";
Apply changes by clicking the "Save" button in the lower-right corner;
Click "Save" in the bottom-right corner of the dialog box;
Make sure that the background of the "building" state has been successfully updated. Save the dashboard.
Switch to the "building" state and enter the dashboard editing mode.Click the "Manage layouts" button in the upper-left corner of the dashboard toolbar;
In the small window that opens, click the "gear" icon to open layout settings;
Find the "Background image" section and click "Browse from gallery";
Upload Your Image by clicking the "Upload image" button in the top-right corner of the window that opens;
Drop an image in the appropriate field, or upload it from a folder on your computer. Then, click "Upload";
Apply changes by clicking the "Save" button in the lower-right corner;
Click "Save" in the bottom-right corner of the dialog box;
Make sure that the background of the "building" state has been successfully updated. Save the dashboard.
Now let’s move on to adding widgets to the “building” state.
Adding information card about building
The first widget we’ll add to the “building” state is a card that displays information about the selected building. It will include the building’s address, contact person, phone number, and email address.
Click the large “Add new widget” icon in the center of the screen;
Select the “Markdown/HTML Card” from the “Cards” widgets bundle;
Now we need to add an alias to define the entities from which the data will be extracted. In the “Alias” field, enter a name for it - “Selected entity”, and click “Create a new one”;
Specify a filter type - “Entity from dashboard state”, and click the “Add”;
Add data keys such as “address”, “contactPerson”, “email”, and “phone”;
Navigate to the “Appearance” tab. Turn on the “Use markdown/HTML value function” option;
Add the Markdown/HTML value function to the appropriate window by taking it from the documentation:
Navigate to the “Widget card” tab, disable “Enable fullscreen” and “Enable data export” options, and then click “Add” to confirm adding the widget.
We have added information card about the building. Resize the widget to your liking.
Open your dashboard and enter edit mode;
Click the "+ Add widget" button at the top of the screen;
Find the "Cards" widgets bundle and click on it;
Select the "Markdown/HTML Card" widget;
Now we need to add an alias to define the entities from which the data will be extracted. In the "Alias" field, enter a name for it - "Selected entity", and click "Create a new one";
Specify a filter type - "Entity from dashboard state", and click the "Add";
Add data keys such as "address", "contactPerson", "email", and "phone";
Navigate to the "Appearance" tab. Turn on the "Use markdown/HTML value function" option, and fill in the "Use markdown/HTML value function" and "Markdown/HTML CSS" sections using the values from the documentation;
Navigate to the "Widget card" tab, turn off "Enable fullscreen" and "Enable data export" options, and then click "Add" to confirm adding the widget;
We have added an information card about the building. Resize the widget to your liking, and save the dashboard.
Map widget
Next, we will add a map widget that will display only the selected building. In a previous lesson, we added a similar widget that displays all our buildings on the map.
ThingsBoard allows copying widgets, so let’s add the map widget by copying and pasting.
Return to the default state of your dashboard where the original map widget is located;
Enter the dashboard editing mode;
Copy the map widget: right-click on the map widget and select “Copy” from the context menu;
Go to the building state;
Paste the map widget: right-click on the dashboard area and select “Paste” to place the copied widget on the dashboard.
Return to the default state of your dashboard where the original map widget is located. Enter dashboard editing mode by clicking the "Edit mode" button on the toolbar on the right;
Copy the map widget: right-click on the map widget and select “Copy” from the context menu;
Go to the building state. Paste the map widget: right-click on the dashboard area and select “Paste” to place the copied widget on the dashboard;
Now, we should change the data source to display only the selected building:
Click the “pencil” icon on the map widget to open its settings;
Change the data source to the “Selected entity” alias to focus the map on the selected building;
Go to the “Appearance” tab, find the “Tooltip” section, and delete the code fragment as shown in the screenshot. Confirm all changes;
Place the widget in the upper-right corner of the dashboard and adjust its size. Save the dashboard by clicking “Save”.
Now, we should change the data source to display only the selected building. Click the “pencil” icon on the map widget to open its settings;
Change the data source to the "Selected entity" alias to focus the map on the selected building;
Go to the "Appearance" tab, find the "Tooltip" section, and delete the code fragment from the tooltip function as shown in the screenshot. Confirm all changes;
Place the widget in the upper-right corner of the dashboard and adjust its size. Save the dashboard by clicking "Save".
In the “Building list” widget, click on the row of any building to transition to its state.
In the "Building list" widget, click on the row of any building to transition to its state;
Building A's state
Offices list widget
Next, we will add a widget to display the list of offices in the selected building. It will be a table that, in addition to listing the offices, displays the floor each office is located on and the contact person's phone number.
Adding the necessary attributes
Information about the floor and the contact phone number should be added as attributes for each office.
Additionally, as attributes, we will add information such as the office manager's first and last name, and office email, which will be used later in another widget.
Go to the "Assets" page and click on the "Office A" to open its details. Navigate to the "Attributes" tab and click the "plus" icon to add a new attribute;
Enter "floor" as the key name, select "Integer" as the value type, and input the floor number. Click "Add".
Go to the "Assets" page and click on the "Office A" to open its details. Navigate to the "Attributes" tab and click the "plus" icon to add a new attribute;
Enter "floor" as the key name, select "Integer" as the value type, and input the floor number. Click "Add".
Similarly, add the “phone”, “email”, and “officeManager” attributes.
After adding these attributes for both offices, your attributes list for each office should look like this:
Similarly, add the "phone", "email", "address", and "officeManager" attributes. After adding these attributes, your attributes list for "Office A" should look like this.
After adding attributes, your attributes list for "Office B" should look like this.
Use the values for the attributes from the table below:
Now let’s add the widget itself, which will display the list of offices. In this widget, we will use the “Asset search query” alias type.
This alias allows displaying assets of specified asset types (asset profiles) up to a specified level that are linked to the root entity. In our case, the root entity is the selected building.
Return to our dashboard, and navigate to the "building" state for either Office A or Office B. Enter dashboard editing mode, and click the "+ Add widget";
Select the "Entities table" widget from the "Tables" widgets bundle;
Now we need to add an alias to define the entities from which the data will be extracted. In the "Alias" field, enter a name for it - "Building offices", and click "Create a new one";
We will use the "Asset search query" alias type, turn on the "Use dashboard state entity as root" option, set "Max relation level" to 1, relation type to "Contains," and specify "office" asset type. Finally, click "Add";
Add the "floor" and "phone" data keys;
Change the card title to "Offices list", uncheck all buttons except "Search" in the "Show card buttons" section, and click "Add";
Move the widget to an empty space and resize it. After that, save the dashboard.
Return to our dashboard, and navigate to the "building" state for either Office A or Office B. Enter dashboard editing mode, and click the "+ Add widget";
Select the "Entities table" widget from the "Tables" widgets bundle;
Now we need to add an alias to define the entities from which the data will be extracted. In the "Alias" field, enter a name for it - "Building offices", and click "Create a new one";
We will use the "Asset search query" alias type, turn on the "Use dashboard state entity as root" option, set "Max relation level" to 1, relation type to "Contains," and specify "office" asset type. Finally, click "Add";
Add the "floor" and "phone" data keys;
Change the card title to "Offices list", uncheck all buttons except "Search" in the "Show card buttons" section, and click "Add";
Move the widget to an empty space and resize it. After that, save the dashboard.
The configured “building” state should look like this:
The building state should look like this.
Office’s state
By transitioning to the state of the selected office, you will access the contact information of the person responsible for the office, see a list of all devices in the office and their main telemetry readings, as well as see the office plan and the placement of devices on it.
Navigation between the building and office states
Let’s set up the ability to transition to the “office” state by clicking on the row with its name in the “Offices list” widget. Use the “Navigation to dashboard state” action here as well.
Enter dashboard editing mode, and click the "pencil" icon on the "Offices list" widget to start editing it;
Scroll to the "Actions" section of the menu and click "Add action";
In the "Actions" window, click the "plus" icon in the upper-right corner to bring up the "Add action" dialog box;
In the "Add action" dialog, select "On row click" as the action source and enter the action name. Choose "Navigate to new dashboard state" as the action type. A dropdown menu will appear for selecting the target dashboard state. Choose the "office" state. Afterwards, click "Add";
Review the configured action in the "Actions" window to ensure the source and type are correct, then click "Save";
Click "Apply" to save the widget settings;
Save the dashboard by clicking "Save" in the upper-right corner of the dashboard page.
Enter dashboard editing mode, and click the "pencil" icon on the "Offices list" widget to start editing it;
Scroll to the "Actions" section of the menu and click "Add action";
In the "Actions" window, click the "plus" icon in the upper-right corner to bring up the "Add action" dialog box;
In the "Add action" dialog, select "On row click" as the action source and enter the action name. Choose "Navigate to new dashboard state" as the action type. A dropdown menu will appear for selecting the target dashboard state. Choose the "office" state. Afterwards, click "Add";
Review the configured action in the "Actions" window to ensure the source and type are correct, then click "Save";
Click "Apply" to save the widget settings;
Save the dashboard by clicking "Save" in the upper-right corner of the dashboard page.
Navigate to the “Office A” state by selecting the appropriate office in the “Offices list” widget:
Click on the "Office A" row in the "Offices list" widget;
You have navigated to the "Office A" state.
Click on the "Office A" row in the "Offices list" widget;
You have navigated to the "Office A" state.
Add a background image for this state. You already know how to do it. Use the image from this tutorial or upload your own image.
Add a background image for office state.
Adding information card about office
Let’s add a widget card that will display contact information about the selected office, such as the building address, contact person, phone number, and email address.
Click the large “Add new widget” icon in the center of the screen;
Select the “Markdown/HTML Card” from the “Cards” widgets bundle;
Specify the “Selected entity” alias as the data source;
Add the following data keys: “floor”, “officeManager”, “email”, and “phone”;
We need to add another alias to extract the building address. Click “Add datasource”. Input “Entity with relation to dashboard state (asset)” as alias name. Then, click “Create a new one!”;
Specify “Relation type” as filter type. Turn on “Use dashboard state entity as root” option. Set the direction to “To”, and maximum relation level to “1”. Add a relation filter: set “Contains” as relation type, and “Asset” as entity type. Then, click “Add”;
Add “Address” to the data keys row;
Navigate to the “Appearance” tab. Turn on “Use markdown/HTML value function” option;
Add the markdown/HTML value function to the appropriate window by taking it from the documentation:
Navigate to the “Widget card” tab, disable “Enable fullscreen” and “Enable data export” options;
Click “Add” to confirm adding the widget;
Resize the widget to your liking. Afterwards, save the dashboard.
We have added an information card about the office.
Click the "Add widget" button at the top of the screen or click the large "Add new widget" icon in the center of the screen (if this is your first widget on this dashboard);
Select the "Markdown/HTML Card" from the "Cards" widgets bundle;
Specify the "Selected entity" alias as the data source and add the following data keys: "floor," "officeManager," "email," and "phone". Then, click "Add datasource" to add another datasource;
Input "Entity with relation to dashboard state (asset)" as alias name. Then, click "Create a new one!";
Specify "Relation type" as filter type. Turn on "Use dashboard state entity as root" option. Set the direction to "To", and maximum relation level to "1";
Add a relation filter: set "Contains" as relation type, and "Asset" as entity type. Then, click "Add";
Add "Address" to the data keys row;
Navigate to the "Appearance" tab. Turn on "Use markdown/HTML value function" option. Fill in the "Markdown/HTML value function" and "Markdown/HTML CSS" sections with the appropriate values, using those provided in the documentation;
Navigate to the "Widget card" tab, turn off "Enable fullscreen" and "Enable data export" options. Click "Add" to confirm adding the widget;
Resize the widget to your liking. Afterwards, save the dashboard;
We have added an information card about the office.
Image Map widget
Our next goal is to visually display the locations of our devices on the floor plan. For this, we will use the “Image Map” widget.
But before we add this widget, we need to do some preparatory work by specifying the coordinates for each device and upload office plan image.
Adding device’s coordinates
For each device, you need to specify its location coordinates on the building’s floor plan as attributes. These coordinates should be within a range from 0 to 1.
Go to the "Devices" page of the "Entities" section on the sidebar. Click on the "Indoor Air Quality Sensor" and navigate to the "Attributes" tab. Select "Server attributes", and click "plus" icon;
Enter "xPos" as key name, select "Double" as the value type, and specify the coordinates for the x-position. Then, click "Add";
Click "plus" icon again to add another attribute key. Enter "yPos" as the key name, select "Double" as the value type, and specify the coordinates for the x-position. Click "Add";
You have now successfully added the xPos and yPos attributes for the Indoor Air Quality Sensor.
Go to the "Devices" page of the "Entities" section on the sidebar. Click on the "Indoor Air Quality Sensor" and navigate to the "Attributes" tab. Select "Server attributes", and click "plus" icon;
Enter "xPos" as key name, select "Double" as the value type, and specify the coordinates for the x-position. Then, click "Add";
Click "plus" icon again to add another attribute key. Enter "yPos" as the key name, select "Double" as the value type, and specify the coordinates for the x-position. Click "Add";
You have now successfully added the xPos and yPos attributes for the Indoor Air Quality Sensor.
Similarly, add attributes with coordinates for the “Energy Meter”, “Water Meter”, and “IAQ Sensor” devices.
The final list of attributes for devices should look like this:
The list of attributes for the "Energy Meter" device should look like this.
The list of attributes for the "Water Flow Meter" device should look like this.
The list of attributes for the "IAQ Sensor" device should look like this.
Coordinates of the devices used in this example:
Device
xPos
yPos
SD-001 (Indoor Air Quality Sensor)
0.51
0.68
EM-002 (Energy Meter)
0.14
0.95
WM-003 (Water Flow Meter)
0.14
0.32
AM-307 (IAQ Sensor)
0.49
0.38
Upload office plan image
Now we need to upload the Office A plan and the Office B plan as graphic files to the Image gallery and add links to them as server attributes for the “Office A” and “Office B” assets, respectively.
Go to the “Image gallery” page of the “Resources” section;
Click “Upload image” button. This will open a new window for uploading the image. Here, you can either drag and drop your office plan image file or select it through a file explorer. Then, click “Upload”;
Once the upload is successful and your image appears in the gallery, look for the “Embed image” icon next to the image. Click this to get a unique link that directly references your uploaded image;
Go to the “Assets” page of the “Entities” section, and click on “Office A”. Navigate to the “Attributes” tab, and click the “plus” icon to add a new attribute;
Name this attribute “office-plan”, choose “String” as the value type, and paste the previously copied link into the value field. Confirm the addition by clicking “Add”;
We have added a new attribute with a link to the image of the Office A plan.
Go to the "Image gallery" page of the "Resources" section. Click "Upload image" button. This will open a new window for uploading the image. Here, you can either drag and drop your office plan image file or select it through a file explorer. Then, click "Upload";
Once the upload is successful and your image appears in the gallery, look for the "Embed image" icon next to the image. Click this to get a unique link that directly references your uploaded image;
Copy the unique link to this image;
Go to the "Assets" page of the "Entities" section, and click on the "Office A". Navigate to the "Attributes" tab, and click the "plus" icon to add a new attribute. Name this attribute "office-plan", choose "String" as the value type, and paste the previously copied link into the value field. Click "Add";
We have added a new attribute with a link to the image of the office plan.
Similarly, upload the Office B plan image to the Image gallery, and add a link to it for “Office B” asset as a server attribute. Use the provided Office B plan image or upload your own image.
We have added a new attribute with a link to the image of the office plan.
Adding Image Map widget
Now that we’ve completed the preparatory steps, it’s time to add the Image Map widget itself. In this widget, we will use the “Device search query” alias type.
This alias allows displaying devices of specified device types (device profiles) up to a specified level that are linked to the root entity. In our case, the root entity is the selected office.
Go to the “office” state and enter dashboard editing mode;
Click the “Add widget” button at the top of the screen;
Select the “Image Map” widget from the “Maps” widgets bundle;
Now we need to add a new alias. In the “Alias” field, enter a name for it - “Office sensors”, and click “Create a new one”;
Select the “Device search query” alias type, turn on the “Use dashboard state entity as root” option, set “Max relation level” to 1, choose “Contains” as the relation type, and list the following device types: “air-sensor”, “energy-sensor”, and “water-sensor”. Finally, click “Add”;
Add “xPos”, “yPos”, and “type” as data keys;
Switch to Office A or Office B state and enter dashboard editing mode;
Click the "Add widget" button at the top of the screen;
Select the "Image Map" widget in the "Maps" widgets bundle;
Now we need to add an alias to define the entities from which the data will be extracted. In our case, the root entity is the selected office. In the "Alias" field, enter a name for it - "Office sensors", and click "Create a new one";
Select the filter type "Device search query", enable the option "Use dashboard state entity as root", set "Max relation level" to 1, relation type to "Contains", and list the device types: "air-sensor", "energy-sensor", and "water-sensor". Click "Add";
Add "xPos", "yPos", and "type" as data keys;
Navigate to the “Appearance” tab, and scroll to the “Map provider settings” section;
Specify “Selected entity” as the image URL source entity alias. This setting ensures that the widget uses the image linked to the selected office;
Specify the “office-plan” as the image URL source entity attribute. This is the attribute where the link to the office plan image is stored;
Now, whenever you select a specific office, the widget will automatically fetch and display the associated office plan image from the “office-plan” attribute.
Now, set the previously uploaded office plan image as the background of the widget. Navigate to the "Appearance" tab, and scroll to the "Map provider settings" section. Specify "Selected entity" as the image URL source entity alias, and the "office-plan" as the image URL source entity attribute;
Scroll to the “Label” section. Here you can change the style of the label that is displayed above the marker.
Please copy the label content from the documentation and insert it into the label field of the widget.
Scroll down a bit to locate the "Label" section. Please copy the label content from the documentation and insert it into the label field of the widget;
In the “Tooltip” section, keep only ${entityName}, which is responsible for the device name. Delete everything else;
In the "Tooltip" section, keep only ${entityName}, which is responsible for the device name. Delete everything else;
Use the marker image function to display the marker image with the corresponding index, depending on the device type:
Copy marker image function from the documentation and paste it into the “Marker image function” field.
Please note: Each marker has its own index (images[0], images[1], etc.). The marker's index must correspond to the device type specified in the marker image function. You can manually reorder the marker images by dragging them.
var type = dsData[dsIndex]['Type'];
if (type == 'air-sensor') {
var res = {
url: images[0],
size: 50
}
return res;
} else if (type == 'energy-sensor') {
var res = {
url: images[1],
size: 50
}
return res;
} else if (type == 'water-sensor') {
var res = {
url: images[2],
size: 50
}
return res;
}
Copy marker image function from the documentation and paste it into the "Marker image function" field, and remove default markers;
Now we need to add new marker images. Click "Browse from gallery";
Upload new markers for each device type;
The “Widget card” tab:
Navigate to the “Widget card” tab and change the title to “Office plan”;
Navigate to the "Widget card" tab and change the title to "Office plan";
Scroll to the “Advanced widget style” section. This area allows you to make deeper widget settings.
Input the following CSS code to the “Widget CSS” section:
Scroll to the "Advanced widget style" section. This area allows you to modify in-depth widget settings. Input the following CSS code to the "Widget CSS" section. This CSS will make the background of the label opaque;
Uncheck the “Enable data export” option in the “Card buttons” section, and click “Add” to complete adding the Image Map widget.
Turn off the "Enable data export" option in the "Card buttons" section, and click "Add" to complete adding the Image Map widget;
Move the “Office plan” widget to the right corner and adjust its size as shown in the screenshot.
The "Office Plan" widget has been added. Move the widget to the right corner and adjust its size as shown in the screenshot.
Finally, let’s make the Image Map widget automatically fill the layout by height:
Go to the “Layout” settings;
Enable the “Auto fill layout height” option, and click “Save”;
Apply layouts settings and save the dashboard.
As you can see, the Image Map widget has filled the entire height of the dashboard.
Go to the "Layout settings";
Enable the "Auto fill layout height" option, and click "Save";
Apply layouts settings and save the dashboard;
A widget has been added that displays the plan of the selected office and the placement of devices on it.
Office A plan: The floor plan displays the devices placed within it.
Office B plan: The floor plan also shows the devices positioned within it.
Office sensors list widget
Add another one widget to “office” state that will display devices and their telemetry in a list.
While in dashboard editing mode, click the "+ Add widget";
Select the "Entities table" widget in the "Tables" widget bundle;
Specify the previously created "Office sensors" alias as datasource, replace the key "name" with "label";
Change the card title to "Office sensors list", uncheck all buttons except "Search" in the "Show card buttons" section, and click "Add";
Position and resize the "Office sensors list" widget to your liking. Afterwards, save the dashboard.
While in dashboard editing mode, click the "+ Add widget";
Select the "Entities table" widget in the "Tables" widget bundle;
Specify the previously created "Office sensors" alias as datasource, replace the key "name" with "label";
Change the card title to "Office sensors list", uncheck all buttons except "Search" in the "Show card buttons" section, and click "Add";
Position and resize the "Office sensors list" widget to your liking. Afterwards, save the dashboard.
The configured “office” state should look like this:
The office state should look like this.
Final view of the dashboard for this lesson
As a result your dashboard should look like this:
Default state;
Building state
Office A state
Office B state
Next step
In the third part of this guide, we will continue to develop our dashboard. We will add individual states and widgets for each device.
When you’re ready to continue, just click the button below.
