Skip to content

Commit

Permalink
docs: update README with some links and clarifications
Browse files Browse the repository at this point in the history
Signed-off-by: deadprogram <[email protected]>
  • Loading branch information
deadprogram committed Jan 16, 2025
1 parent f36a7a6 commit 0b655a6
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Go Bluetooth is a cross-platform package for using [Bluetooth Low Energy](https:

It works on typical operating systems such as [Linux](#linux), [macOS](#macos), and [Windows](#windows).

It can also be used running "bare metal" on microcontrollers produced by [Nordic Semiconductor](https://www.nordicsemi.com/) or using the Bluetooth Host Controller Interface (HCI) by using [TinyGo](https://tinygo.org/).
By using [TinyGo](https://tinygo.org/), it can also be used running "bare metal" on microcontrollers produced by [Nordic Semiconductor](https://www.nordicsemi.com/), or boards that have a Bluetooth co-processor that uses the [Bluetooth Host Controller Interface (HCI)](https://www.bluetooth.com/wp-content/uploads/Files/Specification/HTML/Core-54/out/en/host-controller-interface/host-controller-interface-functional-specification.html).

The Go Bluetooth package can be used to create both Bluetooth Low Energy Centrals as well as to create Bluetooth Low Energy Peripherals.

Expand Down Expand Up @@ -178,7 +178,7 @@ After you have followed the installation, you should be able to compile/run the

## Nordic Semiconductor

Go Bluetooth has bare metal support for several chips from Nordic Semiconductor that include a built-in Bluetooth Low Energy radio.
Go Bluetooth has bare metal support for several chips from [Nordic Semiconductor](https://www.nordicsemi.com/) that include a built-in Bluetooth Low Energy radio.

This support requires compiling your programs using [TinyGo](https://tinygo.org/).

Expand All @@ -201,7 +201,7 @@ Check your desired target board for any additional installation requirements.
The line of "Bluefruit" boards created by Adafruit already have the SoftDevice firmware pre-loaded. This means you can use TinyGo and the Go Bluetooth package without any additional steps required. Supported Adafruit boards include:

* [Adafruit Circuit Playground Bluefruit](https://www.adafruit.com/product/4333)
* [Adafruit CLUE Alpha](https://www.adafruit.com/product/4500)
* [Adafruit CLUE](https://www.adafruit.com/product/4500)
* [Adafruit Feather nRF52840 Express](https://www.adafruit.com/product/4062)
* [Adafruit ItsyBitsy nRF52840](https://www.adafruit.com/product/4481)

Expand All @@ -211,7 +211,19 @@ For example, this command can be used to compile and flash an Adafruit Circuit P

tinygo flash -target circuitplay-bluefruit ./examples/circuitplay

There are other boards with TinyGo support that also use the same UF2 bootloader with pre-loaded SoftDevice. They include:
### Seeed Studio XIAO nRF52840

The Seeed Studio Xiao nRF52840 uses the [UF2 bootloader](https://github.com/microsoft/uf2) with pre-loaded SoftDevice firmware, so it is very easy to use with TinyGo.

* [Seeed Studio XIAO nRF52840](https://wiki.seeedstudio.com/XIAO_BLE)

You can flash your TinyGo program like this:

tinygo flash -target=xiao-ble ./examples/heartrate

### Other boards with UF2 bootloader

There are other boards with TinyGo support that use the same UF2 bootloader with pre-loaded SoftDevice. They include:

* [Nice Keyboards nice!nano](https://nicekeyboards.com/products/nice-nano-v1-0)
* [Makerdiary nRF52840 MDK USB Dongle](https://wiki.makerdiary.com/nrf52840-mdk-usb-dongle/)
Expand Down

0 comments on commit 0b655a6

Please sign in to comment.