SHAKING HANDS OVERSEAS DRIVER

This is the improved version of the Serial Receiver and Serial Sender, merging them together into a singe project.

Overview:

This code allows the user to send data to an API using an Arduino and a computer as an intermediary. You can choose from two options:

• Sender : To send data from an arduino to an API
• Receiver: To receive data from an API and send it to an arduino

Important Information:

I recommend using my arduino Firmware, but feel free to use whatever you prefer. But in the case of creating your own firmware, it's key to understand that the data will only be sent (This applies to the sender Only) if the computer sends the letter "A" and then will respond the Arduino. So then have in mind dealing with this

Sender Firmware

Receiver Firmware

Installation Guide:

1. Download the lastest version from releases in this repository or clone the repository using the following command:

git clone https://github.com/Shaking-Hands-Overseas/Serial-Sender-Receiver

Execute the Powershell file. This will automatically install all dependencies and start the program:

.\run.ps1

Or Install Necessary Dependencies using pip:

pip install pyserial

and:

pip install requests

3. Open the file "src\Var.py" via your text editor and specify your API URL and routes for sending and receiving data.

# MAIN SERVER URL: 
API = ''
# API ROUTE FOR RECEIVING DATA
URL_R = '/reciever'
# API ROUTE FOR SENDING DATA
URL_S = '/servo'
# API ROUTE FOR DATA ORDER
URL_C = '/custom'

It should be noticed that data will be sent to you server as follows:

POST_REQUEST = {
"s1":0,
"s2":1,
"s3":2,
"s4":3,
"s5":100
}

And it is expected to get the information in the same way when using GET with your API.

4. Change the prefered order and template according to your data

DATA_TEMPLATE = {
    "s1":200,
    "s2":200,
    "s3":200,
    "s4":200,
    "s5":200
}
PREFERED_ORDER = {
    "F1": "s1",
    "F2": "s2",
    "F3": "s3",
    "F4": "s4",
    "F5": "s5"
}

With the above should work just fine.

5. Run the script. It will ask you whether you want to be a receiver or sender and serial port. Choose accordingly and should start working. if you notice any bug or strange behaviour, create an issue in this github page.

Todo List for next Versions:

• Creating a GUI
• Allow more than 5 data values at the same time