Skip to content

Commit 09c6b6a

Browse files
committed
add details of uHex tool
1 parent 652023b commit 09c6b6a

File tree

4 files changed

+27
-4
lines changed

4 files changed

+27
-4
lines changed

latest-revision/latest-revision-editors.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,9 @@ The latest board revision introduces a superset of the Intel-Hex format that ena
9898
A **Universal Hex** hex file will work on a V1 or V2 board.
9999
A clear indication that you are working with this format is that a compiled .hex file will be ~1.8Mb as opposed to ~700Kb in size.
100100

101-
A [Universal Hex JavaScript Library](https://github.com/microbit-foundation/microbit-universal-hex) has been written to implement the format and associated detailed [specification of the Universal Hex format](https://github.com/microbit-foundation/universal-hex/). Please [get in contact](mailto:support@microbit.org?subject=Request%20for%20access%20to%20Universal%20hex&20spec&body=Name%3A%0D%0A%0D%0AGitHub%20ID%3A) if you require access to the specification.
101+
We have created a [Universal Hex Creator](../software/universal-hex-creator) tool, to easily create a .hex file that will support all micro:bit variants.
102+
103+
This tool is based on a [Universal Hex JavaScript Library](https://github.com/microbit-foundation/microbit-universal-hex), written to implement the format and associated detailed [specification of the Universal Hex format](https://github.com/microbit-foundation/universal-hex/). Please [get in contact](mailto:support@microbit.org?subject=Request%20for%20access%20to%20Universal%20hex&20spec&body=Name%3A%0D%0A%0D%0AGitHub%20ID%3A) if you require access to the specification.
102104

103105
### Hex format compatibility
104106

latest-revision/latest-revision-main.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ The editors and apps are compatible with and will let you download and flash a f
167167

168168
More information about this is available on our [hex format](../software/hex-format/#universal-hex-files) page
169169

170-
The Foundation has written a javascript library to generate these files - you do not need to re-implement any file generation.
170+
The Foundation has written a javascript library and [Universal Hex Creator](../software/universal-hex-creator) to generate these files - you do not need to re-implement any file generation.
171171

172172
### Bluetooth BLE
173173

software/hex-format.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ A clear indication that you are working with this format is that a compiled .hex
2828

2929
A [Universal Hex JavaScript Library](https://github.com/microbit-foundation/microbit-universal-hex) has been written to implement the format and associated detailed [specification of the Universal Hex format](https://github.com/microbit-foundation/universal-hex/).
3030

31+
## Universal Hex Creator
32+
33+
We have created a [Universal Hex Creator](./universal-hex-creator) tool, to easily create a .hex file that will support all micro:bit variants.
34+
35+
This tool is based on the [Universal Hex JavaScript Library](https://github.com/microbit-foundation/microbit-universal-hex).
36+
3137
### Cross device compatibility
3238

3339
The Universal Hex format has been developed to ensure the best experience for users when moving between board variants. If a V1 only .hex is detected on a V2 board it will throw an error, but a V2 only hex will fail silently on a V1. This is very confusing to users and should be avoided.
@@ -36,8 +42,6 @@ There may be cases where it is not possible to support both boards, for example
3642

3743
We have created a [standalone error hex](/docs/software/assets/stand-alone-error-v1.hex) that can be combined with a V2 only hex to produce a Hex that will work on a V2 board, but error if used on a V1.
3844

39-
{% include alert-info.html content="We are currently working on a web based and CLI tool to generate Universal Hex files and will publish information on usage here when this is ready. In the meantime, please [get in contact](mailto:support@microbit.org) if you require further information" %}
40-
4145
[Download standalone error hex](/docs/software/assets/stand-alone-error-v1.hex){: .btn.sm-btn download}
4246

4347
This example shows the worst, best and acceptable (when support for V1 is impossible) cases for users. The best case is to provide a Universal Hex that supports all board variants.

software/universal-hex-tool.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: page
3+
title: Universal Hex Creator
4+
heading: Universal Hex Creator
5+
description: Create a Universal Hex file
6+
permalink: /software/universal-hex-creator/
7+
ref: universal-hex-tool
8+
lang: en
9+
assigned-to: markw
10+
review-with: carlospa
11+
---
12+
13+
The Universal Hex Creator lets you combine a hex file created for a micro:bit V1 device and a hex file created for a V2 device, resulting in a Universal Hex format that is compatible with all revisions of the micro:bit.
14+
15+
DAPLink will process the Universal Hex and only write data to the relevant board revision; V1 or V2. More information is available on our [Hex format](../hex-format) page and the [Javascript/Typescript libary](https://github.com/microbit-foundation/microbit-universal-hex) on which the Universal Hex Creator tool is based.
16+
17+
{% include uhex-tool.html %}

0 commit comments

Comments
 (0)