Show last authors
1 **Table of Contents:**
2
3 {{toc/}}
4
5
6
7
8 = 1.  Overview =
9
10
11 This is a general instruction for the use of Armbian base OS of Dragino devices. Current models include:
12
13 * HP0A
14 * HP0C
15 * LPS8v2
16 * MS20
17
18 (% style="display:none" %)
19
20
21 = 2.  Development Guide =
22
23
24 For advanced users to develop Driver/ Linux etc.
25
26
27 == 2.1  How to recompile LoRaWAN Concentrator Driver ( dragino-fwd package). ==
28
29
30 === (% style="color:blue" %)**Step 1. Clone dragino-fwd package**(%%) ===
31
32
33 **Requirements:**
34
35 **~ (% style="background-color:yellow; color:green" %)sudo apt install -y libsqlite3-dev(%%)**
36
37 **~ (% style="background-color:yellow; color:green" %)sudo apt install -y libftdi1-dev(%%)**
38
39
40 **Run command clone dragino-fwd package: (% style="background-color:yellow; color:green" %)git clone https:~/~/github.com/dragino/dragino_fwd_src.git(%%)**
41
42
43 [[image:image-20220527151010-1.png]]
44
45
46 === (% style="color:blue" %)**Step 2. Compile dragino_fwd**(%%) ===
47
48
49 **After cloning is complete, Run the command starts compiling:**
50
51 (% style="background-color:yellow; color:green" %)**Compile HP0C/HP0A fwd:  ./hp0z-make-deb.sh c**
52
53
54 The following example compilers HP0C fwd.
55
56 [[image:image-20220527153913-3.png]]
57
58
59
60 When the compilation is complete a** (% style="color:blue" %)draginofwd-*.deb(%%) **package is generated.
61
62 [[image:image-20220527154311-4.png||height="385" width="773"]]
63
64
65 === (% style="color:blue" %)**Step 3. Install the dragino_fwd**(%%) ===
66
67
68 **Run command:**
69
70 (% style="background-color:yellow; color:green" %)**dpkg -i draginofwd-*.deb **
71
72
73 [[image:image-20220527154811-5.png]]
74
75
76 === (% style="color:blue" %)**Step 4. Test**(%%) ===
77
78
79 **Check the dragino_fwd log:**
80
81 (% style="background-color:yellow; color:green" %)**journalctl -u draginofwd -f**
82
83
84 [[image:image-20220527165221-7.png||height="182" width="931"]]
85
86
87 **Start/stop dragino_fwd via systemctl:**
88
89 (% style="background-color:yellow; color:green" %)**systemctl start draginofwd**
90
91 (% style="background-color:yellow; color:green" %)**systemctl stop draginofwd**
92
93
94 == 2.2  How to clone Complete OS on the EMMC to SD card ==
95
96 == 2.3  How to flash SD card to (eMMC) device's built-in Memory ==
97
98 === 2.3.1 Prepare an SD card with OS ===
99
100
101 (% style="background-color:yellow" %)//**Preparations:**//
102
103 ~1. Prepare an SD card and a// card reader device//
104
105 2. Formatting the SD card (//Make sure the SD card is empty//)
106
107 3. //Download the OS image from the **[[release.image>>url:http://repo.dragino.com/release/hp0c-image/]]**: ( File format **dragino-lps8v2-1.7.img** )//
108
109 4. //A Flash software tool ( Such as v1.7.9 from **[[balenaEtcher>>url:https://www.balena.io/etcher/]]** )//
110
111
112
113 === 2.3.2 Flash SD card to device's eMMC ===
114
115
116 //1. Open the device's enclosure, and put the SD card into the SD card slot//
117
118 //2. Power on the device and access the gateway's CLI via the serial port.//
119
120 //3. Login and run the below command to flash.//
121
122
123 **Run command:**
124
125 (% style="background-color:yellow; color:green" %)**nand-sata-install**
126
127
128 [[image:image-20220602112051-1.png]]
129
130
131
132 Select the (% style="color:red" %)**"Boot from eMMC - system on eMMC".**
133
134 [[image:image-20220602112058-2.png||height="292" width="646"]]
135
136
137 [[image:image-20220602112106-3.png||height="301" width="643"]]
138
139
140
141 Select the (% style="color:red" %)**"1  ext4"**
142
143 [[image:image-20220602112113-4.png||height="271" width="642"]]
144
145
146
147 It takes 4-5 minutes to burn from SD card to eMMC
148
149 [[image:image-20220602112119-5.png||height="309" width="641"]]
150
151
152 [[image:image-20220602112125-6.png||height="281" width="640"]]
153
154
155 [[image:image-20220602112131-7.png||height="241" width="638"]]
156
157
158 (% style="color:red" %)**Note: After the flash is complete, power off the device and then remove the SD card.**
159
160
161 == 2.4 Default Built Version ==
162
163
164 [[image:image-20220902155621-1.png]]
165
166
167 == 2.5 How to upgrade the nodejs version to the latest. ==
168
169
170 By default, the nodejs uses the pre-install version v12 which is due to Debian the ultra-stable via ultra-old.
171
172 [[image:image-20221112145029-2.png]]
173
174 **If you want to upgrade the nodejs to the latest, please follow to use these commands on the gateway CIL.**
175
176
177 #install n, which is an Interactively Manage Your Node.js Versions
178
179 [[image:image-20221112154230-3.png||height="89" width="689"]]
180
181 (% class="box infomessage" %)
182 (((
183 **npm install -g n**
184 )))
185
186
187 #Install the latest LTS Node.js release (downloading if necessary)
188
189 [[image:image-20221112154418-4.png||height="184" width="893"]]
190
191 (% class="box infomessage" %)
192 (((
193 **n lts**
194 )))
195
196
197 #Remove all downloaded versions except the installed version
198
199 [[image:image-20221112154456-5.png||height="139" width="899"]]
200
201 (% class="box infomessage" %)
202 (((
203 **n prune**
204 )))
205
206
207 (% class="box infomessage" %)
208 (((
209 **apt remove nodejs -y && apt autoremove -y && reboot**
210 )))
211
212
213 Check the current version
214
215 [[image:image-20221112154724-6.png]]
216
217 (% class="box infomessage" %)
218 (((
219 **node -v**
220 )))
221
222
223 == 2.6 How to install Grafana and influxdb ==
224
225
226 === **Grafana:** ===
227
228
229 (% class="box infomessage" %)
230 (((
231 curl https:~/~/packages.grafana.com/gpg.key | gpg ~-~-dearmor | sudo tee /usr/share/keyrings/grafana-archive-keyrings.gpg >/dev/null
232 echo "deb [signed-by=/usr/share/keyrings/grafana-archive-keyrings.gpg] https:~/~/packages.grafana.com/oss/deb stable main" | sudo tee /etc/apt/sources.list.d/grafana.list
233 apt update && apt install grafana
234 )))
235
236
237 Check the running status:
238
239
240 (% class="box infomessage" %)
241 (((
242 systemctl status grafana-server
243 )))
244
245
246 configuration path:
247
248
249 (% class="box infomessage" %)
250 (((
251 /etc/grafana/grafana.ini
252 )))
253
254
255 === **Influxdb:** ===
256
257
258 (% class="box infomessage" %)
259 (((
260 curl https:~/~/repos.influxdata.com/influxdb.key | gpg ~-~-dearmor | sudo tee /usr/share/keyrings/influxdb-archive-keyring.gpg >/dev/null
261 echo "deb [signed-by=/usr/share/keyrings/influxdb-archive-keyring.gpg] https:~/~/repos.influxdata.com/debian $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/influxdb.list
262 apt update && apt install influxdb
263 )))
264
265
266 Check the running status:
267
268
269 (% class="box infomessage" %)
270 (((
271 systemctl status influxdb
272 )))
273
274
275 configuration path:
276
277
278 (% class="box infomessage" %)
279 (((
280 /etc/influxdb/influxdb.conf
281 )))
282
283
284 == 2.7 How to install BACnet ==
285
286
287 (% class="box infomessage" %)
288 (((
289 wget [[http:~~/~~/dragino.vicp.io:6080/bacnet/dragino-bacnet-apps-hp0c-2023-03-01.deb>>url:http://dragino.vicp.io:6080/bacnet/dragino-bacnet-apps-hp0c-2023-03-01.deb]]
290 dpkg -i dragino-bacnet-apps-hp0c-2023-03-01.deb
291 )))
292
293 [[image:image-20230327152105-1.png||height="163" width="933"]]
294
295
296 === 2.7.1 Configure BACnet ===
297
298
299 After BACnet is installed, run commands to modify BACnet configurations
300
301 (% style="color:red" %)**Note: device_port and bacnet_ip_port are not set to the same**
302
303 (% class="box infomessage" %)
304 (((
305 nano /etc/config/bacnet
306 )))
307
308 **Examples:**
309
310 (% class="box infomessage" %)
311 (((
312 config settings 'general'
313 option bacnet_ip '10.130.2.80'  #The IP address of the BACnetIP network, here basically the same IP as the bbmd address below
314 option bacnet_ip_port '47808'  #As with bbmd_port, the purpose of this is to register a Bacnet Server application as a bbmd registration server
315 option bbmd_address '10.130.2.80'  #bbmd is the BACnet registration server. Only one bbmd server is required in the same ip network
316 option bbmd_port '47808'  #In general, 47808 is used as the default port
317 option bacnet_dev_count '2'  #Here is the number of BACnet devices that need to be simulated, if the number is 2, then the following settings must have 2, which are bacdev_1, bacdev_2
318
319 config settings 'bacdev_1'
320 option device_name 'LHT65N-1'  #The identification name of the bacnet device
321 option device_id '10001'  #The unique identification code in the same network segment of BACnet,Scope is(1 - 4194302)
322 option device_port '47912'  #The IP port occupied by Bacnet when it starts, Scope is (1024 - 65535)
323
324 config settings 'bacdev_2'
325 option device_name 'LHT65N-2'
326 option device_id '10002'
327 option device_port '47913'  
328 )))
329
330
331 === 2.7.2 Run BACnet ===
332
333
334 After the configuration is complete, run the following command to start BACnet, The following are two ways to run BACnet:
335
336 (1) With /etc/config/bacnet configuration, and to run the registration server on the current machine, start it with the following command (configure the /etc/config/bacnet file correctly):
337
338 (% class="box infomessage" %)
339 (((
340 bacserver -c -s
341 )))
342
343
344 (2) Without /etc/config/bacnet, and to run the registration server on the current machine, start it with the following command:
345
346 (% class="box infomessage" %)
347 (((
348 bacserver -s -a 10.130.2.80 -p 47808
349 )))
350
351 This command simulates two devices, with device IDs 47910 and 47911
352
353 Enter bacserver -h to output help
354
355 (% class="box infomessage" %)
356 (((
357 bacserver -h
358 )))
359
360 [[image:image-20230327154700-3.png]]
361
362
363 === 2.7.3 Read devices and modify devices ===
364
365
366 Enter baccli -h to output help
367
368 (% class="box infomessage" %)
369 (((
370 baccli -h
371 )))
372
373 [[image:image-20230327165836-1.png]]
374
375
376 **Examples:**
377
378 (1) List the current Bacnet devices:
379
380 (% class="box infomessage" %)
381 (((
382 baccli -l -a
383 )))
384
385 [[image:image-20230327174537-3.png]]
386
387
388 (2) List device information based on device ID:
389
390 (% class="box infomessage" %)
391 (((
392 baccli -l -i id
393 )))
394
395 [[image:image-20230327174556-4.png]]
396
397
398 (3) List the device details by device ID:
399
400 (% class="box infomessage" %)
401 (((
402 baccli -l -v -i id
403 )))
404
405
406 (4) Modify the specified attribute value based on the device ID:
407
408 (% class="box infomessage" %)
409 (((
410 baccli -i id -p prop -w value
411 )))
412
413 [[image:image-20230327174853-5.png]]
414
415
416 The user can check the data of the device by using the **[[yabe BACnet tool>>https://sourceforge.net/projects/yetanotherbacnetexplorer/]]**
417
418 [[image:image-20230327171824-2.png]]
419
420
421 = 3.  Package Management =
422
423 == 3.1 Default Package Maintain System ==
424
425 === 3.1.1  How Package-Auto-Update works? ===
426
427
428 By default, LPS8v2 / MS20 series products have an auto-update feature for main packages. The device will connect to Dragino's auto-update server and check for updates. 
429
430
431 (% style="color:blue" %)**When devices will check for updates**?
432
433 * Devices will check for updates for every boot.
434 * Devices will check for updates on every day midnight.
435
436 (% style="color:blue" %)**What packages will be checked for updates**?
437
438 dragino-httpd ~-~- Main Web UI http configuration
439
440 dragino-sid  ~-~- SN write and read tool
441
442 dragino-ui  ~-~- Gateway Web UI package
443
444 draginofwd   ~-~- UDP packet forwarder, LoRa Base Station
445
446 draginoups   ~-~- Miscellaneous between different versions
447
448
449
450 (% style="color:blue" %)**Location and changelog for packages**:
451
452 * Location: http:~/~/repo.dragino.com/release/tool/
453 * Changelog: [[http:~~/~~/repo.dragino.com/release/tool/Readme_HP0.txt>>http://repo.dragino.com/release/tool/Readme_HP0.txt]]
454
455 (% style="color:blue" %)**How to view auto-updated log**
456
457 You can view the log on the page of (% style="color:#037691" %)**System ~-~-> Package Management.**
458
459
460 [[image:1661305025451-220.png]]
461
462
463
464 (% style="color:blue" %)**Can I disable package-auto-update?**
465
466 You can check the checkbox and click the(% style="color:red" %)** ‘SAVE’ **(%%)button to enable or disable the auto-update.
467
468
469 [[image:1661305258501-636.png]]
470
471
472 === 3.1.2 How to manually update core packages? ===
473
474
475 You can click the (% style="color:red" %)**‘Manual Update’**(%%) to update the dragino's packages.
476
477
478 [[image:1661305328295-218.png]]
479
480
481 === 3.1.3 How to manually update other packages? ===
482
483
484 For the other packages, you have to access the device's CLI to do it via the apt command.
485
486
487 == 3.2 Set up a 3^^rd^^ party package maintain server ==
488
489 === 3.2.1 Overview ===
490
491
492 Customers can use their own package maintenance system instead of using the default one from Dragino. They need to set up a package maintenance system for Debian. Lots of instructions are available in Internet, below is a reference instruction.
493
494
495 === 3.2.2 Install Apache2 HTTP server ===
496
497
498 (% style="background-color:yellow; color:green" %)**apt install apache2**
499
500
501 === 3.2.3 Creating Package Directories ===
502
503
504 **~ (% style="background-color:yellow; color:green" %)cd /var/www/html/(%%)**
505
506 **~ (% style="background-color:yellow; color:green" %)mkdir debian/release/dists/stable/main/binary-armhf/ -p(%%)**
507
508 **~ (% style="background-color:yellow; color:green" %)mkdir debian/release/pool/main/d/dragino/ -p(%%)**
509
510
511 **Tree Structure:**
512
513 (% style="color:red" %)**Note: If you are not familiar with updating servers, most directory names are not recommended to be changed.**
514
515
516 └── debian
517
518 └── release
519
520 ├── dists
521
522 │   └── stable
523
524 │       └── main
525
526 │           └── binary-armhf
527
528 └── pool
529
530 └── main
531
532 └── d
533
534 └── dragino   ~-~-> (% style="background-color:yellow; color:green" %)**This is the directory to store the packages. User can change it to other name.**
535
536
537 === 3.2.4 Get deb packages ===
538
539
540 The deb packages for auto-update can be placed in** (% style="color:blue" %)/var/www/html/debian/release/pool/main/d/dragino/(%%)**
541
542 Below is an example package(testing-0808.deb) for test purpose:
543
544
545 **~ (% style="background-color:yellow; color:green" %)wget http:~/~/repo.dragino.com/release/tool/unimportant/testing-0808.deb(%%)**
546
547 **~ (% style="background-color:yellow; color:green" %)cp ./testing-0808.deb /var/www/html/debian/release/pool/main/d/dragino/(%%)**
548
549
550 === 3.2.5 Generate Package Index file ===
551
552
553 (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/**
554
555 (% style="background-color:yellow; color:green" %)**dpkg-scanpackages pool/ > dists/stable/main/binary-armhf/Packages**
556
557 (% style="background-color:yellow; color:green" %)**cat dists/stable/main/binary-armhf/Packages | gzip -9 > dists/stable/main/binary-armhf/Packages.gz**
558
559
560 (% style="color:red" %)**Note: Every time a package has been update, above comments need to be executed in the server to get the up-to-date package list.**
561
562
563 === 3.2.6 Generate Release file ===
564
565
566 ==== (% style="color:blue" %)**Create the generated script:**(%%) ====
567
568
569 (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/dists/stable**
570
571
572 (% style="background-color:yellow; color:green" %)**wget [[http:~~/~~/repo.dragino.com/release/tool/unimportant/generate-release.sh>>url:http://repo.dragino.com/release/tool/unimportant/generate-release.sh]]**
573
574 (% style="background-color:yellow; color:green" %)**chmod + x ./generate-release.sh**
575
576 (% style="background-color:yellow; color:green" %)**./generate-release.sh > Release**
577
578
579 === 3.2.7 Sign the Release file with gpg and generating Inrelease file ===
580
581
582 ==== (% style="color:blue" %)**Make sure auto-update server has gnupg**(%%) ====
583
584
585 (% style="background-color:yellow; color:green" %)**apt install gnupg**
586
587
588
589 ==== (% style="color:blue" %)**generate gpg key**(%%) ====
590
591
592 (% style="background-color:yellow; color:green" %)**gpg -gen-key**
593
594
595 (% style="color:red" %)**Note: Fill in the content as required and remember the name and email address.**
596
597
598
599 ==== (% style="color:blue" %)**Check the gen-key**(%%) ====
600
601
602 (% style="background-color:yellow; color:green" %)**gen -list-key**
603
604
605
606 ==== (% style="color:blue" %)**Generate the release.gpg**(%%) ====
607
608
609 (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/dists/stable**
610
611 (% style="background-color:yellow; color:green" %)**gpg ~-~-armor ~-~-detach-sign -o Release.gpg Release**
612
613
614 (% style="background-color:yellow; color:green" %)**gpg ~-~-clearsign -o InRelease Release**
615
616
617
618 ==== (% style="color:blue" %)**Generate the public key**(%%) ====
619
620
621 (% style="background-color:yellow; color:green" %)**gpg ~-~-armor ~-~-output <name>.asc ~-~-export <email address>**
622
623
624 **example: gpg ~-~-armor ~-~-output xiao.asc ~-~-export **[[xiaoye@dragino.cc>>mailto:xiaoye@dragino.cc]]
625
626
627
628 === 3.2.8 Add url as apt source in LPS8v2 / MS20 ===
629
630
631
632 ==== (% style="color:blue" %)**Add the public key**(%%) ====
633
634
635 (% style="background-color:yellow; color:green" %)**cp xiao.asc /etc/apt/trusted.gpg.d/**
636
637
638 (% style="color:red" %)**Note: First need to transfer the public key from auto-update server to device.**
639
640
641
642 ==== (% style="color:blue" %)**Add the apt source list**(%%) ====
643
644
645 Add the apt source list url and name this as test_server.list
646
647 (% style="background-color:yellow; color:green" %)**echo "deb http:~/~/<IP_address or hostname>/debian/release stable main" | tee /etc/apt/sources.list.d/test_server.list**
648
649
650
651 ==== (% style="color:blue" %)**Validate the apt repository**(%%) ====
652
653
654 Get and install the testing package (download testing-0808.deb and test)
655
656 (% style="background-color:yellow; color:green" %)**apt update && apt install testing**
657
658
659 Example output:
660
661 [[image:1661306420449-569.png]]
662
663
664 === 3.2.9 Configure the gateway's auto-upgrade rules ===
665
666
667 ==== (% style="color:blue" %)**Remove dragino apt source**(%%) ====
668
669
670 (% style="background-color:yellow; color:green" %)**/etc/apt/sources.list**
671
672
673 [[image:1661306460134-112.png]]
674
675
676
677 ==== (% style="color:blue" %)**Set up automatic updates**(%%) ====
678
679
680 (% style="background-color:yellow; color:green" %)**Path : /usr/lib/dragino/dragino-apt-updates**
681
682
683 The device performs automatic updates from this script,
684
685 But it will now only look for dragino as a keyword, so you need to replace the keyword dragino with your own keyword.
686
687
688 [[image:1661306487761-768.png]]
689
690
691
Copyright ©2010-2022 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0