Wiki source code of Armbian OS instruction

Version 70.10 by Xiaoling on 2022/08/24 11:38

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