Skip to main content

A transparent library for communication between Python and Arduino

Project description

PyDuino Bridge Build Status PyPI

Library for bi-directional communication between Python and Arduino.

Connect Python and Arduino as easily as sending a list of variables from one platform and receiving it on the other one. With PyDuino Bridge, you can bi-directionally send a string, a list of integers, and a list of floats. Thus, you can bring the Python computational power and flexibility to the real-world interfacing capability of Arduino.

The library is built on the code given by Robin2 in the Arduino forum, but simplified to allow a high-level use.

Instalation

You need to install pyduinobridge in both Arduino IDE and Python.

In Python:

PyDuino Bridge is on the Python Package Index. To install the library, first install pip and then use the command pip install pyduinobridge.

The PyDuino Bridge library requires PySerial library. You can install it with the command pip install pyserial.

The library uses Python>=3.6 and has been tested on different platforms (Windows, Raspberry Pi, and Jetson Nano).

To use the library in your Python code, use the command from pyduinobridge import Bridge_py.

[Linux] Port opening error due to permission requirements:

To solve this error, follow this tutorial from the Arduino official page. Remember that you can log out of your Linux session with the command gnome-session-quit. This error occurs when installing the library on the Jetson Nano board.

In Arduino:

You need to manually add the files src/pyduino_bridge.h and src/pyduino_bridge.cpp to your .../Arduino/libraries folder.

To use the library in your Arduino code, add #include <pyduino_bridge.h> in the header.

Example of use

Once the libraries are installed, executepython_example.py on the Python device.

Also, upload examples/arduino_example/arduino_example.ino to your Arduino board. Connect the devices physically through their serial port. You can use a USB cable or maybe a serial Bluetooth module to achieve wireless connectivity. The example code has been tested on Arduino Nano and UNO boards with Python running on Windows, Raspberry Pi, and Jetson Nano.

Configuration considerations

By default, the maximum number of characters allowed in the messages between Arduino and Python is 40. If you want to change this buffer size, you have to put the same value in both the Python (change the value buffSize when using the begin method) and the Arduino code (change the line #define buffSize 40 in the pyduino_bridge.h and pyduino_bridge.cpp).

Also, verify that the same numIntValues_FromPy and numFloatsValues_FromPy values are configured in your Python code according to the Arduino library files (before uploading, change the lines #define numIntValues_FromPy 1 and #define numFloatValues_FromPy 1 in the pyduino_bridge.h and pyduino_bridge.cpp files). By default, PyDuino Bridge is configured to send and receive a list of one integer and a list of one float (besides the header and the time information).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyduinobridge, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size pyduinobridge-1.0.4-py3-none-any.whl (17.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyduinobridge-1.0.4.tar.gz (5.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page