Last modified by Hera Guo on 2024/12/31 11:55
From version 18.1
edited by Hera Guo
on 2024/11/01 11:42
Change comment: There is no comment for this version
To version 5.1
edited by Chxy
on 2024/10/16 10:43
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.hera
1 +XWiki.EdwinChen
Content
... ... @@ -10,275 +10,91 @@
10 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 11  
12 12  
13 -Note: We can create only one rule chain, device profile and dashboard for one type of devices.
13 +Note: We can create only one rule chain, device profile and dashboard for on type of devices.
14 14  
15 15  
16 16  = 2. For devices which already have dashboard / profile/ rule chain. =
17 17  
18 -== 2.1 Get the json files ==
19 19  
20 -where to get:[[https:~~/~~/github.com/ThingsEye-io/te-platform/tree/main/Devices/Dragino>>path:/xwiki/bin/get/Main/How%20to%20import%20and%20use%20the%20dashboard%3F/?sheet=CKEditor.ResourceDispatcher&outputSyntax=plain&language=&type=doc&reference=&typed=]]
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 125  = 3. For devices doesn't have dashboard / profile/ rule chain. =
126 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 128  
129 -== 3.1 Creat the adshboaed and add branch ==
130 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
23 +{{{How should we import and use a complete dashboard when we receive it? Taking the SN50v3 N_NBemod9 dashboard as an example, this note will provide you with detailed information
132 132  
133 -=== 3.1.1 Create Dashboard ===
25 +first of all, we will receive three JSON files, which include the dashboard, device profiles, and rule chain.}}}
134 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 136  
137 -[[image:1730423736560-539.png]]
28 +[[image:1728978901187-650.png]]
138 138  
139 -[[image:1730423736566-587.png]]
30 +== **Step1.Import dashboard** ==
140 140  
141 -Assigning users and groups is not necessary and can be done uniformly after completing the overall project creation
142 142  
33 +[[image:1728978901199-201.png||height="919" width="1797"]]
143 143  
144 -=== 3.1.2 Add branch ===
35 +[[image:1728978901203-703.png||height="901" width="1801"]]
145 145  
146 -If the dashboard you need requires multiple display interfaces, you need to add branches to the dashboard and connect them together.
37 +== ==
147 147  
148 -* If the dashboard you need only requires a simple interface, then this step is not necessary
39 +== **Step2.Import Device profile** ==
149 149  
150 -[[image:1730423736568-210.png]]
41 +The import method for this section is the same as the dashboard import method.
151 151  
152 -How many interfaces do you need to display, and how many statuses you need to create.
153 153  
154 -[[image:1730423736570-548.png]]
44 +[[image:1729041156898-931.png]]
155 155  
156 -After creating the branch, you can add widgets into your dashboard and decorate it.
46 +[[image:1728978901206-650.png||height="911" width="1799"]]
157 157  
158 -[[image:1730423736572-151.png]]
48 +== ==
159 159  
160 -=== 3.1.3 Creat actions ===
50 +== **Step3. Import Rule chain** ==
161 161  
162 -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
52 +(((
53 +The import method for this section is the same as the dashboard import method.
163 163  
164 -[[image:1730423736591-353.png]]
55 +
56 +)))
165 165  
166 -[[image:1730423736594-830.png]]
58 +(((
59 +**​​​​​**[[image:1729040952504-811.png]]
60 +)))
167 167  
168 -== 3.2 Creat device profiles and set up Alarm ==
62 +[[image:1728978901213-756.png||height="907" width="1802"]]
169 169  
170 -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.
64 +== ==
171 171  
172 -=== 3.2.1 Creat device profiles ===
66 +== **Step4.Modify the rule chain in the device profiles** ==
173 173  
174 -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.
68 +Open the device configuration we just imported and edit it.
175 175  
176 -[[image:1730424112129-248.png]]S
177 177  
178 -**Equipment configuration details**
179 -In the details, the following configurations can be made:
71 +[[image:1729041627624-611.png||height="889" width="1801"]]
180 180  
181 -**Name: **required field, the name of the device configuration;
182 182  
183 -**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;
74 +Modify the rule chain to the one we imported and save it.
184 184  
185 -**Mobile dashboard:** optional field, specifying the dashboard used by the mobile application for device details;
186 186  
187 -**Queue:** optional, can specify the strategy for message submission and processing, default is Main;
77 +[[image:1729041918618-753.png]]
188 188  
189 -**Default edge rule chain:** No configuration required;
190 190  
191 -**Equipment configuration image~:** optional, device images can be uploaded;
192 192  
193 -**Description:** Optional field, equipment description;
81 +== step5.Open our new dashboard and modify the input device for each accessory ==
194 194  
195 195  
196 -**Transmission configuration**
197 -In the transmission configuration, the protocol for uploading device data can be configured, and the system provides the following protocols:
84 +[[image:1729042442077-819.png]]
198 198  
199 -**Default:** Supports basic MQTT, HTTP, and CoAP transmission. If there are no special requirements, the default is generally selected;
200 200  
201 -**MQTT: **Enable advanced MQTT transport settings for advanced configuration;
87 +[[image:1729042599152-568.png||height="869" width="1773"]]
202 202  
203 -**CoAP:** Enable advanced CoAP transmission settings for advanced configuration;
89 +[[image:1729042895928-321.png||height="859" width="1771"]]
204 204  
205 -**LWM2M: **LWM2M transmission type, capable of advanced configuration;
206 206  
207 -**SNMP:** Specify SNMP transmission configuration for advanced configuration;
208 -
92 +Then use this method to modify the input devices of all modules in the dashboard
209 209  
210 -=== 3.2.2 Set up Alarm ===
211 211  
212 -==== 3.2.2.1 Creat  alarm ====
95 +Now our dashboard has been successfully imported and the data can be displayed after processing. Next, we only need to transfer the data in and we can see the data displayed on the dashboard.
213 213  
214 -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).
215 215  
216 -Go to the Alarm Rule Configuration tab, click Add Alarm Rule, and enter the Alarm Rule Configuration page.
98 +[[image:1728978901221-951.png||height="926" width="1777"]]
217 217  
218 -[[image:1730424112138-370.png]]
219 -
220 -[[image:1730424112139-117.png]]
221 -
222 -**Alarm creation rule configuration:**Multiple items can be created using the 'Add Create Condition' button.
223 -
224 -**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.
225 -
226 -**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.
227 -
228 -step1:
229 -
230 -[[image:1730432318961-125.png||height="633" width="1288"]]
231 -
232 -step2:
233 -
234 -[[image:1730432353580-466.png||height="624" width="1288"]]
235 -
236 -step3:
237 -
238 -[[image:1730432390086-645.png||height="625" width="1287"]]
239 -
240 -step4:
241 -
242 -[[image:1730430251352-545.png||height="617" width="1255"]]
243 -
244 -step5:
245 -
246 -[[image:1730432478951-944.png||height="611" width="1255"]]
247 -
248 -Among them:
249 -
250 -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.
251 -
252 -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**).
253 -
254 -[[image:1730432499743-363.png||height="616" width="1256"]]
255 -
256 -[[image:1730432523117-573.png||height="601" width="1254"]]
257 -
258 -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.
259 -
260 -[[image:1730430875777-103.png||height="628" width="1257"]]
261 -
262 -3.2.2.1 clear  alarm
263 -
264 -The configuration and creation steps of alarm clearing rules are exactly the same, only the difference in configuration content is not elaborated here.
265 -
266 -
267 -=== 3.2.3 replace device profile ===
268 -
269 -[[image:1730423736601-389.png]]
270 -
271 -== 3.3 creat rule chain ==
272 -
273 -=== 3.3.1 creat rule chain ===
274 -
275 -The following link will provide a tutorial on rule chains:
276 -
277 -[[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/]]
278 -
279 -=== 3.3.2 replace rule chain ===
280 -
281 -[[image:1730423736607-240.png]]
282 -
283 -
284 284  {{{Hope this article can be helpful to you.Good luck to you!}}}
1729066158155-749.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -280.3 KB
Content
1729066636027-958.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -323.8 KB
Content
1729066864346-718.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -281.2 KB
Content
1729067194004-351.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -43.1 KB
Content
1729067238833-697.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -43.1 KB
Content
1730430251352-545.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -153.3 KB
Content
1730430875777-103.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -220.6 KB
Content
1730432318961-125.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -151.6 KB
Content
1730432353580-466.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -155.1 KB
Content
1730432390086-645.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -166.7 KB
Content
1730432478951-944.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -157.0 KB
Content
1730432499743-363.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -158.4 KB
Content
1730432523117-573.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.hera
Size
... ... @@ -1,1 +1,0 @@
1 -155.5 KB
Content