pypixelcolor

pypixelcolor (also known as iPixel-CLI) is a Python library and CLI tool for controlling iPixel Color LED matrix devices via Bluetooth Low Energy. It allows you to send commands to the device to manipulate the LED display, retrieve device information, and more.

Features

• Send text, images
• Control animations and effects
• Retrieve device information
• Scriptable via Python

Installation

pip install pypixelcolor

Usage

CLI

pypixelcolor --help

Python Library

import pypixelcolor

client = pypixelcolor.Client("BLE_DEVICE_ADDRESS")
client.connect()
client.send_text("Hello, World!")
client.disconnect()

WebSocket server

python -m pypixelcolor.websocket --help

See the wiki for more detailed usage instructions.

Development

This project uses Hatch for packaging and managing the development environment.

Setup development environment

Create and activate the environment

hatch env create

Activate the environment

hatch shell

Install the package in editable mode

hatch run pip install -e '.[dev]'

Run tests

hatch run pytest

Build package

hatch build

💡 If your terminal doesn't support emojis, you can disable them with the --noemojis flag.

Related projects

• iPixel-CFW: CFW experimentation
• iPixel-ESPHome: ESPHome integration

Check also these cool projects made by other developers:

• iPixel-ESP32 (ToBiDi0410): ESP32 port of this project
• iPixel-CLI-ESP32 (Cino2424): Another ESP32 port of this project
• go-ipxl (yyewolf): Go library implementation

License

This project is licensed under the MIT License. See the LICENSE file for details.

This project is not affiliated with or endorsed by the original manufacturer of the iPixel devices or the official "iPixel Color" app.

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request. To get started on how to dump BLE logs from an Android device, refer to the How to get BLE logs guide.