Skip to content

Commit 78aa3ef

Browse files
Add template for universal hex tool (#99)
* Add template for universal hex tool * update uhex tool template * update nav * remove placeholder page * Squashed 'docs/' changes from ae437c7..09c6b6a 09c6b6a add details of uHex tool 652023b Update BLE services file location cd87b61 Merge branch 'master' of https://github.com/microbit-foundation/dev-docs 3229f78 update feature availibility 9cf9964 Update latest-revision-main.md (#209) a7eb1ae Update edgeconnector.md: Fix badly rendered "V2" (#208) 6afa1e6 Correct spelling mistake (#210) 1af07f4 update CODAL info c72e636 Brand tidy up: v1 v2 > V1 V2 3f33b0f add audio expression api 8ac53a3 update BLE profile roles 38464b4 Update Soft Device SD140 > SD113 (#198) 0f1b15d add new brand guidelines info 3d3c6ed fix links 8260131 fix links 504c6df remove link to uhex spec as it 404s bee772f remove link to python mailing list ce75bb4 remove duplicate MakeCode 21c6a16 update table 200mA > 190mA 9cffab0 Update info on MakeCode blocks cc01c0f Latest updates for MakeCode and DAPLink (#193) 18ff8f7 Update hex-format.md: add missing space (#190) af73c3c Update apps-and-examples.md: add missing space (#189) 1f7d600 Spelling mistake (#186) b24c88f Re-phrasing bluetooth section (#181) 4007b76 Rephrase "lozenge" to "rounded rectangular" (#180) f8ca9aa Merge pull request #179 from Gadgetoid/spelling afe3441 Spelling and consistency tweaks 7b0e132 Merge pull request #175 from Gadgetoid/doc-consistency ac8b131 Consistent use of whitespace and Markdown formatting 670d1f1 Remove hard linebreaks and trailing whitespace (#174) 6be457a update iOS beta instructions (#173) 1b2f2ec Update DAPLink error message (#171) 955cf1a spelling git-subtree-dir: docs git-subtree-split: 09c6b6a * Squashed 'docs/' changes from 09c6b6a..a1401e3 a1401e3 fix links git-subtree-dir: docs git-subtree-split: a1401e3 * Squashed 'docs/' changes from a1401e3..1d5265b 1d5265b add details of uHex tool (#213) f5464d9 Rewrite community page (#203) REVERT: a1401e3 fix links REVERT: 09c6b6a add details of uHex tool git-subtree-dir: docs git-subtree-split: 1d5265b * add newlines
1 parent db55b4e commit 78aa3ef

File tree

5 files changed

+37
-11
lines changed

5 files changed

+37
-11
lines changed

community/slack.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ ref: community
99
lang: en
1010
---
1111

12-
The micro:bit community is already spread across the world, building cool things with micro:bits and building the software that runs on them. Many micro:bit hardware and software resources are openly licensed, and we want to encourage and support contributions from anyone interested.
12+
The micro:bit community is spread across the world, building cool things with micro:bits and writing the software that runs on them. Many micro:bit hardware and software resources are openly licensed, and we encourage and support contributions from anyone.
1313

14-
If you'd like to be part of the world-wide micro:bit developer community, then there are a couple of ways you can do this.
14+
If you'd like to be part of the world-wide micro:bit developer community, here's how to get started:
1515

1616
## Subscribe to the DAL, Editors and Devices newsletter
1717

@@ -25,11 +25,13 @@ In addition to our regular [Micro:bit Educational Foundation newsletter](https:/
2525

2626
[Slack](https://slack.com) is a messaging service that allows teams and communities to connect online. It's a brilliant tool for live collaboration and the place to be for current micro:bit chatter!
2727

28-
Please note that Slack complements, but does not replace [micro:bit help & support](http://support.microbit.org, where you can search for help and ask the team questions.
28+
Note: For technical support you should use [micro:bit help & support](http://support.microbit.org), where you can search for answers and raise tickets to ask the team questions. Slack complements, but does not replace, this portal.
2929

30-
Slack operate their own [privacy policy](https://slack.com/privacy-policy), so make sure you have read and you agree with this before signing up.
30+
Slack operate their own [privacy policy](https://slack.com/privacy-policy), make sure you have read and agreed with this before signing up.
3131

32-
If you'd like to join the slack channel, please fill in the form below. This form collects your email address and system metadata, in accordance with the [privacy policy of Freshdesk](https://www.freshworks.com/privacy/) our support system. We only use this to process an invite to Slack. after which the ticket is closed off and archived. If you wish, you can always [deactivate your slack account at a later date.](https://get.slack.help/hc/en-us/articles/203953146-Deactivate-your-Slack-account)Freshdesk is currently working on the ability to [remove your own data.](https://support.freshdesk.com/support/discussions/topics/14331?page=1). In the meantime, please notify <a href="mailto:[email protected]">[email protected]</a> if you wish to have your email address removed from the Freshdesk system
32+
If you'd like to join the slack channel, please fill in the form below. This form collects your email address and system metadata, in accordance with the [privacy policy of Freshdesk](https://www.freshworks.com/privacy/) our support system. We only use this to process an invite to Slack, after which the ticket is closed and archived. If you wish, you can always [deactivate your slack account at a later date.](https://get.slack.help/hc/en-us/articles/203953146-Deactivate-your-Slack-account).
33+
34+
Freshdesk is currently working on the ability to [remove your own data.](https://support.freshdesk.com/support/discussions/topics/14331?page=1). In the meantime, please notify <a href="mailto:[email protected]">[email protected]</a> if you wish to have your email address removed from the Freshdesk system.
3335

3436
<script type="text/javascript" src="http://assets.freshdesk.com/widget/freshwidget.js"></script>
3537
<style type="text/css" media="screen, projection">
@@ -40,10 +42,11 @@ If you'd like to join the slack channel, please fill in the form below. This for
4042

4143
## Other channels and communities
4244

43-
In addition to the Foundation's own channels of communication, there are many other online communities of support.
45+
In addition to the Foundation's own channels, there are other communities for support and discussion:
4446

4547
- [MakeCode micro:bit forum](https://forum.makecode.com/c/microbit/11) Connect with the MakeCode team for more technical details regarding developing micro:bit extensions or working on the MakeCode editor.
4648

4749
- [Mu Gitter](https://gitter.im/mu-editor) Gitter chat is similar to Slack and aimed at developers using [Mu](https://codewith.mu/)
4850

4951
- [/r/microbit](https://www.reddit.com/r/microbit) A reddit discussion on micro:bit
52+

latest-revision/latest-revision-editors.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ To support all revisions of the micro:bit, you will need to ensure you use the l
6363

6464
The BLE Profile for the micro:bit has also been updated to ensure compatibility with both revisions of the board. We have published a binary that enables all BLE services available to the board and shows the connection status on the LED.
6565

66-
[Download the updated version of the BLE all services hex](https://preview-tech.microbit.org/latest-revision/assets/bluetooth-services.hex)
66+
[Download the updated version of the BLE all services hex](/docs/latest-revision/assets/bluetooth-services.hex)
6767

6868
The MakeCode Bluetooth package will include all updates for the revised hardware and we will notify the DAL, Editors and Devices newsletter when this is available.
6969

@@ -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:[email protected]?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 developed 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:[email protected]?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

+1-1
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

+6-2
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:[email protected]) 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

+17
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)