Skip to content
Snippets Groups Projects
Commit c64f1015 authored by Kai Junge's avatar Kai Junge
Browse files

Upadted readme and changelog.

parent 50c0767b
No related branches found
No related tags found
No related merge requests found
......@@ -3,15 +3,16 @@ All notable changes to this project will be documented in this file
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
<!--
## [Unreleased]
### Added
### Changed
### Removed
### Removed -->
## Release v1.0 - 22-1-2022
## [Release v1.0.0](https://gitlab.epfl.ch/create-lab/lab-systems/arduino_python_communication/-/releases/v1.0.0) - 22-1-2022
### Added
- Debugging funcionality to understand the communictaion setup. Notably to easily see what the Arduino side has received from the python side
......
......@@ -16,14 +16,14 @@ This project is very much in its early stages, so some bugs are expected.
- Estabilish a stable communication channel between multiple Arduinos and a single Python script
- Send a single string form the Python side to the Arduino side (e.g.: can be used to tell the arduino "stop the motor", "start the motor", "reset the sensor", etc)
- Send mulitple messages with specified messages names from the Arduino side to the Python side (e.g.: can be used to transfer multiple sensor values, status messages, timestamps, etc)
- Simplified keypress command functionality to test your mechatronic setup
- Simplified keyboard keypress reading functionality to test your mechatronic setup
---
## How to use this tool
### Download the release
Download the latest release from here. You can see rough changes from the previous versions in the CHANGELOG.
Download the latest release from [here](https://gitlab.epfl.ch/create-lab/lab-systems/arduino_python_communication/-/releases). You can see rough changes from the previous versions in the CHANGELOG.
In the release you will find three files: `comms_wrapper.py`, `pyCommsLib.cpp`, and `pyCommsLib.h`. These three files will be used as "Libraries" to provide the communication wrapper functionality.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment