1+ <!doctype html>
2+ < html class ="default no-js ">
3+ < head >
4+ < meta charset ="utf-8 ">
5+ < meta http-equiv ="X-UA-Compatible " content ="IE=edge ">
6+ < title > microbitBoardId | Universal Hex API Docs - v0.2.2</ title >
7+ < meta name ="description " content ="">
8+ < meta name ="viewport " content ="width=device-width, initial-scale=1 ">
9+ < link rel ="stylesheet " href ="../assets/css/main.css ">
10+ </ head >
11+ < body >
12+ < header >
13+ < div class ="tsd-page-toolbar ">
14+ < div class ="container ">
15+ < div class ="table-wrap ">
16+ < div class ="table-cell " id ="tsd-search " data-index ="../assets/js/search.json " data-base =".. ">
17+ < div class ="field ">
18+ < label for ="tsd-search-field " class ="tsd-widget search no-caption "> Search</ label >
19+ < input id ="tsd-search-field " type ="text " />
20+ </ div >
21+ < ul class ="results ">
22+ < li class ="state loading "> Preparing search index...</ li >
23+ < li class ="state failure "> The search index is not available</ li >
24+ </ ul >
25+ < ul class ="results-priority " style ="display:none ">
26+ </ ul >
27+ < a href ="../index.html " class ="title "> Universal Hex API Docs - v0.2.2</ a >
28+  < a href ="" class ="title "> | </ a >
29+  < a href ="https://github.com/microbit-foundation/spec-universal-hex/ " class ="title "> Universal Hex Spec </ a >
30+  < a href ="" class ="title "> | </ a >
31+  < a href ="https://microbit-foundation.github.io/microbit-universal-hex/ " class ="title "> General Docs </ a >
32+  < a href ="" class ="title "> | </ a >
33+  < a href ="https://tech.microbit.org/ " class ="title "> micro:bit Tech Site </ a >
34+ </ div >
35+ < div class ="table-cell " id ="tsd-widgets ">
36+ < div id ="tsd-filter ">
37+ < a href ="# " class ="tsd-widget options no-caption " data-toggle ="options "> Options</ a >
38+ < div class ="tsd-filter-group ">
39+ < div class ="tsd-select " id ="tsd-filter-visibility ">
40+ < span class ="tsd-select-label "> All</ span >
41+ < ul class ="tsd-select-list ">
42+ < li data-value ="public "> Public</ li >
43+ < li data-value ="protected "> Public/Protected</ li >
44+ < li data-value ="private " class ="selected "> All</ li >
45+ </ ul >
46+ </ div >
47+ < input type ="checkbox " id ="tsd-filter-inherited " checked />
48+ < label class ="tsd-widget " for ="tsd-filter-inherited "> Inherited</ label >
49+ </ div >
50+ </ div >
51+ < a href ="# " class ="tsd-widget menu no-caption " data-toggle ="menu "> Menu</ a >
52+ </ div >
53+ </ div >
54+ </ div >
55+ </ div >
56+ < div class ="tsd-page-title ">
57+ < div class ="container ">
58+ < ul class ="tsd-breadcrumb ">
59+ < li >
60+ < a href ="../modules/_universal_hex_.html "> universal-hex</ a >
61+ </ li >
62+ < li >
63+ < a href ="_universal_hex_.microbitboardid.html "> microbitBoardId</ a >
64+ </ li >
65+ </ ul >
66+ </ div >
67+ </ div >
68+ </ header >
69+ < div class ="container container-main ">
70+ < div class ="row ">
71+ < div class ="col-3 col-menu menu-sticky-wrap menu-highlight ">
72+ < nav class ="tsd-navigation outline primary ">
73+ < a style ="margin-left:0em " href ="../globals.html "> Globals</ a >
74+ < ul style ="display:none ">
75+ {"Public API":{"Universal Hex module":"modules/_universal_hex_"}}
76+ </ ul >
77+ </ nav >
78+ </ div >
79+ < div class ="col-7 offset-3 col-content ">
80+ < h1 > Enumeration microbitBoardId</ h1 >
81+ < section class ="tsd-panel tsd-comment "> < div class ="tsd-comment tsd-typography tsd-comment-shorttext ">
82+ < div class ="lead ">
83+ < p > The Board ID is used to identify the different targets from a Universal Hex.
84+ In this case the target represents a micro:bit version.
85+ For micro:bit V1 (v1.3, v1.3B and v1.5) the < code > boardId</ code > is < code > 0x9900</ code > , and for
86+ V2 < code > 0x9903</ code > .</ p >
87+ </ div >
88+ </ div > </ section >
89+ < section class ="tsd-panel-group tsd-index-group ">
90+ < section class ="tsd-panel tsd-index-panel ">
91+ < div class ="tsd-index-content ">
92+ < section class ="tsd-index-section ">
93+ < h3 > Enumeration members</ h3 >
94+ < ul class ="tsd-index-list ">
95+ < li class ="tsd-kind-enum-member tsd-parent-kind-enum "> < a href ="_universal_hex_.microbitboardid.html#v1 " class ="tsd-kind-icon "> V1</ a > </ li >
96+ < li class ="tsd-kind-enum-member tsd-parent-kind-enum "> < a href ="_universal_hex_.microbitboardid.html#v2 " class ="tsd-kind-icon "> V2</ a > </ li >
97+ </ ul >
98+ </ section >
99+ </ div >
100+ </ section >
101+ </ section >
102+ < section class ="tsd-panel-group tsd-member-group ">
103+ < h2 > Enumeration members</ h2 >
104+ < section class ="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum ">
105+ < a name ="v1 " class ="tsd-anchor "> </ a >
106+ < h3 > V1</ h3 >
107+ < div class ="tsd-signature tsd-kind-icon "> V1< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-symbol "> = 39168</ span > </ div >
108+ < aside class ="tsd-sources ">
109+ < ul >
110+ < li > Defined in
111+ < a href ="https://github.com/microbit-foundation/microbit-universal-hex/tree/v0.2.1/src/universal-hex.ts#L31 ">
112+ universal-hex.ts:31
113+ </ a >
114+ </ li >
115+ </ ul >
116+ </ aside >
117+ </ section >
118+ < section class ="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum ">
119+ < a name ="v2 " class ="tsd-anchor "> </ a >
120+ < h3 > V2</ h3 >
121+ < div class ="tsd-signature tsd-kind-icon "> V2< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-symbol "> = 39171</ span > </ div >
122+ < aside class ="tsd-sources ">
123+ < ul >
124+ < li > Defined in
125+ < a href ="https://github.com/microbit-foundation/microbit-universal-hex/tree/v0.2.1/src/universal-hex.ts#L32 ">
126+ universal-hex.ts:32
127+ </ a >
128+ </ li >
129+ </ ul >
130+ </ aside >
131+ </ section >
132+ </ section >
133+ <!--{"options":"config/typedoc.json","tsconfig":"/Users/microbit-carlos/workspace/microbit-foundation/microbit-uh","inputFiles":["./src"],"mode":1,"includeDeclarations":false,"entryPoint":"","exclude":["**/__tests__/**/*"],"externalPattern":[],"excludeExternals":true,"excludeNotExported":true,"excludeNotDocumented":false,"excludePrivate":true,"excludeProtected":true,"ignoreCompilerErrors":false,"disableSources":false,"includes":"","media":"","out":"./docs/api","json":"","theme":"./node_modules/typedoc-neo-theme/bin/default","name":"Universal Hex API Docs","includeVersion":true,"excludeTags":[],"readme":"./docs/api-readme.md","defaultCategory":"Other","categoryOrder":[],"categorizeByGroup":true,"gitRevision":"","gitRemote":"origin","gaID":"","gaSite":"auto","hideGenerator":false,"toc":[],"disableOutputCheck":false,"help":false,"version":false,"plugin":[],"logger":"console","listInvalidSymbolLinks":false,"links":[{"label":" | ","url":null},{"label":" Universal Hex Spec ","url":"https://github.com/microbit-foundation/spec-universal-hex/"},{"label":" | ","url":null},{"label":" General Docs ","url":"https://microbit-foundation.github.io/microbit-universal-hex/"},{"label":" | ","url":null},{"label":" micro:bit Tech Site ","url":"https://tech.microbit.org/"}],"outline":[{"Public API":{"Universal Hex module":"modules/_universal_hex_"}}],"source":[{"path":"https://github.com/microbit-foundation/microbit-universal-hex/tree/v0.2.1/src/","line":"L"}]}-->
134+ </ div >
135+ < div class ="col-2 col-menu secondary-menu ">
136+ < nav class ="tsd-navigation secondary menu-sticky ">
137+ < ul class ="before-current ">
138+ </ ul >
139+ < ul class ="current ">
140+ < li class ="current tsd-kind-enum tsd-parent-kind-module root ">
141+ < a href ="_universal_hex_.microbitboardid.html " class ="tsd-kind-icon "> microbit< wbr > Board< wbr > Id</ a >
142+ < ul >
143+ < li class =" tsd-kind-enum-member tsd-parent-kind-enum ">
144+ < a href ="_universal_hex_.microbitboardid.html#v1 " class ="tsd-kind-icon "> V1</ a >
145+ </ li >
146+ < li class =" tsd-kind-enum-member tsd-parent-kind-enum ">
147+ < a href ="_universal_hex_.microbitboardid.html#v2 " class ="tsd-kind-icon "> V2</ a >
148+ </ li >
149+ </ ul >
150+ </ li >
151+ </ ul >
152+ < ul class ="after-current ">
153+ < li class =" tsd-kind-interface tsd-parent-kind-module root ">
154+ < a href ="../interfaces/_universal_hex_.individualhex.html " class ="tsd-kind-icon "> Individual< wbr > Hex</ a >
155+ </ li >
156+ < li class =" tsd-kind-function tsd-parent-kind-module root ">
157+ < a href ="../modules/_universal_hex_.html#createuniversalhex " class ="tsd-kind-icon "> create< wbr > Universal< wbr > Hex</ a >
158+ </ li >
159+ < li class =" tsd-kind-function tsd-parent-kind-module root ">
160+ < a href ="../modules/_universal_hex_.html#ihextocustomformatblocks " class ="tsd-kind-icon "> i< wbr > Hex< wbr > ToCustom< wbr > Format< wbr > Blocks</ a >
161+ </ li >
162+ < li class =" tsd-kind-function tsd-parent-kind-module root ">
163+ < a href ="../modules/_universal_hex_.html#ihextocustomformatsection " class ="tsd-kind-icon "> i< wbr > Hex< wbr > ToCustom< wbr > Format< wbr > Section</ a >
164+ </ li >
165+ < li class =" tsd-kind-function tsd-parent-kind-module root ">
166+ < a href ="../modules/_universal_hex_.html#ismakecodeforv1hex " class ="tsd-kind-icon "> is< wbr > Make< wbr > Code< wbr > For< wbr > V1Hex</ a >
167+ </ li >
168+ < li class =" tsd-kind-function tsd-parent-kind-module root ">
169+ < a href ="../modules/_universal_hex_.html#isuniversalhex " class ="tsd-kind-icon "> is< wbr > Universal< wbr > Hex</ a >
170+ </ li >
171+ < li class =" tsd-kind-function tsd-parent-kind-module root ">
172+ < a href ="../modules/_universal_hex_.html#separateuniversalhex " class ="tsd-kind-icon "> separate< wbr > Universal< wbr > Hex</ a >
173+ </ li >
174+ </ ul >
175+ </ nav >
176+ </ div >
177+ </ div >
178+ </ div >
179+ < footer class ="with-border-bottom ">
180+ </ footer >
181+ < div class ="container tsd-generator ">
182+ < p > Generated using < a href ="http://typedoc.org/ " target ="_blank "> TypeDoc</ a > </ p >
183+ </ div >
184+ < div class ="overlay "> </ div >
185+ < script src ="../assets/js/main.js "> </ script >
186+ </ body >
187+ </ html >
0 commit comments