Skip to main content

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

Project description

PFx Brick Python API

https://travis-ci.org/fx-bricks/pfx-brick-py.svg?branch=master https://img.shields.io/pypi/v/pfxbrick.svg https://img.shields.io/badge/license-MIT-blue.svg

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

Getting Started

Requirements

  • Python 3.6+
  • hidapi
  • 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

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

Change Log

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

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pfxbrick-0.6.2-py2.py3-none-any.whl (35.7 kB) Copy SHA256 hash SHA256 Wheel py2.py3
pfxbrick-0.6.2-py3.6.egg (69.5 kB) Copy SHA256 hash SHA256 Egg 3.6

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page