Last modified by Hera Guo on 2024/12/31 11:55
Show last authors
1
2
3 **Table of Contents:**
4
5 {{toc/}}
6
7
8 = 1. Overview: =
9
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.
11
12
13 Note: We can create only one rule chain, device profile and dashboard for one type of devices.
14
15
16 = 2. For devices which already have dashboard / profile/ rule chain. =
17
18 == 2.1 Get the json files ==
19
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]]
21
22 what files to get:Select the model you need and download three JSON files from it
23
24 Such as:
25
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]]
29
30 == 2.2 Import Rule chain ==
31
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.
33
34 Open rule chains, click on the "+" in the upper right corner,
35
36 select "import rule chain", and then drag the downloaded JSON file with the suffix "_rule_chain" into the text box
37
38 * Only need to import once for same type of devices.
39
40 **​​​​​**[[image:1729040952504-811.png||height="556" width="1138"]]
41
42 [[image:1729066864346-718.png||height="596" width="1140"]]
43
44 == 2.3 Import Device profile and select the rule chain ==
45
46 === 2.3.1 Import Device profile ===
47
48 At this step, we need to import the device profile first, as shown in the figure.
49
50 First, we need to open the device profiles, click on the "+" in the upper right corner, select "import device profile",
51
52 and then select the file with the suffix "_device_defiles" that we have already downloaded. Drag it into the text box.
53
54 [[image:1729041156898-931.png||height="523" width="1144"]]
55
56 [[image:1729066636027-958.png||height="603" width="1143"]]
57
58 === 2.3.2 Modify the rule chain in the device profiles ===
59
60 After importing the rule chain and device profile, we need to link them together.
61
62 At this point, we need to modify the rule chain on the device profiles page.
63
64 In this section, first we need to open the device profiles module again,
65
66 click on the newly imported device profile file, and then click on the top right corner“ 🖊” After entering the editing mode,
67
68 we will see the Default rule chain under the details section.
69
70 Click on it and select the corresponding rule chain we have newly imported,
71
72 then click the "√" in the upper right corner to save it.
73
74 [[image:1729041627624-611.png||height="567" width="1148"]]
75
76 [[image:1729041918618-753.png||height="558" width="1151"]]
77
78 == 2.4 Import Dashboard and link to each device ==
79
80 After importing the rule chain and device profile, we need to import the dashboard and configure its  datasource.
81
82 === ** **2.4.1 Import dashboard ===
83
84 Firstly, we need to open the dashboard module,
85
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
90 [[image:1728978901199-201.png||height="591" width="1156"]]
91
92 [[image:1729066158155-749.png||height="603" width="1165"]]
93
94
95 === 2.4.2 Modify the datasource of each module in the dashboard ===
96
97 After importing the dashboard, we need to link it with our input device,
98
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.
100
101 (For example, if our input device IMEI is 863663062789483, then our input device name is 863663062789483)
102
103
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.
105
106 Afterwards, select the module to be modified and click on the top right corner of the module“ 🖊” Enter the editing interface,
107
108 then find the Datasource section, select the corresponding device name, and click "Apply" in the upper right corner.
109
110 * Need to repeat for every new device.
111 * Make sure the device already creat in the platform.
112
113 [[image:1729042442077-819.png||height="580" width="1160"]]
114
115 [[image:1729042599152-568.png||height="571" width="1166"]]
116
117 [[image:1729042895928-321.png||height="565" width="1165"]]
118
119 Now our dashboard has been successfully imported and the data can be displayed after processing.
120
121 Next, we only need to transfer the data in and we can see the data displayed on the dashboard.
122
123 [[image:1728978901221-951.png||height="591" width="1134"]]
124
125 = 3. For devices doesn't have dashboard / profile/ rule chain. =
126
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
128
129 == 3.1 Creat the adshboaed and add branch ==
130
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
132
133 === 3.1.1 Create Dashboard ===
134
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
137 [[image:1735617090265-795.png||height="580" width="1133"]]
138
139 [[image:1735617103555-499.png||height="587" width="1130"]]
140
141 Assigning users and groups is not necessary and can be done uniformly after completing the overall project creation
142
143 === 3.1.2 Add branch ===
144
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
149 [[image:1735617123489-152.png||height="561" width="1129"]]
150
151 How many interfaces do you need to display, and how many statuses you need to create.
152
153 [[image:1735617136755-663.png||height="562" width="1134"]]
154
155 After creating the branch, you can add widgets into your dashboard and decorate it.
156
157 [[image:1735617150644-700.png||height="573" width="1135"]]
158
159 === 3.1.3 Creat actions ===
160
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
162
163 [[image:1735617194718-666.png||height="589" width="1148"]]
164
165 [[image:1735617210217-324.png||height="587" width="1150"]]
166
167 == 3.2 Creat device profiles and set up Alarm ==
168
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.
170
171 === 3.2.1 Creat device profiles ===
172
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.
174
175 [[image:1735617233241-442.png||height="580" width="1148"]]
176
177 **Equipment configuration details**
178 In the details, the following configurations can be made:
179
180 **Name: **required field, the name of the device configuration;
181
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;
183
184 **Mobile dashboard:** optional field, specifying the dashboard used by the mobile application for device details;
185
186 **Queue:** optional, can specify the strategy for message submission and processing, default is Main;
187
188 **Default edge rule chain:** No configuration required;
189
190 **Equipment configuration image~:** optional, device images can be uploaded;
191
192 **Description:** Optional field, equipment description;
193
194 **Transmission configuration**
195 In the transmission configuration, the protocol for uploading device data can be configured, and the system provides the following protocols:
196
197 **Default:** Supports basic MQTT, HTTP, and CoAP transmission. If there are no special requirements, the default is generally selected;
198
199 **MQTT: **Enable advanced MQTT transport settings for advanced configuration;
200
201 **CoAP:** Enable advanced CoAP transmission settings for advanced configuration;
202
203 **LWM2M: **LWM2M transmission type, capable of advanced configuration;
204
205 **SNMP:** Specify SNMP transmission configuration for advanced configuration;
206
207
208 === 3.2.2 Set up Alarm ===
209
210 ==== 3.2.2.1 Creat  alarm ====
211
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).
213
214 Go to the Alarm Rule Configuration tab, click Add Alarm Rule, and enter the Alarm Rule Configuration page.
215
216 [[image:1735617252584-445.png||height="586" width="1173"]]
217
218 [[image:1735617272144-174.png||height="1014" width="1166"]]
219
220
221 **Alarm creation rule configuration:**Multiple items can be created using the 'Add Create Condition' button.
222
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.
224
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.
226
227 step1:
228
229 [[image:1730432318961-125.png||height="633" width="1288"]]
230
231 step2:
232
233 [[image:1730432353580-466.png||height="624" width="1288"]]
234
235 step3:
236
237 [[image:1730432390086-645.png||height="625" width="1287"]]
238
239 step4:
240
241 [[image:1730430251352-545.png||height="617" width="1255"]]
242
243 step5:
244
245 [[image:1730432478951-944.png||height="611" width="1255"]]
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
253 [[image:1730432499743-363.png||height="616" width="1256"]]
254
255 [[image:1730432523117-573.png||height="601" width="1254"]]
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
265 === 3.2.3 replace device profile ===
266
267 [[image:1735617035450-740.png||height="627" width="1262"]]
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
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
277 === 3.3.2 replace rule chain ===
278
279 [[image:1735617017552-917.png||height="627" width="1264"]]
280
281
282 {{{Hope this article can be helpful to you.Good luck to you!}}}