@@ -25,9 +25,7 @@ The project is constantly developing so please report bugs or any problems.
## Known issues
- Aduino Nano / Teensy microcontrollers on a Windows system performs poorly (see table below)
- Teensy microcontrollers on a Linux system performs poorly (see table below)
- Certain combinations of microcontrollers and OS does not work well (see table at the bottom of this README)
---
## How to use this tool
...
...
@@ -46,12 +44,9 @@ Copy and paste the `comms_wrapper.py` into the same directory as your Python scr
Copy and paste the `pyCommsLib.cpp` and `pyCommsLib.h` into the same directory as your Arduino .ino file. If you do this correctly, you should see the two files as two tabs on the Arduino IDE.
### How to use the wrapper
Currently, the best way to understand how to use the wrapper is to look at the example code found in the `Exmples/` folder. The implementation for the Python and Arduino side is shown the corresponding `Exmples/Python/` and `Exmples/Arduino/` folders.
To help you get started with this wrapper, look through the commented example code `Exmples/` folder (the implementation for the Python and Arduino side is shown the corresponding `Exmples/Python/` and `Exmples/Arduino/` folders).
### API Description
To be written. Currently, all the documentation is in the form of comments in the example files.
You can also find detailed description of the different functions and variables used in the implementation to understand their functions. You can find this at the bottom of this README file.
---
...
...
@@ -65,4 +60,15 @@ To be written. Currently, all the documentation is in the form of comments in th
## Testing and compatability
This has been tested with Arduino UNO and Arduino Nano Every with an Ubuntu 20.04 machine.
