Skip to content

Commit b244c90

Browse files
Jan1 updates (#104)
* Squashed 'docs/' changes from ae437c7..98a73dc 98a73dc Update index.md (#264) 6eddd17 Re-phrase making-accessories to be more direct (#205) 5bd2059 Minor updates to the pyOCD entry in "read flash" page (#249) 54a568d Add link to Android source code (#259) 91f9009 Fixed typo ba706cf Warn users blhost is advanced and unnecessary 9e3640f Update micropython.md (#257) 113df00 add other tested DAPlink versions a2fdb3c Ignore lancaster article (#246) 5eb4672 Update action.yml (#230) 6b0ecda change case for V2 button and table element ids (#236) 7201870 remove duplicate paragraph cc35817 update Mbed links 58fbba0 re-label new page 7649ddf remove Workbench ab22708 Update edgeconnector.md 16f1c90 fix links 677f242 Nov2 sprint updates (#226) c92dd07 Update latest-revision-main.md (#223) 94aff4f update APIs and editors 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: 98a73dc * Squashed 'docs/' changes from 98a73dc..94067ab 94067ab Update interface.md git-subtree-dir: docs git-subtree-split: 94067ab
1 parent 7e716e3 commit b244c90

File tree

7 files changed

+32
-18
lines changed

7 files changed

+32
-18
lines changed

accessories/making-accessories.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ A [list of available accessories](https://microbit.org/buy/accessories/) is main
1414

1515
## Using the Edge Connector
1616

17-
The micro:bit card edge connector, commonly referred to as the 'edge connector' or the 'pins' makes accessory design easy.
17+
The micro:bit [card edge connector](/hardware/edgeconnector), commonly referred to as the 'edge connector' or the 'pins', is compatible with a standard 1.27mm, 2x40 edge connector socket.
1818

19-
Many micro:bit accessories are designed to use an edge connector socket, so it is simple to plug in and remove the board.
19+
Where possible your accessory design should implement this socket, making it simple for your users to plug in and remove the micro:bit board.
2020

21-
There are limitations to the current that can be drawn from the micro:bit, and accessories must be designed carefully to ensure they do not damage the micro:bit, or that the micro:bit cannot damage them.
21+
There are [limitations to the current that can be drawn from the micro:bit](/hardware/powersupply), accessories must be designed carefully to ensure they do not damage the micro:bit, or that the micro:bit cannot damage them.
22+
23+
- [micro:bit edge connector and pinout](/hardware/edgeconnector)
24+
- [powering accessories from the micro:bit](/hardware/powersupply)
2225

2326
### V2 revision
2427

2528
The edge connector on the <span class="V2">V2</span> board revision is backwards compatible with the <span class="v1">V1</span> edge connector, but has additional dedicated pins.
2629

27-
- Details of the [edge connector and pinout](/hardware/edgeconnector)
28-
- Details about [powering things from the board](/hardware/powersupply)
29-
3030
## Battery Pads
3131

3232
There are two rounded rectangular pads on the back of the micro:bit. These allow you to connect a battery holder via a mechanism other than the JST connector.

bluetooth/apps-and-examples.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Below is a curated list of some Bluetooth applications you might like to read ab
1717

1818
## Applications, tools and examples
1919

20-
- [Android App](https://play.google.com/store/apps/details?id=com.samsung.microbit) facilitates [pairing and flashing programs to the micro:bit](https://support.microbit.org/en/support/solutions/articles/19000051025-pairing-and-flashing-code-via-bluetooth)
20+
- [Android App](https://play.google.com/store/apps/details?id=com.samsung.microbit) facilitates [pairing and flashing programs to the micro:bit](https://support.microbit.org/en/support/solutions/articles/19000051025-pairing-and-flashing-code-via-bluetooth). The app was originally developed by Samsung and is now maintained by the Micro:bit Educational Foundation. The [micro:bit android app source code](https://github.com/microbit-foundation/microbit-android/) can be found on GitHub.
2121

2222
- [iOS App](https://apps.apple.com/gb/app/micro-bit/id1092687276) faciliates [pairing and flashing programs to the micro:bit](https://support.microbit.org/en/support/solutions/articles/19000051025-pairing-and-flashing-code-via-bluetooth)
2323

software/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ Here's a non-exhaustive list of possible code editors for use with the micro:bit
9999

100100
- [PyCharm (with MicroPython plugin, can also flash to micro:bit)](https://plugins.jetbrains.com/plugin/9777-micropython)
101101

102+
- [Thonny (You will need to change the interpreter in Tools > Options > Interpreter)](https://thonny.org/)
103+
102104

103105
## From coding environment to micro:bit
104106

software/interface.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The DAPLink software and interface chip are part of the [Arm Mbed HDK](https://o
5454

5555
The micro:bit currently ships with DAPLink bootloader at version 0255 and interface at version 0255.
5656

57-
The following versions of the device have previously been shipped with the following DAPLink versions:
57+
This table shows the device revision and which DAPLink Bootloader and interface it shipped with:
5858

5959
| Board revision | Bootloader | Interface | Download
6060
| -------------- | ---------- | --------- | --------
@@ -63,6 +63,13 @@ The following versions of the device have previously been shipped with the follo
6363
| 1.5 | 0243 | 0249 | [0249](https://cdn.sanity.io/files/ajwvhvgo/production/26b176670c8f9df4aa015e9067368eafcfd749a1.hex?dl){: .btn.sm-btn download}
6464
| 2.0 | 0255 | 0255 | [0255](https://cdn.sanity.io/files/ajwvhvgo/production/2cfe581e01f533513276485375adec3f00153af5.hex?dl){: .btn.sm-btn download}
6565

66+
This table shows the latest DAPLink release for each board version that has been fully tested by the Foundation:
67+
68+
| Board revision | Bootloader | Interface | Download
69+
| -------------- | ---------- | --------- | --------
70+
| 1.* | 02** | 0253 | [0253](https://cdn.sanity.io/files/ajwvhvgo/production/5ecfa4d407a9d02e0f2e7fe192e5fa6a246f8621.hex?dl){: .btn.sm-btn download}
71+
| 2.* | 0255 | 0255 | [0255](https://cdn.sanity.io/files/ajwvhvgo/production/2cfe581e01f533513276485375adec3f00153af5.hex?dl){: .btn.sm-btn download}
72+
6673

6774
### The DAPLink boot loader
6875

@@ -109,6 +116,11 @@ The API is currently available in [Chrome based browsers](https://caniuse.com/#f
109116

110117
## Updating the DAPLink full image
111118

119+
<div class="alert alert-danger">Please note - there is almost no situtation in the normal use of the micro:bit where this step will be necessary. We have documented it here in the interests of making the the micro:bit more friendly to developers who want to experiement with the code on the KL27. If your microbit enumerates in MAINTENANCE or MICROBIT mode you should never need to perform these steps</div>
120+
121+
122+
**Please only use use these steps if you are familiar with USB bootloaders and command line tools. You should never need to perform these to update a micro:bit.**
123+
112124
You can also flash a full DAPLink image to the <span class="v2">V2</span> device using the KL27 internal bootloader. This will update both interface and bootloader.
113125

114126
[Download latest full DAPLink image](https://cdn.sanity.io/files/ajwvhvgo/production/8206bb64b39ecf8f3c205569bc9e2d4158b7963c.bin?dl){: .btn.sm-btn download}
@@ -142,4 +154,4 @@ Read KL27 flash contents into `kl27_flash_dump.bin` file:
142154

143155
```
144156
blhost -u 0x15a2,0x0073 read-memory 0x0 0x40000 kl27_flash_dump.bin
145-
```
157+
```

software/makecode.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ lang: en
1111

1212
## Overview
1313

14-
[Microsoft MakeCode for micro:bit](htps://makecode.microbit.org) is a free, open source platform for creating projects with the BBC micro:bit.
14+
[Microsoft MakeCode for micro:bit](https://makecode.microbit.org) is a free, open source platform for creating projects with the BBC micro:bit.
1515

1616
Connect colour-coded blocks that relate to hardware features and Computer Science fundamentals and switch between blocks, JavaScript and MakeCode Python views. A device simulator shows you what will happen on the physical device before you download your program.
1717

@@ -54,4 +54,4 @@ There are a variety of ways to get involved and interact:
5454
- Join the [micro:bit developer community on Slack](../../community/)
5555
- Raise a [MakeCode issue or feature request](https://github.com/Microsoft/pxt-microbit/issues)
5656
- Ask the MakeCode development team on [MakeCode forum for micro:bit](https://forum.makecode.com/c/microbit/11)
57-
- Help [Translate MakeCode](https://makecode.com/translate) into your own language.
57+
- Help [Translate MakeCode](https://makecode.com/translate) into your own language.

software/micropython.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ This is, in fact, what you're doing when you live-code using the REPL. However,
8585

8686
MicroPython uses a combination of compilation and interpretation techniques to run your program. Here's how:
8787

88-
When MicroPython sees a script it parses each line of the script. The end result is a set of in-memory tokens grouped in such a way that they represent how your program works. This is called the *parse tree*.
88+
When MicroPython sees a script it parses each line of the script. The end result is a set of in-memory tokens grouped in such a way that they represent how your program works. This is called the *Abstract Syntax Tree (AST)*.
8989

90-
The parse tree is compiled into a terse set of instructions called Python *bytecode*. Bytecode instructions are like CPU assembly language instructions, but they are targeted for a *virtual machine*, not for a real piece of computer hardware.
90+
The AST is compiled into a terse set of instructions called Python *bytecode*. Bytecode instructions are like CPU assembly language instructions, but they are targeted for a *virtual machine*, not for a real piece of computer hardware.
9191

9292
The Python bytecode is given to the Python virtual machine to run and so your program is executed.
9393

software/readout_hex.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,18 @@ This tool has a range of features:
2828

2929
You can download the [latest release of the uBitTool GUI Editor](https://github.com/carlosperate/ubittool/releases/) from the GitHub repository and there are [Instructions to read out the contents of a hex file](https://www.embeddedlog.com/ubittool/usage.html) on the website
3030

31-
## py-ocd
31+
## pyOCD
3232

3333
This method reads out the .hex file on the micro:bit to a file in your working directory.
3434

3535
In order to complete this task you will require some additional tools and libraries:
3636

37-
- Linux/Mac OS
38-
- Python 2 (pyOCD is not supported in Python3)
37+
- Windows/Linux/Mac OS
38+
- Python
3939
- [GNU Project Debugger](https://www.gnu.org/software/gdb/) included as part of [ArmDeveloper GNU Embedded Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads) [How to Install](https://gnu-mcu-eclipse.github.io/toolchain/arm/install/)
40-
- [pyOCD Python library](https://github.com/mbedmicro/pyOCD)
40+
- [pyOCD Python package](https://github.com/pyocd/pyOCD)
4141

42-
The method described here has been tested on Mac OS using [Homebrew as a package manager](https://brew.sh/), but should work on Linux. Additional steps are linked to, but it is outside the scope of this article to go through setup.
42+
The method described here has been tested on Mac OS with a micro:bit V1 using [Homebrew as a package manager](https://brew.sh/), but should work on Linux. Additional steps are linked to, but it is outside the scope of this article to go through setup.
4343

4444
## Procedure
4545

0 commit comments

Comments
 (0)