Wiki source code of How to creat dashboard for a device?
Last modified by Hera Guo on 2024/12/31 11:55
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
4.1 | 1 | |
| 2 | |||
| 3 | **Table of Contents:** | ||
| 4 | |||
| 5 | {{toc/}} | ||
| 6 | |||
| 7 | |||
| |
5.1 | 8 | = 1. Overview: = |
| |
4.1 | 9 | |
| |
5.1 | 10 | After device data arrive to the platform via the method of [[Connect Device to ThingsEye>>https://wiki.thingseye.io/xwiki/bin/view/Main/How%20to%20connect%20my%20devices%20to%20ThingsEye%3F/#]]. We can creat the Dashboard for the specify device. so to view the sensor detail of each device. |
| |
4.1 | 11 | |
| |
5.1 | 12 | |
| |
12.1 | 13 | Note: We can create only one rule chain, device profile and dashboard for one type of devices. |
| |
5.1 | 14 | |
| 15 | |||
| 16 | = 2. For devices which already have dashboard / profile/ rule chain. = | ||
| 17 | |||
| |
13.1 | 18 | == 2.1 Get the json files == |
| |
5.1 | 19 | |
 |
19.1 | 20 | where to get:[[https:~~/~~/github.com/ThingsEye-io/te-platform/tree/main/Devices/Dragino>>https://github.com/ThingsEye-io/te-platform/tree/main/Devices/Dragino]] |
| |
6.1 | 21 | |
| |
7.1 | 22 | what files to get:Select the model you need and download three JSON files from it |
| |
6.1 | 23 | |
| |
7.1 | 24 | Such as: |
| |
6.1 | 25 | |
| |
11.1 | 26 | * [[sn50v3_nb_mod9_dashboard_.json>>url:https://github.com/ThingsEye-io/te-platform/blob/main/Devices/Dragino/SN50v3-NB-Mod9/sn50v3_nb_mod9_dashboard_.json]] |
| 27 | * [[sn50v3_nb_mod9_device_profile.json>>url:https://github.com/ThingsEye-io/te-platform/blob/main/Devices/Dragino/SN50v3-NB-Mod9/sn50v3_nb_mod9_device_profile.json]] | ||
| 28 | * [[sn50v3_nb_mod9_rule_chain.json>>url:https://github.com/ThingsEye-io/te-platform/blob/main/Devices/Dragino/SN50v3-NB-Mod9/sn50v3_nb_mod9_rule_chain.json]] | ||
| |
7.1 | 29 | |
| |
6.1 | 30 | == 2.2 Import Rule chain == |
| 31 | |||
| |
14.1 | 32 | Firstly, we need to import the rule chain. The rule chain tells platform how we should handel the uplink and downlink for this device. |
| |
6.1 | 33 | |
| |
7.1 | 34 | Open rule chains, click on the "+" in the upper right corner, |
| |
6.1 | 35 | |
| |
7.1 | 36 | select "import rule chain", and then drag the downloaded JSON file with the suffix "_rule_chain" into the text box |
| |
6.1 | 37 | |
| |
7.1 | 38 | * Only need to import once for same type of devices. |
| |
6.1 | 39 | |
| |
7.1 | 40 | ****[[image:1729040952504-811.png||height="556" width="1138"]] |
| |
6.1 | 41 | |
| |
7.1 | 42 | [[image:1729066864346-718.png||height="596" width="1140"]] |
| |
6.1 | 43 | |
| |
7.1 | 44 | == 2.3 Import Device profile and select the rule chain == |
| |
6.1 | 45 | |
| |
8.1 | 46 | === 2.3.1 Import Device profile === |
| |
6.1 | 47 | |
| |
7.1 | 48 | At this step, we need to import the device profile first, as shown in the figure. |
| |
6.1 | 49 | |
| |
7.1 | 50 | First, we need to open the device profiles, click on the "+" in the upper right corner, select "import device profile", |
| |
5.1 | 51 | |
| |
7.1 | 52 | and then select the file with the suffix "_device_defiles" that we have already downloaded. Drag it into the text box. |
| |
5.1 | 53 | |
| |
7.1 | 54 | [[image:1729041156898-931.png||height="523" width="1144"]] |
| |
5.1 | 55 | |
| |
8.1 | 56 | [[image:1729066636027-958.png||height="603" width="1143"]] |
| |
1.1 | 57 | |
| |
8.1 | 58 | === 2.3.2 Modify the rule chain in the device profiles === |
| |
1.1 | 59 | |
| |
7.1 | 60 | After importing the rule chain and device profile, we need to link them together. |
| |
2.1 | 61 | |
| |
7.1 | 62 | At this point, we need to modify the rule chain on the device profiles page. |
| |
1.1 | 63 | |
| |
7.1 | 64 | In this section, first we need to open the device profiles module again, |
| |
1.1 | 65 | |
| |
7.1 | 66 | click on the newly imported device profile file, and then click on the top right corner“ 🖊” After entering the editing mode, |
| |
2.1 | 67 | |
| |
7.1 | 68 | we will see the Default rule chain under the details section. |
| |
1.1 | 69 | |
| |
7.1 | 70 | Click on it and select the corresponding rule chain we have newly imported, |
| |
1.1 | 71 | |
| |
7.1 | 72 | then click the "√" in the upper right corner to save it. |
| |
2.1 | 73 | |
| |
8.1 | 74 | [[image:1729041627624-611.png||height="567" width="1148"]] |
| |
1.1 | 75 | |
| |
7.1 | 76 | [[image:1729041918618-753.png||height="558" width="1151"]] |
| |
1.1 | 77 | |
| |
7.1 | 78 | == 2.4 Import Dashboard and link to each device == |
| |
2.1 | 79 | |
| |
10.1 | 80 | After importing the rule chain and device profile, we need to import the dashboard and configure its datasource. |
| |
1.1 | 81 | |
| |
8.1 | 82 | === ** **2.4.1 Import dashboard === |
| |
3.1 | 83 | |
| |
8.1 | 84 | Firstly, we need to open the dashboard module, |
| |
2.1 | 85 | |
| |
8.1 | 86 | click on the "+" in the upper right corner, select "import dashboard", |
| 87 | |||
| 88 | then we shoud drag the downloaded _dashboard file into the text box. | ||
| 89 | |||
| |
7.1 | 90 | [[image:1728978901199-201.png||height="591" width="1156"]] |
| |
1.1 | 91 | |
| |
7.1 | 92 | [[image:1729066158155-749.png||height="603" width="1165"]] |
| |
3.1 | 93 | |
| |
2.1 | 94 | |
| |
14.1 | 95 | === 2.4.2 Modify the datasource of each module in the dashboard === |
| |
1.1 | 96 | |
| |
8.1 | 97 | After importing the dashboard, we need to link it with our input device, |
| |
1.1 | 98 | |
| |
8.1 | 99 | So we need to change the input device of each module in the dashboard , and the corresponding device name is the IMEI of the device we are connected to. |
| |
2.1 | 100 | |
| |
8.1 | 101 | (For example, if our input device IMEI is 863663062789483, then our input device name is 863663062789483) |
| |
1.1 | 102 | |
| 103 | |||
| |
8.1 | 104 | In this section, we should first open our newly imported dashboard and click on "Edit mode" in the upper right corner to edit it. |
| |
2.1 | 105 | |
| |
8.1 | 106 | Afterwards, select the module to be modified and click on the top right corner of the module“ 🖊” Enter the editing interface, |
| |
2.1 | 107 | |
| |
8.1 | 108 | then find the Datasource section, select the corresponding device name, and click "Apply" in the upper right corner. |
| |
1.1 | 109 | |
| |
8.1 | 110 | * Need to repeat for every new device. |
| 111 | * Make sure the device already creat in the platform. | ||
| |
1.1 | 112 | |
| |
8.1 | 113 | [[image:1729042442077-819.png||height="580" width="1160"]] |
| |
3.1 | 114 | |
| |
8.1 | 115 | [[image:1729042599152-568.png||height="571" width="1166"]] |
| |
3.1 | 116 | |
| |
8.1 | 117 | [[image:1729042895928-321.png||height="565" width="1165"]] |
| |
3.1 | 118 | |
| |
8.1 | 119 | Now our dashboard has been successfully imported and the data can be displayed after processing. |
| |
3.1 | 120 | |
| |
8.1 | 121 | Next, we only need to transfer the data in and we can see the data displayed on the dashboard. |
| |
3.1 | 122 | |
| |
7.1 | 123 | [[image:1728978901221-951.png||height="591" width="1134"]] |
| |
2.1 | 124 | |
| |
8.1 | 125 | = 3. For devices doesn't have dashboard / profile/ rule chain. = |
| 126 | |||
| |
17.1 | 127 | If your device is connected to the platform and there is no existing dashboard, the following instructions will tell you how to create your own dashboard |
| |
8.1 | 128 | |
| |
17.1 | 129 | == 3.1 Creat the adshboaed and add branch == |
| |
8.1 | 130 | |
| |
17.1 | 131 | Sometimes the dashboard we need to create may not have just one interface, so in the following tutorial, we will use a hierarchical dashboard as an example to teach you how to create your own dashboard |
| |
16.1 | 132 | |
| |
17.1 | 133 | === 3.1.1 Create Dashboard === |
| |
16.1 | 134 | |
| |
17.1 | 135 | When we want to create a dashboard, we need to open the dashboard menu and follow the tutorial shown in the figure to create it |
| 136 | |||
| |
22.1 | 137 | [[image:1735617090265-795.png||height="580" width="1133"]] |
| |
17.1 | 138 | |
| |
22.1 | 139 | [[image:1735617103555-499.png||height="587" width="1130"]] |
| |
17.1 | 140 | |
| |
16.1 | 141 | Assigning users and groups is not necessary and can be done uniformly after completing the overall project creation |
| 142 | |||
| |
17.1 | 143 | === 3.1.2 Add branch === |
| |
16.1 | 144 | |
| |
17.1 | 145 | If the dashboard you need requires multiple display interfaces, you need to add branches to the dashboard and connect them together. |
| 146 | |||
| 147 | * If the dashboard you need only requires a simple interface, then this step is not necessary | ||
| 148 | |||
| |
22.1 | 149 | [[image:1735617123489-152.png||height="561" width="1129"]] |
| |
17.1 | 150 | |
| |
16.1 | 151 | How many interfaces do you need to display, and how many statuses you need to create. |
| 152 | |||
| |
22.1 | 153 | [[image:1735617136755-663.png||height="562" width="1134"]] |
| |
16.1 | 154 | |
| 155 | After creating the branch, you can add widgets into your dashboard and decorate it. | ||
| 156 | |||
| |
22.1 | 157 | [[image:1735617150644-700.png||height="573" width="1135"]] |
| |
16.1 | 158 | |
| |
17.1 | 159 | === 3.1.3 Creat actions === |
| |
16.1 | 160 | |
| |
17.1 | 161 | If you have created a multi-level dashboard, you need to connect your dashboard with actions to achieve functionality: when you click on a module in the first level dashboard, you can jump to the second dashboard |
| |
16.1 | 162 | |
| |
22.1 | 163 | [[image:1735617194718-666.png||height="589" width="1148"]] |
| |
16.1 | 164 | |
| |
22.1 | 165 | [[image:1735617210217-324.png||height="587" width="1150"]] |
| |
16.1 | 166 | |
| |
17.1 | 167 | == 3.2 Creat device profiles and set up Alarm == |
| |
16.1 | 168 | |
| |
17.1 | 169 | Device configuration can set common message processing methods for a certain type of device, such as rule chain, message transmission queue, transmission protocol configuration, alarm rule configuration, etc. |
| |
16.1 | 170 | |
| |
17.1 | 171 | === 3.2.1 Creat device profiles === |
| |
16.1 | 172 | |
| |
17.1 | 173 | In the process of creating device configuration, it is necessary to separately set device configuration details, transmission configuration, alarm rules, and device pre configuration. The creation process is as follows. |
| |
16.1 | 174 | |
| |
22.1 | 175 | [[image:1735617233241-442.png||height="580" width="1148"]] |
| |
16.1 | 176 | |
| |
17.1 | 177 | **Equipment configuration details** |
| 178 | In the details, the following configurations can be made: | ||
| |
16.1 | 179 | |
| |
17.1 | 180 | **Name: **required field, the name of the device configuration; |
| |
16.1 | 181 | |
| |
17.1 | 182 | **Default rule chain: **optional item, can specify which set of rule chains to use. If not filled in, the default root rule chain will be used; |
| |
16.1 | 183 | |
| |
17.1 | 184 | **Mobile dashboard:** optional field, specifying the dashboard used by the mobile application for device details; |
| |
16.1 | 185 | |
| |
17.1 | 186 | **Queue:** optional, can specify the strategy for message submission and processing, default is Main; |
| |
16.1 | 187 | |
| |
17.1 | 188 | **Default edge rule chain:** No configuration required; |
| |
16.1 | 189 | |
| |
17.1 | 190 | **Equipment configuration image~:** optional, device images can be uploaded; |
| |
16.1 | 191 | |
| |
17.1 | 192 | **Description:** Optional field, equipment description; |
| |
16.1 | 193 | |
| |
17.1 | 194 | **Transmission configuration** |
| 195 | In the transmission configuration, the protocol for uploading device data can be configured, and the system provides the following protocols: | ||
| |
16.1 | 196 | |
| |
17.1 | 197 | **Default:** Supports basic MQTT, HTTP, and CoAP transmission. If there are no special requirements, the default is generally selected; |
| |
16.1 | 198 | |
| |
17.1 | 199 | **MQTT: **Enable advanced MQTT transport settings for advanced configuration; |
| |
16.1 | 200 | |
| |
17.1 | 201 | **CoAP:** Enable advanced CoAP transmission settings for advanced configuration; |
| |
16.1 | 202 | |
| |
17.1 | 203 | **LWM2M: **LWM2M transmission type, capable of advanced configuration; |
| |
16.1 | 204 | |
| |
17.1 | 205 | **SNMP:** Specify SNMP transmission configuration for advanced configuration; |
| 206 | |||
| |
16.1 | 207 | |
| |
17.1 | 208 | === 3.2.2 Set up Alarm === |
| |
16.1 | 209 | |
| |
17.1 | 210 | ==== 3.2.2.1 Creat alarm ==== |
| |
16.1 | 211 | |
| |
17.1 | 212 | In the alarm rules of device configuration, the conditions for creating and eliminating alarms can be configured (the same effect as configuring in the rule engine, where configuration can avoid encoding). |
| |
16.1 | 213 | |
| |
17.1 | 214 | Go to the Alarm Rule Configuration tab, click Add Alarm Rule, and enter the Alarm Rule Configuration page. |
| |
16.1 | 215 | |
| |
22.1 | 216 | [[image:1735617252584-445.png||height="586" width="1173"]] |
| |
16.1 | 217 | |
| |
22.1 | 218 | [[image:1735617272144-174.png||height="1014" width="1166"]] |
| |
16.1 | 219 | |
| |
22.1 | 220 | |
| |
17.1 | 221 | **Alarm creation rule configuration:**Multiple items can be created using the 'Add Create Condition' button. |
| |
16.1 | 222 | |
| |
17.1 | 223 | **Severity level:**The system provides five severity levels of alarms for configuration personnel to choose from, namely dangerous, important, secondary, warning, and uncertain, and can be selected according to the situation. |
| |
16.1 | 224 | |
| |
17.1 | 225 | **condition:**The condition requires configuring the logic for creating alarms. Click the "Add Alarm Rule Condition" button and follow the steps below to complete the creation of an alarm rule condition. |
| |
16.1 | 226 | |
| |
17.1 | 227 | step1: |
| |
16.1 | 228 | |
| |
18.1 | 229 | [[image:1730432318961-125.png||height="633" width="1288"]] |
| |
17.1 | 230 | |
| 231 | step2: | ||
| 232 | |||
| |
18.1 | 233 | [[image:1730432353580-466.png||height="624" width="1288"]] |
| |
17.1 | 234 | |
| 235 | step3: | ||
| 236 | |||
| |
18.1 | 237 | [[image:1730432390086-645.png||height="625" width="1287"]] |
| |
17.1 | 238 | |
| 239 | step4: | ||
| 240 | |||
| 241 | [[image:1730430251352-545.png||height="617" width="1255"]] | ||
| 242 | |||
| 243 | step5: | ||
| 244 | |||
| |
18.1 | 245 | [[image:1730432478951-944.png||height="611" width="1255"]] |
| |
17.1 | 246 | |
| 247 | Among them: | ||
| 248 | |||
| 249 | When configuring the filter in step 2, the system provides three key types for selection, namely attribute, Timeseries, and constant. When selecting the first two, the key name is a dropdown menu, and you can choose the corresponding attribute name; When selecting a constant, the key name is an input box and you need to input it yourself. The value type is a dropdown selection box, including four types to choose from: string, number, boolean, and date time. | ||
| 250 | |||
| 251 | When configuring the filter in step 4, multiple logics can be added by clicking the add button; Operate as a dropdown selection box, providing various comparison logics; The value is the threshold for comparison. The dynamic comparison threshold configuration can be achieved through the following operations. Note that it is necessary to create the source attributes filled in for the selected dynamic source type in advance (the configuration method is described in [[https:~~/~~/wiki.thingseye.io/xwiki/bin/view/Main/Basic%20configuration%20of%20rule%20chains/>>https://wiki.thingseye.io/xwiki/bin/view/Main/Basic%20configuration%20of%20rule%20chains/]]' **customer attributes **and **tenant attributes**). | ||
| 252 | |||
| |
18.1 | 253 | [[image:1730432499743-363.png||height="616" width="1256"]] |
| |
17.1 | 254 | |
| |
18.1 | 255 | [[image:1730432523117-573.png||height="601" width="1254"]] |
| |
17.1 | 256 | |
| 257 | When configuring the condition type in step 5, the system provides three types: simple, duration, and repetition. When selecting the duration, it is necessary to configure the value and time unit of the duration, which can also be configured using dynamic sources; When selecting repetition, it is necessary to configure the number of repetitions, which can also be configured using dynamic sources. | ||
| 258 | |||
| 259 | [[image:1730430875777-103.png||height="628" width="1257"]] | ||
| 260 | |||
| 261 | 3.2.2.1 clear alarm | ||
| 262 | |||
| 263 | The configuration and creation steps of alarm clearing rules are exactly the same, only the difference in configuration content is not elaborated here. | ||
| 264 | |||
| |
21.1 | 265 | === 3.2.3 replace device profile === |
| |
17.1 | 266 | |
| |
21.1 | 267 | [[image:1735617035450-740.png||height="627" width="1262"]] |
| |
17.1 | 268 | |
| 269 | == 3.3 creat rule chain == | ||
| 270 | |||
| 271 | === 3.3.1 creat rule chain === | ||
| 272 | |||
| 273 | The following link will provide a tutorial on rule chains: | ||
| 274 | |||
| |
16.1 | 275 | [[https:~~/~~/wiki.thingseye.io/xwiki/bin/view/Main/Basic%20configuration%20of%20rule%20chains/>>https://wiki.thingseye.io/xwiki/bin/view/Main/Basic%20configuration%20of%20rule%20chains/]] |
| 276 | |||
| |
17.1 | 277 | === 3.3.2 replace rule chain === |
| |
16.1 | 278 | |
| |
21.1 | 279 | [[image:1735617017552-917.png||height="627" width="1264"]] |
| |
16.1 | 280 | |
| 281 | |||
| |
3.1 | 282 | {{{Hope this article can be helpful to you.Good luck to you!}}} |