Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aportela/esp32-server-dashboard
Display realtime server stats
https://github.com/aportela/esp32-server-dashboard
arduino-ide dashboard esp32 mqtt st7789v telegraf
Last synced: 26 days ago
JSON representation
Display realtime server stats
- Host: GitHub
- URL: https://github.com/aportela/esp32-server-dashboard
- Owner: aportela
- License: gpl-3.0
- Created: 2024-07-16T14:08:28.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T22:23:52.000Z (about 2 months ago)
- Last Synced: 2024-09-29T08:41:00.120Z (about 1 month ago)
- Topics: arduino-ide, dashboard, esp32, mqtt, st7789v, telegraf
- Language: C++
- Homepage:
- Size: 500 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esp32-server-dashboard
## Introduction
A small project to display in real time stats (cpu/memory/temperature/network bandwidth usage) of the system (using telegraf to collect data & mqtt to transport messages) on my servers while I was getting started in microcontroller programming.
## Supported hardware
### Display
Any **SPI** display that is supported by the driver **ST7789V** with a resolution of **240x320**.
I'm using displays like these (the cost is about 3.5 euros):
### Microcontroller
In theory you should be able to use any esp32 as long as it has enough pins.
I'm using these two:
ESP32-WROOM-32D (the cost is about 4 euros):
ESP32-C3 SuperMini (the cost is about 2 euros):
### Switch / Button (used to switch between screens)
Any button / switch will work
## Install (Hardware)
### ESP32-WROOM-32D
| ESP32-WROOM-32D | ST7789V |
| --------------- | ------- |
| PIN 5 | CS |
| PIN 4 | RST |
| PIN 2 | DC |
| PIN 23 | SDA |
| PIN 18 | SCL |
| GND | GND |
| 3.3V | VCC |
Switch/button contacts are connected to ESP32-C3 SuperMini PIN 16 and GND.
### ESP32-C3 SuperMini
| ESP32-C3 SuperMini | ST7789V |
| ------------------ | ------- |
| PIN 5 | CS |
| PIN 9 | RST |
| PIN 8 | DC |
| PIN 6 | SDA |
| PIN 4 | SCL |
| GND | GND |
| 3.3V | VCC |
Switch/button contacts are connected to ESP32-C3 SuperMini PIN 10 and GND.
## Install (Software)
Services:
- [Mosquitto](https://mosquitto.org/) (should work with any other server/broker)
Arduino IDE Board setup:
- ESP32-WROOM-32D: **ESP32-WROOM-DA Module**
- requires **#define ESP32_WROOM** on esp32-server-dashboard.ino
- ESP32-C3 SuperMini **ESP32C3 Dev Module**
- Tools => **USB CDC On Boot** => "**Enabled**" (required for serial communication)
- requires **#define ESP32_C3_SUPER_MINI** on esp32-server-dashboard.ino
- [LovyanGFX by lovyan03](https://github.com/lovyan03/LovyanGFX) (ST7789V display driver)
- [Bounce2 by Thomas Ouellet Fredericks](https://github.com/thomasfredericks/Bounce2) (Debouncing library for Arduino and Wiring)
## Configuration
### MQTT
[Authentication with usernames and passwords](https://mosquitto.org/documentation/authentication-methods/) (esp32-server-dashboard it also works without MQTT authentication)
### Telegraf
Configuration file (**telegraf.conf**) file using data collection interval = 1s
```
[global_tags]
[agent]
interval = "1s"
round_interval = true
metric_batch_size = 1000
metric_buffer_limit = 10000
collection_jitter = "0s"
flush_interval = "1s"
flush_jitter = "0s"
precision = "0s"
hostname = ""
omit_hostname = false
[[outputs.mqtt]]
servers = ["192.168.1.1:1883", ]
topic = "telegraf/{{ .Hostname }}/{{ .PluginName }}"
username = "mqtt_username"
password = "mqtt_password"
[[inputs.cpu]]
percpu = false
totalcpu = true
collect_cpu_time = false
report_active = false
core_tags = false
[[inputs.mem]]
[[inputs.system]]
[[inputs.net]]
interfaces = ["enp1s0"]
# lm-sensors package required for linux systems
[[inputs.sensors]]
# uncomment this for using with windows (WARNING: telegraf must be run as administrator)
#[[inputs.temp]]
# uncomment this for using with OPNSense/FreeBSD systems
#[[inputs.exec]]
# commands = [
# "sh /usr/local/etc/telegraf-scripts/cputemp-sensors-by-package.sh",
# ]
# timeout = "5s"
# data_format = "influx"
```
Also, this is my script (/usr/local/etc/telegraf-scripts/cputemp-sensors-by-package.sh) for getting/parsing cpu temperatures on OPNSense.
```
#!/bin/sh
sysctl hw.acpi.thermal.tz0.temperature | sed 's/hw\.acpi\.thermal\.tz0\.temperature: /sensors,feature=package_id_0 temp_input=/;s/.$//'
```
### Microcontroller
Configuration is done via serial sending string commands. Any serial terminal software like putty or Arduino IDE serial monitor console can be used.
NOTE: "clear commands" **require whitespace** (separator without value) at end, ex: clear wifi password => "SET_WIFI_PASSWORD ".
| Command | Param | Description | Example |
| ------------------------------- | ------------------- | ---------------------------------------- | -------------------------------------------------------- |
| REBOOT | | Reboot device | **REBOOT** |
| CLEAR_SETTINGS | | Remove all device settings | **CLEAR_SETTINGS** |
| EXPORT_SETTINGS | | Export all device settings | **EXPORT_SETTINGS** |
| CONNECT_WIFI | | Connect (manually) to WIFI | **CONNECT_WIFI** |
| DISCONNECT_WIFI | | Disconnect (manually) to WIFI | **DISCONNECT_WIFI** |
| SET_WIFI_SSID | | Save WIFI SSID | **SET_WIFI_SSID myssid** |
| | | Clear WIFI SSID | **SET_WIFI_SSID** |
| SET_WIFI_PASSWORD | | Save WIFI password | **SET_WIFI_PASSWORD secret** |
| | | Clear WIFI password | **SET_WIFI_PASSWORD** |
| SET_MQTT_TELEGRAF_URI | | Save MQTT uri | **SET_MQTT_TELEGRAF_URI mqtt://192.168.1.1** |
| | | Clear MQTT uri | **SET_MQTT_TELEGRAF_URI** |
| SET_MQTT_USERNAME | | Save MQTT username | **SET_MQTT_USERNAME foobar** |
| | | Clear MQTT username | **SET_MQTT_USERNAME** |
| SET_MQTT_PASSWORD | | Save MQTT password | **SET_MQTT_PASSWORD secret** |
| | | Clear MQTT password | **SET_MQTT_PASSWORD** |
| SET_MQTT_TELEGRAF_GLOBAL_TOPIC | | Save MQTT topic | **SET_MQTT_TELEGRAF_GLOBAL_TOPIC telegraf/myhostname/#** |
| | | Clear MQTT topic | **SET_MQTT_TELEGRAF_GLOBAL_TOPIC** |
| TOGGLE_SCREEN | | Change screen (info/dashboard) | **TOGGLE_SCREEN** |
| SET_MAX_DOWNLOAD_BITS_BANDWITH | | Save net download graph fixed max scale | **SET_MAX_DOWNLOAD_BITS_BANDWITH 1000000000** |
| | | Clear net download graph fixed max scale | **SET_MAX_DOWNLOAD_BITS_BANDWITH** |
| SET_MAX_UPLOAD_BITS_BANDWITH | | Save net upload graph fixed max scale | **SET_MAX_UPLOAD_BITS_BANDWITH 1000000000** |
| | | Clear net upload graph fixed max scale | **SET_MAX_UPLOAD_BITS_BANDWITH** |
| SET_NETWORK_INTERFACE_ID | | Save network interface id | **SET_NETWORK_INTERFACE_ID enp1s0** |
| | | Clear network interface id | **SET_NETWORK_INTERFACE_ID** |
| SET_HOSTNAME | | Save hostname | **SET_HOSTNAME myhostname** |
| | | Clear hostname | **SET_HOSTNAME** |
| SET_SCREEN_MIRROR_FLIP_VERTICAL | | Save screen mirror orientation | **SET_SCREEN_MIRROR_FLIP_VERTICAL true** |
| | | Clear screen mirror orientation | **SET_SCREEN_MIRROR_FLIP_VERTICAL false** |
| SET_DEFAULT_SCREEN | | Save "INFO" as default screen | **SET_DEFAULT_SCREEN 1** |
| | | Save "DASHBOARD" as default screen | **SET_DEFAULT_SCREEN 2** |
| SET_DASHBOARD_BLOCKS | | Set dashboard blocks | **SET_DASHBOARD_BLOCKS 3 2,3,6,7,8** |
| SET_DASHBOARD_BLOCKS | <0,0,0,0,0> | Clear dashboard blocks | **SET_DASHBOARD_BLOCKS 3 0,0,0,0,0** |
#### NOTES:
- Clear MQTT username/password configuration values if your mqtt server/broker do not require authentication.
- SET_MAX_DOWNLOAD_BITS_BANDWITH && SET_MAX_UPLOAD_BITS_BANDWITH configuration values are required to use "NET DOWN" (27) / "NET UP" (28) static, not auto-scale networking blocks (see next section).
#### EXAMPLES:
Configuration for 4 custom dashboards, network interface name => pppoe0 & network interface speed = 1Gbit
```
# EXPORTED SETTINGS BEGIN
CLEAR_SETTINGS
SET_WIFI_SSID YOUR_WIFI_SSID
SET_WIFI_PASSWORD YOUR_WIFI_PASSWORD
SET_MQTT_TELEGRAF_URI mqtt://192.168.1.5
SET_MQTT_USERNAME telegraf_client
SET_MQTT_PASSWORD telegraf_password
SET_MQTT_TELEGRAF_GLOBAL_TOPIC telegraf/OPNsense.localdomain/#
SET_MAX_DOWNLOAD_BITS_BANDWITH 1000000000
SET_MAX_UPLOAD_BITS_BANDWITH 1000000000
SET_NETWORK_INTERFACE_ID pppoe0
SET_HOSTNAME OPNSENSE
SET_DEFAULT_SCREEN 2
SET_DASHBOARD_BLOCKS 1 1,25,26,29,30
SET_DASHBOARD_BLOCKS 2 1,2,3,6,8
SET_DASHBOARD_BLOCKS 3 25,13,15,16,19
SET_DASHBOARD_BLOCKS 4 26,27,28,29,30
REBOOT
# EXPORTED SETTINGS END
```
Configuration without custom dashboards (set by default one dashboard), network interface name => "Ethernet\ 10G\ (SFP+)" & network interface speed = 10Gbit
```
# EXPORTED SETTINGS BEGIN
CLEAR_SETTINGS
SET_WIFI_SSID YOUR_WIFI_SSID
SET_WIFI_PASSWORD YOUR_WIFI_PASSWORD
SET_MQTT_TELEGRAF_URI mqtt://192.168.1.5
SET_MQTT_USERNAME telegraf_client
SET_MQTT_PASSWORD telegraf_password
SET_MQTT_TELEGRAF_GLOBAL_TOPIC telegraf/D-I7-11700/#
SET_MAX_DOWNLOAD_BITS_BANDWITH 10000000000
SET_MAX_UPLOAD_BITS_BANDWITH 10000000000
SET_NETWORK_INTERFACE_ID Ethernet\ 10G\ (SFP+)
SET_HOSTNAME WINDOWS10-I7
SET_DEFAULT_SCREEN 2
REBOOT
# EXPORTED SETTINGS END
```
#### CUSTOMIZE DASHBOARD BLOCKS
Every dashboard / blocks are customized via serial commands. By default, there is only one dashboard (CPU LOAD, MEM USED, CPU TEMP, DYNAMIC NET DOWN, DYNAMIC NET UPLD) that cannot be deleted but can be modified (block exchange). Dashboard configuration must be sequential (a third one cannot be configured if the second one is not established). To delete a dashboard we only have to specify its index and values 0,0,0,0,0
If you want to add more dashboards and the current limit is not enough (currently 8, defined in src/display/DashboardItemType.hpp) you just have to modify the MAX_DASHBOARDS tag and recompile the project
The list of supported block types corresponds to these values (defined in the src/display/DashboardItemType.hpp file):
| TYPE | VALUE | NOTES |
| ------------------ | ----- | -------------------------------------------------------------------------------- |
| NONE | 0 | empty value, used for removing block |
| CPU LOAD | 1 | |
| CPU USER | 2 | |
| CPU SYSTEM | 3 | |
| CPU IDLE | 4 | |
| CPU ACTIVE | 5 | |
| CPU NICE | 6 | |
| CPU IOWAIT | 7 | |
| CPU IRQ | 8 | |
| CPU SOFT IRQ | 9 | |
| CPU STEAL | 10 | |
| CPU GUEST | 11 | |
| CPU GUEST NICE | 12 | |
| MEM ACTIVE | 13 | |
| MEM AVAILABLE | 14 | |
| MEM BUFFERED | 15 | |
| MEM CACHED | 16 | |
| MEM DIRTY | 17 | |
| MEM FREE | 18 | |
| MEM INACTIVE | 19 | |
| MEM LAUNDRY | 20 | |
| MEM MAPPED | 21 | |
| MEM SHARED | 22 | |
| MEM SWAP CACHED | 23 | |
| MEM SWAP FREE | 24 | |
| MEM USED | 25 | |
| CPU TEMP | 26 | |
| NET DOWN | 27 | requires having a **bit limit** set with the **SET_MAX_DOWNLOAD_BITS_BANDWITH** |
| | | y-axis units are defined in multiples of **bits/sec** (using previous max limit) |
| | | current value units are defined in multiples of **bytes/sec** |
| NET UP | 28 | requires having a **bit limit** set with the **SET_MAX_UPLOAD_BITS_BANDWITH** |
| | | y-axis units are defined in multiples of **bits/sec** (using previous max limit) |
| | | current value units are defined in multiples of **bytes/sec** |
| NET DOWN (DYNAMIC) | 29 | y-axis automatically auto-scales with values over time |
| | | y-axis units are defined in multiples of **bytes/sec** |
| | | current value units are defined in multiples of **bytes/sec** |
| NET UP (DYNAMIC) | 30 | y-axis automatically auto-scales with values over time |
| | | y-axis units are defined in multiples of **bytes/sec** |
| | | current value units are defined in multiples of **bytes/sec** |
#### NOTES:
- Not all blocks are supported on all operating systems.
- All network blocks share the same interface (support for multiple interfaces is not available at this time). If we do not specify a single network interface in the telegraf configuration, data will arrive from several interfaces and if one is not configured via serial commands (SET_NETWORK_INTERFACE_ID), they will all be mixed and the data displayed will be incorrect.
## Working screenshots / photos
