From 1f17c7d3b364f066fae8c28d8c06d8ed2c8e005f Mon Sep 17 00:00:00 2001
From: CaCO3 <caco@ruinelli.ch>
Date: Sun, 26 Feb 2023 23:03:17 +0100
Subject: [PATCH] add data logging doc

---
 docs/data-logging.md                                   | 10 ++++++++++
 docs/nav.yml                                           |  1 +
 .../parameter-pages/DataLogging/DataLogActive.md       |  2 +-
 3 files changed, 12 insertions(+), 1 deletion(-)
 create mode 100644 docs/data-logging.md

diff --git a/docs/data-logging.md b/docs/data-logging.md
new file mode 100644
index 0000000..0d4e20a
--- /dev/null
+++ b/docs/data-logging.md
@@ -0,0 +1,10 @@
+# Data Logging
+
+When Data Logging is enabled (See parameter [`DataLogActive`](../Parameters/#parameter-datalogactive)),
+the results of every round gets written to the SD-Card.
+
+The data files are stored in `/log/data` on the SD-Card.
+
+## Data Format
+The data is stored as CSV with the following columns:
+`time`, `name-of-number`, `raw-value`, `return-value`, `pre-value`, `change-rate`, `change-absolute`, `error-text`, `cnn-digital`, `cnn-analog`
\ No newline at end of file
diff --git a/docs/nav.yml b/docs/nav.yml
index 0f07324..2b8a38b 100644
--- a/docs/nav.yml
+++ b/docs/nav.yml
@@ -29,6 +29,7 @@ nav:
     - Parameters.md
     - Integration-Home-Assistant.md
     - External-LED.md
+    - data-logging.md
     - rolling-installation.md
     - Watermeter-specific-analog---digital-transition.md
     - collect-new-images.md
diff --git a/param-docs/parameter-pages/DataLogging/DataLogActive.md b/param-docs/parameter-pages/DataLogging/DataLogActive.md
index 2293481..03e44ff 100644
--- a/param-docs/parameter-pages/DataLogging/DataLogActive.md
+++ b/param-docs/parameter-pages/DataLogging/DataLogActive.md
@@ -2,7 +2,7 @@
 Default Value: `true`
 Activate data logging to the SD-Card.
 
-The files will be stored in `/log/data/data_YYYY-MM-DD.csv`.
+The files will be stored in `/log/data/data_YYYY-MM-DD.csv`. See [`Data Logging`](../data-logging) for details.
 
 !!! Warning
     A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card!