Add readme file and rename path in the others readme files

This commit is contained in:
Marc-Antoine Lafreniere
2019-04-06 15:39:30 -04:00
parent 8c08de315f
commit 6c790dd0c3
2 changed files with 41 additions and 2 deletions

View File

@@ -0,0 +1,39 @@
# Device Communication
This code is use to communicate with the device
## Getting Started
To use this UI you must have a GCode file to sent to the device unless you want to control manually the device.
### Prerequisites
Since the program is coded in python, you need to install python, we used python 3.7.
You can use an IDE or cmd to launch the program or the UI.
## Using the program
After downloading the project,
You can launch CommunicationMain.py in S4-P3-Projet/devicecommunication/ for the user interface of the program.
### Automatic mode
Enter the parameters in the proper boxes:
```
- The GCode file's path.
- COM port of the OpenCR (ex: COM8).
- The communication baudrate of the OpenCR.
- Maximum communication time in seconds.
This is the maximum time to accept an anwser when a command is request.
- Sleep inital time in seconds.
This is the boot time of the OpenCR. The time to wait before sending the first command.
```
Once all parameters are entered, you can click on the **Start** button.
At the moment everything runs in one thread so the UI is block by the communication
### Manual mode
The manual mode uses the values entered in the Auto tab so be sure the COM port is specified.
At the moment all +/- buttons dont move the motors in a relative movement.
Hence it's better to use the text field to move the mototrs

View File

@@ -1,4 +1,4 @@
# PCB Device
# GCode Extractor
This program transforms a pcb drawing into a gcode.
@@ -16,7 +16,7 @@ You can use an IDE or cmd to launch the program or the UI.
### Using the program
After downloading the project,
You can launch UI.py in S4-P3-Projet/pcbdevice/UI/ for the user interface of the program.
You can launch UI.py in S4-P3-Projet/gcodeextractor/UI/ for the user interface of the program.
Enter the parameters in the proper boxes: