Skip to content

Commit 8d7ebeb

Browse files
Updates 19 11 20 (#102)
* make newsletter more prominent * Squashed 'docs/' changes from ae437c7..4cb9286 4cb9286 add community buttons to index f14030c add error hex to hex tool page 3d71f9d Merge branch 'uhex-page' 854577a add hex format spec link 1d5265b add details of uHex tool (#213) a1401e3 fix links f5464d9 Rewrite community page (#203) 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: 4cb9286 * add newsletter archive * Squashed 'docs/' changes from 4cb9286..4e786f5 4e786f5 add news archive c7ad57d Merge branch 'master' into nov2-sprint-updates 94aff4f update APIs and editors git-subtree-dir: docs git-subtree-split: 4e786f5 * Squashed 'docs/' changes from 4e786f5..faa62ab faa62ab update for Python release git-subtree-dir: docs git-subtree-split: faa62ab * Squashed 'docs/' changes from faa62ab..dbe04f9 dbe04f9 update for Python release 0a4aa2e add news archive d90d3ce add community buttons to index a55fe95 add error hex to hex tool page REVERT: faa62ab update for Python release REVERT: 4e786f5 add news archive REVERT: c7ad57d Merge branch 'master' into nov2-sprint-updates REVERT: 4cb9286 add community buttons to index REVERT: f14030c add error hex to hex tool page git-subtree-dir: docs git-subtree-split: dbe04f9 * Squashed 'docs/' changes from dbe04f9..677f242 677f242 Nov2 sprint updates (#226) c92dd07 Update latest-revision-main.md (#223) REVERT: dbe04f9 update for Python release REVERT: 0a4aa2e add news archive REVERT: d90d3ce add community buttons to index REVERT: a55fe95 add error hex to hex tool page git-subtree-dir: docs git-subtree-split: 677f242
1 parent 78aa3ef commit 8d7ebeb

File tree

6 files changed

+77
-58
lines changed

6 files changed

+77
-58
lines changed

community/developer-news.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: page
3+
order:
4+
title: Developer news
5+
heading: Join the micro:bit developer conversation
6+
description: Sign up to and view the developer news
7+
permalink: /community/news/
8+
ref: news
9+
lang: en
10+
---
11+
12+
## The DAL, Editors and Devices newsletter
13+
14+
In addition to our regular [Micro:bit Educational Foundation newsletter](https://mailchi.mp/microbit/newsletter), our [DAL, Editors and Devices](https://microbit.us14.list-manage.com/subscribe?u=e1c30f24b90ff3d70275cfff2&id=25403c7650) newsletter is a low volume digest on the technical aspects of micro:bit. The details you provide are processed in accordance with The Foundation's [privacy policy](https://microbit.org/privacy/).
15+
16+
<div style="text-align: center;">
17+
<a href="https://microbit.us14.list-manage.com/subscribe?u=e1c30f24b90ff3d70275cfff2&id=25403c7650" class="btn sm-btn" role="button" style="margin-bottom: 2rem;">Subscribe to DAL, Editors and Devices</a>
18+
</div>
19+
20+
## News archive
21+
22+
{% include newsletter-archive.html %}

index.md

+6
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ We hope to encourage contributions into these projects in order to broaden our e
1919

2020
The Micro:bit Educational Foundation aims to be a 'responsible downstream' to the many open source [software](https://tech.microbit.org/software/) projects that are used to build the micro:bit: much like a good Linux distribution collates, tests, stabilises and releases combinations of many diverse open source packages, the micro:bit Educational Foundation and the micro:bit community present micro:bit users with a stable, tested release of all the things you need to make the magical 'end-to-end' micro:bit experience.
2121

22+
## Latest news
23+
24+
For the latest news and community updates, join our mailing list and Slack group.
25+
26+
{% include community.html %}
27+
2228
## Help us build it
2329

2430
If you'd like to help us make the micro:bit better, then there are a number of ways that you can get involved.

latest-revision/latest-revision-editors.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The exisiting API has not changed. Scripts that use features that are common to
5757

5858
To support all revisions of the micro:bit, you will need to ensure you use the latest release of the MicroPython binary with your editor. The simplest way to do this is to flash a program created in the latest Python Editor which will contain the latest MicroPython build.
5959

60-
[https://python.microbit.org/v/beta/](https://python.microbit.org/v/beta/)
60+
[https://python.microbit.org/](https://python.microbit.org/)
6161

6262
## If you’re using the micro:bit profile over BLE
6363

@@ -100,7 +100,7 @@ A clear indication that you are working with this format is that a compiled .hex
100100

101101
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.
102102

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.
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/spec-universal-hex).
104104

105105
### Hex format compatibility
106106

latest-revision/latest-revision-main.md

+29-54
Original file line numberDiff line numberDiff line change
@@ -78,55 +78,6 @@ In an effort to ensure the greatest degree of continuity for teachers, users wil
7878

7979
This means that you can use MakeCode or the online Python Editor as you always have, to use all of the features that are common to both version of the BBC micro:bit: Display, buttons, motion sensing, gestures like shake, light sensing, and even the Music blocks.
8080

81-
## Feature availability
82-
83-
These are the V2 features and whether we expect them to work as expected ✅ or not 🛑, or there are issues still to be fixed 🔶.
84-
85-
| **Feature** | **Codal** | **MakeCode** | **MakeCode Simulator** | **MicroPython** |
86-
| ---------------- | --------- | ------------ | ---------------------- | --------------- |
87-
| Microphone |||||
88-
| Speaker ||| 🛑 ||
89-
| Logo touch |||||
90-
| Power management ||| 🛑 ||
91-
| Sound emoji |||||
92-
93-
## Feature API availability
94-
95-
These are the V2 specific APIs and whether we expect them to work as expected ✅ or not 🛑, or there are issues still to be fixed 🔶.
96-
97-
{% include alert-info.html content="It is important that we work with the community to establish how these APIs work. As such they are subject to change as we get feedback and iterate on them.
98-
When they are finalised, we will notify people via the [DAL, Editors and Devices](https://microbit.us14.list-manage.com/subscribe?u=e1c30f24b90ff3d70275cfff2&id=25403c7650) newsletter." %}
99-
100-
### MakeCode APIs
101-
102-
| API | Blocks | Status | GitHub Issues |
103-
| --------------------------------------------------- | -------------------- | --------------------- | ------------- |
104-
| On loud/quiet sound `input.onSound(SoundType.Loud)` - Triggers after a transition from quiet-loud/loud-quiet, so 'on quiet' will trigger after a loud sound but not continuously | ![on loud sound](/docs/latest-revision/assets/makecode-blocks/loudsound.png){: width="125"} || |
105-
| Set pin touch type `pins.touchSetType(TouchTarget.P0, TouchType.Resistive)`- capacitive/resistive - Logo is capacitive, large pins are resistive by default. | ![set touch type](/docs/latest-revision/assets/makecode-blocks/pin-mode.png){: width="650"} || |
106-
| On Logo pressed `input.onLogoPressed()` | ![logo pressed](/docs/latest-revision/assets/makecode-blocks/onLogoPressed.png){: width="125"} || |
107-
| On logo released `input.onLogoReleased()` | ![logo released](/docs/latest-revision/assets/makecode-blocks/onLogoReleased.png){: width="125"} || |
108-
| Logo is pressed `input.logoIsPressed()` | ![logo is pressed](/docs/latest-revision/assets/makecode-blocks/logoIsPressed.png){: width="150"} || |
109-
| Set on-board speaker On/Off `music.setOnBoardSpeakerEnable(false)` - Edge connector will still output sound | ![speaker disabled](/docs/latest-revision/assets/makecode-blocks/speakerDisabled.png){: width="650"} || |
110-
| Set sound threshold level `input.setSoundThreshold(SoundType.Loud, 128)` - 0-255 threshold for triggering a 'loud' or 'quiet' sound | ![sound threshold](/docs/latest-revision/assets/makecode-blocks/setSoundThreshold.png){: width="650"} || |
111-
| Sound level - returns a filtered 'noise level' not raw microphone samples, useful for eg. 'how noisy is my classroom?' `input.soundLevel()` | ![sound level](/docs/latest-revision/assets/makecode-blocks/soundLevel.png){: width="125"} | 🔶 On battery, the 'soundLevel' reported for quiet sounds is higher than the level reported on USB. |[codal-microbit#131](https://github.com/microbit-foundation/codal-microbit/issues/131) |
112-
| Play sound `soundExpression.giggle.play()`/`soundExpression.giggle.playUntilDone()` - Play from a selection of pre-defined sound emoji | ![play sound](/docs/latest-revision/assets/makecode-blocks/playSound.png){: width="650"} || |
113-
114-
### Python APIs
115-
116-
| API | Usage | Status | GitHub Issues |
117-
| ------------------------------------------ | ------------ | ---------------------------- | ------------- |
118-
| play sound expression (giggle, happy, hello, mysterious, sad, slide, soaring, spring, twinkle, yawn) | `audio.play("hello")`|| |
119-
| Choose music/pitch output pin | `music.play(music.JUMP_UP, pin=microbit.pin_speaker, wait=True)` || |
120-
| Stop music on pin | `music.stop(pin=microbit.pin_speaker)` || |
121-
| Set the volume 0-255 | `microbit.set_volume(128)` || |
122-
| Get current sound loud/quiet |`microbit.microphone.current_sound()` || |
123-
| Check current sound == loud/quiet | `microbit.microphone.current_sound() == microbit.microphone.LOUD` || |
124-
| Check if a loud/quiet sound occurred since the last call to was_sound() | `microbit.microphone.was_sound(microbit.microphone.LOUD)` || |
125-
| Get history of sounds since last call to get_sounds() | `microbit.microphone.get_sounds()` || |
126-
| Set threshold for sound 0-255 | `microbit.microphone.set_threshold(microbit.microphone.LOUD, 128)` || |
127-
| Get current sound level in range 0-255 | `microbit.microphone.sound_level()` || |
128-
| Logo is touched | `microbit.pin_logo.is_touched()` || |
129-
13081
## How do I use the new features?
13182

13283
The **speaker** works in the same way you would expect when you connect up your headphones or an external speaker to the micro:bit. By default, the sound output will be on both the speaker and Edge connector.
@@ -135,12 +86,12 @@ The **logo touch** is implemented in the same way as touching a pin on the edge
13586

13687
To access the features of the latest revision only (eg. to output sound only on the speaker and not the edge connector), you will need to add additional code to your programs. This ensures that the default editor experience continues to work for everyone, regardless of the board revision.
13788

138-
Features that are common to all board variants will work in the same way they always have. For example, you will be able to use the same blocks in MakeCode to use the acceleromater on any board revision.
89+
Features that are common to all board variants will work in the same way they always have. For example, you will be able to use the same blocks in MakeCode to use the accelerometer on any board revision.
13990

14091
### Makecode
141-
You can use the latest board revision in the beta editor [https://makecode.microbit.org/beta](https://makecode.microbit.org/beta) alongside the current revision.
92+
You can use the latest board revision in the live micro:bit editor [https://makecode.microbit.org](https://makecode.microbit.org) alongside the current revision.
14293

143-
#### Using the new features in MakeCode beta
94+
#### Using the new features in MakeCode
14495

14596
The Microphone and Logo touch features can be found in the Input menu
14697

@@ -150,9 +101,9 @@ The Capacative/Resistive touch mode can be found in the Pins menu
150101

151102
### Python
152103

153-
You can use the latest board revision and APIs in the Python beta editor:
104+
You can use the latest board revision and APIs in the Python editor:
154105

155-
[https://python.microbit.org/v/beta](https://python.microbit.org/v/beta/)
106+
[https://python.microbit.org/](https://python.microbit.org/)
156107

157108
If you want to use a specific or custom build of MicroPython you can do this in [Mu](https://codewith.mu/).
158109

@@ -161,6 +112,30 @@ You can use the latest board revision and APIs in the Python beta editor:
161112

162113
![Copy main.py](/docs/latest-revision/assets/copy-main-py-mu.gif){: width="600"}
163114

115+
#### Using the new features in Python
116+
117+
We are currently working on updates to MicroPython documentation, but you can find Python APIs by searching via the REPL for example:
118+
119+
```Python
120+
import microbit
121+
dir(microbit)
122+
```
123+
### Python APIs
124+
125+
| API | Usage |
126+
|--------------------------------------------|--------------|
127+
| play sound expression (GIGGLE, HAPPY, HELLO, MYSTERIOUS, SAD, SLIDE, SOARING, SPRING, TWINKLE, YAWN) | `audio.play(microbit.Sound.HELLO)`|
128+
| Choose music/pitch output pin | `music.play(music.JUMP_UP, pin=microbit.pin_speaker, wait=True)` |
129+
| Stop music on pin | `music.stop(pin=microbit.pin_speaker)` |
130+
| Set the volume 0-255 | `microbit.set_volume(128)` |
131+
| Get current sound loud/quiet |`microbit.microphone.current_sound()` |
132+
| Check current sound == loud/quiet | `microbit.microphone.current_sound() == microbit.microphone.LOUD` |
133+
| Check if a loud/quiet sound occurred since the last call to was_sound() | `microbit.microphone.was_sound(microbit.microphone.LOUD)` |
134+
| Get history of sounds since last call to get_sounds() | `microbit.microphone.get_sounds()` |
135+
| Set threshold for sound 0-255 | `microbit.microphone.set_threshold(microbit.microphone.LOUD, 128)` |
136+
| Get current sound level in range 0-255 | `microbit.microphone.sound_level()` |
137+
| Logo is touched | `microbit.pin_logo.is_touched()` |
138+
164139
## Universal Hex Format
165140

166141
The editors and apps are compatible with and will let you download and flash a file to any micro:bit revision. This is called a **Universal Hex** file. 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.

software/hex-format.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,19 @@ The latest board revision introduces a superset of the Intel-Hex format that ena
2626
A **Universal Hex** hex file will work on a V1 or V2 board.
2727
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.
2828

29-
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/).
29+
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/spec-universal-hex).
30+
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+
37+
## Universal Hex Creator
38+
39+
We have created a [Universal Hex Creator](../universal-hex-creator) tool, to easily create a .hex file that will support all micro:bit variants.
40+
41+
This tool is based on the [Universal Hex JavaScript Library](https://github.com/microbit-foundation/microbit-universal-hex).
3042

3143
## Universal Hex Creator
3244

software/universal-hex-tool.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ review-with: carlospa
1212

1313
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.
1414

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.
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), the [Javascript/Typescript libary](https://github.com/microbit-foundation/microbit-universal-hex) on which the Universal Hex Creator tool is based and the associated [Universal Hex specification](https://github.com/microbit-foundation/spec-universal-hex).
16+
17+
To support [cross-device compatibility](../hex-format/#cross-device-compatibility), we have created a [standalone error hex](/docs/software/assets/stand-alone-error-v1.hex) that can be combined with a V2 only hex in this tool to produce a Hex that will work on a V2 board, but error if used on a V1.
18+
19+
[Download standalone error hex](/docs/software/assets/stand-alone-error-v1.hex){: .btn.sm-btn download}
1620

1721
{% include uhex-tool.html %}

0 commit comments

Comments
 (0)