Wiki source code of Armbian OS instruction

Version 71.1 by Edwin Chen on 2022/09/02 15:56

Hide last authors
Kilight Cao 15.1 1 **Table of Contents:**
2
3 {{toc/}}
4
Edwin Chen 1.1 5
Xiaoling 50.1 6
7
Xiaoling 48.2 8 = 1.  Overview =
9
10
Edwin Chen 1.1 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
Edwin Chen 55.1 16 * MS20
Edwin Chen 1.1 17
Xiaoling 70.8 18
Xiaoling 70.11 19
20
Xiaoling 48.2 21 = 2.  Development Guide =
22
23
Xiaoling 70.4 24 For advanced users to develop Driver/ Linux etc.
Edwin Chen 4.1 25
Kilight Cao 25.1 26
Xiaoling 54.2 27
Xiaoling 48.2 28 == 2.1  How to recompile LoRaWAN Concentrator Driver ( dragino-fwd package). ==
Edwin Chen 4.1 29
30
Xiaoling 54.2 31
Xiaoling 48.3 32 === (% style="color:blue" %)**Step 1. Clone dragino-fwd package**(%%) ===
Edwin Chen 4.1 33
Kilight Cao 30.1 34
Xiaoling 70.4 35 **Requirements:**
Xiaoling 48.3 36
Xiaoling 70.4 37 **~ (% style="background-color:yellow; color:green" %)sudo apt install -y libsqlite3-dev(%%)**
Kilight Cao 30.1 38
Xiaoling 70.4 39 **~ (% style="background-color:yellow; color:green" %)sudo apt install -y libftdi1-dev(%%)**
Kilight Cao 11.1 40
Xiaoling 48.3 41
Xiaoling 70.4 42 **Run command clone dragino-fwd package: (% style="background-color:yellow; color:green" %)git clone https:~/~/github.com/dragino/dragino_fwd_src.git(%%)**
Kilight Cao 11.1 43
Xiaoling 70.4 44
Kilight Cao 11.1 45 [[image:image-20220527151010-1.png]]
46
47
48
Xiaoling 48.3 49 === (% style="color:blue" %)**Step 2. Compile dragino_fwd**(%%) ===
Kilight Cao 48.1 50
Kilight Cao 11.1 51
Xiaoling 70.4 52 **After cloning is complete, Run the command starts compiling:**
Xiaoling 48.3 53
Xiaoling 70.5 54 (% style="background-color:yellow; color:green" %)**Compile HP0C/HP0A fwd:  ./hp0z-make-deb.sh c**
Xiaoling 70.4 55
Xiaoling 70.5 56
Kilight Cao 11.1 57 The following example compilers HP0C fwd.
58
59 [[image:image-20220527153913-3.png]]
60
61
62
Xiaoling 70.5 63 When the compilation is complete a** (% style="color:blue" %)draginofwd-*.deb(%%) **package is generated.
64
Kilight Cao 11.1 65 [[image:image-20220527154311-4.png||height="385" width="773"]]
66
Kilight Cao 25.1 67
Xiaoling 54.2 68
Xiaoling 48.3 69 === (% style="color:blue" %)**Step 3. Install the dragino_fwd**(%%) ===
Kilight Cao 11.1 70
Kilight Cao 14.1 71
Xiaoling 70.4 72 **Run command:**
Kilight Cao 11.1 73
Xiaoling 70.5 74 (% style="background-color:yellow; color:green" %)**dpkg -i draginofwd-*.deb **
Kilight Cao 11.1 75
Xiaoling 70.4 76
Kilight Cao 11.1 77 [[image:image-20220527154811-5.png]]
78
79
80
Xiaoling 48.3 81 === (% style="color:blue" %)**Step 4. Test**(%%) ===
Kilight Cao 14.1 82
Xiaoling 48.3 83
Xiaoling 70.5 84 **Check the dragino_fwd log:**
Kilight Cao 11.1 85
Xiaoling 70.5 86 (% style="background-color:yellow; color:green" %)**journalctl -u draginofwd -f**
Kilight Cao 11.1 87
Xiaoling 70.4 88
Kilight Cao 13.1 89 [[image:image-20220527165221-7.png||height="182" width="931"]]
Kilight Cao 11.1 90
Xiaoling 48.3 91
Xiaoling 70.5 92 **Start/stop dragino_fwd via systemctl:**
Kilight Cao 11.1 93
Xiaoling 70.5 94 (% style="background-color:yellow; color:green" %)**systemctl start draginofwd**
Kilight Cao 13.1 95
Xiaoling 70.5 96 (% style="background-color:yellow; color:green" %)**systemctl stop draginofwd**
Xiaoye 46.1 97
Kilight Cao 13.1 98
Xiaoling 70.4 99
Xiaoling 48.3 100 == 2.2  How to clone Complete OS on the EMMC to SD card ==
Kilight Cao 27.1 101
Xiaoling 48.3 102
Edwin Chen 57.1 103 == 2.3  How to flash SD card to (eMMC) device's built-in Memory ==
Xiaoling 48.3 104
105
Xiaoling 67.2 106 === 2.3.1 Prepare an SD card with OS ===
Edwin Chen 57.1 107
Xiaoling 67.2 108
Xiaoling 70.5 109 (% style="background-color:yellow" %)//**Preparations:**//
Xiaoye 51.1 110
111 ~1. Prepare an SD card and a// card reader device//
112
113 2. Formatting the SD card (//Make sure the SD card is empty//)
114
Xiaoye 62.1 115 3. //Download the OS image from **[[release.image>>url:http://repo.dragino.com/release/hp0c-image/]]**: ( File format **dragino-lps8v2-1.7.img** )//
Xiaoye 51.1 116
Xiaoye 61.1 117 4. //A Flash software tool ( Such as v1.7.9 from **[[balenaEtcher>>url:https://www.balena.io/etcher/]]** )//
Xiaoye 51.1 118
119
120
Xiaoling 67.2 121 === 2.3.2 Flash SD card to device's eMMC ===
122
123
Edwin Chen 57.1 124 //1. Open the device's enclosure, and put the SD card into the SD card slot//
Xiaoye 51.1 125
Edwin Chen 57.1 126 //2. Power on the device and access the gateway's CLI via the serial port.//
Xiaoye 51.1 127
Edwin Chen 57.1 128 //3. Login and run the below command to flash.//
129
130
Xiaoling 70.4 131 **Run command:**
Kilight Cao 27.1 132
Xiaoling 70.6 133 (% style="background-color:yellow; color:green" %)**nand-sata-install**
Kilight Cao 27.1 134
Xiaoling 70.4 135
Kilight Cao 27.1 136 [[image:image-20220602112051-1.png]]
137
Kilight Cao 28.1 138
Kilight Cao 27.1 139
Xiaoling 70.7 140 Select the (% style="color:red" %)**"Boot from eMMC - system on eMMC".**
141
Kilight Cao 27.1 142 [[image:image-20220602112058-2.png||height="292" width="646"]]
143
144 [[image:image-20220602112106-3.png||height="301" width="643"]]
145
146
Xiaoling 70.7 147 Select the (% style="color:red" %)**"1  ext4"**
Kilight Cao 27.1 148
149 [[image:image-20220602112113-4.png||height="271" width="642"]]
150
151
Xiaoling 70.7 152
Kilight Cao 27.1 153 It takes 4-5 minutes to burn from SD card to eMMC
154
155 [[image:image-20220602112119-5.png||height="309" width="641"]]
156
157 [[image:image-20220602112125-6.png||height="281" width="640"]]
158
159 [[image:image-20220602112131-7.png||height="241" width="638"]]
160
161
162 (% style="color:red" %)**Note: After the flash is complete, power off the device and then remove the SD card.**
163
Kilight Cao 28.1 164
Xiaoling 67.2 165
Edwin Chen 63.1 166 = 3. Package Maintain Note =
167
Xiaoling 67.2 168
169 == 3.1 Default Package Maintain System ==
170
171
172 === 3.1.1 How Package-Auto-Update works? ===
173
174
175 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. 
176
177
178 (% style="color:blue" %)**When devices will check for updates**?
179
180 * Devices will check for updates for every boot.
181 * Devices will check for updates on every day midnight.
182
Xiaoling 70.7 183
Xiaoling 70.11 184
Xiaoling 67.2 185 (% style="color:blue" %)**What packages will be checked for updates**?
186
187 dragino-httpd ~-~- Main Web UI http configuration
188
189 dragino-sid  ~-~- SN write and read tool
190
191 dragino-ui  ~-~- Gateway Web UI package
192
193 draginofwd   ~-~- UDP packet forwarder, LoRa Base Station
194
195 draginoups   ~-~- Miscellaneous between different versions
196
197
Xiaoling 70.9 198
Xiaoling 67.2 199 (% style="color:blue" %)**Location and changelog for packages**:
200
201 * Location: http:~/~/repo.dragino.com/release/tool/
202 * Changelog: [[http:~~/~~/repo.dragino.com/release/tool/Readme_HP0.txt>>http://repo.dragino.com/release/tool/Readme_HP0.txt]]
203
Xiaoling 70.7 204
Xiaoling 70.11 205
Xiaoling 67.2 206 (% style="color:blue" %)**How to view auto-updated log**
207
208 You can view the log on the page of (% style="color:#037691" %)**System ~-~-> Package Management.**
209
210
211 [[image:1661305025451-220.png]]
212
213
Xiaoling 70.7 214
Xiaoling 67.2 215 (% style="color:blue" %)**Can I disable package-auto-update?**
216
Xiaoling 70.8 217 You can check the checkbox and click the(% style="color:red" %)** ‘SAVE’ **(%%)button to enable or disable the auto-update.
Xiaoling 67.2 218
219
220 [[image:1661305258501-636.png]]
221
222
223
224 === 3.1.2 How to manually update core packages? ===
225
226
Xiaoling 70.8 227 You can click the (% style="color:red" %)**‘Manual Update’**(%%) to update the dragino's packages.
Xiaoling 67.2 228
229
230 [[image:1661305328295-218.png]]
231
232
233
234 === 3.1.3 How to manually update other packages? ===
235
236
237 For the other packages, you have to access the device's CLI to do it via the apt command.
238
239
240
241 == 3.2 Set up a 3^^rd^^ party package maintain server ==
242
243
244 === 3.2.1 Overview ===
245
246
247 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.
248
249
250
251 === 3.2.2 Install Apache2 HTTP server ===
252
253
Xiaoling 70.5 254 (% style="background-color:yellow; color:green" %)**apt install apache2**
Xiaoling 67.2 255
256
257
258 === 3.2.3 Creating Package Directories ===
259
260
Xiaoling 70.5 261 **~ (% style="background-color:yellow; color:green" %)cd /var/www/html/(%%)**
Xiaoling 67.2 262
Xiaoling 70.5 263 **~ (% style="background-color:yellow; color:green" %)mkdir debian/release/dists/stable/main/binary-armhf/ -p(%%)**
Xiaoling 67.2 264
Xiaoling 70.5 265 **~ (% style="background-color:yellow; color:green" %)mkdir debian/release/pool/main/d/dragino/ -p(%%)**
Xiaoling 67.2 266
267
268 **Tree Structure:**
269
270 (% style="color:red" %)**Note: If you are not familiar with updating servers, most directory names are not recommended to be changed.**
271
272
273 └── debian
274
275 └── release
276
277 ├── dists
278
279 │   └── stable
280
281 │       └── main
282
283 │           └── binary-armhf
284
285 └── pool
286
287 └── main
288
289 └── d
290
Xiaoling 70.5 291 └── dragino   ~-~-> (% style="background-color:yellow; color:green" %)**This is the directory to store the packages. User can change it to other name.**
Xiaoling 67.2 292
293
294
295 === 3.2.4 Get deb packages ===
296
297
298 The deb packages for auto-update can be placed in** (% style="color:blue" %)/var/www/html/debian/release/pool/main/d/dragino/(%%)**
299
300 Below is an example package(testing-0808.deb) for test purpose:
301
302
Xiaoling 70.5 303 **~ (% style="background-color:yellow; color:green" %)wget http:~/~/repo.dragino.com/release/tool/unimportant/testing-0808.deb(%%)**
Xiaoling 67.2 304
Xiaoling 70.5 305 **~ (% style="background-color:yellow; color:green" %)cp ./testing-0808.deb /var/www/html/debian/release/pool/main/d/dragino/(%%)**
Xiaoling 67.2 306
307
308
309 === 3.2.5 Generate Package Index file ===
310
311
Xiaoling 70.5 312 (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/**
Xiaoling 67.2 313
Xiaoling 70.5 314 (% style="background-color:yellow; color:green" %)**dpkg-scanpackages pool/ > dists/stable/main/binary-armhf/Packages**
Xiaoling 67.2 315
Xiaoling 70.5 316 (% style="background-color:yellow; color:green" %)**cat dists/stable/main/binary-armhf/Packages | gzip -9 > dists/stable/main/binary-armhf/Packages.gz**
Xiaoling 67.2 317
318
319 (% 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.**
320
321
322
323 === 3.2.6 Generate Release file ===
324
325
Xiaoling 70.10 326 ==== (% style="color:blue" %)**Create the generated script:**(%%) ====
Xiaoling 67.2 327
328
Xiaoling 70.5 329 (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/dists/stable**
Xiaoling 67.2 330
331
Xiaoling 70.5 332 (% 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]]**
Xiaoling 67.2 333
Xiaoling 70.5 334 (% style="background-color:yellow; color:green" %)**chmod + x ./generate-release.sh**
Xiaoling 67.2 335
Xiaoling 70.5 336 (% style="background-color:yellow; color:green" %)**./generate-release.sh > Release**
Xiaoling 67.2 337
338
339
340 === 3.2.7 Sign the Release file with gpg and generating Inrelease file ===
341
342
Xiaoling 68.2 343
Xiaoling 70.7 344 ==== (% style="color:blue" %)**Make sure auto-update server has gnupg**(%%) ====
Xiaoling 67.2 345
346
Xiaoling 70.5 347 (% style="background-color:yellow; color:green" %)**apt install gnupg**
Xiaoling 68.2 348
349
350
Xiaoling 70.7 351 ==== (% style="color:blue" %)**generate gpg key**(%%) ====
Xiaoling 67.2 352
353
Xiaoling 70.5 354 (% style="background-color:yellow; color:green" %)**gpg -gen-key**
Xiaoling 67.2 355
Xiaoling 68.2 356
Xiaoling 70.10 357 (% style="color:red" %)**Note: Fill in the content as required and remember the name and email address.**
Xiaoling 67.2 358
359
Xiaoling 68.2 360
Xiaoling 70.7 361 ==== (% style="color:blue" %)**Check the gen-key**(%%) ====
Xiaoling 67.2 362
363
Xiaoling 70.5 364 (% style="background-color:yellow; color:green" %)**gen -list-key**
Xiaoling 67.2 365
Xiaoling 68.2 366
367
Xiaoling 70.7 368 ==== (% style="color:blue" %)**Generate the release.gpg**(%%) ====
Xiaoling 67.2 369
370
Xiaoling 70.5 371 (% style="background-color:yellow; color:green" %)**cd /var/www/html/debian/release/dists/stable**
Xiaoling 67.2 372
Xiaoling 70.5 373 (% style="background-color:yellow; color:green" %)**gpg ~-~-armor ~-~-detach-sign -o Release.gpg Release**
Xiaoling 67.2 374
375
Xiaoling 70.5 376 (% style="background-color:yellow; color:green" %)**gpg ~-~-clearsign -o InRelease Release**
Xiaoling 67.2 377
378
Xiaoling 68.2 379
Xiaoling 70.7 380 ==== (% style="color:blue" %)**Generate the public key**(%%) ====
Xiaoling 67.2 381
382
Xiaoling 70.5 383 (% style="background-color:yellow; color:green" %)**gpg ~-~-armor ~-~-output <name>.asc ~-~-export <email address>**
Xiaoling 67.2 384
Xiaoling 68.2 385
Xiaoling 67.2 386 **example: gpg ~-~-armor ~-~-output xiao.asc ~-~-export **[[xiaoye@dragino.cc>>mailto:xiaoye@dragino.cc]]
387
388
389
390 === 3.2.8 Add url as apt source in LPS8v2 / MS20 ===
391
Xiaoling 68.2 392
393
Xiaoling 70.7 394 ==== (% style="color:blue" %)**Add the public key**(%%) ====
Xiaoling 67.2 395
396
Xiaoling 70.5 397 (% style="background-color:yellow; color:green" %)**cp xiao.asc /etc/apt/trusted.gpg.d/**
Xiaoling 67.2 398
Xiaoling 70.7 399
Xiaoling 68.2 400 (% style="color:red" %)**Note: First need to transfer the public key from auto-update server to device.**
Xiaoling 67.2 401
Xiaoling 68.2 402
403
Xiaoling 70.7 404 ==== (% style="color:blue" %)**Add the apt source list**(%%) ====
Xiaoling 67.2 405
Xiaoling 68.2 406
Xiaoling 67.2 407 Add the apt source list url and name this as test_server.list
408
Xiaoling 70.5 409 (% 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**
Xiaoling 67.2 410
411
Xiaoling 68.2 412
Xiaoling 70.7 413 ==== (% style="color:blue" %)**Validate the apt repository**(%%) ====
Xiaoling 67.2 414
Xiaoling 68.2 415
Xiaoling 67.2 416 Get and install the testing package (download testing-0808.deb and test)
417
Xiaoling 70.5 418 (% style="background-color:yellow; color:green" %)**apt update && apt install testing**
Xiaoling 67.2 419
Xiaoling 68.2 420
Xiaoling 67.2 421 Example output:
422
Xiaoling 68.2 423 [[image:1661306420449-569.png]]
Xiaoling 67.2 424
425
426
Xiaoling 70.2 427 === 3.2.9 Configure the gateway's auto-upgrade rules ===
Xiaoling 67.2 428
429
Xiaoling 70.7 430 ==== (% style="color:blue" %)**Remove dragino apt source**(%%) ====
Xiaoling 67.2 431
432
Xiaoling 70.5 433 (% style="background-color:yellow; color:green" %)**/etc/apt/sources.list**
Xiaoling 67.2 434
435
Xiaoling 70.2 436 [[image:1661306460134-112.png]]
Xiaoling 67.2 437
438
439
Xiaoling 70.7 440 ==== (% style="color:blue" %)**Set up automatic updates**(%%) ====
Xiaoling 67.2 441
442
Xiaoling 70.5 443 (% style="background-color:yellow; color:green" %)**Path : /usr/lib/dragino/dragino-apt-updates**
Xiaoling 67.2 444
Xiaoling 70.2 445
Xiaoling 67.2 446 The device performs automatic updates from this script,
447
448 But it will now only look for dragino as a keyword, so you need to replace the keyword dragino with your own keyword.
449
450
Xiaoling 70.2 451 [[image:1661306487761-768.png]]
452
Edwin Chen 1.1 453