Skip to main content

Driver for the CoolLEDX LED signs (signs managed by CoolLED1248 app)

Project description

Maintenance PyPI download month PyPI version fury.io PyPI version shields.io Documentation Status PR welcome issues still open MIT license buymecoffee

CoolLEDX Driver

This package implements a Python driver for the CoolLEDX LED strips (i.e., those strips that are controlled by the CoolLED1248 app). The strips receive commands via Bluetooth, and can generally be programmed to display text (which is actually just a rendered image of the text), images, or animations. You can get these strips pretty cheaply on AliExpress -- just be sure that you see a picture of the CoolLED1248 app on the product page, as this driver won't work with any other sort of strip. That said, they're pretty ubiquitous, at least at the time of this writing (December 2023).

Usage

You need to have a functioning Bluetooth device. This package uses Bleak for all its Bluetooth interactions, so you should be able to use any system supported by Bleak . . . but it hasn't been tested on anything other than Windows 11 (and soon Ubuntu on a Pi).

Roadmap

  • Write some bare-bones documentation, at least
  • Ensure this is tested out on a Raspberry Pi (my end target device)
  • Add a simple REST listener app to allow driving this remotely

Credits and Sources

Main Kudos

This project could not possibly exist without the work done by CrimsonClyde in reverse engineering the CoolLEDX protocol at LED FaceShields. Much of the code in this project is directly derived from that code, and almost all of the insights were from that work. That repository has a bunch of useful information about the underlying protocol.

The Source?

I believe that these LEDs are made by Juntong Technology. I think that the app itself is made by some 3rd party. I sent an email to the contact at Juntong, but never got a reply, so not sure. If anyone has a contact, I'd love to get connected, as I really like their strips!

For source code related to the app, which was helpful in some questions I had about the protocol (but, honestly, not too much there, and a headache to read), you could try:

Sniffing the CoolLED1248 App

For some of my protocol analysis, I found it useful to do the following:

  • Turn on BLE logging on my Android phone (under developer options) to save a log capture. Be sure to turn it on right before you start the capture, then turn it off immediately, so that you're not collecting a ton of junk information.
  • Run the CoolLED1248 app and send commands to the LED strip
  • Pull the log file from the phone to my PC using the ADB interface
  • Analyze it with Wireshark (just put a filter on the MAC address of the LED strip)

This helped me get over some spots where I was a bit lost in the handshakes, or making some bad assumptions about what was or was not working.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coolledx-0.1.0.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

coolledx-0.1.0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file coolledx-0.1.0.tar.gz.

File metadata

  • Download URL: coolledx-0.1.0.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.7 Windows/10

File hashes

Hashes for coolledx-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4180d3f50af252bf86eef80d65bd551f9fb109781526e101ca2ffb27d4ce73b4
MD5 f09e744158fdbad10652b4e44b41ce62
BLAKE2b-256 906a3d15bbdb5f9b2cdbbff4957abd7b15b93f8a62c25295b8a5b8cb9a304242

See more details on using hashes here.

File details

Details for the file coolledx-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: coolledx-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.7 Windows/10

File hashes

Hashes for coolledx-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0591aaae7bb84d41725e0f68c03869247a5564b663b4f2a19b01cac57aa970d
MD5 dd6e152f1f4e2af70a4838fe4813d05e
BLAKE2b-256 33b5a13c357d48036f94b65e5f5c8da93284ef90e3c0e42066773341ac7dbe2b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page