Skip to content

Commit ac8b131

Browse files
committed
Consistent use of whitespace and Markdown formatting
This changeset enforces some style rules in the name of consistency: - All pages have a title - Bulleted lists use -, numbered use N. - Bulleted lists of links separated by linebreaks - One line-break before and after titles, lists and tables - All titles use markdown title syntax - Titles start with level 2, website uses h1 in header - Lists of links are always bulleted - Lead-in to lists ends with semi-colon These "rules" are somewhat arbitrary, but informed by the HTML rendered to the website and for ease of reading/editing.
1 parent 670d1f1 commit ac8b131

34 files changed

+366
-372
lines changed

README.md

Lines changed: 3 additions & 2 deletions
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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,20 @@ Many micro:bit accessories are designed to use an edge connector socket, so it i
2121
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.
2222

2323
### V2 revision
24+
2425
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.
2526

26-
* Details of the [edge connector and pinout](/hardware/edgeconnector)
27-
* 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)
2829

2930
## Battery Pads
3031

3132
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.
3233

33-
3434
![Picture of the two lozenges](/docs/accessories/assets/making-accessories-d7c25.png)
3535

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

3940
- 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.

bluetooth/apps-and-examples.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,46 +9,46 @@ ref: bluetooth
99
lang: en
1010
---
1111

12+
## Overview
13+
1214
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.
1315

1416
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)
1517

16-
1718
## Applications, tools and examples
1819

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)
1921

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)
21-
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

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
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
2525

26-
[Scratch](https://scratch.mit.edu/microbit) facilitates a connection to the micro:bit and uses display, buttons and motion sensor services.
26+
- [Scratch](https://scratch.mit.edu/microbit) facilitates a connection to the micro:bit and uses display, buttons and motion sensor services.
2727

28-
[Bitty Software Apps](https://bittysoftware.blogspot.com/p/applications.html)
28+
- [Bitty Software Apps](https://bittysoftware.blogspot.com/p/applications.html)
2929

30-
[micro:bit Blue App for Android](https://github.com/microbit-foundation/microbit-blue)
30+
- [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/)
32+
- [droidscript microbit](http://www.microbit-js.org/controlling-microbit-with-droidscript/)
3333

34-
[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/)
3535

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

40-
[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.
4141

42-
[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.
4343

44-
[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.
4545

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

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.
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.
5151

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,18 @@ permalink: /bluetooth/
88
ref: bluetooth
99
lang: en
1010
---
11-
# Overview
11+
12+
## Overview
13+
1214
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.
1315

1416
## Bluetooth software stack
17+
1518
<span class="v1">v1</span> Nordic Semiconductor [Soft Device S110](https://www.nordicsemi.com/Software-and-Tools/Software/S110)
1619
<span class="v2">V2</span> Nordic Semiconductor [Soft Device S140](https://www.nordicsemi.com/Software-and-tools/Software/S140)
1720

1821
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)).
1922

20-
2123
Using Bluetooth, you can connect to other devices and send and receive data from and to the micro:bit.
2224

2325
## micro:bit Bluetooth Features
@@ -32,13 +34,11 @@ The processor also has a number of non-bluetooth proprietary modes of operation,
3234

3335
## Apps
3436

35-
[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)
36-
[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)
37-
[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
3840
Scratch.
3941

40-
## Links
41-
42-
[Bluetooth Specification](https://www.bluetooth.com/specifications/adopted-specifications)
43-
42+
## Further information
4443

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

bluetooth/profile.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ The micro:bit supports Bluetooth via a single BBC micro:bit profile which was cu
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

18-
1918
## BBC micro:bit Bluetooth Profile
2019

2120
The BBC micro:bit [Bluetooth profile is defined in the DAL](https://lancaster-university.github.io/microbit-docs/ble/profile/)
@@ -46,20 +45,18 @@ Data transfer rates will only be a few 100K per second at best and it very much
4645

4746
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)
4847

49-
5048
## Challenge
5149

5250
It would be possible for anyone with the appropriate knowledge to define and implement other Bluetooth profiles. You would need to use the Mbed C/C++ environment to do this.
5351

5452
We are seeking collaborators to help us define the new profile elements that expose some of the <span class="v2">V2</span> features.
5553

56-
5754
## Further information
5855

59-
[Martin Woolley's Bluetooth Blog](https://bluetooth-developer.blogspot.com/) has a range of information on using Bluetooth with micro:bit
56+
- [Martin Woolley's Bluetooth Blog](https://bluetooth-developer.blogspot.com/) has a range of information on using Bluetooth with micro:bit
6057

61-
[BittySoftware](https://bittysoftware.blogspot.com) has a range of Bluetooth enabled software for the micro:bit
58+
- [BittySoftware](https://bittysoftware.blogspot.com) has a range of Bluetooth enabled software for the micro:bit
6259

63-
[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
60+
- [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
6461

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

community/slack.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,11 @@ If you'd like to join the slack channel, please fill in the form below. This for
3939
</iframe>
4040

4141
## Other channels and communities
42+
4243
In addition to the Foundation's own channels of communication, there are many other online communities of support.
4344

4445
- [MakeCode micro:bit forum](https://forum.makecode.com/c/microbit/11) Connect with the MakeCode team for more technical details regarding developing micro:bit extensions or working on the MakeCode editor.
46+
4547
- [Mu Gitter](https://gitter.im/mu-editor) Gitter chat is similar to Slack and aimed at developers using [Mu](https://codewith.mu/)
48+
4649
- [/r/microbit](https://www.reddit.com/r/microbit) A reddit discussion on micro:bit

0 commit comments

Comments
 (0)