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

added badge for github actions

Browse Source
This commit is contained in:
Holger Fleischmann
2020-12-10 19:38:36 +01:00
parent df997b295b
commit e2f9e6fb25
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -1,4 +1,4 @@
[![Build Status](https://travis-ci.org/grillbaer/esp32-geiger-counter.svg?branch=master)](https://travis-ci.org/grillbaer/esp32-geiger-counter)
![PlatformIO CI](https://github.com/grillbaer/esp32-geiger-counter/workflows/PlatformIO%20CI/badge.svg) [![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, Thingspeak Channel and MQTT
@@ -9,7 +9,7 @@
- WiFi mode for
- optional thingspeak data upload every minute, see https://thingspeak.com/channels/758223
[![https://thingspeak.com/channels/758223](media/thingspeak.png)](https://thingspeak.com/channels/758223)
- MQTT publishing to a broker every minute
- MQTT publishing to a broker every minute with optional SSL/TLS support
Feel free to use this project as a base for your own projects AT YOUR OWN RISK!
@@ -30,7 +30,7 @@ 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, [U8g2](https://github.com/olikraus/u8g2) for display output and [Arduino-MQTT](https://github.com/256dpi/arduino-mqtt).
- 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.
- Credentials, addresses and user for WiFi, thingspeak channel and mqtt broker are declared in `credentials.h` and replaced by dummy values in `credentials.cpp` by default. Define your real secrets in a sibling file named `secret_credentials.h` (do never committed!). It will automatically be included by `credentials.cpp` if it exists. You may copy `TEMPLATE_secret_credentials.h` as a starting point.
- Credentials, addresses and user for WiFi, thingspeak channel and mqtt broker are declared in `credentials.h` and replaced by dummy values in `credentials.cpp` by default. Define your real secrets in a sibling file named `secret_credentials.h` (do never committed!). It will be automatically included by `credentials.cpp` if it exists. You may copy `TEMPLATE_secret_credentials.h` as a starting point.
# MQTT Message Format