pixelblaze-client 1.0.1

Library for Pixelblaze addressable LED controller.

pixelblaze-client

A Python library that presents a simple, synchronous interface for communicating with and controlling one or more Pixelblaze LED controllers.

Requirements

• Python 3.9-3.10
• websocket-client (installable via pip install websocket-client, or from https://github.com/websocket-client/websocket-client)
• requests (installable via pip install requests, or from https://github.com/psf/requests)
• pytz (installable via pip install pytz, or from https://github.com/stub42/pytz)

Installation

Install pixelblaze-client with all required packages using pip:

pip install pixelblaze-client

Or, if you prefer, drop a copy of pixelblaze.py into your project directory and reference it within your project:

from pixelblaze import *

Documentation

API and other documention is available in Markdown and HTML.

Sample code illustrating usage is provided in the examples directory.

Version history

Current Version [v1.0.1] - 2022-11-04

Minor bug fixes and various adjustments to the compatibility & helper functions

Added

• simple.py example (in the /examples folder) shows basic Pixelblaze control features: how to set a pattern, change color and change brightness.

Fixed

• getActiveVariables now (correctly) returns a dictionary of variables and values instead of a nested dictionary under the single key "vars"
• setActivePatternByName works again

Previous Version [v1.0.0] - 2022-10-01

A major refactoring and enhancement of the pixelblaze-client library with many significant changes.

The API surface is completely new, so users of previous versions are urged to review the API documentation.

Added

• new PBB class for reading, writing and manipulating Pixelblaze Binary Backups for backup/restore of Pixelblaze configurations and patterns.

• new PBP class for reading, writing and manipulating Pixelblaze Binary Patterns as stored within Pixelblaze Binary Backups.

• new EPE class for reading, writing and manipulating Encapsulated Pattern Expressions as imported/exported from the Pixelblaze pattern editor.

• new methods to provide access to all of the features exposed by the Pixelblaze webUI. See the API documentation for more details.

• new example programs to demonstrate the new API.

Changed

• Many existing methods renamed to give common names to related functions. See the API documentation for more details.

Deprecated

• Some existing methods deprecated. See the API documentation for more details.

Removed

• Some existing methods removed.

• Internal methods (names beginning with "_") were removed where no longer required.

Older Versions

See CHANGELOG.md for complete version history.

Known Issues

• None at the moment; if you find something, let us know!