PFx Brick API Reference¶

The PFx Brick API has a top level PFxBrick class object. An instance of PFxBrick is used to open, maintain, and close an operating session with a PFx Brick. This class internally contains several supporting child classes used as convenient containers for related data. In particular, it contains a PFxConfig and PFxDir class which store configuration and file system data respectively.

The PFxAction class is used to specify actions the PFx Brick can perform including motor control, lighting effects, and sound effects. It has many supporting methods to conveniently specify popular actions. A host application can also directly modify the field attributes of a PFxAction instance to specify a detailed action description. Details of specifying these fields can be found in the PFx Brick Interface Control Document (ICD).

This page summarizes the main functional groups of functionality contained in this API in sections that follow.

Connection¶

Functions to establish a connected session with a PFx Brick.

PFxBrick::close()

Information¶

Functions to get information and status from the PFx Brick.

Configuration¶

Functions which query and modify PFx Brick configuration and settings.

Event/Action LUT¶

Functions which query and modify the event/action look up table in the PFx Brick.

File System¶

Functions which interact with the PFx Brick file system.

Actions¶

Functions which specify and perform common actions.

PFxBrick::test_action()

Motor Actions¶

PFxAction::set_motor_speed()

PFxAction::stop_motor()