From 21ef87919046d0d9bd8932b2635251eff22f7563 Mon Sep 17 00:00:00 2001
From: Selene ToyKeeper
Date: Sun, 17 Dec 2023 00:17:32 -0700
Subject: documented Wurkkos TS25/TS11/FC13 distinctions

---
 hw/wurkkos/fc13/README.md | 10 ++++++++++
 hw/wurkkos/ts11/README.md |  8 ++++++++
 hw/wurkkos/ts25/README.md | 20 ++++++++++++++++++++
 3 files changed, 38 insertions(+)
 create mode 100644 hw/wurkkos/fc13/README.md
 create mode 100644 hw/wurkkos/ts11/README.md
 create mode 100644 hw/wurkkos/ts25/README.md

(limited to 'hw')

diff --git a/hw/wurkkos/fc13/README.md b/hw/wurkkos/fc13/README.md
new file mode 100644
index 0000000..ab9b87f
--- /dev/null
+++ b/hw/wurkkos/fc13/README.md
@@ -0,0 +1,10 @@
+# Wurkkos FC13
+
+Single LED 18650 torch with FET+1 driver and RGB button.  Includes a built-in
+charger / powerbank too, separate from the main torch circuit.
+
+The Wurkkos SP30S Pro also uses this firmware.
+
+Either torch may ship with the `0715` (wurkkos-ts25) firmware installed, but
+the RGB button does not work fully until upgrading to this FC13 firmware.
+
diff --git a/hw/wurkkos/ts11/README.md b/hw/wurkkos/ts11/README.md
new file mode 100644
index 0000000..e53e038
--- /dev/null
+++ b/hw/wurkkos/ts11/README.md
@@ -0,0 +1,8 @@
+# Wurkkos TS11
+
+Single LED 18350 / 18650 torch with FET+1 driver, RGB button, and RGB front
+aux.  Includes a built-in charger too, separate from the main torch circuit.
+
+May ship with the `0715` (wurkkos-ts25) firmware installed, but the RGB button
+does not work fully until upgrading to this TS11 firmware.
+
diff --git a/hw/wurkkos/ts25/README.md b/hw/wurkkos/ts25/README.md
new file mode 100644
index 0000000..b3c33af
--- /dev/null
+++ b/hw/wurkkos/ts25/README.md
@@ -0,0 +1,20 @@
+# Wurkkos TS25
+
+A quad LED 21700 light with FET+1 driver and RGB front aux.  A charge port is
+built in too, but operates independently and is not visible to the main
+firmware.
+
+Some other Wurkkos models may also ship with this firmware, and should be
+upgraded to use a more specific build:
+
+  - FC13: use wurkkos-fc13
+  - TS11: use wurkkos-ts11
+  - SP30S Pro: use wurkkos-fc13
+
+These builds have different aux LED behavior.  The difference is whether the
+RGB aux is on the front, the side (button), or both.
+
+  - Front: TS25
+  - Side: FC13
+  - Both: TS11
+
-- 
cgit v1.2.3