Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.48 KB

README.md

File metadata and controls

25 lines (19 loc) · 1.48 KB

bgapi_py

A library for using Bluetooth Low Energy modules created by BlueGiga. This module is pure python usable from Windows, Ubuntu, and any platform with a serial port and the ability to run Python (like Raspberry Pi and Beaglebone Black). Examples are provided for both client and server functionality. Note that if you want to develop your own device GATT profile, it requires a module firmware update.

bgapi.py has two important components:

  1. BlueGigaAPI wraps the serial connection, it can be used synchronously by calling the polling function, or it can be used asynchronously by starting the daemon thread.

  2. BlueGigaCallbacks is a base class for callbacks from responses and events received from the module. Inherit this class and override the functions you need to trigger your code or get your data.

cmd_def.py eliminates the need for magic numbers in method parameters, use it for more readable code.

bgmodule.py wraps the API in an additional layer of abstraction. It attempts to eliminate the need to understand the BlueGiga API, so that only an understanding of BLE is required.

Example Code

The test folder demonstrates high level Bluetooth Smart operations. It provides examples of Apple's iBeacon and Google's prototype Physical Web. Testing of this library is limited to what you see in these examples. Many BGAPI commands cannot be tested, especially hardware operations like GPIO and I2C. Two BLE112 devices are needed for all tests.