ledsign 0.8.1

LED Sign Python API

LED Sign

This ledsign module allows the direct control and programming of the LED Sign series of devices using Python 3, or through a dedicated CLI interface. This module however does not allow for hardware-level configuration of the device, as any such modifications must be done through the dedicated UI interface.

The documentation is hosted on ReadTheDocs, accessible through this link.

Installation

The ledsign is available for easy download via PyPI. It can be installed with pip:

$ pip install ledsign

Alternatively, development versions can be installed directly from the GitHub repository:

$ git clone https://github.com/krzem5/ledsign
$ cd ledsign
$ pip install -e .

CLI Interface

Outside of the programmatic interface outlined in the Documentation, the ledsign module also features a command-line interface, accessible through the Python executable:

$ python -m ledsign -h
Usage: ledsign [options]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -d DEVICE_PATH|DEVICE_INDEX, --device=DEVICE_PATH|DEVICE_INDEX
                        open device at DEVICE_PATH, or the device at index
                        DEVICE_INDEX (leave empty to use default device path)
  -e, --enumerate       enumerate all available devices
  -x, --enumerate-only  enumerate all available devices and exit (implies
                        --enumerate)
  -i, --print-info      print device hardware information
  -c, --print-config    print device configuration
  -p, --print-driver    print driver stats
  -s PROGRAM, --save=PROGRAM
                        save current program into PROGRAM
  -u PROGRAM, --upload=PROGRAM
                        upload file PROGRAM to the device (requires read-write
                        mode)
  -z, --start-proxy-server
                        start a proxy server (required to communicate with the
                        device)

Proxy server

Due to issues with how Windows handles USB connections, a proxy server is required to bridge the gap between the system-level device handles and the UI/ledsign module. This proxy server can be started using the following command:

$ python -m ledsign -z
Proxy server running on port 9100, hit 'Enter' to stop...