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