Skip to content

A Python SDK for interacting with Neosensory products. Powered by the Python Bleak library

License

Notifications You must be signed in to change notification settings

neosensory/neosensory-sdk-for-python

Repository files navigation

Neosensory Python SDK

NOTE: This SDK is not fully working yet and we are not able to offer support for it at this time. Members of the community are more than welcome to contribute, build off of this, and help test!

A Python package for interacting with Neosensory products. This is designed to work with Bleak, a cross-platform Python Bluetooth Low Energy (BLE) client for Windows, MacOS, and Linux. Please see the Bleak project page for more specifics on supported platforms. IMPORTANT: At the moment this is tested and only working on Windows.

Requirements

This SDK relies on Bleak to take care of the underlying Bluetooth low energy shenanigans. It is included as a dependency and should get automatically installed if using pip or setup.py.

Installation

you can clone this repo and run

python setup.py develop

or

pip install neosensory-python

from within the root directory.

Usage

You may need to first pair your Neosensory Buzz in advance with your operating system (OS). To do so, find your OS's Bluetooth settings/panel and follow its instructions for pairing a new device. To put Buzz into pairing mode, hold down the (+) and (-) buttons until the LEDs flash blue.

See this repo's examples directory to get up and running quickly.

Documentation

You can learn more about the available commands on this project documentation page. Neosensory platform-agnostic documentation can be obtained from the Neosensory developer site.

License

Please note that while this project has an Apache 2.0 license, usage of the Neosensory API to interface with Neosensory products is still subject to the Neosensory developer terms of service located here

About

A Python SDK for interacting with Neosensory products. Powered by the Python Bleak library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages