From 23183d32ae2745d5895e29f5d83e52477a9001dd Mon Sep 17 00:00:00 2001 From: Thomas Lambert <t.lambert@uliege.be> Date: Wed, 9 Nov 2022 13:57:02 +0100 Subject: [PATCH] doc(readme): add small precisions --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9920a4e..4f95109 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # MechaRaptor controller -The **MechaRaptor** is a tandem flapping wing system built for my Ph.D. at the +The **MechaRaptor** is a tandem flapping wings system built for my Ph.D. at the University of Liège. The goal of this setup is to conduct experimental analysis -of the aerodynamics of tandem flapping wings and better understand the wake -dynamics and how it impacts the lift and drag of the aft wing. +of the aerodynamics of such configuration and better understand the wake +dynamics and its impact on the performance of the aft wing. The system is actuated by two sets of brushless DC motors (BLDC), each controlled with an Engine Speed Controller (ESC). The ESCs are themselves -controlled using an Arduino Uno. The Arduino acts as the brain of the whole -system and is the main interface for piloting the setup and logging important +controlled using an Arduino Uno, which acts as the "brain" of the whole system. +This Arduino is the main interface for piloting the setup and logging important metrics. This repository contains the Arduino code and the wiring schematics for the @@ -22,7 +22,9 @@ electrical components of the setup. position of the wings. _Note: A maximum rotation speed is imposed to the BLDC by the ESC. This value -has been manually set for each ESC using the ESC's terminal (JETIBOX)._ +has been manually set for each ESC using the ESC's terminal (JETIBOX). This +value is reflected in the Arduino code as well, in so the inputs and outputs are +calibrated properly._ ## Usage @@ -33,6 +35,12 @@ Before powering the Arduino, set the ON/OFF switch in the appropriate position: Further switch changes during the Arduino runtime will not be accounted for. +Then turn plug the ESCs power using batteries or DC power supply. + +If the setup is in manual mode, the potentiometer must be turned all the way +down to initiate the setup. If it is in automatic mode, it will wait for a +serial connection and initial user input. + ### Manual mode In this mode, the potentiometer is used to control the motors. When it is turned @@ -49,8 +57,11 @@ desired frequency and will use that value to control the motors. The potentiometer is completely bypassed. **To turn off the motor, send 0 to the console at any moment.** This -will first decrease the RPM to a moderate speed and then turn off completely -the motor. +will first decrease the RPM to a moderate speed for three seconds. Then the +motor will be turned off completely. +Once the motor is completely stopped, the system will lock itself to prevent +any accidental re-start. To start another run, close the serial connection and +re-open a new one. ## Data logging and visualization @@ -85,7 +96,7 @@ allows the automatic logging and retention of all data in _csv_ spreadsheets. ## Schematics -To Do (January 2023) +To Do (ETA January 2023) [plettenberg]: <https://plettenbergmotors.com/> [serial-studio]: <https://serial-studio.github.io/> -- GitLab