Skip to content

Commit 79f3c2d

Browse files
committed
docs: update overview.puml color scheme to match state diagram and add construction warnings to readme
1 parent 91cf650 commit 79f3c2d

2 files changed

Lines changed: 49 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,26 @@
88
[![Platform](https://img.shields.io/badge/platform-nRF52840-orange?style=flat-square)](https://www.nordicsemi.com/Products/nRF52840)
99
[![RTOS](https://img.shields.io/badge/RTOS-Zephyr%20%2F%20NCS-7EC8E3?style=flat-square)](https://developer.nordicsemi.com)
1010
[![Status](https://img.shields.io/badge/status-WIP-red?style=flat-square)](#roadmap)
11+
![Last Commit](https://img.shields.io/github/last-commit/jknoxdev/lima-node)
1112

12-
13+
> ⚠️ **Work in Progress**
14+
>
15+
> L.I.M.A Node is under active development. The current phase focuses on
16+
> stabilizing the firmware state machine before integrating sensors,
17+
> cryptographic packet signing, and radio transport.
1318
---
1419

20+
21+
1522
## What is LIMA?
1623

1724
LIMA nodes are small, battery-powered sensors that detect physical integrity events — door opens, enclosure breaches, vehicle towing, cabinet punctures — and deliver cryptographically signed alerts to a local gateway, which routes them to operators via push notification, SIEM, or cloud audit trail.
1825

1926
The system is designed to be **air-gapped first**. No cloud dependency for core operation. No persistent BLE connections. No trusted local network required. Just a node, a gateway, and a signed audit trail that survives internet outages.
2027

28+
## System Overview
29+
30+
2131
**Two independent threat models, one pipeline:**
2232

2333
| Trigger | Use Case | Sensor |
@@ -101,7 +111,7 @@ Each fires independently. An attacker must defeat both sensors simultaneously to
101111

102112
## Getting Started
103113

104-
See [`docs/FLASHING.md`](docs/build/FLASHING.md) for the complete build and flash guide.
114+
See [`docs/build/FLASHING.md`](docs/build/FLASHING.md) for the complete build and flash guide.
105115

106116
```bash
107117
# 1. Initialize workspace

docs/architecture/overview.puml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
@startuml overview
2+
!pragma layout smetana
3+
4+
skinparam {
5+
BackgroundColor #1a1a2e
6+
ArrowColor #7EC8E3
7+
ArrowFontColor #CCCCCC
8+
ArrowFontSize 10
9+
DefaultFontName Arial
10+
DefaultFontColor #E0E0E0
11+
DefaultFontSize 11
12+
StateBorderColor #4A90D9
13+
StateBorderThickness 2
14+
StateBackgroundColor #0f3460
15+
StateFontColor #FFFFFF
16+
StateFontSize 12
17+
}
18+
19+
title L.I.M.A Node — System Overview
20+
21+
22+
state "Sensors" as sensors
23+
state "Event Detection" as detect
24+
state "FSM\n(State Machine)" as fsm
25+
state "Signed Event Record" as packet
26+
state "BLE Transport" as ble
27+
state "Gateway" as gw
28+
state "MQTT / Storage / Alerts" as backend
29+
30+
sensors --> detect
31+
detect --> fsm
32+
fsm --> packet
33+
packet --> ble
34+
ble --> gw
35+
gw --> backend
36+
37+
@enduml

0 commit comments

Comments
 (0)