omarkhorshid / OpenRad

Introducing OpenRad, a simple radiation monitoring solution powered by the SBM-20 GM tube and TTGO ESP32 microcontroller. this project offers a user-friendly approach to way to track radiation levels.

OpenRad

Introducing OpenRad, a simple radiation monitoring solution powered by the SBM-20 GM tube and TTGO ESP32 microcontroller. this project offers a user-friendly approach to tracking and measuring radiation levels.

Table of Contents

• Demo
• Install
• Folder Structure
• FAQS
• License

Demo

Device UI

Youtube Demo

Install

1. Install VSCode.
2. Install PlatformIO.
3. Clone this repository

git clone https://github.com/omarkhorshid/OpenRad.git

4. (optional) Install Squareline Studio.
5. (optional) For Squareline, Change the project settings save paths to match your project directory.
6. In PlatformIO extension: Platform > Upload the Filesystem Image.
7. In PlatformIO extension: General > Upload the code to the TTGO board.

Dependencies

• lvgl v8.3.11
• TFT_eSPI v2.4.61
• AsyncTCP-esphome v1.2.2
• ESPAsyncWebServer-esphome v2.1.0
• PubSubClient v2.8
• ArduinoJson v7.0.4

Folder Structure

Software/Firmware/src

• hardware.cpp/h : Contains hardware init and functions.
• settings.cpp/h : Contains the settings.
• geiger.cpp/h : Contains geiger calculations.
• gui.cpp/h : Contains LVGL functions.
• connectivity.cpp/h : Contains all the connectivity functions.

Software/Firmware/lib/ui/src

• ui_events.c/h : Contains the UI events.

Software/Firmware/data

• index.html : Contains the web interface.
• chart.js : Chart.js Library file.

Schematics

View project schematics

FAQs

How do I Navigate the UI in OpenRad?

Using the three buttons, up down and enter. ...

How do I change the measuring window?

After uploading the code to the ESP, open the settings cogwheel, and change the settings you want.

How do I turn OpenRad off?

• For Sleep mode: Navigate to the power button and click it.
• For Deep Sleep mode: Hold the button untill this message pops up, then release it before it disappears.

What types of connectivity does OpenRad have?

OpenRad has WiFi and MQTT connectivity to be able to remotely monitor the radiation levels from the Web interface.

How do I connect to OpenRad?

To connect to OpenRad and access the web interface:

If not connected to a Wifi network:

1. Enable Wifi from the on device settings
2. Enable "Wi-Fi Access Point"
3. Connect to the device's AP using the password on screen
4. Navigate to "http://192.168.4.1" or use the "Manage Router" option on your phone

If Connected:

• From a device on the same network navigate to the IP address showing on the device screen in the Connectivity settings

License

OpenRad is BSD-3 Licensed