Skip to content

Commit

Permalink
Move all example apps to common folder
Browse files Browse the repository at this point in the history
  • Loading branch information
lulf committed Aug 26, 2024
1 parent c4b043e commit 774c682
Show file tree
Hide file tree
Showing 27 changed files with 861 additions and 708 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
needs: build
strategy:
matrix:
example: [nrf-sdc, serial-hci, esp32] #, apache-nimble]
example: [nrf-sdc, serial-hci, esp32, rp-pico-w] #, apache-nimble]
steps:
- uses: actions/checkout@v4
- name: Add dependencies
Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,23 @@ The implementation has the following functionality working:

See the [issues](https://github.com/embassy-rs/trouble/issues) for a list of TODOs.

## Minimum supported Rust version (MSRV)

Trouble is guaranteed to compile on stable Rust 1.80 and up. It *might*
compile with older versions but that may change in any new patch release.

## Examples

See `examples` for example applications. Currently there are three examples:
See `examples` for example applications for different BLE controllers.

* `nrf-sdc` for the nRF52 based using the [`nrf-sdc`](https://github.com/alexmoon/nrf-sdc) crate.
* `serial-hci` which runs on std using a controller attached via a serial port (Such as [this Zephyr sample](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/zephyr/samples/bluetooth/hci_uart/README.html)).
* `apache-nimble` which uses the controller from the [NimBLE stack](https://github.com/apache/mynewt-nimble) through high-level bindings from the [`apache-nimble`](https://github.com/benbrittain/apache-nimble-sys) crate.
* `esp32` which uses the BLE controller in the [esp-hal](https://github.com/esp-rs/esp-hal).
* `rp-pico-w` which uses the BLE controller in the [Raspberry Pi Pico W](https://www.raspberrypi.com/documentation/microcontrollers/pico-series.html#raspberry-pi-pico-w).

Since a lot of the examples demo the same BLE functionality, they only contain basic wiring specific to the BLE controller, and share the 'business logic' within the `examples/apps` folder.

## License

Trouble is licensed under either of
Expand Down
Loading

0 comments on commit 774c682

Please sign in to comment.