From e6ac1279fe1b4b6562f5f9a49740345c929c5afd Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Fri, 4 Nov 2022 01:10:05 +0100
Subject: [PATCH] doc: update changelog and minor Readme adjust

---
 CHANGELOG.md |  5 ++++-
 README.md    | 18 ++++++++----------
 2 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 30f6121..19584eb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,13 +10,16 @@ to [Semantic Versioning][sem_ver].
 ### Added
 
 - **Doc**: Changelog
-- **Controller**: Serial control
+- **Controller**: Complete control over Serial
+- **Acquisition**: Angle sensor acquisition
 
 ### Changed
 
 - **Doc**: Update features in Readme
 - **Controller**: Switch no longer just a safety, but a mode select
 - **Logging**: Minor adaptations to serial-studio interface
+- **Logging**: Output desired frequency as well
+- **All**: Various refactoring and style improvements
 
 ### Deprecated
 
diff --git a/README.md b/README.md
index 5634dba..6ee3569 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,11 @@ The MechaRaptor is a tandem flapping wing system built at the University of
 Liège during my Ph.D. thesis. The goal of this model is to conduct experimental
 analysis of the aerodynamics of tandem flapping wings.
 
-The system is activated by two sets of Brushless DC motors (BLDC), powered by an
-Engine Speed Controller (ESC) which is itself controlled through an Arduino Uno.
+The system is actuated by two sets of Brushless DC motors (BLDC), each powered
+by an Engine Speed Controller (ESC) which is itself controlled through an
+Arduino Uno.
 
-This repository contains the Arduino code and wiring schematics for the
+This repository contains the Arduino code and the wiring schematics for the
 electrical components of the controller.
 
 ## Controller features
@@ -64,7 +65,7 @@ separately.
 
 A single Arduino board is used to control the entire setup. Its role is to send
 the commands to the BLDC motors ESCs. It also logs the flapping angle of each
-wing, which are measured using absolute magnetic rotary encoders.
+wing, which is measured using absolute magnetic rotary encoders.
 
 ### List of devices
 
@@ -76,15 +77,12 @@ wing, which are measured using absolute magnetic rotary encoders.
 | **PSU**           | [Electroautomatik][elektro] PSI 8080 - 60 T (1500W) <br />_(Discontinued by manufacturer)_ | DC power supply |
 | **Controller board**  | [Arduino uno (Rev 3)][arduino] | Full setup control, data logging|
 | **Encoders**      | [Broadcom AEAT 6012][AEAT612] | Flapping angle measurement |
-| **Potentiometer** | N/A | Manual control of RPM in v1.x.x |
-| **ON/OFF switch** | N/A | Safety: Prevent ESC from starting[^1] |
+| **Potentiometer** | N/A | Manual control of RPM|
+| **ON/OFF switch** | N/A | Switch between `Serial` and `Manual` control |
 
 ## Schematics
 
-[^1]: This is useful in monitoring mode, when the JETIBOX is attached to the ESC
-for analysis. As long as the switch is OFF, the Arduino will bypass the
-potentiometer and write 0 to the ESC. This prevent any accidental start of the
-motor while the operator is looking into diagnostics.
+To Do (January 2023)
 
 [plettenberg]: <https://plettenbergmotors.com/>
 [serial-studio]: <https://serial-studio.github.io/>
-- 
GitLab