forked from cradlepoint/sdk-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGNU_Make_README.html
428 lines (365 loc) · 10.9 KB
/
GNU_Make_README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
<!DOCTYPE html>
<html>
<head>
<title>GNU_Make_README</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<style type="text/css">
/* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */
/* Author: Nicolas Hery - http://nicolashery.com */
/* Version: b13fe65ca28d2e568c6ed5d7f06581183df8f2ff */
/* Source: https://github.com/nicolahery/markdownpad-github */
/* RESET
=============================================================================*/
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0;
border: 0;
}
/* BODY
=============================================================================*/
body {
font-family: Helvetica, arial, freesans, clean, sans-serif;
font-size: 14px;
line-height: 1.6;
color: #333;
background-color: #fff;
padding: 20px;
max-width: 960px;
margin: 0 auto;
}
body>*:first-child {
margin-top: 0 !important;
}
body>*:last-child {
margin-bottom: 0 !important;
}
/* BLOCKS
=============================================================================*/
p, blockquote, ul, ol, dl, table, pre {
margin: 15px 0;
}
/* HEADERS
=============================================================================*/
h1, h2, h3, h4, h5, h6 {
margin: 20px 0 10px;
padding: 0;
font-weight: bold;
-webkit-font-smoothing: antialiased;
}
h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
font-size: inherit;
}
h1 {
font-size: 28px;
color: #000;
}
h2 {
font-size: 24px;
border-bottom: 1px solid #ccc;
color: #000;
}
h3 {
font-size: 18px;
}
h4 {
font-size: 16px;
}
h5 {
font-size: 14px;
}
h6 {
color: #777;
font-size: 14px;
}
body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {
margin-top: 0;
padding-top: 0;
}
a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
margin-top: 0;
padding-top: 0;
}
h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
margin-top: 10px;
}
/* LINKS
=============================================================================*/
a {
color: #4183C4;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* LISTS
=============================================================================*/
ul, ol {
padding-left: 30px;
}
ul li > :first-child,
ol li > :first-child,
ul li ul:first-of-type,
ol li ol:first-of-type,
ul li ol:first-of-type,
ol li ul:first-of-type {
margin-top: 0px;
}
ul ul, ul ol, ol ol, ol ul {
margin-bottom: 0;
}
dl {
padding: 0;
}
dl dt {
font-size: 14px;
font-weight: bold;
font-style: italic;
padding: 0;
margin: 15px 0 5px;
}
dl dt:first-child {
padding: 0;
}
dl dt>:first-child {
margin-top: 0px;
}
dl dt>:last-child {
margin-bottom: 0px;
}
dl dd {
margin: 0 0 15px;
padding: 0 15px;
}
dl dd>:first-child {
margin-top: 0px;
}
dl dd>:last-child {
margin-bottom: 0px;
}
/* CODE
=============================================================================*/
pre, code, tt {
font-size: 12px;
font-family: Consolas, "Liberation Mono", Courier, monospace;
}
code, tt {
margin: 0 0px;
padding: 0px 0px;
white-space: nowrap;
border: 1px solid #eaeaea;
background-color: #f8f8f8;
border-radius: 3px;
}
pre>code {
margin: 0;
padding: 0;
white-space: pre;
border: none;
background: transparent;
}
pre {
background-color: #f8f8f8;
border: 1px solid #ccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}
pre code, pre tt {
background-color: transparent;
border: none;
}
kbd {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
background-color: #DDDDDD;
background-image: linear-gradient(#F1F1F1, #DDDDDD);
background-repeat: repeat-x;
border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
border-image: none;
border-radius: 2px 2px 2px 2px;
border-style: solid;
border-width: 1px;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
line-height: 10px;
padding: 1px 4px;
}
/* QUOTES
=============================================================================*/
blockquote {
border-left: 4px solid #DDD;
padding: 0 15px;
color: #777;
}
blockquote>:first-child {
margin-top: 0px;
}
blockquote>:last-child {
margin-bottom: 0px;
}
/* HORIZONTAL RULES
=============================================================================*/
hr {
clear: both;
margin: 15px 0;
height: 0px;
overflow: hidden;
border: none;
background: transparent;
border-bottom: 4px solid #ddd;
padding: 0;
}
/* TABLES
=============================================================================*/
table th {
font-weight: bold;
}
table th, table td {
border: 1px solid #ccc;
padding: 6px 13px;
}
table tr {
border-top: 1px solid #ccc;
background-color: #fff;
}
table tr:nth-child(2n) {
background-color: #f8f8f8;
}
/* IMAGES
=============================================================================*/
img {
max-width: 100%
}
</style>
</head>
<body>
<h1>Router SDK reference application and development tools.</h1>
<p>Available GNU make targets:</p>
<p><strong>default:</strong>
Build and test the router SDK reference app and create the archive file suitable for deployment to a router DEV mode or for uploading to ECM.</p>
<p><strong>clean:</strong>
Clean all project artifacts. If a package returns with 'nothing to be done', a clean will cause the next package to occur.</p>
<p><strong>package:</strong>
Create the application archive tar.gz file.</p>
<p><strong>status:</strong>
Fetch and print current SDK app status from the locally connected router.</p>
<p><strong>install:</strong>
Secure copy the application archive to a locally connected router. The router must already be in DEV mode via the ECM.</p>
<p><strong>start:</strong>
Start the application on the locally connected router.</p>
<p><strong>stop:</strong>
Stop the application on the locally connected router.</p>
<p><strong>uninstall:</strong>
Uninstall the application from the locally connected router.</p>
<p><strong>purge:</strong>
Purge all applications from the locally connected router.</p>
<hr />
<h1>HOW-TO Steps for running the reference application on your router.</h1>
<ol>
<li>
<p>Register your router with ECM.</p>
</li>
<li>
<p>Put your router into DEV mode via ECM.</p>
</li>
<li>
<p>Export the following variables in your environment:</p>
<pre><code>APP_NAME - The directory that contains the app
APP_UUID - Each app must have its own UUID
DEV_CLIENT_MAC - The mac address of your router
DEV_CLIENT_IP - The lan ip address of your router
DEV_CLIENT_PASSWORD - The router password. Only needed if the
default password has been changed.
</code></pre>
<p>Example:</p>
<pre><code>$ export APP_NAME=ping
$ export APP_UUID=38858989-af8b-4e5d-8e2e-1cbc79acdde4
$ export DEV_CLIENT_MAC=44224267
$ export DEV_CLIENT_IP=192.168.0.1
</code></pre>
</li>
<li>
<p>Create the application package (i.e. <app_name>.tar.gz).</p>
<pre><code>$ make
</code></pre>
</li>
<li>
<p>Test connectivity with your router via the 'status' target.</p>
<pre><code>$ make status
curl -s --digest --insecure -u admin:441dbbec \
-H "Accept: application/json" \
-X GET http://192.168.0.1/api/status/system/sdk | \
/usr/bin/env python3 -m json.tool
{
"data": {},
"success": true
}
</code></pre>
</li>
<li>
<p>Install the application in the router.</p>
<pre><code>$ make install
scp /home/sfisher/dev/sdk/hspt.tar.gz [email protected]:/app_upload
[email protected]'s password:
hspt.tar.gz 100% 1439 1.4KB/s 00:00
Received disconnect from 192.168.0.1: 11: Bye Bye
lost connection
</code></pre>
</li>
<li>
<p>Get application execution status from your router.</p>
<pre><code>$ make status
curl -s --digest --insecure -u admin:441dbbec \
-H "Accept: application/json" \
-X GET http://192.168.0.1/api/status/system/sdk | \
/usr/bin/env python3 -m json.tool
{
"data": {
"7042c8fd-fe7a-4846-aed1-e3f8d6a1c91c": {
"app": {
"date": "2015-12-04T09:30:39.656151",
"name": "hspt",
"restart": true,
"uuid": "7042c8fd-fe7a-4846-aed1-e3f8d6a1c91c",
"vendor": "Cradlebox",
"version_major": 1,
"version_minor": 1
},
"base_directory": "/var/mnt/sdk/apps/7042c8fd-fe7a-4846-aed1-e3f8d6a1c91c",
"directory": hspt",
"filename": "dist/tmp_znv2t",
"state": "started",
"summary": "Package started successfully",
"type": "development",
"url": "file:///var/tmp/tmpg1385l",
"uuid": "7042c8fd-fe7a-4846-aed1-e3f8d6a1c91c"
}
},
"success": true
}
</code></pre>
</li>
<li>
<p>Uninstall the application in the router.</p>
<pre><code>$ make uninstall
curl -s --digest --insecure -u admin:441dbbec \
-H "Accept: application/json" \
-X PUT http://192.168.0.1/api/control/system/sdk/action \
-d data='"uninstall 7042c8fd-fe7a-4846-aed1-e3f8d6a1c91c"' | \
/usr/bin/env python3 -m json.tool
{
"data": "uninstall 7042c8fd-fe7a-4846-aed1-e3f8d6a1c91c",
"success": true
}
</code></pre>
</li>
</ol>
<hr />
<p>Published Date: 5-9-2017</p>
<p>This article not have what you need? Not find what you were looking for? Think this article can be improved? Please let us know at <a href="mailto:suggestions@cradlepoint.com">suggestions@cradlepoint.com</a>.</p>
</body>
</html>
<!-- This document was created with MarkdownPad, the Markdown editor for Windows (http://markdownpad.com) -->