From 9118e89c71f181e0caf720e955e9e00b3b1188f6 Mon Sep 17 00:00:00 2001
From: Jochen Vothknecht <jochen3120@gmail.com>
Date: Wed, 8 Jun 2022 09:17:28 +0200
Subject: [PATCH] Describing the complete design of CyanLight

---
 README.md     | 56 ++++++++++++++-------------------------------------
 pcb/README.md | 41 +++++++++++++++++++++++++++++++++++--
 2 files changed, 54 insertions(+), 43 deletions(-)

diff --git a/README.md b/README.md
index 111f4e5..7ae497d 100644
--- a/README.md
+++ b/README.md
@@ -1,55 +1,29 @@
 CyanLight
 =========
 
-Simple `PT4115`-BreakoutBoard, initially designed for my special 490 nm LED but may also be used for generic projects
+Evolved from a "Simple `PT4115`-BreakoutBoard" we now have a full blown electronics and software project!
 
-If you want to know more about `CyanBus`, `CyanLight`'s new animation protocol suite on top of `RS485` just goto [the documentation of SiliconTorch](SiliconTorch/README.md) !
+`CyanLight` now stands for the complete light and animation system which I'm developing for my appartement.
 
-Pinout
-------
+It consists of multiple hardware and software layers with a possible full stack-up looking like this from the bottom upwards:
 
-Pinout of the companion board `CyanLightControl`. All external general purpose IOs are protected against ESD and negative reverse voltage input.
+- `CyanLight v[10W].1` - `PT4115` board (LED current control)  
+- `CyanLightControl` - `ESP32` board outputting some `PWM` signals  
+- `SiliconTorch[C++]` - `ESP32` firmware implementing protocols like `CyanBus` and `FxCyanF`  
+- `CyanBus` - `RS485` serial protocol for packetized data streaming  
+- `FxCyanF` - `LED` animation protocol  
+- `CyanBusInjector` - `Ethernet` to `CyanBus` bridging board  
+- `SiliconTorch[PY]` - High-Level device control via `Python`  
 
-| GPIO |    Function     |
-|-----:|----------------:|
-|  27  |  `PT4115` DIM   |
-|  23  |     IR recv     |
-|  25  | general purpose |
-|  26  | general purpose |
-|  32  | general purpose |
-|  33  | general purpose |
+The last mentioned layer would then run on some SBC in a drawer and do the animation rendering. But what if this is not the end?  
 
+Big things are on the way! Source-less animation building coming soonâ„¢!
 
-Component selection
--------------------
 
-### Current sensing resistor `Rs`
-
-| I_LED |   Rs    |     P | Min PKG |
-|------:|:-------:|------:|--------:|
-| 0.1 A | 1.000 Ω | 10 mW |    0201 |
-| 0.2 A | 0.500 Ω | 20 mW |    0201 |
-|  0.3A | 0.333 Ω | 30 mW |    0201 |
-| 0.4 A | 0.250 Ω | 40 mW |    0201 |
-| 0.5 A | 0.200 Ω | 50 mW |    0201 |
-| 0.6 A | 0.167 Ω | 60 mW |    0402 |
-| 0.7 A | 0.143 Ω | 70 mW |    0603 |
-| 0.8 A | 0.125 Ω | 80 mW |    0603 |
-| 0.9 A | 0.111 Ω | 90 mW |    0603 |
-| 1.0 A | 0.100 Ω |100 mW |    0603 |
-| 1.1 A | 0.091 Ω |110 mW |    0805 |
-| 1.2 A | 0.083 Ω |120 mW |    0805 |
-
-
-### Inductor `I`
-
-|             I_LED |           L |
-|------------------:|------------:|
-|           I > 1 A |  27 - 47 µH |
-|   0.8 A < I ≤ 1 A |  33 - 82 µH |
-| 0.4 A < I ≤ 0.8 A | 47 - 100 µH |
-|         I ≤ 0.4 A | 68 - 220 µH |
+`CyanLight` PCBs
+----------------
 
+Section moved to the [PCB README file](/pcb/README.md)
 
 
 `fxCyanF` aka `CyanLight`s network protocol
diff --git a/pcb/README.md b/pcb/README.md
index 0551307..e65781d 100644
--- a/pcb/README.md
+++ b/pcb/README.md
@@ -28,8 +28,42 @@ There never was a `v1.0` of this board.
 |  33  | general purpose |
 
 
-`CyanLight` PCBs
-----------------
+`CyanLight` LED PCBs
+--------------------
+
+Simple `PT4115`-BreakoutBoard, initially designed for my special 490 nm LED but may also be used for generic projects
+
+If you want to know more about `CyanBus`, `CyanLight`'s new animation protocol suite on top of `RS485` just goto [the documentation of SiliconTorch](/SiliconTorch/README.md) !
+
+
+### Component selection
+
+#### Current sensing resistor `Rs`
+
+| I_LED |   Rs    |     P | Min PKG |
+|------:|:-------:|------:|--------:|
+| 0.1 A | 1.000 Ω | 10 mW |    0201 |
+| 0.2 A | 0.500 Ω | 20 mW |    0201 |
+|  0.3A | 0.333 Ω | 30 mW |    0201 |
+| 0.4 A | 0.250 Ω | 40 mW |    0201 |
+| 0.5 A | 0.200 Ω | 50 mW |    0201 |
+| 0.6 A | 0.167 Ω | 60 mW |    0402 |
+| 0.7 A | 0.143 Ω | 70 mW |    0603 |
+| 0.8 A | 0.125 Ω | 80 mW |    0603 |
+| 0.9 A | 0.111 Ω | 90 mW |    0603 |
+| 1.0 A | 0.100 Ω |100 mW |    0603 |
+| 1.1 A | 0.091 Ω |110 mW |    0805 |
+| 1.2 A | 0.083 Ω |120 mW |    0805 |
+
+
+#### Inductor `I`
+
+|             I_LED |           L |
+|------------------:|------------:|
+|           I > 1 A |  27 - 47 µH |
+|   0.8 A < I ≤ 1 A |  33 - 82 µH |
+| 0.4 A < I ≤ 0.8 A | 47 - 100 µH |
+|         I ≤ 0.4 A | 68 - 220 µH |
 
 ### `10W`
 
@@ -45,3 +79,6 @@ May be populated with up to 6 individual LEDs and contains `0805` footprints to
 
 ![PCB rendering](/doc/HexPCB.png "PCB rendering")
 
+
+
+## TODO: futher PCB doc!
-- 
GitLab