mirrors/esp32-geiger-counter
1
0
Fork 0
mirror of https://github.com/grillbaer/esp32-geiger-counter.git synced 2025-12-21 21:33:03 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

travis support

Browse Source
This commit is contained in:
Holger Fleischmann
2019-09-13 19:16:11 +02:00
parent db6bf5b7e6
commit 17060ad77d
3 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -1,4 +1,5 @@
.pio
.pioenvs .pioenvs
.piolibdeps .piolibdeps
.vscode .vscode
credentials.cpp secret_*

4
README.md
View File

@@ -1,3 +1,5 @@
[![Build Status](https://travis-ci.org/grillbaer/esp32-geiger-counter.svg?branch=master)](https://travis-ci.org/grillbaer/esp32-geiger-counter)
# IoT Geiger Counter with ESP32, OLED Display and Thingspeak Channel # IoT Geiger Counter with ESP32, OLED Display and Thingspeak Channel
- Measures radioactive gamma and beta radiation with quite good resolution at the typical low levels of the natural radiation (due to the big STS-6 tube) - Measures radioactive gamma and beta radiation with quite good resolution at the typical low levels of the natural radiation (due to the big STS-6 tube)
@@ -26,4 +28,4 @@ Feel free to use this project as a base for your own projects AT YOUR OWN RISK!
- [PlatformIO VSCode project](https://github.com/platformio/platformio-vscode-ide) using [Arduino](https://github.com/arduino/Arduino) library, [Espressif ESP-IDF](https://github.com/espressif/esp-idf) for sleep functions and [U8g2](https://github.com/olikraus/u8g2) for display output - [PlatformIO VSCode project](https://github.com/platformio/platformio-vscode-ide) using [Arduino](https://github.com/arduino/Arduino) library, [Espressif ESP-IDF](https://github.com/espressif/esp-idf) for sleep functions and [U8g2](https://github.com/olikraus/u8g2) for display output
- Low-power mode uses light sleep, a wake-up for each signal pulse change and a wake-up every 1000 ms to update pulse statistics and OLED. This results in about 90% sleep. Could be improved using deep sleep and ULP. However, light sleep is already quite good and much easier. - Low-power mode uses light sleep, a wake-up for each signal pulse change and a wake-up every 1000 ms to update pulse statistics and OLED. This results in about 90% sleep. Could be improved using deep sleep and ULP. However, light sleep is already quite good and much easier.
- WiFi mode uses no sleep and simple interrupts for pulse counting. Pulse statistics and OLED are updated every 1000 ms, data is sent to thingspeak every 60 s. - WiFi mode uses no sleep and simple interrupts for pulse counting. Pulse statistics and OLED are updated every 1000 ms, data is sent to thingspeak every 60 s.
- Credentials (WiFi SSID, password, thingspeak channel key) are only declared in `credentials.h` and must be defined in a `credentials.cpp` - Credentials (WiFi SSID, password, thingspeak channel key) are declared in `credentials.h` and defined with dummy values in `credentials.cpp`. Define them in a sibling file named `secret_credentials` (which is never committed) and uncomment its include in `credentials.cpp`

13
src/credentials.cpp Normal file
View File

@@ -0,0 +1,13 @@
#include "credentials.h"
// keep secret credentials in an external file that is never committed:
// #include "secret_credentials"
#ifndef _SECRET_CREDENTIALS
// use dummy credentials to make it compilable without secrets
const char *wifiSsid = "unset-wifi-ssid";
const char *wifiPassword = "unset-password";
const char *thingspeakApiKey = "unset-thinkspeak-api-key";
#endif