Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/araffin/python-arduino-serial
A simple and robust serial communication protocol. It was designed for Arduino but can be used for other purposes (e.g. bluetooth, sockets). This is the Python implementation.
https://github.com/araffin/python-arduino-serial
arduino bluetooth communication protocol python raspberry-pi serial sockets
Last synced: about 2 months ago
JSON representation
A simple and robust serial communication protocol. It was designed for Arduino but can be used for other purposes (e.g. bluetooth, sockets). This is the Python implementation.
- Host: GitHub
- URL: https://github.com/araffin/python-arduino-serial
- Owner: araffin
- License: mit
- Created: 2018-03-10T14:16:49.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-10T17:18:43.000Z (over 1 year ago)
- Last Synced: 2024-11-02T04:12:03.863Z (about 2 months ago)
- Topics: arduino, bluetooth, communication, protocol, python, raspberry-pi, serial, sockets
- Language: Python
- Homepage: https://python-arduino-serial.readthedocs.io
- Size: 45.9 KB
- Stars: 32
- Watchers: 4
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Robust Arduino Serial Protocol in Python
 [](https://python-arduino-serial.readthedocs.io/en/latest/?badge=latest)
**Robust Arduino Serial** is a simple and robust serial communication protocol. It was designed to make two arduinos communicate, but can also be useful when you want a computer (e.g. a Raspberry Pi) to communicate with an Arduino.
It supports Python 3.8+.
This repository is part of the Robust Arduino Serial project, main repository: [https://github.com/araffin/arduino-robust-serial](https://github.com/araffin/arduino-robust-serial)
**Please read the [Medium Article](https://medium.com/@araffin/simple-and-robust-computer-arduino-serial-communication-f91b95596788) to have an overview of this protocol.**
Documentation: [https://python-arduino-serial.readthedocs.io](https://python-arduino-serial.readthedocs.io)
Implementations are available in various programming languages:
- [Arduino](https://github.com/araffin/arduino-robust-serial)
- [Python](https://github.com/araffin/python-arduino-serial)
- [C++](https://github.com/araffin/cpp-arduino-serial)
- [Rust](https://github.com/araffin/rust-arduino-serial)
## Installation
Using pip:
```
pip install robust_serial
```
From Source:
```
git clone https://github.com/araffin/python-arduino-serial.git
pip install -e .
```
## Tests
Run the tests (require pytest):
```
make pytest
```
## Examples
Read write in a file (WARNING: the file will be deleted when the script exits)
```
python -m examples.file_read_write -f test.txt
```
Serial communication with an Arduino: [Arduino Source Code](https://github.com/araffin/arduino-robust-serial/tree/master/arduino-board/)
```
python -m examples.arduino_serial
```
### Example: Communication with Sockets
It can be useful when you want two programs to communicate over a network (e.g. using wifi) or even locally on the same computer (e.g. when you want a python2 script that communicates with a python3 script).
1. Start the server:
```
python -m examples.socket_example --server
```
2. Run the client:
```
python -m examples.socket_example --client
```
### Bluetooth Example with Two Computers
Dependencies:
```
sudo apt-get install libbluetooth-dev bluez
pip install pybluez
```
You need to change the server mac address `SERVER_ADDR`, you can use `hciconfig` to know the mac address of your computer.
Server:
```
python -m examples.bluetooth_example --server
```
Client:
```
python -m examples.bluetooth_example --client
```