From 6c790dd0c3d6fe91a2c43769f18cb286991ac5a3 Mon Sep 17 00:00:00 2001 From: Marc-Antoine Lafreniere Date: Sat, 6 Apr 2019 15:39:30 -0400 Subject: [PATCH] Add readme file and rename path in the others readme files --- devicecommunication/README.md | 39 +++++++++++++++++++++++++++++++++++ gcodeextractor/README.md | 4 ++-- 2 files changed, 41 insertions(+), 2 deletions(-) create mode 100644 devicecommunication/README.md diff --git a/devicecommunication/README.md b/devicecommunication/README.md new file mode 100644 index 0000000..88c61c1 --- /dev/null +++ b/devicecommunication/README.md @@ -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 diff --git a/gcodeextractor/README.md b/gcodeextractor/README.md index 72ebd77..57f5b51 100644 --- a/gcodeextractor/README.md +++ b/gcodeextractor/README.md @@ -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: