Metadata-Version: 2.1
Name: pixelblaze-client
Version: 1.0.0
Summary: Library for Pixelblaze addressable LED controller.
Home-page: https://github.com/zranger1/pixelblaze-client
Author: pixxxie & ZRanger1
License: MIT
Keywords: pixelblaze
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Hardware
Classifier: Intended Audience :: Developers
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md

# 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, or from https://github.com/websocket-client/websocket-client)
- requests (installable via pip, or from https://github.com/psf/requests)

## Installation
Install with pip:

```pip install pixelblaze-client```

Or, if you prefer, drop a copy of [pixelblaze.py](https://github.com/zranger1/pixelblaze-client/blob/main/pixelblaze-client/pixelblaze.py) into your project directory and reference it within your project:

```from pixelblaze import *```

## Documentation

API and other documention is available [here](https://github.com/zranger1/pixelblaze-client/blob/main/docs/index.md).

Sample code illustrating usage is provided in the [examples directory](https://github.com/zranger1/pixelblaze-client/blob/main/pixelblaze-client/examples).

## Version history

### Current Version [**v1.0.0**] - 2022-10-01

This is a major refactoring and enhancement of the **pixelblaze-client** library with many significant changes. The API surface is completely new, but compatibility stubs have been provided for most existing methods to assist in transitioning to the new API.

#### 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.  Compatibility stubs have been provided to maintain functionality; warning messages are emitted to encourage movement to the new API.

#### Removed

* Some internal methods (names beginning with "_") were removed where no longer required.

### Previous Versions

See [changelog.md](https://github.com/zranger1/pixelblaze-client/blob/main/changelog.md) for details on previous versions.

## Known Issues
- None at the moment; if you find something, [let us know](https://github.com/zranger1/pixelblaze-client/issues/new/choose)!
