From 67c24396217b813120afe5f6834615d1a15e75d4 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 18:14:38 +0100 Subject: [PATCH 01/31] Create README2.md --- README2.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 README2.md diff --git a/README2.md b/README2.md new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/README2.md @@ -0,0 +1 @@ + From 3f7e92f0b0560f1d920bb0e699eedab5b1c08319 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 18:40:35 +0100 Subject: [PATCH 02/31] Create README2.md with project overview and sections Added initial content and structure for README2.md. --- README2.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/README2.md b/README2.md index 8b137891..aaf68cab 100644 --- a/README2.md +++ b/README2.md @@ -1 +1,42 @@ +# Krake™ +[main photo] +One-paragraph pitch: what it is, who it's for, why it exists +## Quick Start +How to get one running — buy/build/flash — in as few steps as possible + +## Table of Contents + +## Why Krake (merged: origin story + use cases, trimmed) + +## Features (single consolidated list) + +## Hardware +- Photos (rev1, rev2, captions explaining what changed) +- Power options +- COM port specs + +## Firmware +- Architecture table +- MQTT / GPAP protocol reference +- LCD UI + navigation + +## Building Your Own +- BOM / test & assembly procedure (as a public link) +- MockingKrake prototype notes + +## Roadmap (Future Features) + +## Contributing +(link to WorkflowProcedure.md) + +## Credits & Mentorship + + +## Trust & Credentials +- OSHWA certification + + +## References & Further Reading + +## License From c66fd52e40249846d7731818bf21f00500a4dcbc Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 18:51:42 +0100 Subject: [PATCH 03/31] Update README2 with OSHWA certification information Added OSHWA certification details and related links. --- README2.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README2.md b/README2.md index aaf68cab..e7eb444d 100644 --- a/README2.md +++ b/README2.md @@ -34,7 +34,18 @@ How to get one running — buy/build/flash — in as few steps as possible ## Trust & Credentials -- OSHWA certification + +image + +Krake hardware has been certified by the Open Source Hardware Association (OSHWA): +- OSHWA certification listing: +[OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) +- Certification UID: ``` US002818 ``` + +Website: https://pubinv.github.io/krake/ + +HardwareX Article: [HardwareX Article](https://www.overleaf.com/project/6696aaaaa7299f34f83a5575) + ## References & Further Reading From e595872e9f2a22faef669578b9d3cb01d5b1db0d Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 18:53:04 +0100 Subject: [PATCH 04/31] Update README2 with references and manuals Added references and further reading section to README2. --- README2.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README2.md b/README2.md index e7eb444d..ce72840a 100644 --- a/README2.md +++ b/README2.md @@ -41,13 +41,14 @@ Krake hardware has been certified by the Open Source Hardware Association (OSHWA - OSHWA certification listing: [OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) - Certification UID: ``` US002818 ``` - + +## References & Further Reading Website: https://pubinv.github.io/krake/ HardwareX Article: [HardwareX Article](https://www.overleaf.com/project/6696aaaaa7299f34f83a5575) - - -## References & Further Reading +User Manual: [draft user manual](https://docs.google.com/document/d/1qrhc7Yi6PFmagl4gnvSoc0T4vC_uqu-NLrmWMKFnwA0/edit?usp=sharing) + +Developers Manual: [draft developers manual](https://docs.google.com/document/d/150WA6Mb1_SFOBmFc9qBpT5b-MqXb7ejaZbKIxUqaDBY/edit?usp=sharing). ## License From fd1244eb962ea1f101cf10c83922268d5a884866 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 18:53:42 +0100 Subject: [PATCH 05/31] Add image to README2 and update pitch text --- README2.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README2.md b/README2.md index ce72840a..ae0c80ae 100644 --- a/README2.md +++ b/README2.md @@ -1,6 +1,7 @@ # Krake™ -[main photo] -One-paragraph pitch: what it is, who it's for, why it exists + image + + One-paragraph pitch: what it is, who it's for, why it exists ## Quick Start How to get one running — buy/build/flash — in as few steps as possible From 8d442a5d18a2566054d7fa182992dcaf48b96a4a Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 19:00:54 +0100 Subject: [PATCH 06/31] Update README2 with credits and mentorship details Added credits and mentorship information for the Krake project. --- README2.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README2.md b/README2.md index ae0c80ae..898abe8b 100644 --- a/README2.md +++ b/README2.md @@ -32,6 +32,17 @@ How to get one running — buy/build/flash — in as few steps as possible (link to WorkflowProcedure.md) ## Credits & Mentorship +The Krake has been developed primarily by volunteer engineer Nagham Kheir, with mentorship and oversight from volunteer Inventional Coach Lee Erickson. + +[Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) + +Nagham Kheir: Invention Coach +Forrest Lee Erickson: Invention Coach +Robert L. Read: Invention Coach +Yehia Shalaby: Public Inventor +Courtney Ludick: Public Inventor +Yukti: Public Inventor +Juhandre Knoetze: Public Inventor ## Trust & Credentials From 949463863985ec52c37cf50e2e680f1476dd2f90 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 19:34:02 +0100 Subject: [PATCH 07/31] Enhance README2 with Krake features and overview Added detailed features and specifications for the Krake wireless alarm device. --- README2.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README2.md b/README2.md index 898abe8b..dd974e72 100644 --- a/README2.md +++ b/README2.md @@ -1,7 +1,7 @@ # Krake™ +## A wireless alarm device purpose-built for life's critical moments image - - One-paragraph pitch: what it is, who it's for, why it exists +Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with audio visual capabilitites deisgned to alert a human to something needing attention. ## Quick Start How to get one running — buy/build/flash — in as few steps as possible @@ -12,6 +12,24 @@ How to get one running — buy/build/flash — in as few steps as possible ## Features (single consolidated list) +| Feature | Details | +| -------- | ------- | +| Customiseable audio |WAV and MP3 playback, Alarm-level-specific audio, Adjustable volume,SD-card-based audio storage, Busy-line monitoring and Runtime diagnostics | +| LCD User Interface & Rotary Knob | 20 x 4 I²C LCD interface integrated with a rotary encoder and custom menu system to navigate settings without the need for an external device. Real-time alarm display, Alarm queue indication, Wi-Fi status indication, MQTT broker status indication, Volume and mute display and Alarm acknowledgement actions | +| LED Annunciation | Variety of LED levels including steady or blinking deisgned to be visible across a room | +| Flexible Power | USB-C, 2.1mm center-positive barrel connector or RJ12 SPI interface power jumpers | +| Wi-Fi Connectivity | Acts as a Wi-Fi station connected to a local network enabling alerts locally or via internet, captive portal set up, storage of multiple Wi-Fi credentials, automatic reconnection, OTA firmware updates and Network status display | +| MQTT Protocol | MQTT alarm subscriptions, GPAP response publishing, Alarm acknowledgements, Alarm dismissal and shelving, Device monitoring, Configurable topic subscriptions and MQTT status display on LCD | +| Mute Button & time out handling | Configurable mute timeout, Automatic unmute, Manual mute override and LCD mute indication | +| HL7 Compatible | Designed to work with medical data standards | +| Fully Open Source | AGPL firmware, CERN OHL Hardware | +| Persistent COM configuration | Interfaces to external controllers through a DB9 Female RS-232 DCE connection. Configurable baud rate (1200,2400,4800, 9600, 19200, 38400, 57600, 115200), RTS/CTS hardware flow control and LCD-based configuration menu | + +| GPAP message parsing | ? | +| Alarm Acknowledgement workflow, queue handlings and state persistence | ? | +| LittleFS Configuration storage | ? | +| SPI alarm input support | ? | + ## Hardware - Photos (rev1, rev2, captions explaining what changed) - Power options From 3b36625db7737369cec8417862a20e0a18a5ae84 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:03:15 +0100 Subject: [PATCH 08/31] Enhance README with features and documentation Expanded the README with detailed sections on features, hardware, firmware, and contributing guidelines. Updated the quick start instructions and added links to user and developer manuals. --- README2.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 99 insertions(+), 13 deletions(-) diff --git a/README2.md b/README2.md index dd974e72..4dcc591b 100644 --- a/README2.md +++ b/README2.md @@ -1,16 +1,39 @@ +KRAKE 2 + + # Krake™ + ## A wireless alarm device purpose-built for life's critical moments image + Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with audio visual capabilitites deisgned to alert a human to something needing attention. ## Quick Start -How to get one running — buy/build/flash — in as few steps as possible +How to get one running — buy/build/flash — in as few steps as possible? ## Table of Contents +- About Krake & Example Use Cases +- Features +- Hardware +- Firmware +- Building Your Own +- Roadmap +- Contributing +- Credits & Mentorship +- Trust & Credentials +- References & Further Reading + +## About Krake & Example Use Cases +The hope was to develop the initial design for a wireless alarm device to alert nearby parties of a particular state. +We developed the name of this invention team based on a Crake: a bird with a distinctive, slightly alarming cry. We changed the spelling as a joke. “Flaycrake” is an old term for a scarecrow, which also aligned with our mission. + +Care at home: Alert an elderly person living alone to a fall or blood pressure drop — giving family peace of mind from anywhere. + +Medical Equipment: For ventilators and critical devices, Krake provides a dedicated alarm channel for life-threatening mechanical failures. -## Why Krake (merged: origin story + use cases, trimmed) +IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS fails, or network connectivity drops — a physical alarm that doesn't rely on the very infrastructure it's monitoring. -## Features (single consolidated list) +## Features | Feature | Details | | -------- | ------- | @@ -24,30 +47,92 @@ How to get one running — buy/build/flash — in as few steps as possible | HL7 Compatible | Designed to work with medical data standards | | Fully Open Source | AGPL firmware, CERN OHL Hardware | | Persistent COM configuration | Interfaces to external controllers through a DB9 Female RS-232 DCE connection. Configurable baud rate (1200,2400,4800, 9600, 19200, 38400, 57600, 115200), RTS/CTS hardware flow control and LCD-based configuration menu | - +| Speaker | ? | | GPAP message parsing | ? | | Alarm Acknowledgement workflow, queue handlings and state persistence | ? | | LittleFS Configuration storage | ? | | SPI alarm input support | ? | ## Hardware -- Photos (rev1, rev2, captions explaining what changed) -- Power options -- COM port specs +Enlarged enclosure to accomodate larger speaker ? whats changed + +| Krake™ rev2 | Krake™ rev1| +| -------- | ------- | +|image | image | + ## Firmware -- Architecture table -- MQTT / GPAP protocol reference +| Module | Purpose | +| -------------------- | ---------------------------------- | +| `alarm_api.*` | Abstract alarm state machine | +| `GPAD_HAL.*` | Hardware abstraction layer | +| `GPAD_menu.*` | Rotary encoder and LCD menu system | +| `mqtt_handler.*` | MQTT publishing and GPAP responses | +| `gpad_serial.*` | Serial protocol parser | +| `DFPlayer.*` | Audio playback subsystem | +| `WiFiManagerOTA.*` | Wi-Fi management and OTA | +| `InterruptRotator.*` | Rotary encoder interrupt handling | + +- Example GPAP Responses + +```text +oa{1234} -> Acknowledge +od{1234} -> Dismiss +os{1234} -> Shelve +``` - LCD UI + navigation + +Planned LCD Layout: + +```text +Q:+ NEXT W B M ⚙ +CRIT Pump Failure +ID:123 Temp High +Ack Dismiss Shelve +``` + +Rotary Encoder: +```text +Rotate: Navigate alarms or menu entries +Short Press: Select item +Long Press: Open Settings Menu + ``` + +Alarm Actions: +```text +Rotatary encoder to enter action selection +Acknowledge, Dismiss or Shelve + ``` + +Settings Menu: +```text +The local settings menu includes: +* Volume Level +* Mute Duration +* COM Setup +* Device Reset +* Exit Menu + ``` + ## Building Your Own -- BOM / test & assembly procedure (as a public link) -- MockingKrake prototype notes +- Instructions for testing and assembly of Krake hardware: +[Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) + ## Roadmap (Future Features) +* Advanced alarm queue management +* Enhanced LCD UI animations and icons +* Bluetooth and BLE alarm forwarding +* Mesh networking support +* Remote firmware fleet management +* Local event history logging +* Expanded GPAP/HL7 interoperability +* Power optimization modes +* Alarm escalation workflows ## Contributing -(link to WorkflowProcedure.md) +[Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) ## Credits & Mentorship The Krake has been developed primarily by volunteer engineer Nagham Kheir, with mentorship and oversight from volunteer Inventional Coach Lee Erickson. @@ -81,4 +166,5 @@ User Manual: [draft user manual](https://docs.google.com/document/d/1qrhc7Yi6PFm Developers Manual: [draft developers manual](https://docs.google.com/document/d/150WA6Mb1_SFOBmFc9qBpT5b-MqXb7ejaZbKIxUqaDBY/edit?usp=sharing). -## License +Hollifield, Bill R., and Eddie Habibi. *Alarm Management: A Comprehensive Guide.* ISA, 2010. + From 91e839cd6dae1d8d68c2bbcf121a6ac19410f428 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:06:26 +0100 Subject: [PATCH 09/31] Enhance Krake description for clarity and detail Updated description of the Krake alarm device to clarify its customizable features. --- README2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README2.md b/README2.md index 4dcc591b..7e6f086d 100644 --- a/README2.md +++ b/README2.md @@ -6,7 +6,7 @@ ## A wireless alarm device purpose-built for life's critical moments image -Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with audio visual capabilitites deisgned to alert a human to something needing attention. +Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with fully customiseable audio visual capabilitites designed to alert a human to something needing attention. ## Quick Start How to get one running — buy/build/flash — in as few steps as possible? From 31ee91e7314084b7bcaedf2b7346f165502174e0 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:09:47 +0100 Subject: [PATCH 10/31] Add 'How it works?' section to README2.md Added a section explaining how the Krake alarm device works. --- README2.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README2.md b/README2.md index 7e6f086d..d4472224 100644 --- a/README2.md +++ b/README2.md @@ -8,6 +8,12 @@ Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with fully customiseable audio visual capabilitites designed to alert a human to something needing attention. +#### How it works? +1. Condition detected- A sensor triggers an alarm event +2. Krake Receives it- Alert arrives wirelessly via MQTT over local network or internet +3. You're alerted- Lights flash, audio plays and acknowledgement is sent back + + ## Quick Start How to get one running — buy/build/flash — in as few steps as possible? From 5f771b94660bd72b19b8e311dff243d5c93fae7d Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:35:01 +0100 Subject: [PATCH 11/31] Enhance README with LCD UI details and credits Added detailed navigation and settings information for the LCD UI, including planned layout, rotary encoder actions, and alarm actions. Updated credits and certification information. --- README2.md | 95 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 54 insertions(+), 41 deletions(-) diff --git a/README2.md b/README2.md index d4472224..8ca175f2 100644 --- a/README2.md +++ b/README2.md @@ -17,6 +17,40 @@ Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake i ## Quick Start How to get one running — buy/build/flash — in as few steps as possible? +#### LCD UI + navigation + +Planned LCD Layout: + +```text +Q:+ NEXT W B M ⚙ +CRIT Pump Failure +ID:123 Temp High +Ack Dismiss Shelve +``` + +Rotary Encoder: +```text +Rotate: Navigate alarms or menu entries +Short Press: Select item +Long Press: Open Settings Menu + ``` + +Alarm Actions: +```text +Rotatary encoder to enter action selection +Acknowledge, Dismiss or Shelve + ``` + +Settings Menu: +```text +The local settings menu includes: +* Volume Level +* Mute Duration +* COM Setup +* Device Reset +* Exit Menu + ``` + ## Table of Contents - About Krake & Example Use Cases - Features @@ -55,12 +89,11 @@ IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS | Persistent COM configuration | Interfaces to external controllers through a DB9 Female RS-232 DCE connection. Configurable baud rate (1200,2400,4800, 9600, 19200, 38400, 57600, 115200), RTS/CTS hardware flow control and LCD-based configuration menu | | Speaker | ? | | GPAP message parsing | ? | -| Alarm Acknowledgement workflow, queue handlings and state persistence | ? | | LittleFS Configuration storage | ? | | SPI alarm input support | ? | ## Hardware -Enlarged enclosure to accomodate larger speaker ? whats changed +comparison? | Krake™ rev2 | Krake™ rev1| | -------- | ------- | @@ -86,40 +119,6 @@ oa{1234} -> Acknowledge od{1234} -> Dismiss os{1234} -> Shelve ``` -- LCD UI + navigation - -Planned LCD Layout: - -```text -Q:+ NEXT W B M ⚙ -CRIT Pump Failure -ID:123 Temp High -Ack Dismiss Shelve -``` - -Rotary Encoder: -```text -Rotate: Navigate alarms or menu entries -Short Press: Select item -Long Press: Open Settings Menu - ``` - -Alarm Actions: -```text -Rotatary encoder to enter action selection -Acknowledge, Dismiss or Shelve - ``` - -Settings Menu: -```text -The local settings menu includes: -* Volume Level -* Mute Duration -* COM Setup -* Device Reset -* Exit Menu - ``` - ## Building Your Own - Instructions for testing and assembly of Krake hardware: @@ -141,27 +140,34 @@ The local settings menu includes: [Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) ## Credits & Mentorship -The Krake has been developed primarily by volunteer engineer Nagham Kheir, with mentorship and oversight from volunteer Inventional Coach Lee Erickson. +The Krake has been developed primarily by volunteer engineer Nagham Kheir, with mentorship and oversight from volunteer Inventional Coach Lee Erickson and a group of volunteers from around the globe. [Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) Nagham Kheir: Invention Coach + Forrest Lee Erickson: Invention Coach + Robert L. Read: Invention Coach + Yehia Shalaby: Public Inventor + Courtney Ludick: Public Inventor + Yukti: Public Inventor + Juhandre Knoetze: Public Inventor -## Trust & Credentials +## Certifications image Krake hardware has been certified by the Open Source Hardware Association (OSHWA): -- OSHWA certification listing: + OSHWA certification listing: [OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) -- Certification UID: ``` US002818 ``` + +Certification UID: ``` US002818 ``` ## References & Further Reading Website: https://pubinv.github.io/krake/ @@ -172,5 +178,12 @@ User Manual: [draft user manual](https://docs.google.com/document/d/1qrhc7Yi6PFm Developers Manual: [draft developers manual](https://docs.google.com/document/d/150WA6Mb1_SFOBmFc9qBpT5b-MqXb7ejaZbKIxUqaDBY/edit?usp=sharing). -Hollifield, Bill R., and Eddie Habibi. *Alarm Management: A Comprehensive Guide.* ISA, 2010. +OSHWA certification listing: +[OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) + +[Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) + +[Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) + +[Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) From 6baf5109aa06927b2b90a58176c84ce707ed6bab Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:46:20 +0100 Subject: [PATCH 12/31] Enhance README2 with new sections and details Updated the README2.md to include purchasing information, build instructions, and detailed speaker specifications. --- README2.md | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/README2.md b/README2.md index 8ca175f2..886da37b 100644 --- a/README2.md +++ b/README2.md @@ -15,7 +15,7 @@ Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake i ## Quick Start -How to get one running — buy/build/flash — in as few steps as possible? +Purchasable from https://www.pubinv.org/shop/ - user and devlopers manuals can be found in the references and further reading section #### LCD UI + navigation @@ -50,13 +50,15 @@ The local settings menu includes: * Device Reset * Exit Menu ``` +#### Build your own +To build your own please see instructions for testing and assembly of Krake hardware: +[Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) ## Table of Contents - About Krake & Example Use Cases - Features - Hardware - Firmware -- Building Your Own - Roadmap - Contributing - Credits & Mentorship @@ -87,7 +89,7 @@ IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS | HL7 Compatible | Designed to work with medical data standards | | Fully Open Source | AGPL firmware, CERN OHL Hardware | | Persistent COM configuration | Interfaces to external controllers through a DB9 Female RS-232 DCE connection. Configurable baud rate (1200,2400,4800, 9600, 19200, 38400, 57600, 115200), RTS/CTS hardware flow control and LCD-based configuration menu | -| Speaker | ? | +| Speaker | 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz | | GPAP message parsing | ? | | LittleFS Configuration storage | ? | | SPI alarm input support | ? | @@ -98,6 +100,7 @@ comparison? | Krake™ rev2 | Krake™ rev1| | -------- | ------- | |image | image | +| 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz.| 28mm Speaker| ## Firmware @@ -120,11 +123,6 @@ od{1234} -> Dismiss os{1234} -> Shelve ``` -## Building Your Own -- Instructions for testing and assembly of Krake hardware: -[Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) - - ## Roadmap (Future Features) * Advanced alarm queue management * Enhanced LCD UI animations and icons @@ -171,7 +169,15 @@ Certification UID: ``` US002818 ``` ## References & Further Reading Website: https://pubinv.github.io/krake/ - + +Brochure: [Copy of Krake Brochure.pdf](https://github.com/user-attachments/files/29981489/Copy.of.Krake.Brochure.pdf) + +Logo: KRAKE 2 + +Krake Repo: https://github.com/PubInv/krake + +Wiki: https://github.com/PubInv/krake/wiki + HardwareX Article: [HardwareX Article](https://www.overleaf.com/project/6696aaaaa7299f34f83a5575) User Manual: [draft user manual](https://docs.google.com/document/d/1qrhc7Yi6PFmagl4gnvSoc0T4vC_uqu-NLrmWMKFnwA0/edit?usp=sharing) @@ -181,9 +187,16 @@ Developers Manual: [draft developers manual](https://docs.google.com/document/d/ OSHWA certification listing: [OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) -[Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) +The team behind Krake: [Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) -[Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) +Krake workflow: [Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) -[Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) +Build your own: [Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) + +#### Public Invention + + +- Github repo: https://github.com/PubInv +- Website: https://www.pubinv.org/ +- Products page: https://www.pubinv.org/shop/ From a1a0fc188ceb48325e6a68fb0d23dae5f34a019b Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:51:48 +0100 Subject: [PATCH 13/31] Update README2.md --- README2.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README2.md b/README2.md index 886da37b..c4943b1a 100644 --- a/README2.md +++ b/README2.md @@ -90,17 +90,16 @@ IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS | Fully Open Source | AGPL firmware, CERN OHL Hardware | | Persistent COM configuration | Interfaces to external controllers through a DB9 Female RS-232 DCE connection. Configurable baud rate (1200,2400,4800, 9600, 19200, 38400, 57600, 115200), RTS/CTS hardware flow control and LCD-based configuration menu | | Speaker | 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz | -| GPAP message parsing | ? | -| LittleFS Configuration storage | ? | -| SPI alarm input support | ? | +| GPAP message parsing | Alarm message are structured, message type, severity digit (0-5), optional message id, optional alarm type deisgnator and optional content up to 80 characters | +| SPI alarm input support | ALlows processing of alert signals communicated or wired through SPI data lines to recognise fault or warning flags in connected sensors | ## Hardware -comparison? - | Krake™ rev2 | Krake™ rev1| | -------- | ------- | |image | image | | 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz.| 28mm Speaker| +|dimensions|dimensions| +|functionality?|functionality| ## Firmware @@ -193,6 +192,8 @@ Krake workflow: [Krake Workflow Contribution Procedure](https://github.com/PubIn Build your own: [Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) +GPAP: https://github.com/PubInv/gpap + #### Public Invention From 3e6a01dd7ad4e928f4f1493fa738adfe0665ee5e Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:52:28 +0100 Subject: [PATCH 14/31] Update README2.md for clarity and corrections Clarified the quick start section and fixed typos. --- README2.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README2.md b/README2.md index c4943b1a..e3da3302 100644 --- a/README2.md +++ b/README2.md @@ -15,7 +15,9 @@ Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake i ## Quick Start -Purchasable from https://www.pubinv.org/shop/ - user and devlopers manuals can be found in the references and further reading section +Purchasable from https://www.pubinv.org/shop/ + +User manuals can be found in the references and further reading section #### LCD UI + navigation From 41c2cef938cc43d8963845307be61160f108e3eb Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:54:02 +0100 Subject: [PATCH 15/31] Update README2.md --- README2.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README2.md b/README2.md index e3da3302..edd4f0a6 100644 --- a/README2.md +++ b/README2.md @@ -122,6 +122,7 @@ IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS oa{1234} -> Acknowledge od{1234} -> Dismiss os{1234} -> Shelve +??{1234} -> Complete ``` ## Roadmap (Future Features) From b2c4797839a153a3f808a52bbbd9bff248e1515e Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:56:16 +0100 Subject: [PATCH 16/31] Update README2.md --- README2.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README2.md b/README2.md index edd4f0a6..e476d805 100644 --- a/README2.md +++ b/README2.md @@ -195,6 +195,10 @@ Krake workflow: [Krake Workflow Contribution Procedure](https://github.com/PubIn Build your own: [Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) +Database for Krake units and test registries: [Krake Factory Inventory](http://ec2-13-51-158-67.eu-north-1.compute.amazonaws.com/factory-form.html) + +Global Open Source Quality Assuring System:[Asset History Records Public Invention Krake Rev. 2](https://gosqas.org/record/8CMgkfrS4ufevweKy1QowF) + GPAP: https://github.com/PubInv/gpap #### Public Invention From f6e103035d319c8987058e9e96f8b88a5d8d2799 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:57:23 +0100 Subject: [PATCH 17/31] Add license section to README2.md Added licensing information for firmware and hardware. --- README2.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README2.md b/README2.md index e476d805..80fa50de 100644 --- a/README2.md +++ b/README2.md @@ -208,3 +208,8 @@ GPAP: https://github.com/PubInv/gpap - Website: https://www.pubinv.org/ - Products page: https://www.pubinv.org/shop/ + +## License +Firmware: GNU Affero GPL 3.0 +Hardware: CERN Open Hardware Licence Version 2 - Strongly Reciprocal +Krake™ is a trademark of Public Invention. From fb247fc0b8a644e29db86cfc86ae6ae87baba2a0 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 20:57:53 +0100 Subject: [PATCH 18/31] Add hardware license information to README2.md --- README2.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README2.md b/README2.md index 80fa50de..a0341873 100644 --- a/README2.md +++ b/README2.md @@ -211,5 +211,7 @@ GPAP: https://github.com/PubInv/gpap ## License Firmware: GNU Affero GPL 3.0 + Hardware: CERN Open Hardware Licence Version 2 - Strongly Reciprocal + Krake™ is a trademark of Public Invention. From b2d40fba69491417ce11b2f7c53d47b33f802d63 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 21:01:04 +0100 Subject: [PATCH 19/31] Revise README for branding and feature updates Updated README to reflect new branding and added detailed descriptions of features and functionalities. TBC/ TBD: GPAP complete response removal of : mockingkrake esp32-wroom-32d firmware development resources --- README.md | 514 ++++++++++++++---------------------------------------- 1 file changed, 128 insertions(+), 386 deletions(-) diff --git a/README.md b/README.md index 82b3637d..a0341873 100644 --- a/README.md +++ b/README.md @@ -1,135 +1,27 @@ -# Krake +KRAKE 2 -Website https://pubinv.github.io/krake/ - -[HardwareX Article](https://www.overleaf.com/project/6696aaaaa7299f34f83a5575) - ---- - -# User and Developer Manuals - -We have a [draft user manual](https://docs.google.com/document/d/1qrhc7Yi6PFmagl4gnvSoc0T4vC_uqu-NLrmWMKFnwA0/edit?usp=sharing) and -a [draft developers manual](https://docs.google.com/document/d/150WA6Mb1_SFOBmFc9qBpT5b-MqXb7ejaZbKIxUqaDBY/edit?usp=sharing). - -# Open Source Hardware Certification - -Krake hardware has been certified by the Open Source Hardware Association (OSHWA). - -Certification UID: - -```text -US002818 -``` +# Krake™ -OSHWA certification listing: -[OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) - - image +## A wireless alarm device purpose-built for life's critical moments + image ---- +Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with fully customiseable audio visual capabilitites designed to alert a human to something needing attention. -# Krake™ rev2 +#### How it works? +1. Condition detected- A sensor triggers an alarm event +2. Krake Receives it- Alert arrives wirelessly via MQTT over local network or internet +3. You're alerted- Lights flash, audio plays and acknowledgement is sent back - image ---- +## Quick Start +Purchasable from https://www.pubinv.org/shop/ -# Krake™ rev1 +User manuals can be found in the references and further reading section -image +#### LCD UI + navigation ---- - -# Mentorship and Development - -The Krake has been developed primarily by volunteer engineer Nagham Kheir, with mentorship and oversight from volunteer Inventional Coach Lee Erickson. - -[Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) - ---- - -# Use Cases - -The Krake is intended to inform human operators of alarm conditions requiring attention. - -## Healthcare and Assisted Living - -One intended use case is monitoring elderly individuals or patients living independently. A Krake device mounted within a residence may announce: - -* Falls -* Blood pressure abnormalities -* Sensor-triggered emergencies -* Medical equipment alarms - -The Krake is intended to support interoperability with the HL7 medical standard and the open-source ADaM (Alarm Dialog Management) project. - -## Medical Devices - -The Krake may function as a dedicated annunciator for sophisticated medical equipment such as ventilators or patient monitoring systems. - -Examples include: - -* Ventilator hose disconnects -* Power failures -* Pressure abnormalities -* Mechanical faults - -The Krake focuses on annunciation and communication, while upstream systems determine alarm conditions. - -## Industrial and General Annunciation - -Potential applications include: - -* Schools -* Factories -* Industrial process monitoring -* Smart buildings -* Emergency notification systems -* Accessibility alerting systems - ---- - -# Current Firmware Features - -The current Krake firmware includes: - -* Wi-Fi station + captive portal support -* MQTT alarm communication -* GPAP message parsing -* Rotary encoder navigation -* LCD menu system -* Alarm acknowledgement workflow -* Alarm queue handling -* DFPlayer audio annunciation -* Persistent COM configuration -* Mute timeout handling -* OTA firmware updates -* LittleFS configuration storage -* Alarm state persistence -* RS-232 controller interface -* Hardware flow control support -* LED annunciation patterns -* SPI alarm input support - ---- - -# Smart LCD User Interface - -The Krake includes a 20x4 I²C LCD interface integrated with a rotary encoder and custom menu system. - -## LCD Features - -* Real-time alarm display -* Alarm queue indication -* Wi-Fi status indication -* MQTT broker status indication -* Volume and mute display -* Alarm acknowledgement actions -* Rotary encoder navigation -* Settings configuration menu - -## Planned LCD Layout +Planned LCD Layout: ```text Q:+ NEXT W B M ⚙ @@ -138,197 +30,81 @@ ID:123 Temp High Ack Dismiss Shelve ``` -## LCD Navigation - -### Rotary Encoder - -* Rotate: - - * Navigate alarms or menu entries -* Short Press: - - * Select item -* Long Press: - - * Open Settings Menu - -### Alarm Actions - -When an alarm is active: - -* Rotate encoder to enter action selection -* Available actions: - - * Acknowledge - * Dismiss - * Shelve +Rotary Encoder: +```text +Rotate: Navigate alarms or menu entries +Short Press: Select item +Long Press: Open Settings Menu + ``` -### Settings Menu +Alarm Actions: +```text +Rotatary encoder to enter action selection +Acknowledge, Dismiss or Shelve + ``` +Settings Menu: +```text The local settings menu includes: - * Volume Level * Mute Duration * COM Setup * Device Reset * Exit Menu + ``` +#### Build your own +To build your own please see instructions for testing and assembly of Krake hardware: +[Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) ---- - -# Wi-Fi Connectivity - -The Krake normally operates as a Wi-Fi station connected to a local network. - -For setup and provisioning, the Krake can create a temporary Wi-Fi access point using WiFiManager. Wi-Fi credentials are stored in ESP32 NVS so they survive LittleFS UI uploads. - -## Features - -* Captive portal setup -* Multiple stored Wi-Fi credentials -* Automatic reconnection -* OTA firmware updates -* MQTT connectivity monitoring -* LCD network status display +## Table of Contents +- About Krake & Example Use Cases +- Features +- Hardware +- Firmware +- Roadmap +- Contributing +- Credits & Mentorship +- Trust & Credentials +- References & Further Reading -Wi-Fi credentials are stored locally in ESP32 NVS. A `/wifi.json` LittleFS mirror is maintained for backward compatibility and diagnostics, but NVS is authoritative so uploading a new LittleFS image does not erase the reconnect list. -At startup, saved-network retries and the fallback WiFiManager recovery portal are time-bounded so a missing or invalid configuration cannot indefinitely block the Krake hardware loop. +## About Krake & Example Use Cases +The hope was to develop the initial design for a wireless alarm device to alert nearby parties of a particular state. +We developed the name of this invention team based on a Crake: a bird with a distinctive, slightly alarming cry. We changed the spelling as a joke. “Flaycrake” is an old term for a scarecrow, which also aligned with our mission. ---- +Care at home: Alert an elderly person living alone to a fall or blood pressure drop — giving family peace of mind from anywhere. -# MQTT Protocol +Medical Equipment: For ventilators and critical devices, Krake provides a dedicated alarm channel for life-threatening mechanical failures. -The Krake communicates using MQTT for alarm distribution and acknowledgement. +IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS fails, or network connectivity drops — a physical alarm that doesn't rely on the very infrastructure it's monitoring. ## Features -* MQTT alarm subscriptions -* GPAP response publishing -* Alarm acknowledgements -* Alarm dismissal and shelving -* Device monitoring -* Configurable topic subscriptions -* MQTT status display on LCD - -Each Krake subscribes to alarm topics and publishes alarm responses on dedicated ACK topics. - -## Example GPAP Responses - -```text -oa{1234} -> Acknowledge -od{1234} -> Dismiss -os{1234} -> Shelve -``` - -## MQTT Testing Page - -[MQTT Publishing Test Page](https://pubinv.github.io/krake/PMD_GPAD_API.html) - ---- - -# GPAP Alarm Message Support - -The Krake firmware supports GPAP alarm messaging and response handling. - -Incoming alarm messages may contain: - -* Alarm level -* Alarm ID -* Alarm type -* Alarm message text - -Supported alarm actions: - -| Action | MQTT Response | -| ----------- | ------------- | -| Acknowledge | `oa{alarmId}` | -| Dismiss | `od{alarmId}` | -| Shelve | `os{alarmId}` | - ---- - -# COM Port - -The Krake interfaces to external controllers through a DB9 Female RS-232 DCE connection. - -## COM Features - -* Configurable baud rate -* RTS/CTS hardware flow control -* Persistent configuration storage -* LCD-based configuration menu - -## Supported Baud Rates - -* 1200 -* 2400 -* 4800 -* 9600 -* 19200 -* 38400 -* 57600 -* 115200 - -## Current Serial Configuration - -* 8-N-1 -* Optional RTS/CTS flow control - ---- - -# Arbitrary Sonic Alarms - -The Krake uses a DFPlayer Mini MP3 module connected through UART2 on the ESP32. - -## Audio Features - -* WAV and MP3 playback -* Alarm-level-specific audio -* Adjustable volume -* SD-card-based multilingual audio -* Busy-line monitoring -* Runtime diagnostics - -The SD card is removable so that alarm audio may be customized or localized for language and application. - ---- - -# Mute Button - -Pressing the local mute button toggles silencing of audio alarms. - -The firmware supports: - -* Configurable mute timeout -* Automatic unmute -* Manual mute override -* LCD mute indication - ---- - -# Rotary Encoder Knob - -The rotary encoder allows users to: - -* Navigate menus -* Configure settings -* Control volume -* Respond to alarms -* Navigate queued alarms - ---- - -# Configurable Power Options - -The Krake may be powered using: - -* 2.1 mm center-positive barrel connector -* USB-C -* RJ12 SPI interface power jumpers - ---- - -# Firmware Architecture - +| Feature | Details | +| -------- | ------- | +| Customiseable audio |WAV and MP3 playback, Alarm-level-specific audio, Adjustable volume,SD-card-based audio storage, Busy-line monitoring and Runtime diagnostics | +| LCD User Interface & Rotary Knob | 20 x 4 I²C LCD interface integrated with a rotary encoder and custom menu system to navigate settings without the need for an external device. Real-time alarm display, Alarm queue indication, Wi-Fi status indication, MQTT broker status indication, Volume and mute display and Alarm acknowledgement actions | +| LED Annunciation | Variety of LED levels including steady or blinking deisgned to be visible across a room | +| Flexible Power | USB-C, 2.1mm center-positive barrel connector or RJ12 SPI interface power jumpers | +| Wi-Fi Connectivity | Acts as a Wi-Fi station connected to a local network enabling alerts locally or via internet, captive portal set up, storage of multiple Wi-Fi credentials, automatic reconnection, OTA firmware updates and Network status display | +| MQTT Protocol | MQTT alarm subscriptions, GPAP response publishing, Alarm acknowledgements, Alarm dismissal and shelving, Device monitoring, Configurable topic subscriptions and MQTT status display on LCD | +| Mute Button & time out handling | Configurable mute timeout, Automatic unmute, Manual mute override and LCD mute indication | +| HL7 Compatible | Designed to work with medical data standards | +| Fully Open Source | AGPL firmware, CERN OHL Hardware | +| Persistent COM configuration | Interfaces to external controllers through a DB9 Female RS-232 DCE connection. Configurable baud rate (1200,2400,4800, 9600, 19200, 38400, 57600, 115200), RTS/CTS hardware flow control and LCD-based configuration menu | +| Speaker | 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz | +| GPAP message parsing | Alarm message are structured, message type, severity digit (0-5), optional message id, optional alarm type deisgnator and optional content up to 80 characters | +| SPI alarm input support | ALlows processing of alert signals communicated or wired through SPI data lines to recognise fault or warning flags in connected sensors | + +## Hardware +| Krake™ rev2 | Krake™ rev1| +| -------- | ------- | +|image | image | +| 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz.| 28mm Speaker| +|dimensions|dimensions| +|functionality?|functionality| + + +## Firmware | Module | Purpose | | -------------------- | ---------------------------------- | | `alarm_api.*` | Abstract alarm state machine | @@ -340,34 +116,16 @@ The Krake may be powered using: | `WiFiManagerOTA.*` | Wi-Fi management and OTA | | `InterruptRotator.*` | Rotary encoder interrupt handling | ---- - -# Krake Test and Assembly Procedure - -Instructions for testing and assembly of Krake hardware: - -[Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) - ---- - -# Inventory - -[Krake Factory Inventory](http://ec2-13-51-158-67.eu-north-1.compute.amazonaws.com/factory-form.html) - -Database for Krake units and test registries. - ---- - -# GDT Records - -[Asset History Records Public Invention Krake Rev. 2](https://gosqas.org/record/8CMgkfrS4ufevweKy1QowF) +- Example GPAP Responses -Global Open Source Quality Assuring System. - ---- - -# Future Features +```text +oa{1234} -> Acknowledge +od{1234} -> Dismiss +os{1234} -> Shelve +??{1234} -> Complete +``` +## Roadmap (Future Features) * Advanced alarm queue management * Enhanced LCD UI animations and icons * Bluetooth and BLE alarm forwarding @@ -378,98 +136,82 @@ Global Open Source Quality Assuring System. * Power optimization modes * Alarm escalation workflows ---- +## Contributing +[Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) -# MockingKrake (Prototype Platform) +## Credits & Mentorship +The Krake has been developed primarily by volunteer engineer Nagham Kheir, with mentorship and oversight from volunteer Inventional Coach Lee Erickson and a group of volunteers from around the globe. -During development, a breadboard prototype called the MockingKrake was used to validate: +[Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) -* Alarm functionality -* DFPlayer interoperability -* Wi-Fi communication -* LCD functionality -* Rotary encoder navigation -* MQTT messaging +Nagham Kheir: Invention Coach -## Components +Forrest Lee Erickson: Invention Coach -* ESP32 DevKit V1 -* DFPlayer Mini -* SD card -* Speaker -* Alarm LEDs -* Rotary encoder -* LCD display -* Breadboard prototype system +Robert L. Read: Invention Coach ---- +Yehia Shalaby: Public Inventor -# Typical Current Consumption +Courtney Ludick: Public Inventor -| TEST NUMBER | Current | LCD Condition | DFPlayer Condition | -| ----------- | ----------- | ------------- | ------------------ | -| 1 | 0.12–0.16 A | LCD ON | DFPlayer OFF | -| 2 | 0.08–0.11 A | LCD OFF | DFPlayer OFF | -| 3 | 0.23 A max | LCD OFF | DFPlayer ON | -| 4 | 0.24 A max | LCD ON | DFPlayer ON | +Yukti: Public Inventor ---- +Juhandre Knoetze: Public Inventor -# ESP32-WROOM-32D -[ESP32-WROOM-32D Datasheet](https://www.lcsc.com/datasheet/lcsc_datasheet_2304140030_Espressif-Systems-ESP32-WROOM-32D-N4_C473012.pdf) +## Certifications -![esp32-pinout-chip-ESP-WROOM-32](https://github.com/user-attachments/assets/c536d734-6dd7-4b16-834e-3e3d778a77b9) +image ---- +Krake hardware has been certified by the Open Source Hardware Association (OSHWA): + OSHWA certification listing: +[OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) + +Certification UID: ``` US002818 ``` + +## References & Further Reading +Website: https://pubinv.github.io/krake/ -# Enhancements +Brochure: [Copy of Krake Brochure.pdf](https://github.com/user-attachments/files/29981489/Copy.of.Krake.Brochure.pdf) -1. HTTP server support -2. Web monitoring interface -3. Five-level LED annunciation -4. WAV/MP3 alarm playback -5. 20x4 LCD alarm display -6. Configurable mute handling -7. Wi-Fi captive portal setup -8. MQTT alarm workflow support -9. Rotary encoder menu navigation +Logo: KRAKE 2 ---- +Krake Repo: https://github.com/PubInv/krake -# Workflow Contribution Procedure +Wiki: https://github.com/PubInv/krake/wiki -[Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) +HardwareX Article: [HardwareX Article](https://www.overleaf.com/project/6696aaaaa7299f34f83a5575) ---- +User Manual: [draft user manual](https://docs.google.com/document/d/1qrhc7Yi6PFmagl4gnvSoc0T4vC_uqu-NLrmWMKFnwA0/edit?usp=sharing) + +Developers Manual: [draft developers manual](https://docs.google.com/document/d/150WA6Mb1_SFOBmFc9qBpT5b-MqXb7ejaZbKIxUqaDBY/edit?usp=sharing). + +OSHWA certification listing: +[OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) -# References +The team behind Krake: [Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) -Hollifield, Bill R., and Eddie Habibi. *Alarm Management: A Comprehensive Guide.* ISA, 2010. +Krake workflow: [Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) ---- +Build your own: [Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) -# Firmware Development Resources +Database for Krake units and test registries: [Krake Factory Inventory](http://ec2-13-51-158-67.eu-north-1.compute.amazonaws.com/factory-form.html) -## Multi-tasking the Arduino +Global Open Source Quality Assuring System:[Asset History Records Public Invention Krake Rev. 2](https://gosqas.org/record/8CMgkfrS4ufevweKy1QowF) -[https://learn.adafruit.com/multi-tasking-the-arduino-part-1](https://learn.adafruit.com/multi-tasking-the-arduino-part-1) +GPAP: https://github.com/PubInv/gpap -## Random Nerd Tutorials +#### Public Invention -1. ESP32 Wi-Fi Manager - [https://randomnerdtutorials.com/esp32-wi-fi-manager-asyncwebserver/](https://randomnerdtutorials.com/esp32-wi-fi-manager-asyncwebserver/) -2. ESP32 OTA Updates - [https://randomnerdtutorials.com/esp32-ota-elegantota-arduino/](https://randomnerdtutorials.com/esp32-ota-elegantota-arduino/) +- Github repo: https://github.com/PubInv +- Website: https://www.pubinv.org/ +- Products page: https://www.pubinv.org/shop/ -3. ESP32 LittleFS Uploader - [https://randomnerdtutorials.com/esp32-littlefs-arduino-ide/](https://randomnerdtutorials.com/esp32-littlefs-arduino-ide/) ---- +## License +Firmware: GNU Affero GPL 3.0 -# License +Hardware: CERN Open Hardware Licence Version 2 - Strongly Reciprocal -* Firmware: GNU Affero GPL 3.0 -* Hardware: CERN Open Hardware Licence Version 2 - Strongly Reciprocal -* Krake™ is a trademark of Public Invention. +Krake™ is a trademark of Public Invention. From 46740aed66885e75de8c808666c27183ddecb5da Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 21:02:36 +0100 Subject: [PATCH 20/31] Fix formatting issues in README.md TBC comparison of rev1 & 2 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a0341873..a9be418e 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS |image | image | | 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz.| 28mm Speaker| |dimensions|dimensions| -|functionality?|functionality| +|functionality?|functionality?| ## Firmware From 1952d2104a737627b2c7b75103a15f618eecb58f Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 13 Jul 2026 21:05:22 +0100 Subject: [PATCH 21/31] Delete README2.md --- README2.md | 217 ----------------------------------------------------- 1 file changed, 217 deletions(-) delete mode 100644 README2.md diff --git a/README2.md b/README2.md deleted file mode 100644 index a0341873..00000000 --- a/README2.md +++ /dev/null @@ -1,217 +0,0 @@ -KRAKE 2 - - -# Krake™ - -## A wireless alarm device purpose-built for life's critical moments - image - -Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with fully customiseable audio visual capabilitites designed to alert a human to something needing attention. - -#### How it works? -1. Condition detected- A sensor triggers an alarm event -2. Krake Receives it- Alert arrives wirelessly via MQTT over local network or internet -3. You're alerted- Lights flash, audio plays and acknowledgement is sent back - - -## Quick Start -Purchasable from https://www.pubinv.org/shop/ - -User manuals can be found in the references and further reading section - -#### LCD UI + navigation - -Planned LCD Layout: - -```text -Q:+ NEXT W B M ⚙ -CRIT Pump Failure -ID:123 Temp High -Ack Dismiss Shelve -``` - -Rotary Encoder: -```text -Rotate: Navigate alarms or menu entries -Short Press: Select item -Long Press: Open Settings Menu - ``` - -Alarm Actions: -```text -Rotatary encoder to enter action selection -Acknowledge, Dismiss or Shelve - ``` - -Settings Menu: -```text -The local settings menu includes: -* Volume Level -* Mute Duration -* COM Setup -* Device Reset -* Exit Menu - ``` -#### Build your own -To build your own please see instructions for testing and assembly of Krake hardware: -[Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) - -## Table of Contents -- About Krake & Example Use Cases -- Features -- Hardware -- Firmware -- Roadmap -- Contributing -- Credits & Mentorship -- Trust & Credentials -- References & Further Reading - -## About Krake & Example Use Cases -The hope was to develop the initial design for a wireless alarm device to alert nearby parties of a particular state. -We developed the name of this invention team based on a Crake: a bird with a distinctive, slightly alarming cry. We changed the spelling as a joke. “Flaycrake” is an old term for a scarecrow, which also aligned with our mission. - -Care at home: Alert an elderly person living alone to a fall or blood pressure drop — giving family peace of mind from anywhere. - -Medical Equipment: For ventilators and critical devices, Krake provides a dedicated alarm channel for life-threatening mechanical failures. - -IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS fails, or network connectivity drops — a physical alarm that doesn't rely on the very infrastructure it's monitoring. - -## Features - -| Feature | Details | -| -------- | ------- | -| Customiseable audio |WAV and MP3 playback, Alarm-level-specific audio, Adjustable volume,SD-card-based audio storage, Busy-line monitoring and Runtime diagnostics | -| LCD User Interface & Rotary Knob | 20 x 4 I²C LCD interface integrated with a rotary encoder and custom menu system to navigate settings without the need for an external device. Real-time alarm display, Alarm queue indication, Wi-Fi status indication, MQTT broker status indication, Volume and mute display and Alarm acknowledgement actions | -| LED Annunciation | Variety of LED levels including steady or blinking deisgned to be visible across a room | -| Flexible Power | USB-C, 2.1mm center-positive barrel connector or RJ12 SPI interface power jumpers | -| Wi-Fi Connectivity | Acts as a Wi-Fi station connected to a local network enabling alerts locally or via internet, captive portal set up, storage of multiple Wi-Fi credentials, automatic reconnection, OTA firmware updates and Network status display | -| MQTT Protocol | MQTT alarm subscriptions, GPAP response publishing, Alarm acknowledgements, Alarm dismissal and shelving, Device monitoring, Configurable topic subscriptions and MQTT status display on LCD | -| Mute Button & time out handling | Configurable mute timeout, Automatic unmute, Manual mute override and LCD mute indication | -| HL7 Compatible | Designed to work with medical data standards | -| Fully Open Source | AGPL firmware, CERN OHL Hardware | -| Persistent COM configuration | Interfaces to external controllers through a DB9 Female RS-232 DCE connection. Configurable baud rate (1200,2400,4800, 9600, 19200, 38400, 57600, 115200), RTS/CTS hardware flow control and LCD-based configuration menu | -| Speaker | 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz | -| GPAP message parsing | Alarm message are structured, message type, severity digit (0-5), optional message id, optional alarm type deisgnator and optional content up to 80 characters | -| SPI alarm input support | ALlows processing of alert signals communicated or wired through SPI data lines to recognise fault or warning flags in connected sensors | - -## Hardware -| Krake™ rev2 | Krake™ rev1| -| -------- | ------- | -|image | image | -| 3 inch 10W Full Range Round 8 ohm Speaker with FR:12-16KHz.| 28mm Speaker| -|dimensions|dimensions| -|functionality?|functionality| - - -## Firmware -| Module | Purpose | -| -------------------- | ---------------------------------- | -| `alarm_api.*` | Abstract alarm state machine | -| `GPAD_HAL.*` | Hardware abstraction layer | -| `GPAD_menu.*` | Rotary encoder and LCD menu system | -| `mqtt_handler.*` | MQTT publishing and GPAP responses | -| `gpad_serial.*` | Serial protocol parser | -| `DFPlayer.*` | Audio playback subsystem | -| `WiFiManagerOTA.*` | Wi-Fi management and OTA | -| `InterruptRotator.*` | Rotary encoder interrupt handling | - -- Example GPAP Responses - -```text -oa{1234} -> Acknowledge -od{1234} -> Dismiss -os{1234} -> Shelve -??{1234} -> Complete -``` - -## Roadmap (Future Features) -* Advanced alarm queue management -* Enhanced LCD UI animations and icons -* Bluetooth and BLE alarm forwarding -* Mesh networking support -* Remote firmware fleet management -* Local event history logging -* Expanded GPAP/HL7 interoperability -* Power optimization modes -* Alarm escalation workflows - -## Contributing -[Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) - -## Credits & Mentorship -The Krake has been developed primarily by volunteer engineer Nagham Kheir, with mentorship and oversight from volunteer Inventional Coach Lee Erickson and a group of volunteers from around the globe. - -[Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) - -Nagham Kheir: Invention Coach - -Forrest Lee Erickson: Invention Coach - -Robert L. Read: Invention Coach - -Yehia Shalaby: Public Inventor - -Courtney Ludick: Public Inventor - -Yukti: Public Inventor - -Juhandre Knoetze: Public Inventor - - -## Certifications - -image - -Krake hardware has been certified by the Open Source Hardware Association (OSHWA): - OSHWA certification listing: -[OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) - -Certification UID: ``` US002818 ``` - -## References & Further Reading -Website: https://pubinv.github.io/krake/ - -Brochure: [Copy of Krake Brochure.pdf](https://github.com/user-attachments/files/29981489/Copy.of.Krake.Brochure.pdf) - -Logo: KRAKE 2 - -Krake Repo: https://github.com/PubInv/krake - -Wiki: https://github.com/PubInv/krake/wiki - -HardwareX Article: [HardwareX Article](https://www.overleaf.com/project/6696aaaaa7299f34f83a5575) - -User Manual: [draft user manual](https://docs.google.com/document/d/1qrhc7Yi6PFmagl4gnvSoc0T4vC_uqu-NLrmWMKFnwA0/edit?usp=sharing) - -Developers Manual: [draft developers manual](https://docs.google.com/document/d/150WA6Mb1_SFOBmFc9qBpT5b-MqXb7ejaZbKIxUqaDBY/edit?usp=sharing). - -OSHWA certification listing: -[OSHWA Certification Directory](https://certification.oshwa.org/list.html?utm_source=chatgpt.com) - -The team behind Krake: [Mentorship and Teamwork: The Story of the Krake](https://www.pubinv.org/2025/03/17/mentorship-and-teamwork-the-story-of-the-krake/) - -Krake workflow: [Krake Workflow Contribution Procedure](https://github.com/PubInv/krake/blob/main/WorkflowProcedure.md) - -Build your own: [Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) - -Database for Krake units and test registries: [Krake Factory Inventory](http://ec2-13-51-158-67.eu-north-1.compute.amazonaws.com/factory-form.html) - -Global Open Source Quality Assuring System:[Asset History Records Public Invention Krake Rev. 2](https://gosqas.org/record/8CMgkfrS4ufevweKy1QowF) - -GPAP: https://github.com/PubInv/gpap - -#### Public Invention - - -- Github repo: https://github.com/PubInv -- Website: https://www.pubinv.org/ -- Products page: https://www.pubinv.org/shop/ - - -## License -Firmware: GNU Affero GPL 3.0 - -Hardware: CERN Open Hardware Licence Version 2 - Strongly Reciprocal - -Krake™ is a trademark of Public Invention. From 065117162f951adc942d46d6723fcf34b8ec1cd2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 13 Jul 2026 20:09:38 +0000 Subject: [PATCH 22/31] Bump GPAD firmware version --- Firmware/GPAD_API/FIRMWARE_VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Firmware/GPAD_API/FIRMWARE_VERSION b/Firmware/GPAD_API/FIRMWARE_VERSION index 0d816f8e..f985c60d 100644 --- a/Firmware/GPAD_API/FIRMWARE_VERSION +++ b/Firmware/GPAD_API/FIRMWARE_VERSION @@ -1 +1 @@ -0.58.5 +0.58.6 From c893ced14787b3d57eaa5faec0e71078396b753a Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 20 Jul 2026 15:59:42 +0100 Subject: [PATCH 23/31] Enhance README with images and formatting Put images initial images side by side --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a9be418e..c6c1e34c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -KRAKE 2 - +

