Add description of minimum needed telemetryDimensions

Joolee · Feb 26, 2022 · a1f77e0 · a1f77e0
1 parent 50b58b1
commit a1f77e0
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/lib/Telemetry.js b/lib/Telemetry.js
@@ -5,6 +5,17 @@ const TelemetryDimensions = require('/assets/json/telemetryDimensions.json');
 const http = require('http.min');
 const util = require('util');
 
+/*
+	/assets/json/telemetryDimensions.json must contain at least:
+	["-"
+		"App version",
+		"Homey firmware version",
+		"Debug mode"
+	]
+
+	These value locations (in this case, 1, 2 and 3) must also be defined as Matomo Custom Dimensions (type 'Visit') with corresponding ID's.
+*/
+
 module.exports = class Telemetry extends Homey.SimpleClass {
 	constructor({
 		host,