Home Original page

GitHub - CharaChorder/charachorder.py: A wrapper for CharaChorder's Serial API written in Python

A wrapper for CharaChorder's Serial API written in Python

Warning: This project is in beta; breaking changes will occur without notice. Please wait for v1.0.0

Features

  • Supports all major versions of Python3.
  • Exhaustive list of commands as in the Serial API.
  • Events (coming soon).

Installation

Python 3.9 or higher is required.

# Linux/macOS
python3 -m pip install -U charachorder.py

# Windows
py -3 -m pip install -U charachorder.py

To install the development version, run the following:

git clone https://github.com/CharaChorder/charachorder.py
cd charachorder.py
python3 -m pip install -U .

Usage

from charachorder import CharaChorder

for device in CharaChorder.list_devices():
    # Method 1
    with device:
        print(device.get_id())

    # Method 2
    device.open()
    print(device.get_id())
    device.close()

Links