+ + +

# Krake™ ## A wireless alarm device purpose-built for life's critical moments - image Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with fully customiseable audio visual capabilitites designed to alert a human to something needing attention. From 65d2df95c0c85dff3e26f30633426e5eee72108e Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 20 Jul 2026 16:01:11 +0100 Subject: [PATCH 24/31] Revise Krake product description in README Updated product description and clarified device features. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c6c1e34c..893f3674 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,9 @@ # Krake™ ## A wireless alarm device purpose-built for life's critical moments - -Based on the Public Invention, General Purpose Alarm Device (GPAD) , the Krake is a wireless alarm device with fully customiseable audio visual capabilitites designed to alert a human to something needing attention. +The Krake, An Alarm Annunciator designed for easy integration into systems needing to bring to the attention of humans some condition. Can be used by professional system integrators and hobbyists. + +This ?150? x ?180? x ?67? mm device has a speaker, a 20x4 character display, five white LEDs. It is a peripheral which can be controlled over a WiFi network using MQTT interface, a wired RS232 interface or a wired SPI interface with fully customiseable audio visual capabilitites. #### How it works? 1. Condition detected- A sensor triggers an alarm event From 426313f38ba03bb42390cefc0e7245f1b3748224 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 20 Jul 2026 16:02:07 +0100 Subject: [PATCH 25/31] Enhance README with product introduction Added an introductory paragraph about the Krake alarm device. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 893f3674..a68a2f8e 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@

