From 87577f6d7180d31620f754e5548a4108104794f1 Mon Sep 17 00:00:00 2001
From: Daniel Tartavel <dtux@free.fr>
Date: Sat, 10 Sep 2022 14:58:55 +0200
Subject: [PATCH] added templates

---
 README.md                             |  5 ++++
 config/aliases.php.template           |  7 +++++
 config/config.php.template            | 12 ++++++++
 config/dashboard_conf.php.template    | 13 +++++++++
 config/dbConfig.php.template          |  7 +++++
 config/devices_constants.php.template | 19 +++++++++++++
 config/liste_telephones.php.template  | 10 +++++++
 config/properties2log.php.template    | 41 +++++++++++++++++++++++++++
 config/users.php.template             |  9 ++++++
 9 files changed, 123 insertions(+)
 create mode 100644 config/aliases.php.template
 create mode 100644 config/config.php.template
 create mode 100644 config/dashboard_conf.php.template
 create mode 100644 config/dbConfig.php.template
 create mode 100644 config/devices_constants.php.template
 create mode 100644 config/liste_telephones.php.template
 create mode 100644 config/properties2log.php.template
 create mode 100644 config/users.php.template

diff --git a/README.md b/README.md
index a288677..e547c60 100644
--- a/README.md
+++ b/README.md
@@ -9,3 +9,8 @@ You must configure sudoers to allow usr domotique to execute nmap and systemctl
 
 Cmnd_Alias DOM = /usr/bin/nmap, /usr/bin/systemctl restart presenceD.service
 domotique ALL=(ALL) NOPASSWD: DOM
+
+
+php-mosquitto:
+
+https://mosquitto-php.readthedocs.io/en/latest/overview.html#installation
diff --git a/config/aliases.php.template b/config/aliases.php.template
new file mode 100644
index 0000000..ad40273
--- /dev/null
+++ b/config/aliases.php.template
@@ -0,0 +1,7 @@
+<?php
+
+$aliases = array(
+		//"<friendlyName" => "<alias>",
+)
+
+?>
diff --git a/config/config.php.template b/config/config.php.template
new file mode 100644
index 0000000..2ca0897
--- /dev/null
+++ b/config/config.php.template
@@ -0,0 +1,12 @@
+<?php
+
+$notificationLevel = ALERT;
+$logLevel = DEBUG | INFO | NOTICE | WARNING | ERROR | ALERT;
+
+// le premier utilisateur est l'utilisateur par défaut
+$defaultUser = array(
+//"<friendlyName>" => "<userName>",
+// example: "rdc" => "Daniel",
+);
+
+?>
diff --git a/config/dashboard_conf.php.template b/config/dashboard_conf.php.template
new file mode 100644
index 0000000..64edec4
--- /dev/null
+++ b/config/dashboard_conf.php.template
@@ -0,0 +1,13 @@
+<?php
+	// $dashboards["<dashboardName>"] =array(
+	//array(<device constant>, "<property>")
+	//);
+
+	/* example:
+	$dashboards["default"] = array(
+		array(RDC_SALON_ECLAIRAGE_PANNEAU, "state"),
+		array(RDC_SDB_WC_ECLAIRAGE, "state_l1"),
+	);
+	*/
+
+?>
diff --git a/config/dbConfig.php.template b/config/dbConfig.php.template
new file mode 100644
index 0000000..565b365
--- /dev/null
+++ b/config/dbConfig.php.template
@@ -0,0 +1,7 @@
+<?php
+	// configuration of mysql server
+	$mysqlServer = "<server address>";		// Your production server
+	$username = "";
+	$passwd = "";
+	$database = "";
+?>
diff --git a/config/devices_constants.php.template b/config/devices_constants.php.template
new file mode 100644
index 0000000..2a75c77
--- /dev/null
+++ b/config/devices_constants.php.template
@@ -0,0 +1,19 @@
+<?php
+
+/************************************************************************************/
+/*edit this file for defining constants of devices									*/
+/*e.g.																				*/
+/* $deviceTable = array( <ieeeAddress of device> => <name of the constant>, ...);	*/
+/************************************************************************************/
+
+$deviceTable = array(
+	//example: "0x00124b0022ebac5c" => "RDC_SALON_MVMT2",
+);
+
+foreach($deviceTable as $device => $name)
+{
+	define($name, $device);
+}
+
+?>
+
diff --git a/config/liste_telephones.php.template b/config/liste_telephones.php.template
new file mode 100644
index 0000000..6ac6ee6
--- /dev/null
+++ b/config/liste_telephones.php.template
@@ -0,0 +1,10 @@
+<?php
+
+// Liste of mac Addresses of persons
+
+$macAddresses = array(
+//example: "E8:78:29:C2:79:22" => "Daniel",
+
+);
+
+?>
diff --git a/config/properties2log.php.template b/config/properties2log.php.template
new file mode 100644
index 0000000..0eff6dd
--- /dev/null
+++ b/config/properties2log.php.template
@@ -0,0 +1,41 @@
+<?php
+
+// list of properties to log in database
+// key is property name => value is % of difference with stocked value. if new value is stored if
+// superior or inferior at value +/- x%
+
+$properties2log = array(
+	"action" => null,
+	"state" =>null,
+	"contact" => null,
+	"temperature" => 0.5,
+	"local_temperature" => 0.5,
+	"state_l1" => null,
+	"state_l2" => null,
+	"current_heating_setpoint" => null,
+	"position" => null,
+	"pressure" => 10,
+	"occupancy" => null,
+	"illuminance_lux" => function($value) {$r = ($value < 500?50:$value*10/100); return $r;},
+	"requested_brightness_level" => function($value) {$r = ($value < 500?50:$value*10/100);return $r;},
+	"tempc" => 0.5,
+	"humidity" => 2,
+	"dewptc" => 0.5,
+	"windchillc" => 0.5,
+	"winddir" => 40,
+	"windspeedkmh" => 5,
+	"windgustkmh" => 5,
+	"rainin" => 0.5,
+	//"dailyrainin" => null,
+	//"weeklyrainin" => null,
+	//"monthlyrainin" => null,
+	//"yearlyrainin" => null,
+	"solarradiation" => 10,
+	"UV" => null,
+	"indoortempc" => 0.5,
+	"indoorhumidity" => 0.5,
+	"baromin" => 10,
+	"presence" => null,
+	"vibration" => null
+	);
+
diff --git a/config/users.php.template b/config/users.php.template
new file mode 100644
index 0000000..9e59fe4
--- /dev/null
+++ b/config/users.php.template
@@ -0,0 +1,9 @@
+<?php
+
+$users = array(
+	//example: "Daniel",
+)
+
+?>
+
+