Wiki source code of Armbian OS instruction
Show last authors
author | version | line-number | content |
---|---|---|---|
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 | |||
19 | |||
20 | = 2. Development Guide = | ||
21 | |||
22 | |||
23 | For advanced users to develop Driver/ Linux etc. | ||
24 | |||
25 | |||
26 | == 2.1 How to recompile LoRaWAN Concentrator Driver ( dragino-fwd package). == | ||
27 | |||
28 | |||
29 | === (% style="color:blue" %)**Step 1. Clone dragino-fwd package**(%%) === | ||
30 | |||
31 | |||
32 | **Requirements:** | ||
33 | |||
34 | **~ (% style="background-color:yellow; color:green" %)sudo apt install -y libsqlite3-dev(%%)** | ||
35 | |||
36 | **~ (% style="background-color:yellow; color:green" %)sudo apt install -y libftdi1-dev(%%)** | ||
37 | |||
38 | |||
39 | **Run command clone dragino-fwd package: (% style="background-color:yellow; color:green" %)git clone https:~/~/github.com/dragino/dragino_fwd_src.git(%%)** | ||
40 | |||
41 | |||
42 | [[image:image-20220527151010-1.png]] | ||
43 | |||
44 | |||
45 | === (% style="color:blue" %)**Step 2. Compile dragino_fwd**(%%) === | ||
46 | |||
47 | |||
48 | **After cloning is complete, Run the command starts compiling:** | ||
49 | |||
50 | (% style="background-color:yellow; color:green" %)**Compile HP0C/HP0A fwd: ./hp0z-make-deb.sh c** | ||
51 | |||
52 | |||
53 | The following example compilers HP0C fwd. | ||
54 | |||
55 | [[image:image-20220527153913-3.png]] | ||
56 | |||
57 | |||
58 | |||
59 | When the compilation is complete a** (% style="color:blue" %)draginofwd-*.deb(%%) **package is generated. | ||
60 | |||
61 | [[image:image-20220527154311-4.png||height="385" width="773"]] | ||
62 | |||
63 | |||
64 | === (% style="color:blue" %)**Step 3. Install the dragino_fwd**(%%) === | ||
65 | |||
66 | |||
67 | **Run command:** | ||
68 | |||
69 | (% style="background-color:yellow; color:green" %)**dpkg -i draginofwd-*.deb ** | ||
70 | |||
71 | |||
72 | [[image:image-20220527154811-5.png]] | ||
73 | |||
74 | |||
75 | === (% style="color:blue" %)**Step 4. Test**(%%) === | ||
76 | |||
77 | |||
78 | **Check the dragino_fwd log:** | ||
79 | |||
80 | (% style="background-color:yellow; color:green" %)**journalctl -u draginofwd -f** | ||
81 | |||
82 | |||
83 | [[image:image-20220527165221-7.png||height="182" width="931"]] | ||
84 | |||
85 | |||
86 | **Start/stop dragino_fwd via systemctl:** | ||
87 | |||
88 | (% style="background-color:yellow; color:green" %)**systemctl start draginofwd** | ||
89 | |||
90 | (% style="background-color:yellow; color:green" %)**systemctl stop draginofwd** | ||
91 | |||
92 | |||
93 | == 2.2 How to clone Complete OS on the EMMC to SD card == | ||
94 | |||
95 | == 2.3 How to flash SD card to (eMMC) device's built-in Memory == | ||
96 | |||
97 | === 2.3.1 Prepare an SD card with OS === | ||
98 | |||
99 | |||
100 | (% style="background-color:yellow" %)//**Preparations:**// | ||
101 | |||
102 | ~1. Prepare an SD card and a// card reader device// | ||
103 | |||
104 | 2. Formatting the SD card (//Make sure the SD card is empty//) | ||
105 | |||
106 | 3. //Download the OS image from the **[[release.image>>url:http://repo.dragino.com/release/hp0c-image/]]**: ( File format **dragino-lps8v2-1.7.img** )// | ||
107 | |||
108 | 4. //A Flash software tool ( Such as v1.7.9 from **[[balenaEtcher>>url:https://www.balena.io/etcher/]]** )// | ||
109 | |||
110 | |||
111 | |||
112 | === 2.3.2 Flash SD card to device's eMMC === | ||
113 | |||
114 | |||
115 | //1. Open the device's enclosure, and put the SD card into the SD card slot// | ||
116 | |||
117 | //2. Power on the device and access the gateway's CLI via the serial port.// | ||
118 | |||
119 | //3. Login and run the below command to flash.// | ||
120 | |||
121 | |||
122 | **Run command:** | ||
123 | |||
124 | (% style="background-color:yellow; color:green" %)**nand-sata-install** | ||
125 | |||
126 | |||
127 | [[image:image-20220602112051-1.png]] | ||
128 | |||
129 | |||
130 | |||
131 | Select the (% style="color:red" %)**"Boot from eMMC - system on eMMC".** | ||
132 | |||
133 | [[image:image-20220602112058-2.png||height="292" width="646"]] | ||
134 | |||
135 | |||
136 | [[image:image-20220602112106-3.png||height="301" width="643"]] | ||
137 | |||
138 | |||
139 | |||
140 | Select the (% style="color:red" %)**"1 ext4"** | ||
141 | |||
142 | [[image:image-20220602112113-4.png||height="271" width="642"]] | ||
143 | |||
144 | |||
145 | |||
146 | It takes 4-5 minutes to burn from SD card to eMMC | ||
147 | |||
148 | [[image:image-20220602112119-5.png||height="309" width="641"]] | ||
149 | |||
150 | |||
151 | [[image:image-20220602112125-6.png||height="281" width="640"]] | ||
152 | |||
153 | |||
154 | [[image:image-20220602112131-7.png||height="241" width="638"]] | ||
155 | |||
156 | |||
157 | (% style="color:red" %)**Note: After the flash is complete, power off the device and then remove the SD card.** | ||
158 | |||
159 | |||
160 | == 2.4 Default Built Version == | ||
161 | |||
162 | |||
163 | [[image:image-20220902155621-1.png]] | ||
164 | |||
165 | |||
166 | == 2.5 How to upgrade the nodejs version to the latest. == | ||
167 | |||
168 | |||
169 | By default, the nodejs uses the pre-install version v12 which is due to Debian the ultra-stable via ultra-old. | ||
170 | |||
171 | [[image:image-20221112145029-2.png]] | ||
172 | |||
173 | **If you want to upgrade the nodejs to the latest, please follow to use these commands on the gateway CIL.** | ||
174 | |||
175 | |||
176 | #install n, which is an Interactively Manage Your Node.js Versions | ||
177 | |||
178 | [[image:image-20221112154230-3.png||height="89" width="689"]] | ||
179 | |||
180 | (% class="box infomessage" %) | ||
181 | ((( | ||
182 | **npm install -g n** | ||
183 | ))) | ||
184 | |||
185 | |||
186 | #Install the latest LTS Node.js release (downloading if necessary) | ||
187 | |||
188 | [[image:image-20221112154418-4.png||height="184" width="893"]] | ||
189 | |||
190 | (% class="box infomessage" %) | ||
191 | ((( | ||
192 | **n lts** | ||
193 | ))) | ||
194 | |||
195 | |||
196 | #Remove all downloaded versions except the installed version | ||
197 | |||
198 | [[image:image-20221112154456-5.png||height="139" width="899"]] | ||
199 | |||
200 | (% class="box infomessage" %) | ||
201 | ((( | ||
202 | **n prune** | ||
203 | ))) | ||
204 | |||
205 | |||
206 | (% class="box infomessage" %) | ||
207 | ((( | ||
208 | **apt remove nodejs -y && apt autoremove -y && reboot** | ||
209 | ))) | ||
210 | |||
211 | |||
212 | Check the current version | ||
213 | |||
214 | [[image:image-20221112154724-6.png]] | ||
215 | |||
216 | (% class="box infomessage" %) | ||
217 | ((( | ||
218 | **node -v** | ||
219 | ))) | ||
220 | |||
221 | |||
222 | == 2.6 How to install Grafana and influxdb == | ||
223 | |||
224 | |||
225 | === **Grafana:** === | ||
226 | |||
227 | |||
228 | (% class="box infomessage" %) | ||
229 | ((( | ||
230 | curl https:~/~/packages.grafana.com/gpg.key | gpg ~-~-dearmor | sudo tee /usr/share/keyrings/grafana-archive-keyrings.gpg >/dev/null | ||
231 | 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 | ||
232 | apt update && apt install grafana | ||
233 | ))) | ||
234 | |||
235 | |||
236 | Check the running status: | ||
237 | |||
238 | |||
239 | (% class="box infomessage" %) | ||
240 | ((( | ||
241 | systemctl status grafana-server | ||
242 | ))) | ||
243 | |||
244 | |||
245 | configuration path: | ||
246 | |||
247 | |||
248 | (% class="box infomessage" %) | ||
249 | ((( | ||
250 | /etc/grafana/grafana.ini | ||
251 | ))) | ||
252 | |||
253 | |||
254 | === **Influxdb:** === | ||
255 | |||
256 | |||
257 | (% class="box infomessage" %) | ||
258 | ((( | ||
259 | curl https:~/~/repos.influxdata.com/influxdb.key | gpg ~-~-dearmor | sudo tee /usr/share/keyrings/influxdb-archive-keyring.gpg >/dev/null | ||
260 | 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 | ||
261 | apt update && apt install influxdb | ||
262 | ))) | ||
263 | |||
264 | |||
265 | Check the running status: | ||
266 | |||
267 | |||
268 | (% class="box infomessage" %) | ||
269 | ((( | ||
270 | systemctl status influxdb | ||
271 | ))) | ||
272 | |||
273 | |||
274 | configuration path: | ||
275 | |||
276 | |||
277 | (% class="box infomessage" %) | ||
278 | ((( | ||
279 | /etc/influxdb/influxdb.conf | ||
280 | ))) | ||
281 | |||
282 | |||
283 | = 3. Package Maintain Note = | ||
284 | |||
285 | == 3.1 Default Package Maintain System == | ||
286 | |||
287 | === 3.1.1 How Package-Auto-Update works? === | ||
288 | |||
289 | |||
290 | 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. | ||
291 | |||
292 | |||
293 | (% style="color:blue" %)**When devices will check for updates**? | ||
294 | |||
295 | * Devices will check for updates for every boot. | ||
296 | * Devices will check for updates on every day midnight. | ||
297 | |||
298 | (% style="color:blue" %)**What packages will be checked for updates**? | ||
299 | |||
300 | dragino-httpd ~-~- Main Web UI http configuration | ||
301 | |||
302 | dragino-sid ~-~- SN write and read tool | ||
303 | |||
304 | dragino-ui ~-~- Gateway Web UI package | ||
305 | |||
306 | draginofwd ~-~- UDP packet forwarder, LoRa Base Station | ||
307 | |||
308 | draginoups ~-~- Miscellaneous between different versions | ||
309 | |||
310 | |||
311 | |||
312 | (% style="color:blue" %)**Location and changelog for packages**: | ||
313 | |||
314 | * Location: http:~/~/repo.dragino.com/release/tool/ | ||
315 | * Changelog: [[http:~~/~~/repo.dragino.com/release/tool/Readme_HP0.txt>>http://repo.dragino.com/release/tool/Readme_HP0.txt]] | ||
316 | |||
317 | (% style="color:blue" %)**How to view auto-updated log** | ||
318 | |||
319 | You can view the log on the page of (% style="color:#037691" %)**System ~-~-> Package Management.** | ||
320 | |||
321 | |||
322 | [[image:1661305025451-220.png]] | ||
323 | |||
324 | |||
325 | |||
326 | (% style="color:blue" %)**Can I disable package-auto-update?** | ||
327 | |||
328 | You can check the checkbox and click the(% style="color:red" %)** ‘SAVE’ **(%%)button to enable or disable the auto-update. | ||
329 | |||
330 | |||
331 | [[image:1661305258501-636.png]] | ||
332 | |||
333 | |||
334 | |||
335 | === 3.1.2 How to manually update core packages? === | ||
336 | |||
337 | |||
338 | You can click the (% style="color:red" %)**‘Manual Update’**(%%) to update the dragino's packages. | ||
339 | |||
340 | |||
341 | [[image:1661305328295-218.png]] | ||
342 | |||
343 | |||
344 | |||
345 | === 3.1.3 How to manually update other packages? === | ||
346 | |||
347 | |||
348 | For the other packages, you have to access the device's CLI to do it via the apt command. | ||
349 | |||
350 | |||
351 | |||
352 | == 3.2 Set up a 3^^rd^^ party package maintain server == | ||
353 | |||
354 | === 3.2.1 Overview === | ||
355 | |||
356 | |||
357 | 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. | ||
358 | |||
359 | |||
360 | === 3.2.2 Install Apache2 HTTP server === | ||
361 | |||
362 | |||
363 | (% style="background-color:yellow; color:green" %)**apt install apache2** | ||
364 | |||
365 | |||
366 | === 3.2.3 Creating Package Directories === | ||
367 | |||
368 | |||
369 | **~ (% style="background-color:yellow; color:green" %)cd /var/www/html/(%%)** | ||
370 | |||
371 | **~ (% style="background-color:yellow; color:green" %)mkdir debian/release/dists/stable/main/binary-armhf/ -p(%%)** | ||
372 | |||
373 | **~ (% style="background-color:yellow; color:green" %)mkdir debian/release/pool/main/d/dragino/ -p(%%)** | ||
374 | |||
375 | |||
376 | **Tree Structure:** | ||
377 | |||
378 | (% style="color:red" %)**Note: If you are not familiar with updating servers, most directory names are not recommended to be changed.** | ||
379 | |||
380 | |||
381 | └── debian | ||
382 | |||
383 | └── release | ||
384 | |||
385 | ├── dists | ||
386 | |||
387 | │ └── stable | ||
388 | |||
389 | │ └── main | ||
390 | |||
391 | │ └── binary-armhf | ||
392 | |||
393 | └── pool | ||
394 | |||
395 | └── main | ||
396 | |||
397 | └── d | ||
398 | |||
399 | └── dragino ~-~-> (% style="background-color:yellow; color:green" %)**This is the directory to store the packages. User can change it to other name.** | ||
400 | |||
401 | |||
402 | === 3.2.4 Get deb packages === | ||
403 | |||
404 | |||
405 | The deb packages for auto-update can be placed in** (% style="color:blue" %)/var/www/html/debian/release/pool/main/d/dragino/(%%)** | ||
406 | |||
407 | Below is an example package(testing-0808.deb) for test purpose: | ||
408 | |||
409 | |||
410 | **~ (% style="background-color:yellow; color:green" %)wget http:~/~/repo.dragino.com/release/tool/unimportant/testing-0808.deb(%%)** | ||
411 | |||
412 | **~ (% style="background-color:yellow; color:green" %)cp ./testing-0808.deb /var/www/html/debian/release/pool/main/d/dragino/(%%)** | ||
413 | |||
414 | |||
415 | === 3.2.5 Generate Package Index file === | ||
416 | |||
417 | |||
418 | (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/** | ||
419 | |||
420 | (% style="background-color:yellow; color:green" %)**dpkg-scanpackages pool/ > dists/stable/main/binary-armhf/Packages** | ||
421 | |||
422 | (% style="background-color:yellow; color:green" %)**cat dists/stable/main/binary-armhf/Packages | gzip -9 > dists/stable/main/binary-armhf/Packages.gz** | ||
423 | |||
424 | |||
425 | (% 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.** | ||
426 | |||
427 | |||
428 | === 3.2.6 Generate Release file === | ||
429 | |||
430 | |||
431 | ==== (% style="color:blue" %)**Create the generated script:**(%%) ==== | ||
432 | |||
433 | |||
434 | (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/dists/stable** | ||
435 | |||
436 | |||
437 | (% 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]]** | ||
438 | |||
439 | (% style="background-color:yellow; color:green" %)**chmod + x ./generate-release.sh** | ||
440 | |||
441 | (% style="background-color:yellow; color:green" %)**./generate-release.sh > Release** | ||
442 | |||
443 | |||
444 | === 3.2.7 Sign the Release file with gpg and generating Inrelease file === | ||
445 | |||
446 | |||
447 | ==== (% style="color:blue" %)**Make sure auto-update server has gnupg**(%%) ==== | ||
448 | |||
449 | |||
450 | (% style="background-color:yellow; color:green" %)**apt install gnupg** | ||
451 | |||
452 | |||
453 | |||
454 | ==== (% style="color:blue" %)**generate gpg key**(%%) ==== | ||
455 | |||
456 | |||
457 | (% style="background-color:yellow; color:green" %)**gpg -gen-key** | ||
458 | |||
459 | |||
460 | (% style="color:red" %)**Note: Fill in the content as required and remember the name and email address.** | ||
461 | |||
462 | |||
463 | |||
464 | ==== (% style="color:blue" %)**Check the gen-key**(%%) ==== | ||
465 | |||
466 | |||
467 | (% style="background-color:yellow; color:green" %)**gen -list-key** | ||
468 | |||
469 | |||
470 | |||
471 | ==== (% style="color:blue" %)**Generate the release.gpg**(%%) ==== | ||
472 | |||
473 | |||
474 | (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/dists/stable** | ||
475 | |||
476 | (% style="background-color:yellow; color:green" %)**gpg ~-~-armor ~-~-detach-sign -o Release.gpg Release** | ||
477 | |||
478 | |||
479 | (% style="background-color:yellow; color:green" %)**gpg ~-~-clearsign -o InRelease Release** | ||
480 | |||
481 | |||
482 | |||
483 | ==== (% style="color:blue" %)**Generate the public key**(%%) ==== | ||
484 | |||
485 | |||
486 | (% style="background-color:yellow; color:green" %)**gpg ~-~-armor ~-~-output <name>.asc ~-~-export <email address>** | ||
487 | |||
488 | |||
489 | **example: gpg ~-~-armor ~-~-output xiao.asc ~-~-export **[[xiaoye@dragino.cc>>mailto:xiaoye@dragino.cc]] | ||
490 | |||
491 | |||
492 | |||
493 | === 3.2.8 Add url as apt source in LPS8v2 / MS20 === | ||
494 | |||
495 | |||
496 | |||
497 | ==== (% style="color:blue" %)**Add the public key**(%%) ==== | ||
498 | |||
499 | |||
500 | (% style="background-color:yellow; color:green" %)**cp xiao.asc /etc/apt/trusted.gpg.d/** | ||
501 | |||
502 | |||
503 | (% style="color:red" %)**Note: First need to transfer the public key from auto-update server to device.** | ||
504 | |||
505 | |||
506 | |||
507 | ==== (% style="color:blue" %)**Add the apt source list**(%%) ==== | ||
508 | |||
509 | |||
510 | Add the apt source list url and name this as test_server.list | ||
511 | |||
512 | (% 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** | ||
513 | |||
514 | |||
515 | |||
516 | ==== (% style="color:blue" %)**Validate the apt repository**(%%) ==== | ||
517 | |||
518 | |||
519 | Get and install the testing package (download testing-0808.deb and test) | ||
520 | |||
521 | (% style="background-color:yellow; color:green" %)**apt update && apt install testing** | ||
522 | |||
523 | |||
524 | Example output: | ||
525 | |||
526 | [[image:1661306420449-569.png]] | ||
527 | |||
528 | |||
529 | === 3.2.9 Configure the gateway's auto-upgrade rules === | ||
530 | |||
531 | |||
532 | ==== (% style="color:blue" %)**Remove dragino apt source**(%%) ==== | ||
533 | |||
534 | |||
535 | (% style="background-color:yellow; color:green" %)**/etc/apt/sources.list** | ||
536 | |||
537 | |||
538 | [[image:1661306460134-112.png]] | ||
539 | |||
540 | |||
541 | |||
542 | ==== (% style="color:blue" %)**Set up automatic updates**(%%) ==== | ||
543 | |||
544 | |||
545 | (% style="background-color:yellow; color:green" %)**Path : /usr/lib/dragino/dragino-apt-updates** | ||
546 | |||
547 | |||
548 | The device performs automatic updates from this script, | ||
549 | |||
550 | But it will now only look for dragino as a keyword, so you need to replace the keyword dragino with your own keyword. | ||
551 | |||
552 | |||
553 | [[image:1661306487761-768.png]] |