Skip to content

Commit de6c2ca

Browse files
i6modsclaude
i6mods
and
claude
committed
Redesign README with badges, tables, and dashboard-matching structure
- Shields.io badges for live dashboard, hardware, location, update rate - Dashboard features table mirroring the 6 stat cards with matching icons - Radiation dose scale table with coloured emoji indicators (🟢→⛔) - Health context reference table - Hardware specs in code block - Repository file map table - Configuration snippets for firmware and index.html - Centred header and footer to match dashboard aesthetic Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent f23fd11 commit de6c2ca

1 file changed

Lines changed: 114 additions & 35 deletions

File tree

‎README.md‎

Lines changed: 114 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,114 @@
1-
# Geigerduino
2-
Live Radiation Data from Lancashire United Kingdom 2025
3-
Using: esp32-c3 & sbm-20 tube Link to LIVE DATA FEED >>>>
4-
#
5-
https://benb0jangles.github.io/Geigerduino/
6-
#
7-
Here's a breakdown of radiation levels and their significance:
8-
Normal Background Radiation Levels
9-
Average global background: ~0.08-0.10 µSv/h (microsieverts per hour)
10-
Typical indoor readings: 0.05-0.20 µSv/h
11-
High altitude locations: Can reach 0.25-0.30 µSv/h naturally
12-
Granite-rich areas: Can see 0.10-0.40 µSv/h due to natural uranium
13-
#
14-
Elevated (Worth Monitoring) Levels
15-
0.5-1.0 µSv/h: Above normal but not concerning for short exposure
16-
1.0-5.0 µSv/h: Elevated level that warrants investigation of source
17-
5.0-10 µSv/h: Significantly above background, may require reporting to authorities if persistent
18-
#
19-
Concerning Levels
20-
10-50 µSv/h: Potentially hazardous for long-term exposure
21-
50-100 µSv/h: Areas with this level typically have access restrictions
22-
#
23-
Dangerous Levels
24-
100+ µSv/h: Restricted zone level, significant health risk with prolonged exposure
25-
1,000+ µSv/h (1 mSv/h): Hazardous, requires protective equipment
26-
10,000+ µSv/h (10 mSv/h): Extremely dangerous, severe radiation hazard
27-
#
28-
Context and Health Impacts
29-
Annual recommended limit for the public: 1 mSv/year (≈0.11 µSv/h if continuous)
30-
Nuclear industry worker limits: 20 mSv/year
31-
Acute radiation sickness begins: Around 500,000 µSv received in a short period
32-
CT scan: Single procedure delivers about 10,000-20,000 µSv total dose
33-
Chest X-ray: Around 20-100 µSv total dose
34-
#
35-
When using your Geiger counter, readings around 0.05-0.20 µSv/h are typically normal. If you detect levels consistently above 1.0 µSv/h without an obvious source (like a known radioactive mineral sample), it may be worth investigating further.
1+
<div align="center">
2+
3+
# ☢ Geigerduino — Radiation Monitor
4+
5+
**Real-time environmental radiation monitoring from Lancashire, United Kingdom**
6+
7+
[![Live Dashboard](https://img.shields.io/badge/LIVE%20DASHBOARD-View%20Now-FFD700?style=for-the-badge&logoColor=black)](https://benb0jangles.github.io/Geigerduino/)
8+
[![Hardware](https://img.shields.io/badge/Hardware-ESP32--C3%20%2B%20SBM--20-orange?style=for-the-badge)](#hardware)
9+
[![Location](https://img.shields.io/badge/📍-Lancashire%2C%20UK-blue?style=for-the-badge)](#)
10+
[![Update Rate](https://img.shields.io/badge/Updates-Every%2030s-green?style=for-the-badge)](#)
11+
12+
</div>
13+
14+
---
15+
16+
## 🌐 Live Data Feed
17+
18+
> **[benb0jangles.github.io/Geigerduino](https://benb0jangles.github.io/Geigerduino/)**
19+
20+
The dashboard displays real-time CPM and µSv/h readings with interactive time-range charts, a moving average trend line, period min/max, and a colour-coded dose scale — all auto-refreshing every 30 seconds.
21+
22+
---
23+
24+
## 📊 Dashboard Features
25+
26+
| Card | Description |
27+
|------|-------------|
28+
| ⚡ **Count Rate** | Live Counts Per Minute (CPM) from the Geiger tube |
29+
| ☢ **Dose Rate** | Converted µSv/h using the SBM-20 factor of 0.0057 |
30+
| 🟢 **Radiation Level** | Status: Normal / Slightly Elevated / Elevated / High / Danger |
31+
| 📊 **Data Points** | Number of readings in the selected time window |
32+
| 📈 **Period Average** | Mean µSv/h for the active range (1hr / 24hr / 7 Day / 30 Day) |
33+
| ↕ **Period Range** | Low ▼ and High ▲ µSv/h — High coloured to match the dose scale |
34+
35+
**Charts** show raw readings plus a smoothed moving average trend line. The µSv/h chart includes a green threshold line at **0.30 µSv/h** marking the normal background ceiling.
36+
37+
---
38+
39+
## ☢ Radiation Dose Reference Scale
40+
41+
| Level | Range | Significance |
42+
|-------|-------|--------------|
43+
| 🟢 **Normal** | < 0.30 µSv/h | Natural background. Global average 0.08–0.30 µSv/h |
44+
| 🟡 **Slightly Elevated** | 0.30 – 1.0 µSv/h | Above typical background; not concerning for short exposure |
45+
| 🟠 **Elevated** | 1.0 – 5.0 µSv/h | Warrants investigation of source |
46+
| 🔴 **High** | 5.0 – 20.0 µSv/h | Significantly above background; may require reporting if persistent |
47+
| ⛔ **Danger** | > 20.0 µSv/h | Restricted zone level; significant health risk with prolonged exposure |
48+
49+
### Context & Health Reference
50+
51+
| Dose / Limit | Value |
52+
|---|---|
53+
| Annual public limit | 1 mSv/year ≈ 0.11 µSv/h continuous |
54+
| Nuclear industry worker limit | 20 mSv/year |
55+
| Chest X-ray | ~20–100 µSv total |
56+
| CT scan | ~10,000–20,000 µSv total |
57+
| Acute radiation sickness threshold | ~500,000 µSv received in a short period |
58+
59+
> **Typical reading:** 0.05–0.20 µSv/h is normal. Readings consistently above **1.0 µSv/h** without a known source (e.g. a mineral sample) are worth investigating.
60+
61+
---
62+
63+
## 🔧 Hardware
64+
65+
```
66+
MCU : ESP32-C3 Super Mini
67+
Tube : SBM-20 Geiger-Müller Tube
68+
Factor: 0.0057 µSv/h per CPM
69+
IoT : ThingSpeak (field1 = CPM, field2 = µSv/h)
70+
Power : USB-C
71+
```
72+
73+
The ESP32-C3 reads pulses from the SBM-20 tube, calculates CPM and µSv/h, then pushes readings to the IoT server every 30 seconds over Wi-Fi.
74+
75+
---
76+
77+
## 🗂 Repository
78+
79+
| File | Description |
80+
|------|-------------|
81+
| `index.html` | Live dashboard — hosted via GitHub Pages |
82+
| `geigerduino_xiao_esp32c3/` | Firmware for XIAO ESP32-C3 |
83+
| `geigerduino_esp32c3_supermini/` | Firmware for ESP32-C3 Super Mini |
84+
| `geigerduino2_thingspeak/` | ThingSpeak variant firmware |
85+
| `XIAO_ESP32C3_SETUP_REFERENCE.txt` | Wiring & board setup notes |
86+
87+
---
88+
89+
## ⚙️ Configuration
90+
91+
Open the firmware `.ino` file and set your credentials:
92+
93+
```cpp
94+
const char* ssid = "YOUR_WIFI_SSID";
95+
const char* password = "YOUR_WIFI_PASSWORD";
96+
const char* apiKey = "YOUR_THINGSPEAK_WRITE_KEY";
97+
```
98+
99+
In `index.html`, update the channel and read key:
100+
101+
```js
102+
const CHANNEL_ID = 'YOUR_CHANNEL_ID';
103+
const READ_API_KEY = 'YOUR_READ_API_KEY';
104+
```
105+
106+
---
107+
108+
<div align="center">
109+
110+
*Natural background radiation (global average) ≈ 0.10–0.30 µSv/h*
111+
112+
☢ **Geigerduino** · ESP32-C3 + SBM-20 · Lancashire, UK · 2025
113+
114+
</div>

0 commit comments

Comments
 (0)