diff options
| author | Dan Halbert <halbert@halwitz.org> | 2019-01-24 00:13:15 -0500 |
|---|---|---|
| committer | Dan Halbert <halbert@halwitz.org> | 2019-01-24 00:13:15 -0500 |
| commit | 04aa906fac7b57d56c3f7c1249ebe4b1e8690422 (patch) | |
| tree | 836a844400c380960e6f5165bfdc204fc340c0b1 | |
| parent | 7998a7696d31c68c8837af86173ec5d507567ca2 (diff) | |
fix a few ble-related doc issues
| -rw-r--r-- | docs/drivers.rst | 2 | ||||
| -rw-r--r-- | shared-bindings/bleio/Device.c | 3 | ||||
| -rw-r--r-- | shared-bindings/bleio/Peripheral.c | 2 |
3 files changed, 6 insertions, 1 deletions
diff --git a/docs/drivers.rst b/docs/drivers.rst index fcd94bc3b..148db804d 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -70,6 +70,8 @@ These libraries build on top of the low level APIs to simplify common tasks. miniQR Non-hardware QR code generator <https://circuitpython.readthedocs.io/projects/miniqr/en/latest/> Slideshow <https://circuitpython.readthedocs.io/projects/slideshow/en/latest/> LED Animation <https://circuitpython.readthedocs.io/projects/led-animation/en/latest/> + Bluetooth Low Energy (BLE) <https://circuitpython.readthedocs.io/projects/ble/en/latest/> + Bluefruit LE Connect App <https://circuitpython.readthedocs.io/projects/bluefruitconnect/en/latest/> Blinky -------- diff --git a/shared-bindings/bleio/Device.c b/shared-bindings/bleio/Device.c index cbad9fb7e..e40efbb59 100644 --- a/shared-bindings/bleio/Device.c +++ b/shared-bindings/bleio/Device.c @@ -48,6 +48,9 @@ //| :class:`Device` -- BLE device //| ========================================================= //| +//| **IGNORE ``Device`` and all its documentation. +//| It is being replaced by `Peripheral` and other classes.** +//| //| Provides access a to BLE device, either in a Peripheral or Central role. //| When a device is created without any parameter passed to the constructor, //| it will be set to the Peripheral role. If a address is passed, the device diff --git a/shared-bindings/bleio/Peripheral.c b/shared-bindings/bleio/Peripheral.c index eff4ca7f2..340485f35 100644 --- a/shared-bindings/bleio/Peripheral.c +++ b/shared-bindings/bleio/Peripheral.c @@ -70,7 +70,7 @@ static const char default_name[] = "CIRCUITPY"; //| periph = bleio.Peripheral([service]) //| periph.start_advertising() //| -//| while not periph.connected(): +//| while not periph.connected: //| # Wait for connection. //| pass //| |