summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..11997c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+Contains two scripts:
+ - Bash script generating rrd database and generating graphs from it
+ - Python script readding from MQTT and updating rrd database
+ - Settings for the Python script
+
+DEPENDENCIES:
+ - configparser
+ - paho
+ - rrdtool
+ kernel support ( amongst others (: ):
+ - CONFIG_USB_VIDEO_CLASS
+
+Steps to get going:
+ - Generate rrd file with ./generate_rrd_db.sh -c -i <rrd-file>
+ - Set up MQTT broker.
+ - Set up Raspberry Pi pico (Pico project in Micropython section)
+ - Fill in settings.cfg with your data
+ - Set up certificates (Check out Pico project for Bash script generating them)
+ - Run Python script.
+ - Set up cron job regenerating graphs with frequency to your liking.
+
+(So that I don't forget:)
+What is still missing:
+ - Python script should run as a daemon.
+ - Python script could generate more graphs based on averages from rrd database showing long term trends.
+ - Graph generation could be done with rrdcgi (not sure it is needed though)
+ - Documentation is lacking detailed step by step setup guide.