Skip to content

Commit 97edb54

Browse files
microbit-markmicrobit-mark
authored
Squashed 'docs/' changes from ae437c7..7b0e132 (#93)
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: 7b0e132
1 parent 92ca9a0 commit 97edb54

36 files changed

+649
-1140
lines changed

‎README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
22

3-
# Microbit Developer Community Docs
3+
## Microbit Developer Community Docs
44

55
These docs form the content that is rendered into the [micro:bit Developer Commmunity site](http://tech.microbit.org)
66

77
## Using these docs
88

99
These docs are made available under a Creative Commons license, to support the micro:bit community. Issues and Pull Requests are welcomed and encouraged. Please review the [Foundation community and brand guidelines](https://microbit.org/community/) and the [tech.microbit.org](http://tech.microbit.org) homepage for further details about contribution.
1010

11-
**Documentation development tools**
11+
### Documentation development tools
12+
1213
- The docs are mostly written in [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)

‎accessories/making-accessories.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,30 @@ 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, commonly referred to as the 'edge connector' or the 'pins' makes accessory design easy.
1818

19-
Many micro:bit accessories are designed to use an edge connector socket, so it is simple
20-
to plug in and remove the board.
19+
Many micro:bit accessories are designed to use an edge connector socket, so it is simple to plug in and remove the board.
2120

2221
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.
2322

2423
### V2 revision
24+
2525
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.
2626

27-
* Details of the [edge connector and pinout](/hardware/edgeconnector)
28-
* Details about [powering things from the board](/hardware/powersupply)
27+
- Details of the [edge connector and pinout](/hardware/edgeconnector)
28+
- Details about [powering things from the board](/hardware/powersupply)
2929

3030
## Battery Pads
3131

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

34-
3534
![Picture of the two lozenges](/docs/accessories/assets/making-accessories-d7c25.png)
3635

3736
### V2 revision
37+
3838
In the <span class="v2">V2</span> board revision, the 3V lozenge is connected to the 3V ring on the edge connector.
3939

40-
- If you make an accessory that uses the lozenges, it must be protected from reverse charging
41-
when the board is powered by USB, battery or edge connector.
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.
4241
- 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.
4342

4443
Due to the addition of a speaker, current accessories that use the lozenges to power the micro:bit will no longer fit.

‎bluetooth/apps-and-examples.md

+22-33
Original file line numberDiff line numberDiff line change
@@ -9,57 +9,46 @@ ref: bluetooth
99
lang: en
1010
---
1111

12-
Bluetooth applications can run on a variety of devices, including but not limited
13-
to smart phones and tablets. You can also run Bluetooth enabled applications
14-
on devices such as a Raspberry Pi.
12+
## Overview
1513

16-
Below is a curated list of some Bluetooth applications you might like to read
17-
about and try for yourself with your micro:bit. Please contribute to this list
18-
if you know of any more. Many listed here are take from the [micro:bit Awesome list](https://github.com/carlosperate/awesome-microbit)
14+
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.
1915

20-
## Applications, tools and examples
21-
22-
23-
[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)
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)
2417

25-
[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)
26-
27-
[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
28-
29-
[Scratch](https://scratch.mit.edu/microbit) facilitates a connection to the micro:bit and uses display, buttons and motion sensor services.
18+
## Applications, tools and examples
3019

31-
[Bitty Software Apps](https://bittysoftware.blogspot.com/p/applications.html)
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)
3221

33-
[Bitty Software Apps](https://bittysoftware.blogspot.com/p/applications.html)
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)
3423

35-
[App Inventor + IoT](http://iot.appinventor.mit.edu/#/microbit/microbitintro) - Control a micro:bit via Bluetooth with App Inventor, a visual programming environment for Android applications.
24+
- [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
3625

37-
[BlockyTalkyBLE](https://www.playfulcomputation.group/blockytalkyble.html) - MakeCode and App Inventor extension that makes it easy to connect AppInventor mobile phone apps with the BBC micro:bit wirelessly over Bluetooth.
26+
- [Scratch](https://scratch.mit.edu/microbit) facilitates a connection to the micro:bit and uses display, buttons and motion sensor services.
3827

39-
[CBMicroBit](https://github.com/Louismac/CBMicroBit) - CoreBluetooth wrapper in C++ that connects a micro:bit to a computer running macOS using BLE and outputs over OSC (can be used standalone, or as a C++ or Objective C library).
28+
- [Bitty Software Apps](https://bittysoftware.blogspot.com/p/applications.html)
4029

41-
[evothings](https://evothings.com/evothings-and-the-bbc-microbit/)
30+
- [micro:bit Blue App for Android](https://github.com/microbit-foundation/microbit-blue)
4231

43-
[droidscript microbit](http://www.microbit-js.org/controlling-microbit-with-droidscript/)
32+
- [droidscript microbit](http://www.microbit-js.org/controlling-microbit-with-droidscript/)
4433

45-
[droidscript plugin](http://www.microbit-js.org/installing-the-microbit-plugin-for-droidscript/)
34+
- [droidscript plugin](http://www.microbit-js.org/installing-the-microbit-plugin-for-droidscript/)
4635

47-
[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.
36+
- [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.
4837

49-
[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 amulti-device coding canvas for block-based programming that connects with BLE devices via Chrome Web Bluetooth.
5039

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

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

55-
[microbit-web-components](https://github.com/thegecko/microbit-web-components) - Web Components for all the micro:bit features exposed via BLE.
44+
- [microbit-web-components](https://github.com/thegecko/microbit-web-components) - Web Components for all the micro:bit features exposed via BLE.
5645

57-
[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.
46+
- [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.
5847

59-
[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) - Multiplayer snake game on Android, controlled with micro:bits via Bluetooth.
6049

61-
[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.
50+
- [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.
6251

63-
[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.
52+
- [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.
6453

65-
[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

+17-24
Original file line numberDiff line numberDiff line change
@@ -8,44 +8,37 @@ permalink: /bluetooth/
88
ref: bluetooth
99
lang: en
1010
---
11-
# Overview
12-
The micro:bit processor has an on board
13-
[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
14-
the micro:bit a certified and credible Bluetooth capability.
11+
12+
## Overview
13+
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
17-
<span class="v1">v1</span> Nordic Semiconductor [Soft Device S110](https://www.nordicsemi.com/Software-and-Tools/Software/S110)
18-
<span class="v2">V2</span> Nordic Semiconductor [Soft Device S140](https://www.nordicsemi.com/Software-and-tools/Software/S140) . We may switch to [S113](https://www.nordicsemi.com/Software-and-tools/Software/S113) and [S122](https://www.nordicsemi.com/Software-and-tools/Software/S122) at compile time to save flash memory (if this affects anything you are working on please [contact micro:bit support](https://support.microbit.org/en/support/tickets/new)).
1917

18+
<span class="v1">v1</span> Nordic Semiconductor [Soft Device S110](https://www.nordicsemi.com/Software-and-Tools/Software/S110)
19+
<span class="v2">V2</span> Nordic Semiconductor [Soft Device S140](https://www.nordicsemi.com/Software-and-tools/Software/S140)
20+
21+
We may switch to [S113](https://www.nordicsemi.com/Software-and-tools/Software/S113) and [S122](https://www.nordicsemi.com/Software-and-tools/Software/S122) at compile time to save flash memory (if this affects anything you are working on please [contact micro:bit support](https://support.microbit.org/en/support/tickets/new)).
2022

21-
Using Bluetooth, you can connect to other devices and send and receive
22-
data from and to the micro:bit.
23+
Using Bluetooth, you can connect to other devices and send and receive data from and to the micro:bit.
2324

2425
## micro:bit Bluetooth Features
2526

26-
Bluetooth features available on the micro:bit are defined in a
27-
[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.
32-
[MakeCode](https://makecode.microbit.org/reference/bluetooth) contains a set of blocks to make use
33-
of the various micro:bit services.
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.
3432

35-
The processor also has a number of non-bluetooth proprietary
36-
modes of operation, on which we build the micro:bit radio
37-
protocol. This only works between micro:bits and is what is defined as 'Micro:bit Radio' in the DAL
38-
and 'radio' in MakeCode and MicroPython, as well as Mbed C++.
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++.
3934

4035
## Apps
4136

42-
[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)
43-
[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)
44-
[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
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)
38+
- [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)
39+
- [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
4540
Scratch.
4641

47-
## Links
48-
49-
[Bluetooth Specification](https://www.bluetooth.com/specifications/adopted-specifications)
50-
42+
## Further information
5143

44+
- [Bluetooth Specification](https://www.bluetooth.com/specifications/adopted-specifications)

0 commit comments

Comments
 (0)