Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmazzella/uble
Lightweight Bluetooth Low Energy driver written in pure python for micropython
https://github.com/dmazzella/uble
bluenrg-ms bluetooth-low-energy eddystone hci micropython pyboard spbtle-rf
Last synced: 2 months ago
JSON representation
Lightweight Bluetooth Low Energy driver written in pure python for micropython
- Host: GitHub
- URL: https://github.com/dmazzella/uble
- Owner: dmazzella
- License: mit
- Created: 2017-01-25T09:59:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-29T12:52:34.000Z (over 5 years ago)
- Last Synced: 2024-01-27T08:08:45.403Z (5 months ago)
- Topics: bluenrg-ms, bluetooth-low-energy, eddystone, hci, micropython, pyboard, spbtle-rf
- Language: Python
- Homepage:
- Size: 6.85 MB
- Stars: 79
- Watchers: 10
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-micropython - uble - Lightweight Bluetooth Low Energy driver written in pure Python for MicroPython. (Libraries / Communications)
README
# uble
Lightweight Bluetooth Low Energy driver written in pure python for micropython.
WARNING: this project is in beta stage and is subject to changes of the
code-base, including project-wide name changes and API changes.
Features
---------------------
- Parsing and Building of HCI packets
- Allows PyBoard to control BLE chips using HCI packets
Usage
---------------------
- Parsing of HCI packets:
```python
MicroPython v1.8.7-79-g221f88d-dirty on 2017-01-26; PYBv1.1 with STM32F405RG
Type "help()" for more information.
>>> from bluetooth_low_energy.protocols.hci import (cmd, uart)
>>> buf = b'\x01\x03\x0c\x00'
>>> hci_uart = uart.HCI_UART.from_buffer(buf)
>>> print(hci_uart)
>>> hci_cmd = cmd.HCI_COMMAND.from_buffer(hci_uart.data)
>>> print(hci_cmd)
>>> hci_cmd.to_buffer()
b'\x03\x0c\x00'
>>>
```
- Building of HCI Packets:
```python
MicroPython v1.8.7-79-g221f88d-dirty on 2017-01-26; PYBv1.1 with STM32F405RG
Type "help()" for more information.
>>> from bluetooth_low_energy.protocols.hci import cmd
>>> hci_cmd = cmd.HCI_COMMAND(ogf=cmd.OGF_LE_CTL, ocf=cmd.OCF_LE_RAND)
>>> print(hci_cmd)
>>> hci_cmd.to_buffer()
b'\x18 \x00'
>>>
```
- Control BLE chips examples
With low level api:
- [basic.py](https://github.com/dmazzella/uble/blob/master/examples/basic.py): print BlueNRG FW versions
- [bluest_protocol.py](https://github.com/dmazzella/uble/blob/master/examples/bluest_protocol.py): implements the BlueST protocol usable for test with 'ST BlueMS' app
- [eddystone.py](https://github.com/dmazzella/uble/blob/master/examples/eddystone.py): implement an Eddystone Beacon device
- [sensor_demo.py](https://github.com/dmazzella/uble/blob/master/examples/sensor_demo.py): usable for test with 'BlueNRG' app
- [firmware_update.py](https://github.com/dmazzella/uble/blob/master/examples/firmware_update/firmware_update.py): update SPBTLE-RF firmware (see [README](https://github.com/dmazzella/uble/blob/master/examples/firmware_update/README.txt))
With high level api:
- [api_eddystone.py](https://github.com/dmazzella/uble/blob/master/examples/api/api_eddystone.py): implement an Eddystone Beacon device
- [api_sensor_demo.py](https://github.com/dmazzella/uble/blob/master/examples/api/api_sensor_demo.py): usable for test with 'BlueNRG' app
- [api_scan.py](https://github.com/dmazzella/uble/blob/master/examples/api/api_scan.py): implement a Scanner object used to scan for LE devices which are broadcasting advertising data
- [api_hid_over_gatt.py](https://github.com/dmazzella/uble/blob/master/examples/api/api_hid_over_gatt.py): implement a HID over GATT keyboard (tested with iOS and Windows 10)
- [api_repl.py](https://github.com/dmazzella/uble/blob/master/examples/api/api_repl.py): implement a Bluetooth LE REPL (need _thread enabled and external dependency collections.deque already available into folder 'micropython-lib' of this repository. If found ucollections.deque use it internally)
Usable terminal available at [Micropython WebBluetooth REPL](https://dmazzella.github.io/htdocs/repl/)
Software
---------------------
Currently implemented full HCI commands from [STSW-BLUENRG-DK 2.0.2](http://www.st.com/en/embedded-software/stsw-bluenrg-dk.html)
User manual [BlueNRG-MS Bluetooth® LE stack application command interface](http://www.st.com/resource/en/user_manual/dm00162667.pdf)
Programming manual [BlueNRG, BlueNRG-MS stacks programming guidelines](http://www.st.com/resource/en/programming_manual/dm00141271.pdf)
Hardware
---------------------
Currently supported module STMicroelectronics [SPBTLE-RF](http://www.st.com/en/wireless-connectivity/spbtle-rf.html)
From STMicroelectronics [X-NUCLEO-IDB05A1](http://www.st.com/en/ecosystems/x-nucleo-idb05a1.html):
PyBoard breakout board:
Fritzing for breakout: [MicroPython_SPBTLERF_Breakout_v03_mod.fzz](https://github.com/dmazzella/uble/raw/master/hardware/MicroPython_SPBTLERF_Breakout_v03/MicroPython_SPBTLERF_Breakout_v03_mod.fzz)
Gerber for breakout: [MicroPython_SPBTLERF_Breakout_v03_mod.zip](https://github.com/dmazzella/uble/raw/master/hardware/MicroPython_SPBTLERF_Breakout_v03/MicroPython_SPBTLERF_Breakout_v03_mod.zip)
If have interest into preassembled breakout board contact me at [email protected]
External dependencies
---------------------
Only for examples:
'logging' already available into folder 'micropython-lib' of this repository
Install 'bluetooth_low_energy' into the pyboard
---------------------
To enable the functionality you need to freeze the package 'bluetooth_low_energy',
to do this, copy the package 'bluetooth_low_energy' into 'micropython-lib'.
Navigate to the folder containing the repository [micropython](https://github.com/micropython/micropython):
```bash
$ cd ports/stm32
$ make FROZEN_MPY_DIR="~/uble/micropython-lib"
```