@@ -12,35 +12,44 @@ nav_order: 1
12
12
13
13
Create Universal Hex files for the micro: bit .
14
14
15
- - [ micro: bit Universal Hex Specification] ( https://github.com/microbit-foundation/spec-universal-hex ) contains a lot more information
16
- about the file data format.
17
- - [ GitHub] ( https://microbit-foundation.github.io/microbit-universal-hex/ ) contains general documentation for this
18
- library.
19
- - [ The micro: bit Tech Site] ( https://tech.microbit.org ) contains general technical information about the
20
- micro: bit .
21
- - [ Universal Hex Creator demo] ( ./examples/webtool.html )
22
- - [ Universal Hex Splitter demo] ( ./examples/separate.html )
23
-
24
- ---
25
-
26
15
This is the documentation for the micro: bit Universal Hex library.
27
16
28
17
Here you will find the available public API to convert Intel Hex strings into Universal Hex strings and vice-versa.
29
18
30
- Originally the micro: bit hex files used the
31
- [ Intel Hex format] ( https://en.wikipedia.org/wiki/Intel_HEX ) and with the
32
- micro: bit V2 release a new hex format was created to be able to flash any
33
- micro: bit board version with a single file.
19
+ ## Universal Hex format
34
20
35
- The Universal Hex file format can contain the binary data for multiple micro: bit
36
- board versions and this TypeScript/JavaScript library can be used to create a
21
+ The micro: bit Universal Hex format is a superset of the
22
+ [ Intel Hex file format] ( https://en.wikipedia.org/wiki/Intel_HEX ) designed to be
23
+ able to include data for multiple targets into a single file. A Universal Hex file can contain the binary data for multiple micro: bit
24
+ board versions. This allows the creation of a hex file that will work on micro: bit V1 and V2.
25
+
26
+ Detailed information of the Universal Hex format can be found in the [ specification] ( https://github.com/microbit-foundation/spec-universal-hex ) .
27
+
28
+ This TypeScript/JavaScript library can be used to create a
37
29
micro: bit Universal Hex from two or more micro: bit Intel Hex files.
38
30
39
- ## Navigation
31
+ ## Online tool
32
+
33
+ An implementation example can be found in the [ webtool.html] ( ./examples/webtool.html )
34
+ in the repository and it is hosted in the
35
+ [ micro: bit Tech Site] ( ttps://tech.microbit.org ) .
36
+
37
+ This web tool can generate a Universal Hex from an Intel Hex file for micro: bit
38
+ V1 and an Intel Hex file for micro: bit V2.
39
+
40
+ - [ Universal Hex Creator] ( https://tech.microbit.org/software/universal-hex-creator/ )
41
+ - [ Universal Hex Separator] ( https://microbit-foundation.github.io/microbit-universal-hex/examples/separate.html )
42
+
43
+ ## Related documentation
44
+
45
+ [ micro: bit Universal Hex Specification] ( https://github.com/microbit-foundation/spec-universal-hex ) contains a lot more information
46
+ about the file data format.
47
+
48
+ [ GitHub] ( https://microbit-foundation.github.io/microbit-universal-hex/ ) contains general documentation for this
49
+ library.
40
50
41
- - ⬆️ The header at the top contains a search bar
42
- - ⬅️ The menu on the left shows you the available documentation pages
43
- - ⬇️ If you'd like to contribute to the docs there is an edit link at the footer
51
+ [ The micro: bit Tech Site] ( https://tech.microbit.org ) contains general technical information about the
52
+ micro: bit .
44
53
45
54
## License
46
55
0 commit comments