Crownstone UART
Official Python lib for Crownstone: "Crownstone Unified System Bridge", or Crownstone USB implementation.
This works on all platforms and requires a Crownstone USB to work.
Install guide
This module is written in Python 3 and needs Python 3.7 or higher. The reason for this is that most of the asynchronous processes use the embedded asyncio core library.
If you want to use python virtual environments, take a look at the README_VENV
You can install the package by pip:
pip3 install crownstone-uart
If you prefer the cutting edge (which may not always work!) or want to work on the library itself, use the setuptools: python3 setup.py install
Requirements for the Crownstone USB
OS X
OS X requires installation of the SiliconLabs driver: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
Ubuntu
In order to use serial without root access, you should be in the dialout group.
You can check if you're in the group:
$ groups
To add yourself:
$ sudo adduser $USER dialout
You may need to logout and login again.
Raspbian
Similar to Ubuntu.
Arch Linux
To use serial in Arch Linux, add yourself to the uucp group.
To add yourself to the group:
$ sudo gpasswd -a $USER uucp
Make sure to logout and login again to register the group change.
Example
An example is provided in the root of this repository.
Prerequisites
- First use the phone app to setup your Crownstones and the Crownstone USB.
- Make sure you update the Crownstones' firmware to at least 5.4.0.
- Find out what port to use (e.g.
COM1,/dev/ttyUSB0, or/dev/tty.SLAB_USBtoUART), use this to initialize the library. - Have this library installed.
Find the IDs of your Crownstones
Firstly run the example script that simply lists the IDs of the Crownstones.:
$ python3 ./examples/discovery_example.py
Once some IDs are printed, use one of them for the next example. This can take a while because Crownstones, if not switched, only broadcast their state every 60 seconds.
Switch a Crownstone, and show power usage.
Edit the file switch_example.py:
- Set
targetCrownstoneIdto a Crownstone ID that was found in the previous example.
Run the file:
$ python3 ./examples/switch_example.py
API documentation
The API documentation can be found here.
License
MIT
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file crownstone-uart-2.3.0.tar.gz.
File metadata
- Download URL: crownstone-uart-2.3.0.tar.gz
- Upload date:
- Size: 24.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cf62c91cf5a9c82362c1ccfba5d9aed98e34f7d71813085dcabe458b2eb552cd
|
|
| MD5 |
af9ee74102e033fe2688374cc83a3942
|
|
| BLAKE2b-256 |
de895537384fd26c09e943c4e9813af4b82a20870345cd59927e59840cc107d8
|
File details
Details for the file crownstone_uart-2.3.0-py3-none-any.whl.
File metadata
- Download URL: crownstone_uart-2.3.0-py3-none-any.whl
- Upload date:
- Size: 41.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98453fa539797aefd0f72d193c5b90dbe32a413d5fcd08ba0d9fc129dad39e38
|
|
| MD5 |
a0b8d76eb792adb531f5319fee88cc52
|
|
| BLAKE2b-256 |
a769b74827ca3464aa9c0a4692069874b5c09905029dcdc2a49e41571984f21f
|
