# 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 or newer
- 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)
- py-mini-racer (installable via `pip install py-mini-racer`, or from https://github.com/sqreen/PyMiniRacer)
## Installation
Install pixelblaze-client with all required packages using pip:
```pip install pixelblaze-client```
Or, if you prefer, drop a copy of [pixelblaze.py](pixelblaze/pixelblaze.py) into your project directory and reference it within your project:
```from pixelblaze import *```
## <a name="documentation"></a>Documentation
API and other documention is available in [Markdown](docs/index.md) and [HTML](https://zranger1.github.io/pixelblaze-client/).
Sample code illustrating usage is provided in the [examples directory](examples/).
**Please note that version 1.0.0 was a major refactoring and enhancement of the library, with many new features and significant changes.** The API surface is completely new. See the the [API documentation](#documentation) for details.
## Current Version [**v1.1.4**] - 2024-8-27
#### Fixed
* Update firmware version check for remote pattern compilation
* Added ignoreOpenFailure to Pixelblaze() constructor to allow object creation without immediate connection to Pixelblaze.
* Preview frame image no longer contains unwanted header data
### Older Versions
See [CHANGELOG.md](CHANGELOG.md) for complete version history.
## Known Issues
- Check our github repo; if you find something, [let us know](/../../issues/new/choose)!
Raw data
{
"_id": null,
"home_page": "https://github.com/zranger1/pixelblaze-client",
"name": "pixelblaze-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "pixelblaze",
"author": "pixelblaze-client team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d3/9a/b525a5bd9680673c21f72db1fcd19ad8ea914f970b46be01baa17a75fc36/pixelblaze_client-1.1.4.tar.gz",
"platform": null,
"description": "# pixelblaze-client\r\nA Python library that presents a simple, synchronous interface for communicating with and\r\ncontrolling one or more Pixelblaze LED controllers. \r\n\r\n## Requirements\r\n- Python 3.9 or newer\r\n- websocket-client (installable via `pip install websocket-client`, or from https://github.com/websocket-client/websocket-client)\r\n- requests (installable via `pip install requests`, or from https://github.com/psf/requests)\r\n- pytz (installable via `pip install pytz`, or from https://github.com/stub42/pytz)\r\n- py-mini-racer (installable via `pip install py-mini-racer`, or from https://github.com/sqreen/PyMiniRacer)\r\n\r\n## Installation\r\nInstall pixelblaze-client with all required packages using pip:\r\n\r\n```pip install pixelblaze-client```\r\n\r\nOr, if you prefer, drop a copy of [pixelblaze.py](pixelblaze/pixelblaze.py) into your project directory and reference it within your project:\r\n\r\n```from pixelblaze import *```\r\n\r\n## <a name=\"documentation\"></a>Documentation\r\n\r\nAPI and other documention is available in [Markdown](docs/index.md) and [HTML](https://zranger1.github.io/pixelblaze-client/).\r\n\r\nSample code illustrating usage is provided in the [examples directory](examples/).\r\n\r\n**Please note that version 1.0.0 was a major refactoring and enhancement of the library, with many new features and significant changes.** The API surface is completely new. See the the [API documentation](#documentation) for details. \r\n\r\n## Current Version [**v1.1.4**] - 2024-8-27\r\n\r\n#### Fixed\r\n* Update firmware version check for remote pattern compilation\r\n* Added ignoreOpenFailure to Pixelblaze() constructor to allow object creation without immediate connection to Pixelblaze.\r\n* Preview frame image no longer contains unwanted header data\r\n\r\n### Older Versions\r\n\r\nSee [CHANGELOG.md](CHANGELOG.md) for complete version history.\r\n\r\n## Known Issues\r\n- Check our github repo; if you find something, [let us know](/../../issues/new/choose)!\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library for Pixelblaze addressable LED controller.",
"version": "1.1.4",
"project_urls": {
"Homepage": "https://github.com/zranger1/pixelblaze-client"
},
"split_keywords": [
"pixelblaze"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f5bb9642b20714a7382fd89e1fb40fb323f6baf829682672cc71ac68a26ed2d",
"md5": "ca400b7716372859823b3648f94e49fd",
"sha256": "5c3e74fd3b01aa70cbe6771f2262c824e1fa5142776738091beed0590a7228fd"
},
"downloads": -1,
"filename": "pixelblaze_client-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca400b7716372859823b3648f94e49fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 39279,
"upload_time": "2024-08-28T01:07:10",
"upload_time_iso_8601": "2024-08-28T01:07:10.950166Z",
"url": "https://files.pythonhosted.org/packages/7f/5b/b9642b20714a7382fd89e1fb40fb323f6baf829682672cc71ac68a26ed2d/pixelblaze_client-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d39ab525a5bd9680673c21f72db1fcd19ad8ea914f970b46be01baa17a75fc36",
"md5": "b9e64056e27e720b7da79d387c941f66",
"sha256": "89b0e97536e96019110374ffdb56a3bb9fd6b32222ea1d22bf2c493bb362c4ec"
},
"downloads": -1,
"filename": "pixelblaze_client-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "b9e64056e27e720b7da79d387c941f66",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 48578,
"upload_time": "2024-08-28T01:07:12",
"upload_time_iso_8601": "2024-08-28T01:07:12.270560Z",
"url": "https://files.pythonhosted.org/packages/d3/9a/b525a5bd9680673c21f72db1fcd19ad8ea914f970b46be01baa17a75fc36/pixelblaze_client-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 01:07:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zranger1",
"github_project": "pixelblaze-client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pixelblaze-client"
}
JSON
