Skip to content

Commit 7e716e3

Browse files
Squashed 'docs/' changes from ae437c7..a2fdb3c (#103)
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: a2fdb3c
1 parent 8d7ebeb commit 7e716e3

File tree

10 files changed

+22
-39
lines changed

10 files changed

+22
-39
lines changed

.github/workflows/action.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ jobs:
1111
steps:
1212
- uses: actions/checkout@master
1313
- uses: peter-evans/link-checker@v1
14+
id: lc
1415
with:
1516
# Only check external links
16-
args: -v -x "^[^:]+$|^https://uk\.farnell\.com/|^https://www\.kitronik\.co\.uk/pdf/bbc_microbit_mechanical_datasheet_V2\.pdf$" -d . -t 30 -r *
17+
args: -v -x "^[^:]+$|^https://uk\.farnell\.com/|^https://www\.kitronik\.co\.uk/pdf/bbc_microbit_mechanical_datasheet_V2\.pdf|^https://www\.lancaster\.ac\.uk/news/articles/2016/lancaster-university-helps-bbc-get-kids-coding/$" -d . -t 30 -r *
1718
- name: Create Issue From File
1819
uses: peter-evans/create-issue-from-file@v2
1920
with:
2021
title: Link Checker Report
2122
content-filepath: ./link-checker/out.md
2223
labels: links
24+
- name: Fail if there were link errors
25+
run: exit ${{ steps.lc.outputs.exit_code }}

bluetooth/apps-and-examples.md

-6
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,8 @@ Below is a curated list of some Bluetooth applications you might like to read ab
2929

3030
- [micro:bit Blue App for Android](https://github.com/microbit-foundation/microbit-blue)
3131

32-
- [droidscript microbit](http://www.microbit-js.org/controlling-microbit-with-droidscript/)
33-
34-
- [droidscript plugin](http://www.microbit-js.org/installing-the-microbit-plugin-for-droidscript/)
35-
3632
- [Kitronik Move](https://play.google.com/store/apps/details?id=com.kitronik.blemove) - Android app that presents a D-Pad interface to control a micro:bit over Bluetooth LE.
3733

38-
- [Workbench](https://edu.workbencheducation.com/partners/microbit) is a multi-device coding canvas for block-based programming that connects with BLE devices via Chrome Web Bluetooth.
39-
4034
- [microBit.js](https://github.com/antefact/microBit.js) - JavaScript library to interact with BBC micro:bit using web bluetooth API.
4135

4236
- [microbit-web-bluetooth](https://github.com/thegecko/microbit-web-bluetooth) - Web Bluetooth library implementing the micro:bit Bluetooth Profile.

community/developer-news.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: page
33
order:
44
title: Developer news
55
heading: Join the micro:bit developer conversation
6-
description: Sign up to and view the developer news
6+
description: Sign up to the newsletter and view recent news
77
permalink: /community/news/
88
ref: news
99
lang: en

hardware/edgeconnector.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ Pin 9 is no longer jointly shared with the LED display, but Pin 8 and Pin 9 can
4040

4141
### Pins and Signals
4242

43-
[V2](#pins-and-signals){: #V2-button .btn.sm-btn .variation} [V1](#pins-and-signals){: #v1-button .btn.sm-btn}
43+
[V2](#pins-and-signals){: #v2-button .btn.sm-btn .variation} [V1](#pins-and-signals){: #v1-button .btn.sm-btn}
4444

4545
This table shows various data about each of the pins on the micro:bit edge connector.
4646

47-
{: #V2-pins}
47+
{: #v2-pins}
4848
| m:b ring | mod | schem | MCU | s/w | functions | dir | pull? |
4949
| -------- | --- | ----- | --- | --- | --------- | --- | ----- |
5050
| | 21 | COLR3 | P0.31/AIN7 | P3 | (GPIO), (ANALOG), **LEDCOL(3)**, (PWM), (UART) | O | -- |
@@ -231,10 +231,10 @@ These key GPIO parameters are transcribed directly from Section 6, 7 and 8 of th
231231
| VOL,HDH | Voltage Output Low, high drive, 5 mA, VDD ≥ 2.7 | 6.8.3 | VSS | VSS +0.4 |
232232
| VOL,HDL | Voltage Output Low, high drive, 3mA, VDD ≥ 1.7 | 6.8.3 | VSS | VSS +0.4 |
233233
| VOH,SD | Voltage Output High, standard drive,0.5 mA, VDD ≥ 1.7 | 6.8.3 | VDD -0.4 | VDD |
234-
| VOL,HDH | Voltage Output How, high drive, 5 mA, VDD ≥ 2.7 | 6.8.3 | VDD -0.4 | VDD |
235-
| VOL,HDL | Voltage Output How, high drive, 3mA, VDD ≥ 1.7 | 6.8.3 | VDD -0.4 | VDD |
236-
| VIL | Input voltage for logic low | 6.8.3 | VSS | 0.3*VDD |
237-
| VIH | Input voltage for logic high | 6.8.3 | 0.7*VDD | VDD |
234+
| VOL,HDH | Voltage Output High, high drive, 5 mA, VDD ≥ 2.7 | 6.8.3 | VDD -0.4 | VDD |
235+
| VOL,HDL | Voltage Output High, high drive, 3mA, VDD ≥ 1.7 | 6.8.3 | VDD -0.4 | VDD |
236+
| VIL | Input voltage for logic low | 6.8.3 | VSS | 0.3 * VDD |
237+
| VIH | Input voltage for logic high | 6.8.3 | 0.7 * VDD | VDD |
238238
| xxx | Max source current from IO pin | TBC | -- | TBC |
239239
| xxx | Max sink current into IO pin | TBC | -- | TBC |
240240
| VIO≤3.6 | Tolerable pin voltages for IO pin with VDD ≤3.6 | 9 | -0.3V | VDD+0.3 |

hardware/reference-design.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ If you don't have a debugger, the nRF51-DK board can be used as a J-link debugge
8181

8282
![Using an nRF51-DK as a debugger](/docs/hardware/assets/referencedesign-609b1.png){:width="40%"}
8383

84-
Please see [this page](https://developer.mbed.org/users/MarceloSalazar/notebook/programming-a-minibeacon-bluetooth-module-nordic-n/) for more information.
84+
Please see [this page](https://os.mbed.com/users/MarceloSalazar/notebook/programming-a-minibeacon-bluetooth-module-nordic-n/) for more information.
8585

8686
### nRF51 Software
8787

latest-revision/latest-revision-editors.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Please note that we do as much development as possible in the open, so if you’
2525

2626
- [microbit-dal](https://github.com/lancaster-university/microbit-dal)
2727

28-
- [CODAL](https://github.com/microbit-foundation/codal/)
28+
- [CODAL](https://github.com/lancaster-university/codal-microbit-v2)
2929

3030
- [microbit](https://github.com/lancaster-university/microbit)
3131

@@ -47,7 +47,7 @@ Mbed does not support the nRF52833 by default, though The Foundation does intend
4747

4848
### Building CODAL
4949

50-
The [instructions for building CODAL](https://github.com/microbit-foundation/codal/blob/master/mb-build-instructions.md) are located in the micro:bit CODAL repository. The final link is TBC and may change.
50+
The [instructions for building CODAL](https://github.com/lancaster-university/microbit-v2-samples) are located in the micro:bit CODAL repository. The final link is TBC and may change.
5151

5252
## If you’re using MicroPython
5353

software/hex-format.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,7 @@ 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/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).
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).
4230

4331
## Universal Hex Creator
4432

software/index.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ Here's a non-exhaustive list of possible code editors for use with the micro:bit
8383

8484
- [Kittenblock](https://www.kittenbot.cc/pages/software)
8585

86-
- [Kodu](https://www.kodugamelab.com/resources/bbc-microbit/)
86+
- [Kodu](https://www.kodugamelab.com/resources/#microbit)
8787

8888
- [MATLAB & Simulink](https://uk.mathworks.com/academia/highschool/courseware/microbit.html)
8989

90-
- [Mbed Online Compiler](http://developer.mbed.org/platforms/Microbit)
90+
- [Mbed Online Compiler](https://os.mbed.com/platforms/Microbit/)
9191

9292
- [mBlock 5](https://www.makeblock.com/software/mblock5)
9393

@@ -99,8 +99,6 @@ 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-
- [Workbench](https://edu.workbencheducation.com/partners/microbit)
103-
104102

105103
## From coding environment to micro:bit
106104

software/interface.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This software provides four USB endpoints that have specific purposes:
5050

5151
- WebUSB - facilitates communicating with the device via a WebUSB capable browser.
5252

53-
The DAPLink software and interface chip are part of the [Arm Mbed HDK](https://developer.mbed.org/handbook/mbed-HDK) and the [Mbed Enabled program](https://www.mbed.com/en/about-mbed/mbed-enabled/)
53+
The DAPLink software and interface chip are part of the [Arm Mbed HDK](https://os.mbed.com/handbook/mbed-HDK)
5454

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

software/runtime.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,17 @@ The information on Arm Mbed applies to <span class="v1">V1</span> only.
8787

8888
### Hardware and Low Level Software
8989

90-
The micro:bit hardware is based on the Mbed HDK, and the software on the Mbed SDK. Any program that runs on an Mbed platform will run on the micro:bit provided the required peripherals and memory are present. This means that developers using the micro:bit already have access to a huge [library of components](https://developer.mbed.org/components/) that they can use with the micro:bit. Furthermore, it means that things developed on the micro:bit can be used on other Mbed platforms.
90+
The micro:bit hardware is based on the Mbed HDK, and the software on the Mbed SDK. Any program that runs on an Mbed platform will run on the micro:bit provided the required peripherals and memory are present. This means that developers using the micro:bit already have access to a huge [library of components](https://os.mbed.com/components/) that they can use with the micro:bit. Furthermore, it means that things developed on the micro:bit can be used on other Mbed platforms.
9191

92-
Of particular interest are the Mbed BLE projects, many of which were developed on nRF51-based hardware very similar to the micro:bit. The Mbed [Bluetooth Low Energy Team](https://developer.mbed.org/teams/Bluetooth-Low-Energy/) has many useful links and examples.
92+
Of particular interest are the Mbed BLE projects, many of which were developed on nRF51-based hardware very similar to the micro:bit. The Mbed [Bluetooth Low Energy Team](https://os.mbed.com/teams/Bluetooth-Low-Energy/) has many useful links and examples.
9393

9494
### Online IDE
9595

96-
Mbed also provides an online C/C++ IDE with which you can program the micro:bit. To get started with this, please see the [micro:bit Platform Page](http://developer.mbed.org/platforms/Microbit) on the Mbed site, where there's a getting started video.
96+
Mbed also provides an online C/C++ IDE with which you can program the micro:bit. To get started with this, please see the [micro:bit Platform Page](hhttps://os.mbed.com/platforms/Microbit/) on the Mbed site, where there's a getting started video.
9797

9898
### Mbed Source Code and Versions Used
9999

100-
The Mbed repository for micro:bit is [https://github.com/lancaster-university/mbed-classic](https://github.com/lancaster-university/mbed-classic), this is a fork of Mbed OS 2 (classic) with changes and fixes needed for the micro:bit project. This is the version of Mbed used with the offline DAL toolchain, [Mbed Online Compiler](https://ide.mbed.com/compiler/), and the [online editors on microbit.org](https://microbit.org/code).
100+
The Mbed repository for micro:bit is [https://github.com/lancaster-university/mbed-classic](https://github.com/lancaster-university/mbed-classic), this is a fork of Mbed OS 2 (classic) with changes and fixes needed for the micro:bit project. This is the version of Mbed used with the offline DAL toolchain, [Mbed Online Compiler](https://os.mbed.com/handbook/mbed-Compiler), and the [online editors on microbit.org](https://microbit.org/code).
101101

102102
micro:bit was based on the well-established Mbed 2.0 SDK, with which Mbed 5 is compatible. Work is ongoing to [bring the micro:bit runtime onto Mbed 5](https://github.com/lancaster-university/microbit-dal/issues/224).
103103

0 commit comments

Comments
 (0)