Python API for Numato GPIO Expanders

This Python API can be used to control Numato USB GPIO expanders.

Configure ports as input or output port
Write to output ports
Read from input ports
Read integer values from ADC input ports (1 - 7)
Register a callback for input port events (edge detection)

See the changelog for details on the releases.

Installation

Install latest development version:

pip install --user git+https://github.com/clssn/numato-gpio.git

Install latest release:

pip install --user numato-gpio

Usage CLI

Test whether your devices can be found running the command-line interface like python3 -m numato_gpio. Remember to have your user in the dialout group, since the devices are registered as /dev/ttyACMx (i.e. modem devices).

Expected output:

❯ python3 -m numato_gpio
dev: /dev/ttyACM0 | id: 0 | ver: 9 | ports: 32 | eol: '\r\n' | iodir: 0xffffffff | iomask: 0x00000000 | state: 0x00000000
dev: /dev/ttyACM1 | id: 1 | ver: 9 | ports: 32 | eol: '\r\n' | iodir: 0xffffffff | iomask: 0x00000000 | state: 0x00000000

Usage API

The API can be used like:

import numato_gpio as gpio

# you can instanciate the device directly from its OS identifier, for instance
# "/dev/ttyACM0" on Linux or "COM5" on Windows.
dev = gpio.NumatoUsbGpio("/dev/ttyACM0")

# alternatively, you can use the discovery function, but currently it works
# only on Linux for /dev/ttyACM* devices:
# my_device_id = 0
# gpio.discover()
# dev = gpio.devices[my_device_id]

# configure port 4 as output and set it to high
dev.setup(4, gpio.OUT)
dev.write(4, 1)

# configure port 27 as input and print its logic level
dev.setup(27, gpio.IN)
print(dev.read(27))

# configure port 2 as input and print its ADC value
dev.setup(2, gpio.IN)
print(dev.adc_read(2))

# configure port 14 as input and setup notification on logic level changes
dev.setup(14, gpio.IN)
def callback(port, level):
    print("{edge:7s} edge detected on port {port} "
        "-> new logic level is {level}".format(
        edge="Rising" if level else "Falling",
        port=port,
        level="high" if level else "low")
    )

dev.add_event_detect(14, callback, gpio.BOTH)
dev.notify = True

Release Versions

See changelog.

Troubleshooting

In case your device can't be discovered or you even get an error message or stacktrace, please follow the troubleshooting guide.

Known Issues

Though the code works well in a Home Assistant integration since 2018, there are quite some aspects to improve. The following issues are only the ones the author is aware of:

Some docstrings are hard to understand
Device discovery/registry as module-global dict is sub-optimal
Only /dev/ACMx devices are scanned which were mapped on the author's Linux
No async API available

System Tests

Unit tests in the tests directory are using a device mockup which mimicks a Numato device's responses as far as known at the state of development.

System tests in the sys_tests folder are meant to be run using a real device and will just fail, if no device is connected. They are an important complement to unit tests, because they are the real thing and might behave differently than the mockup device for the unit tests.

If you consider to run system tests you should be aware that it may be dangerous running them.

WARNING

Only run the system tests with gpio ports disconnected! You otherwise risk a short circuit which may lead to damage or destruction of your device or even fire.

ocroquette/numato-gpio