Documentation/issue #582 edit readme.md#585
Conversation
Added initial content and structure for README2.md.
Added OSHWA certification details and related links.
Added references and further reading section to README2.
Added credits and mentorship information for the Krake project.
Added detailed features and specifications for the Krake wireless alarm device.
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.
Updated description of the Krake alarm device to clarify its customizable features.
Added a section explaining how the Krake alarm device works.
Added detailed navigation and settings information for the LCD UI, including planned layout, rotary encoder actions, and alarm actions. Updated credits and certification information.
Updated the README2.md to include purchasing information, build instructions, and detailed speaker specifications.
Clarified the quick start section and fixed typos.
Added licensing information for firmware and hardware.
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
TBC comparison of rev1 & 2
ForrestErickson
left a comment
ForrestErickson
left a comment
There was a problem hiding this comment.
This is Lee's first pass only. I became fatigued before finishing.
| @@ -1,135 +1,27 @@ | |||
| # Krake | |||
| <img width="2000" height="2000" alt="KRAKE 2" src="https://github.com/user-attachments/assets/0f4e3910-4cee-44f4-986c-50cb737b0a3f" /> | |||
|
|
|||
There was a problem hiding this comment.
Make the logo much smaller. Place it to the left of an image of the Krake which is on the same "line".
The visitor should not have to scroll to get to text to learn more.
|
|
||
| --- | ||
| 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. | ||
|
|
There was a problem hiding this comment.
The visitor needs to know what Krake is in a way that the can understand if it meets their use case.
I suggest Krake be explained like this:
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, or a wired RS232 interface or a wired SPI interface.
|
|
||
| # Krake™ rev2 | ||
| #### How it works? | ||
| 1. Condition detected- A sensor triggers an alarm event |
There was a problem hiding this comment.
Regarding, " Condition detected- A sensor triggers an alarm event" The visitor will not clearly understand "who" is doing the detection. The Krake?
We have limited time (words) to get the visitor to understand that Krake is part of a system with other devices. The Krake is added to such systems so that a device (Example gate opening sensor) wanting to alert a human of condition uses the Krake to announce the alarm.
| # 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 |
There was a problem hiding this comment.
Note the passive voice in this sentence. I think that warns of the opportunity for confusing. We should be heading off such confusion.
Illistrate with an example.
For example a gate open sensor on a security system publishes a message and MQTT message to the Krake, or by direct RS232 connection writes a message to the Krake.
| #### 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 |
There was a problem hiding this comment.
The Krake makes sound, lights some LEDs and displays on the LCD a message to the user.
With the Rotary encoder the user can react to the alarm, {Ack, Dismiss , Shelve, or Complete}
With the Mute button the user can temporarily mute the audio message for some alarm fatigue relief.
| 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. |
There was a problem hiding this comment.
Change to something like:
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 .
| 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. |
There was a problem hiding this comment.
These use cases come out of the blue with out even an explanatory heading.
| | 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 | |
There was a problem hiding this comment.
There is a lot here a visitor will not understand.
Also things not fully tested.
Regarding, " Alarm queue indication" What would a three deep queue look like and how could we produce it now (15 July 2026)?
| | 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 | |
There was a problem hiding this comment.
Here "GPAP " is introduced without explanation.
|
|
||
|
|
||
| ## Firmware | ||
| | Module | Purpose | |
There was a problem hiding this comment.
Do we need this on the main Readme?
2 participants
Links
Artifacts (attach if relevant)
Checklist
check for ? in documentation