-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.html
592 lines (526 loc) · 17.3 KB
/
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
<!DOCTYPE html>
<html>
<head>
<title>README.md</title>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<style>
/* https://github.com/microsoft/vscode/blob/master/extensions/markdown-language-features/media/markdown.css */
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
body {
font-family: var(--vscode-markdown-font-family, -apple-system, BlinkMacSystemFont, "Segoe WPC", "Segoe UI", "Ubuntu", "Droid Sans", sans-serif);
font-size: var(--vscode-markdown-font-size, 14px);
padding: 0 26px;
line-height: var(--vscode-markdown-line-height, 22px);
word-wrap: break-word;
}
#code-csp-warning {
position: fixed;
top: 0;
right: 0;
color: white;
margin: 16px;
text-align: center;
font-size: 12px;
font-family: sans-serif;
background-color:#444444;
cursor: pointer;
padding: 6px;
box-shadow: 1px 1px 1px rgba(0,0,0,.25);
}
#code-csp-warning:hover {
text-decoration: none;
background-color:#007acc;
box-shadow: 2px 2px 2px rgba(0,0,0,.25);
}
body.scrollBeyondLastLine {
margin-bottom: calc(100vh - 22px);
}
body.showEditorSelection .code-line {
position: relative;
}
body.showEditorSelection .code-active-line:before,
body.showEditorSelection .code-line:hover:before {
content: "";
display: block;
position: absolute;
top: 0;
left: -12px;
height: 100%;
}
body.showEditorSelection li.code-active-line:before,
body.showEditorSelection li.code-line:hover:before {
left: -30px;
}
.vscode-light.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(0, 0, 0, 0.15);
}
.vscode-light.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(0, 0, 0, 0.40);
}
.vscode-light.showEditorSelection .code-line .code-line:hover:before {
border-left: none;
}
.vscode-dark.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(255, 255, 255, 0.4);
}
.vscode-dark.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(255, 255, 255, 0.60);
}
.vscode-dark.showEditorSelection .code-line .code-line:hover:before {
border-left: none;
}
.vscode-high-contrast.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(255, 160, 0, 0.7);
}
.vscode-high-contrast.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(255, 160, 0, 1);
}
.vscode-high-contrast.showEditorSelection .code-line .code-line:hover:before {
border-left: none;
}
img {
max-width: 100%;
max-height: 100%;
}
a {
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
a:focus,
input:focus,
select:focus,
textarea:focus {
outline: 1px solid -webkit-focus-ring-color;
outline-offset: -1px;
}
hr {
border: 0;
height: 2px;
border-bottom: 2px solid;
}
h1 {
padding-bottom: 0.3em;
line-height: 1.2;
border-bottom-width: 1px;
border-bottom-style: solid;
}
h1, h2, h3 {
font-weight: normal;
}
table {
border-collapse: collapse;
}
table > thead > tr > th {
text-align: left;
border-bottom: 1px solid;
}
table > thead > tr > th,
table > thead > tr > td,
table > tbody > tr > th,
table > tbody > tr > td {
padding: 5px 10px;
}
table > tbody > tr + tr > td {
border-top: 1px solid;
}
blockquote {
margin: 0 7px 0 5px;
padding: 0 16px 0 10px;
border-left-width: 5px;
border-left-style: solid;
}
code {
font-family: Menlo, Monaco, Consolas, "Droid Sans Mono", "Courier New", monospace, "Droid Sans Fallback";
font-size: 1em;
line-height: 1.357em;
}
body.wordWrap pre {
white-space: pre-wrap;
}
pre:not(.hljs),
pre.hljs code > div {
padding: 16px;
border-radius: 3px;
overflow: auto;
}
pre code {
color: var(--vscode-editor-foreground);
tab-size: 4;
}
/** Theming */
.vscode-light pre {
background-color: rgba(220, 220, 220, 0.4);
}
.vscode-dark pre {
background-color: rgba(10, 10, 10, 0.4);
}
.vscode-high-contrast pre {
background-color: rgb(0, 0, 0);
}
.vscode-high-contrast h1 {
border-color: rgb(0, 0, 0);
}
.vscode-light table > thead > tr > th {
border-color: rgba(0, 0, 0, 0.69);
}
.vscode-dark table > thead > tr > th {
border-color: rgba(255, 255, 255, 0.69);
}
.vscode-light h1,
.vscode-light hr,
.vscode-light table > tbody > tr + tr > td {
border-color: rgba(0, 0, 0, 0.18);
}
.vscode-dark h1,
.vscode-dark hr,
.vscode-dark table > tbody > tr + tr > td {
border-color: rgba(255, 255, 255, 0.18);
}
</style>
<style>
/* Tomorrow Theme */
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
/* Tomorrow Comment */
.hljs-comment,
.hljs-quote {
color: #8e908c;
}
/* Tomorrow Red */
.hljs-variable,
.hljs-template-variable,
.hljs-tag,
.hljs-name,
.hljs-selector-id,
.hljs-selector-class,
.hljs-regexp,
.hljs-deletion {
color: #c82829;
}
/* Tomorrow Orange */
.hljs-number,
.hljs-built_in,
.hljs-builtin-name,
.hljs-literal,
.hljs-type,
.hljs-params,
.hljs-meta,
.hljs-link {
color: #f5871f;
}
/* Tomorrow Yellow */
.hljs-attribute {
color: #eab700;
}
/* Tomorrow Green */
.hljs-string,
.hljs-symbol,
.hljs-bullet,
.hljs-addition {
color: #718c00;
}
/* Tomorrow Blue */
.hljs-title,
.hljs-section {
color: #4271ae;
}
/* Tomorrow Purple */
.hljs-keyword,
.hljs-selector-tag {
color: #8959a8;
}
.hljs {
display: block;
overflow-x: auto;
color: #4d4d4c;
padding: 0.5em;
}
.hljs-emphasis {
font-style: italic;
}
.hljs-strong {
font-weight: bold;
}
</style>
<style>
/*
* Markdown PDF CSS
*/
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe WPC", "Segoe UI", "Ubuntu", "Droid Sans", sans-serif, "Meiryo";
padding: 0 12px;
}
pre {
background-color: #f8f8f8;
border: 1px solid #cccccc;
border-radius: 3px;
overflow-x: auto;
white-space: pre-wrap;
overflow-wrap: break-word;
}
pre:not(.hljs) {
padding: 23px;
line-height: 19px;
}
blockquote {
background: rgba(127, 127, 127, 0.1);
border-color: rgba(0, 122, 204, 0.5);
}
.emoji {
height: 1.4em;
}
code {
font-size: 14px;
line-height: 19px;
}
/* for inline code */
:not(pre):not(.hljs) > code {
color: #C9AE75; /* Change the old color so it seems less like an error */
font-size: inherit;
}
/* Page Break : use <div class="page"/> to insert page break
-------------------------------------------------------- */
.page {
page-break-after: always;
}
</style>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
</head>
<body>
<script>
mermaid.initialize({
startOnLoad: true,
theme: document.body.classList.contains('vscode-dark') || document.body.classList.contains('vscode-high-contrast')
? 'dark'
: 'default'
});
</script>
<p><img src="assets/microchip.png" alt="https://www.microchip.com/"></p>
<h1 id="template-mplab-x-project-for-sensiml">Template MPLAB X Project for SensiML</h1>
<h1 id="contents">Contents</h1>
<ul>
<li><a href="#overview">Overview</a></li>
<li><a href="#knowledge-pack-deployment">Knowledge Pack Deployment</a></li>
<li><a href="#knowledge-pack-integration">Knowledge Pack Integration</a>
<ul>
<li><a href="#binary-format">Binary Format</a></li>
<li><a href="#library-format">Library Format</a></li>
<li><a href="#source-format">Source Format</a></li>
</ul>
</li>
<li><a href="#firmware-operation">Firmware Operation</a></li>
<li><a href="#visualization-with-sensiml-open-gateway">Visualization with SensiML Open Gateway</a></li>
</ul>
<div style="page-break-after: always;"></div>
<h1 id="overview">Overview</h1>
<p>This repository contains an MPLAB X project that can be used as a starting point for running any SensiML Knowledge Pack on the SAMD21 Machine Learning Evaluation Kit (<a href="https://www.microchip.com/developmenttools/ProductDetails/EV45Y33A">BMI160</a> or <a href="https://www.microchip.com/DevelopmentTools/ProductDetails/PartNO/EV18H79A">ICM42688</a> variant). Read on for instructions on how to go from a SensiML Knowledge Pack deployment to a full working MPLAB X project.</p>
<table>
<thead>
<tr>
<th style="text-align:center"><img src="assets/mlkits.png" alt="ml eval kits"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center"><em>Microchip SAMD21 Machine Learning Evaluation Kits</em></td>
</tr>
</tbody>
</table>
<h2 id="hardware-used">Hardware Used</h2>
<ul>
<li>SAMD21 Machine Learning Evaluation Kit with Bosch BMI160 IMU (<a href="https://www.microchip.com/developmenttools/ProductDetails/EV45Y33A">EV45Y33A</a>)</li>
<li>SAMD21 Machine Learning Evaluation Kit with TDK ICM42688 IMU (<a href="https://www.microchip.com/developmenttools/ProductDetails/EV18H79A">EV18H79A</a>)</li>
</ul>
<h2 id="software-used">Software Used</h2>
<ul>
<li>MPLAB® X IDE (https://microchip.com/mplab/mplab-x-ide)</li>
<li>MPLAB® XC32 compiler (https://microchip.com/mplab/compilers)</li>
<li>MPLAB® Harmony 3 (https://www.microchip.com/harmony)</li>
<li>SensiML Analytics Toolkit (https://sensiml.com/download/)</li>
</ul>
<h2 id="related-documentation">Related Documentation</h2>
<ul>
<li>ATSAMD21G18 <a href="https://www.microchip.com/wwwproducts/en/ATSAMD21G18">Product Family Page</a></li>
<li>SAM-IoT WG Development Board <a href="https://www.microchip.com/developmenttools/ProductDetails/EV75S95A">Product Details</a></li>
</ul>
<div style="page-break-after: always;"></div>
<h1 id="knowledge-pack-deployment">Knowledge Pack Deployment</h1>
<p>To deploy a knowledge pack for the SAMD21 ML Eval Kit:</p>
<ol>
<li>Open up your SensiML project in the <a href="https://app.sensiml.cloud/">Analytics Studio</a> and navigate to the <em>Download Model</em> tab.</li>
<li>Select <code>Microchip SAMD21 ML Eval Kit</code> from the <em>HW Platform</em> options.</li>
<li>Select one of <em>Binary</em>, <em>Library</em> or <em>Source</em> from the <em>Format</em> options. <em>Note: source format is only available for upper tier customers</em>.</li>
<li>Select the appropriate sensor configuration for your project from the <em>Data Source</em> options. Note that this configuration should match the one you used to capture the data your model was trained with.</li>
<li>Click the <em>Download</em> button to download the model.</li>
</ol>
<table>
<thead>
<tr>
<th style="text-align:center"><img src="assets/deployment.jpeg" alt="https://www.microchip.com/"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">Deployment from the Analytics Studio</td>
</tr>
</tbody>
</table>
<div style="page-break-after: always;"></div>
<h1 id="knowledge-pack-integration">Knowledge Pack Integration</h1>
<h2 id="binary-format">Binary Format</h2>
<p>If you deployed a knowledge pack in the <em>Binary</em> format, the archive should contain the binary file which can be written directly to the SAMD21.</p>
<h2 id="library-format">Library Format</h2>
<p>If you deployed a knowledge pack in the <em>Library</em> format, the archive should contain a complete, ready to compile, MPLAB X project. Follow the steps below to compile your project:</p>
<ol>
<li>In MPLAB X, open up the .X project folder under the <code>firmware</code> folder of the knowledge pack</li>
<li>Select the <em>Project Configuration</em> option in the MPLAB X toolbar according to which sensor you're using.
<table>
<thead>
<tr>
<th style="text-align:center"><img src="assets/project-configuration.png" alt="https://www.microchip.com/"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">Set the Project Configuration according to sensor</td>
</tr>
</tbody>
</table>
</li>
</ol>
<p>Your project should now be ready to compile.</p>
<h2 id="source-format">Source Format</h2>
<p>If you deployed a knowledge pack in the <em>Source</em> format there are a few manual steps to add the required sensiml files to the MPLAB X project:</p>
<ol>
<li>In MPLAB X, open up the .X project folder under the <code>firmware</code> folder of this repository.</li>
<li>Select the <em>Project Configuration</em> option in the MPLAB X toolbar according to which sensor you're using.
<table>
<thead>
<tr>
<th style="text-align:center"><img src="assets/project-configuration.png" alt="https://www.microchip.com/"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">Set the Project Configuration according to sensor</td>
</tr>
</tbody>
</table>
</li>
<li>In the <em>Projects</em> pane, right click the <em>Header Files</em> folder under the template project and select <em>Add Existing Items from Folders</em> from the options.
<table>
<thead>
<tr>
<th style="text-align:center"><img src="assets/add_header_files_1.png" alt="https://www.microchip.com/"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">Adding knowledge pack header files to your project</td>
</tr>
</tbody>
</table>
</li>
<li>In the resulting window that opens, click the <em>Add Folder</em> button.</li>
<li>In the new dialog, select <em>Header Files</em> from the <em>Files of Type</em> dropdown, then navigate to the template project's <code>firmware</code> directory and select the <code>knowledgepack</code> directory. Click the <em>Select</em> button to add the directory.
<table>
<thead>
<tr>
<th style="text-align:center"><img src="assets/add_header_files_2.png" alt="https://www.microchip.com/"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">Recursively add header files (.h) under the <code>knowledgepack</code> folder</td>
</tr>
</tbody>
</table>
</li>
<li>Back in the <em>Add Files</em> window, click the <em>Add</em> button to finish adding the necessary header files and close the dialog.</li>
<li>Right click the <em>Source Files</em> folder in the <em>Projects</em> pane and select <em>Add Existing Items from Folders</em> from the menu. Repeat steps 4-6 to add all source files (.c files) from the <code>knowledgepack</code> folder.</li>
</ol>
<p>Your Knowledge Pack is now integrated into your MPLAB X project. You should be able to compile your project and flash it onto the SAMD21.</p>
<div style="page-break-after: always;"></div>
<h1 id="firmware-operation">Firmware Operation</h1>
<p>The firmware behavior can be summarized as operating in one of three distinct states as reflected by the onboard LEDs and described in the table below:</p>
<table>
<thead>
<tr>
<th>State</th>
<th>LED Behavior</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Error</td>
<td>Red (ERROR) LED lit</td>
<td>Fatal error. (Do you have the correct sensor plugged in?).</td>
</tr>
<tr>
<td>Buffer Overflow</td>
<td>Yellow (DATA) and Red (ERROR) LED lit for 5 seconds</td>
<td>Processing is not able to keep up with real-time; data buffer has been reset.</td>
</tr>
<tr>
<td>Running</td>
<td>Yellow (DATA) LED flashing slowly</td>
<td>Firmware is running normally.</td>
</tr>
</tbody>
</table>
<p>When operating normally, the firmware prints the classification prediction (classification ID number) and the generated feature vector for each sample window over the UART port. To read the UART port use a terminal emulator of your choice (e.g., MPLAB Data Visualizer's integrated terminal tool) with the following settings:</p>
<ul>
<li>Baudrate 115200</li>
<li>Data bits 8</li>
<li>Stop bits 1</li>
<li>Parity None</li>
</ul>
<p>A sample of the terminal output is shown in the figure below.</p>
<table>
<thead>
<tr>
<th style="text-align:center"><img src="assets/terminal-output.png" alt="Terminal output"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">UART Terminal Output</td>
</tr>
</tbody>
</table>
<p>Note that by default the feature vector will not be output. You can enable this behavior by setting <code>write_features=1</code> in <code>sml_output.c</code>.</p>
<div style="page-break-after: always;"></div>
<h1 id="visualization-with-sensiml-open-gateway">Visualization with SensiML Open Gateway</h1>
<p>In addition to reading the text output of the firmware with a terminal emulator, the output may be visualized with the SensiML <a href="https://github.com/sensiml/open-gateway">Open Gateway application</a>. Follow the below instructions to get started:</p>
<ol>
<li>Open a terminal and change to the directory where you've checked out this repository.</li>
<li>Clone the open-gateway repository and install the dependencies:
<blockquote>
<p><code>git clone https://github.com/sensiml/open-gateway</code><br>
<code>pip install -r open-gateway/requirements.txt</code></p>
</blockquote>
</li>
<li>Change the baudrate (<code>BAUD_RATE</code> variable) in <code>open-gateway/config.py</code> to 115200</li>
<li>Change to the open-gateway directory and run the open-gateway application, passing in the knowledge pack model.json description file:
<blockquote>
<p><code>cd open-gateway</code><br>
<code>python app.py -m $(find ../firmware/knowledgepack/ -name model.json)</code></p>
</blockquote>
</li>
<li>Connect to the SAMD21 board in the gateway application:
<ul>
<li>Select the <code>Recognition</code> device mode.</li>
<li>Select <code>Serial</code> connection type, and enter the UART address (e.g. COM4) in the <code>Device ID</code> field.</li>
<li>Click <code>Connect To Device</code>.</li>
</ul>
</li>
<li>Switch to the <code>Test Mode</code> tab and click <code>Start Stream</code>.</li>
</ol>
</body>
</html>