+ # Krake™ ## A wireless alarm device purpose-built for life's critical moments From edb8436a1513daad3b2392b23cc4c44603c7b473 Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 20 Jul 2026 16:11:07 +0100 Subject: [PATCH 26/31] Clarify the origin of the name 'Krake' Revised the explanation of the name 'Krake' for clarity and humor. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a68a2f8e..d2effda4 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ To build your own please see instructions for testing and assembly of Krake hard ## About Krake & Example Use Cases The hope was to develop the initial design for a wireless alarm device to alert nearby parties of a particular state. -We developed the name of this invention team based on a Crake: a bird with a distinctive, slightly alarming cry. We changed the spelling as a joke. “Flaycrake” is an old term for a scarecrow, which also aligned with our mission. +About the name, Krake, the inspiration for the invention name is based on a Crake: a bird with a distinctive, slightly alarming cry. We changed the spelling so as to have a unique name and still preserve the humor. Care at home: Alert an elderly person living alone to a fall or blood pressure drop — giving family peace of mind from anywhere. From 470c55146b24abd61061b1353aa7143355894aba Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 20 Jul 2026 16:12:22 +0100 Subject: [PATCH 27/31] Refactor README sections for clarity Separated 'About Krake' and 'Example Use Cases' into distinct sections for clarity. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d2effda4..a865f372 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,8 @@ To build your own please see instructions for testing and assembly of Krake hard [Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) ## Table of Contents -- About Krake & Example Use Cases +- About Krake +- Example Use Cases - Features - Hardware - Firmware @@ -70,10 +71,11 @@ To build your own please see instructions for testing and assembly of Krake hard - Trust & Credentials - References & Further Reading -## About Krake & Example Use Cases +## About Krake The hope was to develop the initial design for a wireless alarm device to alert nearby parties of a particular state. About the name, Krake, the inspiration for the invention name is based on a Crake: a bird with a distinctive, slightly alarming cry. We changed the spelling so as to have a unique name and still preserve the humor. +## Example Use Cases Care at home: Alert an elderly person living alone to a fall or blood pressure drop — giving family peace of mind from anywhere. Medical Equipment: For ventilators and critical devices, Krake provides a dedicated alarm channel for life-threatening mechanical failures. From a812e269d8ff5506f95afacf26a100934684bbee Mon Sep 17 00:00:00 2001 From: Courtney Date: Mon, 20 Jul 2026 17:14:10 +0100 Subject: [PATCH 28/31] Revise 'How it works' section for clarity and detail Enhanced the explanation of how the device works, providing more detail on sensor detection and user interaction with alarms. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a865f372..90c74a41 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,10 @@ The Krake, An Alarm Annunciator designed for easy integration into systems needi This ?150? x ?180? x ?67? mm device has a speaker, a 20x4 character display, five white LEDs. It is a peripheral which can be controlled over a WiFi network using MQTT interface, a wired RS232 interface or a wired SPI interface with fully customiseable audio visual capabilitites. #### How it works? -1. Condition detected- A sensor triggers an alarm event -2. Krake Receives it- Alert arrives wirelessly via MQTT over local network or internet -3. You're alerted- Lights flash, audio plays and acknowledgement is sent back +1. A condition is detected by an external sensor that relays this information to Krake to trigger and alarm event. Such as a pressure sensor detecting the opening of a gate. +2. The Krake receives the information about the event wirelessly via MQTT over local network or internet. A gate open sensor on a security system would publish a message to the Krake via MQTT or direct RS232 connection +3. The Krake alerts you of this event- Lights flash, audio plays and the message is displayed on an LCD for the user +4. The user is able to react to the alarm with {acknowledgement, dismissal, shelving or completion}, A mute button allows the user to temporarily mute the audio to prevent alarm fatigue. ## Quick Start From aa1587bdece3025df613e701f3eebe9fa01827e5 Mon Sep 17 00:00:00 2001 From: Courtney Date: Wed, 22 Jul 2026 16:20:14 +0100 Subject: [PATCH 29/31] Enhance README with Table of Contents and updates Added a Table of Contents and updated user manual references. --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 90c74a41..031c4acf 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,25 @@ This ?150? x ?180? x ?67? mm device has a speaker, a 20x4 character display, fiv 3. The Krake alerts you of this event- Lights flash, audio plays and the message is displayed on an LCD for the user 4. The user is able to react to the alarm with {acknowledgement, dismissal, shelving or completion}, A mute button allows the user to temporarily mute the audio to prevent alarm fatigue. +## Table of Contents +- Quick Start +- About Krake +- Example Use Cases +- Features +- Hardware +- Firmware +- Roadmap +- Contributing +- Credits & Mentorship +- Trust & Credentials +- References & Further Reading ## Quick Start +Once upon a time, we (Robert, Nagham and Lee) had envisioned that upon receiving a Krake the user would practice working with it by using the MQTT web page to publish messages to their device. + Purchasable from https://www.pubinv.org/shop/ -User manuals can be found in the references and further reading section +User manuals & test and assembly procedure can be found in the references and further reading section #### LCD UI + navigation @@ -60,17 +74,6 @@ The local settings menu includes: To build your own please see instructions for testing and assembly of Krake hardware: [Krake Test and Assembly Procedure Document](https://www.overleaf.com/project/691ca3def1fcd4e384b10919) -## Table of Contents -- About Krake -- Example Use Cases -- Features -- Hardware -- Firmware -- Roadmap -- Contributing -- Credits & Mentorship -- Trust & Credentials -- References & Further Reading ## About Krake The hope was to develop the initial design for a wireless alarm device to alert nearby parties of a particular state. From 8abc3fe1b664dca81bd85fba013b93e94c593350 Mon Sep 17 00:00:00 2001 From: Courtney Date: Wed, 22 Jul 2026 16:20:43 +0100 Subject: [PATCH 30/31] Update LCD User Interface feature details in README Removed redundant alarm queue indication from the LCD User Interface feature description. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 031c4acf..f506d221 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS | Feature | Details | | -------- | ------- | | Customiseable audio |WAV and MP3 playback, Alarm-level-specific audio, Adjustable volume,SD-card-based audio storage, Busy-line monitoring and Runtime diagnostics | -| LCD User Interface & Rotary Knob | 20 x 4 I²C LCD interface integrated with a rotary encoder and custom menu system to navigate settings without the need for an external device. Real-time alarm display, Alarm queue indication, Wi-Fi status indication, MQTT broker status indication, Volume and mute display and Alarm acknowledgement actions | +| LCD User Interface & Rotary Knob | 20 x 4 I²C LCD interface integrated with a rotary encoder and custom menu system to navigate settings without the need for an external device. Real-time alarm display, Wi-Fi status indication, MQTT broker status indication, Volume and mute display and Alarm acknowledgement actions | | LED Annunciation | Variety of LED levels including steady or blinking deisgned to be visible across a room | | Flexible Power | USB-C, 2.1mm center-positive barrel connector or RJ12 SPI interface power jumpers | | Wi-Fi Connectivity | Acts as a Wi-Fi station connected to a local network enabling alerts locally or via internet, captive portal set up, storage of multiple Wi-Fi credentials, automatic reconnection, OTA firmware updates and Network status display | From 0c54544ce405c784b240bb4511f45e54c2d4e847 Mon Sep 17 00:00:00 2001 From: Courtney Date: Wed, 22 Jul 2026 16:22:40 +0100 Subject: [PATCH 31/31] Remove firmware details and GPAP examples from README Removed firmware section and example GPAP responses from README. --- README.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/README.md b/README.md index f506d221..f85428d8 100644 --- a/README.md +++ b/README.md @@ -113,27 +113,6 @@ IT Infrastructure: Alert on-site staff instantly when a server overheats, a UPS |functionality?|functionality?| -## Firmware -| Module | Purpose | -| -------------------- | ---------------------------------- | -| `alarm_api.*` | Abstract alarm state machine | -| `GPAD_HAL.*` | Hardware abstraction layer | -| `GPAD_menu.*` | Rotary encoder and LCD menu system | -| `mqtt_handler.*` | MQTT publishing and GPAP responses | -| `gpad_serial.*` | Serial protocol parser | -| `DFPlayer.*` | Audio playback subsystem | -| `WiFiManagerOTA.*` | Wi-Fi management and OTA | -| `InterruptRotator.*` | Rotary encoder interrupt handling | - -- Example GPAP Responses - -```text -oa{1234} -> Acknowledge -od{1234} -> Dismiss -os{1234} -> Shelve -??{1234} -> Complete -``` - ## Roadmap (Future Features) * Advanced alarm queue management * Enhanced LCD UI animations and icons