pfxbrick 0.7.1

A python API for host control of USB connected PFx Bricks.

PFx Brick Python API

This repository contains a python package API for developing python scripts and applications which communicate with the PFx Brick. This package supports both USB and Bluetooth LE connections to the PFx Brick and is supported for Windows, macOS and linux.

Getting Started

Requirements

• Python 3.6+

• HIDAPI

• Bleak

• sphinx (for documentation)

Installation

The pfxbrick package can be installed with pip:

$ pip install pfxbrick

or directly from the source code:

$ git clone https://github.com/fx-bricks/pfx-brick-py.git
$ cd pfx-brick-py
$ python setup.py install

Basic Usage

After installation, the package can imported:

$ python
>>> import pfxbrick
>>> pfxbrick.__version__

An example of the package can be seen below

from pfxbrick import PFxBrick

# Open a PFx Brick session instance
brick = PFxBrick()
brick.open()

# Get the status and identity of the PFx Brick
print('PFx Brick ICD version : %s' %(brick.get_icd_rev()))
brick.get_status()
brick.print_status()

# Get the PFx Brick configuration settings
brick.get_config()
brick.print_config()

# Get the user defined name of the PFx Brick
brick.get_name()
print(brick.name)

# Change the user defined name
brick.set_name('My Cool Brick')

# End the session
brick.close()

---

Documentation

• PFx Brick Interface Control Document (ICD) v.3.37 describes details of PFx Brick operation and communication protocol

• Python API Reference Documentation

If you want to learn more about PFx Brick, check out our website.

Change Log

v.0.7.1

• revised documentation

• improved BLE notifcation callbacks

v.0.7.0

• added Bluetooth LE connection access with same functionality as USB

• added convenience methods to PFxBrick class to execute actions directly

• added support for running scripts on PFx Brick

v.0.6.2

• fixed error reporting for file system access methods

• fixed file directory refresh to ignore empty directory entries

v.0.6.1

• changed the USB write function to ensure consistent cross-platform compatibility

v.0.6.0

• finished implementing missing functionality

• finished documentation

• first public announced release

v.0.5.1

• Added CHANGELOG.rst to project manifest

v.0.5.0

• Initial release