Skip to main content

Interface with code running on a microprocessor via serial

Project description

uCommander - The Micro Commander

This library simplifies interfacing with code written on a microprocessor like an Arduino, Teensy, or similar devices via serial communication.

The Python code is designed to work with the uCommander Arduino library.

Basic CLI Usage

First, install the ucommander Python library with pip, ideally in a virtual environment.

$ cd myproject
$ python -m venv venv
$ pip install ucommander

After you have the ucommander library installed in your Python environment, ensure your microprocessor is attached to your host and determine what serial port you will use to communicate with it.

The listports command can help with this.

$ python -m ucommander listports
Attempting to enumerate serial ports...
/dev/cu.SOC - n/a
/dev/cu.usbmodem - USB Serial

Once you know the serial port, run the discover command to learn which commands you can run and what arguments they require.

$ python -m ucommander -p /dev/cu.usbmodem discover
Available commands:
 ledIfPi        FLOAT(4)

Finally, run the commands, providing any required arguments after the command name.

$ python -m ucommander -p /dev/cu.usbmodem ledIfPi 3.14
$ python -m ucommander -p /dev/cu.usbmodem ledIfPi 3.24

Copyright (C) 2019 Mark A Kendrick

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

ucommander-1.0.2.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ucommander-1.0.2-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file ucommander-1.0.2.tar.gz.

File metadata

  • Download URL: ucommander-1.0.2.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0

File hashes

Hashes for ucommander-1.0.2.tar.gz
Algorithm Hash digest
SHA256 336399a50a1e84fa80e974ecb9d90d124238690fce748d30fca07c7cabc65976
MD5 e9265674268fd837a295714733259858
BLAKE2b-256 c6b8f56ac771de597654f3015b82008bfa4871df4b4f90cc864c8f938c5ec52c

See more details on using hashes here.

File details

Details for the file ucommander-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: ucommander-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0

File hashes

Hashes for ucommander-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4e5bc55234a3b735688dfc17bf787696c73c7112910f73aebf1d6add6a627652
MD5 4d334ba71898ae2af45190cdd8dfa4e5
BLAKE2b-256 c6a02f5e2e4cf04997bc3983f39a373e279bce3ca5f5fa877e05b121ccf781c7

See more details on using hashes here.

Supported by

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