Skip to main content

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

Project description

PFx Brick Python API

This repository contains the API for developing python scripts and applications which communicate with the PFx Brick.

Getting Started


  • Python 3.6+
  • hidapi
  • sphinx (for documentation)


The pfxbrick package can be installed with pip:

$ pip install pfxbrick

or directly from the source code:

$ git clone
$ cd pfx-brick-py
$ python 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()

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

# Get the PFx Brick configuration settings

# Get the user defined name of the PFx Brick

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

# End the session


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

Change Log


  • fixed error reporting for file system access methods
  • fixed file directory refresh to ignore empty directory entries


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


  • finished implementing missing functionality
  • finished documentation
  • first public announced release


  • Added CHANGELOG.rst to project manifest


  • Initial release

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pfxbrick, version 0.6.2
Filename, size File type Python version Upload date Hashes
Filename, size pfxbrick-0.6.2-py2.py3-none-any.whl (35.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pfxbrick-0.6.2-py3.6.egg (69.5 kB) File type Egg Python version 3.6 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page