iPixel CLI

Python CLI rewrite of the "iPixel Color" application for LED Matrix displays manufactured by Taizhou Yumo Lighting Co., Ltd. Tested only on a 96x16 display, but should work on other sizes (if not please open an issue).

⚠️ Still experimental, some commands might change in the future. ⚠️

Features

• 🔗 Connect to the device
• 🔆 Set brightness
• 🟥 Set pixels on screen
• ⏲️ Set clock mode
• 🎉 Set the display mode to fun mode (do not save display)
• ✏️ Write text on the screen (with custom font support)
• 💥 Clear memory
• 🎢 Send animations
• 🖼️ Write frames to EEPROM
• ✅ Maintain connection to the device (WebSocket server)
• 🔧 Change orientation
• 🔧 Set the date
• 🔧 Set the clock
• 🔈 Rhythm mode
• 🔒 Set password

Installation

Clone the repository and install the required packages.

git clone https://github.com/lucagoc/iPixel-CLI
cd iPixel-CLI

Then use the package manager pip to install the required packages.

pip install -r requirements.txt

Usage

⚠️ WARNING ⚠️

Invalid data sent to the device can lead to BOOTLOOPS

While it is possible to recover from a bootloop by sending a clear command before the device tries to read the EEPROM, it is a little bit tricky and the timing is very short. This tool is still experimental, use at your own risk.

Commands are executed using the following format:

python ipixelcli.py -a <DEVICE_MAC_ADDRESS> -c <COMMAND> [PARAMETERS]

-c can be used multiple times to send multiple commands in a single request.

Example:

python ipixelcli.py -a 4B:1E:2E:35:73:A3 -c set_brightness value=20 -c send_text "Hello World" rainbow_mode=9 speed=50 animation=1

---

Commands

set_clock_mode

Description: Set the clock mode of the device.

Parameters:

• style (int): Clock style (0-8). Default: 1
• date (str): Date in DD/MM/YYYY format. Default: current date
• show_date (bool): Show date (true/false). Default: true
• format_24 (bool): 24-hour format (true/false). Default: true

---

set_rhythm_mode

Description: Set the rhythm mode of the device (Frequency).

Parameters:

• style (int): Style (0-4). Default: 0
• l1 to l11 (int): Levels for each channel (0-15). Default: 0 for all channels

---

set_rhythm_mode_2

Description: Set the rhythm mode of the device (Simple animation).

Parameters:

• style (int): Style (0-1). Default: 0
• t (int): Frame time of the animation (0-7). Default: 0

---

set_time

Description: Set the time of the device.

Parameters:

• hour (int): Hour (0-23). Default: current hour
• minute (int): Minute (0-59). Default: current minute
• second (int): Second (0-59). Default: current second

If one or more parameter is missing, the current time will be used.

---

set_fun_mode

Description: Set the DIY Fun Mode (Drawing Mode).

Parameters:

• value (bool): Enable or disable the mode (true/false). Default: false

---

set_orientation

Description: Set the orientation of the device.

Parameters:

• orientation (int): Orientation value (0-2). Default: 0

---

clear

Description: Clear the EEPROM.

Parameters: None

---

set_brightness

Description: Set the brightness of the device.

Parameters:

• value (int): Brightness level (0-100).

---

set_pixel

Description: Set the color of a specific pixel. (EXPERIMENTAL)

Parameters:

• x (int): X-coordinate of the pixel.
• y (int): Y-coordinate of the pixel.
• color (str): Hexadecimal color value (e.g., ff0000 for red).

---

send_text

Description: Send a text to the device with configurable parameters.

Parameters:

• text (str): The text to display.
• rainbow_mode (int): Rainbow effect mode (0-9). Default: 0
• animation (int): Animation style (0-7). Default: 0
• save_slot (int): Save slot for the text (1-10). Default: 1
• speed (int): Speed of the text animation (0-100). Default: 80
• color (str): Hexadecimal color value. Default: ffffff

---

set_screen

Description: Set the screen to display an image. (EXPERIMENTAL)

Parameters:

• path (str): Path to the image file.

---

send_animation

Description: Send a GIF animation to the device, size must be 96x16 pixels and small.

Parameters:

• path_or_hex (str): Path to the GIF file or its hexadecimal representation.

---

delete_screen

Description: Delete a screen from the EEPROM.

Parameters:

• n (int): Index of the screen to delete.

WebSocket server

You can also start a basic WebSocket server using the following command :

python ipixelcli.py -a <bt_address> --server -p <port>

Then, send a request to the server with the following content:

{
    "command": "<command>",
    "params": ["<param1>", "<param2>", "<param3>"]
}

For example :

{
    "command": "send_text",
    "params": ["Hello World", "rainbow_mode=1", "speed=50"]
}

Font generation

Edit the all.png file in the font folder to change characters. Then run gen_font.py to get the trimmed characters.

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.