Developer

Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
Fx Bricks GitHub profile

PFx Brick Interface Control Document (ICD)

The ICD describes the details of the PFx Brick internal operations and the communication protocol used by both USB and BLE interfaces.

Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
PFx Brick ICD (English) Rev 3.38 (Aug 2021)
Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
Developer docs/ICD GitHub repository
Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
PFx Brick ICD (English) Rev 3.37 (May 2019)

Python API

Write your own applications and scripts in python to control your PFx Brick! This open source python API is cross platform compatible and is easy to install. You can clone the source code from our GitHub repository or install the pfxbrick package using pip from the PyPI repository.

Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
Python API GitHub repository
Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
Python API Online Documentation

C++ API

Write your own applications in C++ to control your PFx Brick! This open source python API should be cross platform compatible and requires the use of the hidapi (included in the repository as a submodule). You can clone the source code from our GitHub repository and refer to the examples folder for guidance on using the API.

Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
C++ API GitHub repository
Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
C++ API Online Documentation

PFx Brick Scripting Language

The PFx Brick supports running script files. Scripts are simple, human readable text files stored in the PFx Brick file system. These files conform to a simple script language syntax. Script files can be loaded on to the PFx Brick using the PFx App or by using other 3rd party software to copy files from a host PC to the PFx Brick.

We've also created a Visual Studio Code plugin extension to add syntax highlighting for PFx Brick script files. Also, brickelectronic.de has kindly created a PFx language profile for Notepad++.

Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
PFx Brick Visual Studio Code extension
Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
PFx Brick Language Profile for Notepad++
Produced by OmniGraffle 7.18.5\n2021-06-03 17:07:29 +0000 Canvas 1 Layer 1
PFx Script Language Cheatsheet