Skip to content

Commit ce0d4e7

Browse files
Squashed 'docs/' changes from ae437c7..cc01c0f (#95)
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: cc01c0f
1 parent 97edb54 commit ce0d4e7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+213
-30847
lines changed

.github/ISSUE_TEMPLATE/bug.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ about: Create a github issue to fix an error in the docs
1111
A clear and concise description of what the error is.
1212

1313

14-
## Expected behavior
14+
## Expected behaviour
1515
A clear and concise description of what you expected to see/read
1616

1717
## Screenshots

.github/ISSUE_TEMPLATE/labs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ about: Create a github issue to add your research or project to tech.microbit.or
77

88
---
99

10-
Edit as neccessary
10+
Edit as necessary
1111

1212
### Example Project
1313
![Image](https://images.unsplash.com/photo-1552581234-26160f608093?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1050&q=80){:style="max-width: 50%;"}

accessories/making-accessories.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,19 @@ The edge connector on the <span class="V2">V2</span> board revision is backwards
2929

3030
## Battery Pads
3131

32-
There are two lozenge shaped pads on the back of the micro:bit. These allow you to connect a battery holder via a mechanism other than the JST connector.
32+
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.
3333

34-
![Picture of the two lozenges](/docs/accessories/assets/making-accessories-d7c25.png)
34+
![Picture of the two rounded rectangular pads](/docs/accessories/assets/making-accessories-d7c25.png)
35+
36+
The upper pad is 0V or GND and the lower pad is 3V.
3537

3638
### V2 revision
3739

38-
In the <span class="v2">V2</span> board revision, the 3V lozenge is connected to the 3V ring on the edge connector.
40+
In the <span class="v2">V2</span> board revision, the 3V rounded rectangular pad is connected to the 3V ring on the edge connector.
3941

40-
- If you make an accessory that uses the lozenges, it must be protected from reverse charging when the board is powered by USB, battery or edge connector.
41-
- You can now source power from the lozenges if you are making an accessory, as they are consistent with the power architecture of the edge connector.
42+
- If you make an accessory that uses the rounded rectangular pads, it must be protected from reverse charging when the board is powered by USB, battery or edge connector.
43+
- You can now source power from the rounded rectangular pads if you are making an accessory, as they are consistent with the power architecture of the edge connector.
4244

43-
Due to the addition of a speaker, current accessories that use the lozenges to power the micro:bit will no longer fit.
45+
Due to the addition of a speaker, current accessories that use the rounded rectangular pads to power the micro:bit will no longer fit.
4446

4547

bluetooth/apps-and-examples.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ lang: en
1313

1414
Bluetooth applications can run on a variety of devices, including but not limited to smart phones and tablets. You can also run Bluetooth enabled applications on devices such as a Raspberry Pi.
1515

16-
Below is a curated list of some Bluetooth applications you might like to read about and try for yourself with your micro:bit. Please contribute to this list if you know of any more. Many listed here are take from the [micro:bit Awesome list](https://github.com/carlosperate/awesome-microbit)
16+
Below is a curated list of some Bluetooth applications you might like to read about and try for yourself on your micro:bit. Please contribute to this list if you know of any more. Many listed here are taken from the [micro:bit Awesome list](https://github.com/carlosperate/awesome-microbit)
1717

1818
## Applications, tools and examples
1919

20-
- [Android App](https://play.google.com/store/apps/details?id=com.samsung.microbit) faciliates [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)
2121

22-
- [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)
22+
- [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

2424
- [Swift Playgrounds](https://github.com/microbit-foundation/microbit-swift-playgrounds) contains a Playground Book available in the Swift app and a micro:bit Swift API to develop further resources
2525

@@ -35,7 +35,7 @@ Below is a curated list of some Bluetooth applications you might like to read ab
3535

3636
- [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.
3737

38-
- [Workbench](https://edu.workbencheducation.com/partners/microbit) is amulti-device coding canvas for block-based programming that connects with BLE devices via Chrome Web Bluetooth.
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.
3939

4040
- [microBit.js](https://github.com/antefact/microBit.js) - JavaScript library to interact with BBC micro:bit using web bluetooth API.
4141

@@ -45,10 +45,10 @@ Below is a curated list of some Bluetooth applications you might like to read ab
4545

4646
- [Gobot](https://gobot.io/documentation/platforms/microbit/) - Framework for the Go programming language to program devices in the real world. It can access the micro:bit via Bluetooth LE.
4747

48-
- [micro:bit Slither](https://github.com/novucs/microbit-slither) - Multiplayer snake game on Android, controlled with micro:bits via Bluetooth.
48+
- [micro:bit Slither](https://github.com/novucs/microbit-slither) - Multi-player snake game on Android, controlled with micro:bits via Bluetooth.
4949

5050
- [Serial Bluetooth Terminal](https://play.google.com/store/apps/details?id=de.kai_morich.serial_bluetooth_terminal)- Android app capable to send and receive micro:bit Bluetooth UART data.
5151

5252
- [Bluetooth Low Energy Remote Control for Spotify](https://www.hackster.io/josejuansanchez/bluetooth-low-energy-remote-control-for-spotify-3438d1) - This project allows you to configure your micro:bit to work as a Bluetooth Low Energy remote control for Spotify on macOS.
5353

54-
- [Musical Instrument Controller](https://phwallen.github.io/microbit-music-controller/) - A micro:bit instrument that communities with an iPad via Bluetooth into MIDI controller app that can play music via GarageBand.
54+
- [Musical Instrument Controller](https://phwallen.github.io/microbit-music-controller/) - A micro:bit instrument that communities with an iPad via Bluetooth into MIDI controller app that can play music via GarageBand.

bluetooth/index.md

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

1212
## Overview
1313

14-
The micro:bit processor has an on board [Bluetooth](http://blog.bluetooth.com/a-developers-guide-to-bluetooth/) transceiver. This is combined with a PCB trace aerial and other minor components alongside a software stack that gives the micro:bit a certified and credible Bluetooth capability.
14+
The micro:bit processor has an on-board [Bluetooth](http://blog.bluetooth.com/a-developers-guide-to-bluetooth/) transceiver. This is combined with a PCB trace aerial and other minor components alongside a software stack that gives the micro:bit a certified and credible Bluetooth capability.
1515

1616
## Bluetooth software stack
1717

@@ -24,21 +24,22 @@ Using Bluetooth, you can connect to other devices and send and receive data from
2424

2525
## micro:bit Bluetooth Features
2626

27-
Bluetooth features available on the micro:bit are defined in a [Bluetooth profile](/bluetooth/profile). The micro:bit supports one, custom developed profile.
27+
Bluetooth features available on the micro:bit are defined in a [Bluetooth profile](/bluetooth/profile). The micro:bit supports one, custom-developed profile.
2828

2929
## Bluetooth and the micro:bit software
3030

31-
The [DAL/C++](https://lancaster-university.github.io/microbit-docs/ble/profile/#reference-documentation) lists the adopted and custom features available within the profile. [MakeCode](https://makecode.microbit.org/reference/bluetooth) contains a set of blocks to make use of the various micro:bit services.
31+
The [DAL/C++ reference documentation](https://lancaster-university.github.io/microbit-docs/ble/profile/#reference-documentation) lists the adopted and custom features available within the profile. [MakeCode](https://makecode.microbit.org/reference/bluetooth) contains a set of blocks to make use of the various micro:bit services.
3232

33-
The processor also has a number of non-bluetooth proprietary modes of operation, on which we build the micro:bit radio protocol. This only works between micro:bits and is what is defined as 'Micro:bit Radio' in the DAL and 'radio' in MakeCode and MicroPython, as well as Mbed C++.
33+
The processor also has several non-bluetooth, proprietary modes of operation upon which the micro:bit radio protocol is based. This protocol works only between micro:bits and is defined as 'Micro:bit Radio' in the DAL and 'radio' in MakeCode, MicroPython, and Mbed C++.
3434

3535
## Apps
3636

37-
- [Android App](https://play.google.com/store/apps/details?id=com.samsung.microbit) faciliates [pairing and flashing programs to the micro:bit](https://support.microbit.org/en/support/solutions/articles/19000051025-pairing-and-flashing-code-via-bluetooth)
37+
- [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)
3838
- [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)
3939
- [Swift Playgrounds](https://github.com/microbit-foundation/microbit-swift-playgrounds) contains a Playground Book available in the Swift app and a micro:bit Swift API to develop further resources
4040
Scratch.
4141

4242
## Further information
4343

4444
- [Bluetooth Specification](https://www.bluetooth.com/specifications/adopted-specifications)
45+
- [DAL/C++ Bluetooth Reference Documentation](https://lancaster-university.github.io/microbit-docs/ble/profile/#reference-documentation)

bluetooth/profile.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,36 @@ lang: en
1111

1212
## Overview
1313

14-
The micro:bit supports Bluetooth via a single BBC micro:bit profile which was custom developed for the device. This profile allows it to communicate with other BLE capable devices.
14+
The micro:bit supports Bluetooth via a single, custom-developed, BBC micro:bit profile. This profile allows it to communicate with other BLE capable devices.
1515

1616
If you are looking for information about the 'radio' feature, it is a [proprietary protocol from Nordic and Lancaster University](https://lancaster-university.github.io/microbit-docs/ubit/radio/). This is not Bluetooth and the difference is described further in [this article on using the micro:bit wirelessly](https://support.microbit.org/support/solutions/articles/19000083637-using-the-micro-bit-wirelessly-)
1717

1818
## BBC micro:bit Bluetooth Profile
1919

2020
The BBC micro:bit [Bluetooth profile is defined in the DAL](https://lancaster-university.github.io/microbit-docs/ble/profile/)
2121

22-
You can flash a pre-compiled Hex files, to the micro:bit that enables bluetooth services.As Bluetooth is memory intensive, these are supplied as either 'without Magnetometer Service' or 'without DFU Service':
22+
You can flash one of two pre-compiled Hex files to the micro:bit that enable bluetooth services. As Bluetooth is memory intensive, these are supplied as either 'without Magnetometer Service' or 'without DFU Service':
2323

24-
[Without magnetometer](/docs/bluetooth/assets/BLE_All_Services_DAL_2-1-1-No-Mag.hex)
25-
[Without DFU](/docs/bluetooth/assets/BLE_All_Services_DAL_2-1-1-No-DFU.hex)
24+
- [Without magnetometer](/docs/bluetooth/assets/BLE_All_Services_DAL_2-1-1-No-Mag.hex)
25+
- [Without DFU](/docs/bluetooth/assets/BLE_All_Services_DAL_2-1-1-No-DFU.hex)
2626

2727
The DAL contains the [C++ source for the BLE service files](https://github.com/lancaster-university/microbit-samples/blob/master/source/examples/bluetooth-services/main.cpp)
2828

2929
There are also some example programs in the [microbit-samples](https://github.com/lancaster-university/microbit-samples) repository:
3030

31-
[bluetooth-eddystone-uid]https://github.com/lancaster-university/microbit-samples/tree/master/source/examples/bluetooth-eddystone-uid
32-
[bluetooth-eddystone-url]https://github.com/lancaster-university/microbit-samples/tree/master/source/examples/bluetooth-eddystone-url
33-
[bluetooth-uart]https://github.com/lancaster-university/microbit-samples/tree/master/source/examples/bluetooth-uart
31+
- [bluetooth-eddystone-uid]https://github.com/lancaster-university/microbit-samples/tree/master/source/examples/bluetooth-eddystone-uid
3432

35-
The micro:bit has a Bluetooth 4.1 stack with Bluetooth Low Energy (BLE) and supports the [GAP Perhipheral Role](https://bluetooth-developer.blogspot.com/2016/07/microbit-and-bluetooth-roles.html).
33+
- [bluetooth-eddystone-url]https://github.com/lancaster-university/microbit-samples/tree/master/source/examples/bluetooth-eddystone-url
3634

37-
As per all Bluetooth, it operates in the ISM (Industrial Scientific Medical) band and this starts at **2.4GHz and ends at 2.41GHz**. BLE divides the frequency band into 50 x 2MHz bands of which 40 are used.
38-
These are called **channels** and numbered **0 to 39**.
39-
Channels 37, 38 and 39 are used for “advertising”.
35+
- [bluetooth-uart]https://github.com/lancaster-university/microbit-samples/tree/master/source/examples/bluetooth-uart
4036

41-
When devices are connected, they use the other channels in a particular sequence controlled by a feature called **adaptive frequency hopping**.
42-
This helps reduce the impact of congestion from other radio users.
37+
The micro:bit has a Bluetooth 4.1 stack with Bluetooth Low Energy (BLE) and supports the [GAP Peripheral Role](https://bluetooth-developer.blogspot.com/2016/07/microbit-and-bluetooth-roles.html).
4338

44-
Data transfer rates will only be a few 100K per second at best and it very much depends on how your application uses the Bluetooth features; lots of small temperature containing packets would have a lower data transfer rate than using the UART service, as it depends on the proportion of system protocol information vs. application data.
39+
It operates in the ISM (Industrial Scientific Medical) band, as per all Bluetooth devices. This starts at **2.4GHz and ends at 2.41GHz**. BLE divides the frequency band into 50 x 2MHz bands of which 40 are used. These are called **channels** and numbered **0 to 39**. Channels 37, 38 and 39 are used for "advertising".
40+
41+
When devices are connected, they use the other channels in a particular sequence controlled by a feature called **adaptive frequency hopping**. This helps reduce the impact of congestion from other radio users.
42+
43+
Data transfer rates will only be a few hundred Kilobytes per second at best, and throughput depends on how your application uses the Bluetooth features. Throughput depends on the proportion of system protocol overheads to application data. Lots of small packets containing - for example - temperature data would have a lower data transfer rate than using the UART service.
4544

4645
There are some useful [advanced configuration options in the micro:bit runtime code](https://lancaster-university.github.io/microbit-docs/advanced/#compile-time-options-with-yotta)
4746

@@ -60,3 +59,5 @@ We are seeking collaborators to help us define the new profile elements that exp
6059
- [Original micro:bit "Out of the Box" experience](https://support.microbit.org/a/solutions/articles/19000021613), including some of the attributes in the Bluetooth Profile
6160

6261
- [Full profile with the display unused](https://lancaster-university.github.io/microbit-docs/resources/microbit-1_4_17_pwr0.zip). If you want to write to the display over bluetooth then you should use this file instead of the 'Out of the Box' hex, which uses the display.
62+
63+
- [micro:bit radio API documentation](https://lancaster-university.github.io/microbit-docs/ubit/radio/)

community/slack.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ In addition to our regular [Micro:bit Educational Foundation newsletter](https:/
2727

2828
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.
2929

30-
Slack operates it's 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), so make sure you have read and you agree with this before signing up.
3131

3232
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
3333

0 commit comments

Comments
 (0)