pyduin 0.6.4

Extensive Arduino abstraction

pyduin

Pyduin is a Python wrapper for Arduino and other IOT devices such as ESP. It aims to support everything, that platformio supports. The following components are part of the package.

• A python library
• A firmware to be loaded onto the device
• A command-line interface (to flash the firmware)

What for?

Pyduin makes it easy to interact with an Arduino or other IOT device from within Python. Once a device has the correct firmware applied, one can set pin modes, pin states, pwm values and more.

This makes it easy to wire a sensor, switch to an IOT device, connect it to a computer and start working with the sensor values in Python. The library supports:

• Analog read and write
• Digital read and write
• PWM
• Pin modes
• OneWire (firmware works, not yet implemented in lib)
• DHT Sensors (firmware works, not yet implemented in lib)
• SPI (firmware works, not yet implemented in lib)
• ...

Device support

In theory, any device supported by platformio can work. Currently, the following devices are supported

• Arduino Uno
• Arduino Nano
• Sparkfun Pro Micro (ATMEGA32U4)

Installation

pyduin module

Only pip installs are available.

pip install pyduin

Dependency socat

Opening a serial connection resets most Arduinos. pyduin circumvents this drawback with a socat proxy.

To make meaningful use of the command-line features, the installation and usage of soact is recommended. To activate usage, edit ~/.pyduin.yml and set use_socat to yes (default).

serial:
  use_socat: yes

If socat is installed, a proxy will be started for every device that connections are made to. The pins get set up according to the pinfile and the initial modes get set on first connect. The following connections will not reset the Arduino. The proxy will stop safely on device disconnect. The proxy will also be stopped for flashing.

Usage

As python module

After installation the pyduin module can be imported.

from pyduin import arduino
from pyduin import _utils as utils

board = 'nanoatmega328'
boardfile = utils.board_boardfile(board)

Arduino = arduino.Arduino(board=board,
                          tty='/dev/ttyUSB0',
                          boardfile=boardfile,
                          wait=True)
print(Arduino.firmware_version)
pin = Arduino.get_pin(13)
pin.set_mode('OUTPUT')
pin.high()
print(Arduino.free_memory)

Command-line

The command-line interface provides a help page for all options and commands.

pyduin --help

Every positional argument that serves as a subcommand, has it's own help page.

pyduin firmware|pin|dependencies|versions --help

Most of the commands have shorter aliases. The following command sets the pwm value for pin 5 to 125.

pyduin --tty /dev/USB0 --baudrate 115200 --board nanoatmega328 pin 5 pwm 125

To connect to a device --tty and --board arguments are required.

Configuration file

Pyduin creates a configuration file in ~/.pyduin.yml from a template. This file contains some generic settings and the buddy list.

The buddy list

The buddy-list feature allows one to define known devices aka buddies. In ~/.pyduin.yml a dictionary of buddies can be declared.

buddies:
  uber:
    board: nanoatmega328 # as in platformio. required.
    tty: /dev/uber # required
    baudrate: 115200 # default derived from pinfile, optional
  under:
    board: uno
    tty: /dev/ttyUSB0

The buddies can be used in the command line interface.

pyduin -B uber pin 13 high

Default buddy

A default_buddy can be defined in the configuration file. This allows to target a device that is known and appropriately configured, without specifying the buddy option.

pyduin pin 13 high

Flashing firmware to the Arduino

pyduin --buddy uber firmware flash

It can also be done without the buddy list.

pyduin --board nanoatmega328 --tty=/dev/mytty fw f

Control the Arduinos pins

Using the command-line, the pins can be controlled as follows. The following command can be used to switch on and off digital pins.

pyduin --buddy uber pin 4 {high|low}

The pin mode can be set as follows

pyduin -B uber pin 4 mode {input|ouput|input_pullup,pwm}

A pin can also be read from. Resulting in 0 or 1 for digital pins and a value between 0 and 1024 (10bit) for analog pins. The analog pins also have aliases configured according to the Arduino conventions.

pyduin p A0 read

Control the builtin leds

The builtin leds defined in the pinfile can be addressed by their corresponding names

pyduin -B foo led1 {on|off}

Pyduin determines the correct read command in the background depending on the pins nature.

Get firmware version from the Arduino

pyduin --buddy uber firmware version [device|available]

Get free memory from the Arduino

pyduin --buddy uber free

Contribute

mkdir pyduindev && cd !$
git [e-mail]:SteffenKockel/pyduin.git
virtualenv .
. bin/activate
pip install -e .

Pull requests welcome.

Add device

Adding a device works, by editing the ~/.pyduin/platformio.ini and and provide a pinfile. These files and folders gets created, when attempting to flash firmware. Changes made here are preserved. A device must also provide a pinfile. The name of the pinfile should have the name of the corresponding board name (as in platformio). When developing, the pinfile can just be added in the Repository structure. To test a pinfile while not in development mode, the -p option can be used.