From 4878e7bcae835ee686794c9be28735afab2777c9 Mon Sep 17 00:00:00 2001
From: atef <sarraj@innov.energy>
Date: Fri, 10 Nov 2023 11:02:47 +0100
Subject: [PATCH] Add a readme file for the config.json

---
 csharp/App/SaliMax/resources/ConfigReadme.txt | 110 ++++++++++++++++++
 1 file changed, 110 insertions(+)
 create mode 100644 csharp/App/SaliMax/resources/ConfigReadme.txt

diff --git a/csharp/App/SaliMax/resources/ConfigReadme.txt b/csharp/App/SaliMax/resources/ConfigReadme.txt
new file mode 100644
index 000000000..a47ab3469
--- /dev/null
+++ b/csharp/App/SaliMax/resources/ConfigReadme.txt
@@ -0,0 +1,110 @@
+"MinSoc": Number, 0 - 100 this is the minimum State of Charge that the batteries must not go below,
+  "ForceCalibrationCharge": Boolean (true or false), A flag to force a calibration charge,
+  "DisplayIndividualBatteries": Boolean (true or false), To display the indvidual batteries
+  "PConstant": Number 0 - 1,  P value of our controller.
+  "GridSetPoint": Number in Watts, The set point of our controller.
+  "BatterySelfDischargePower": Number, 200,  this a physical measurement of the self discharging power.
+  "HoldSocZone": Number, 1, This is magic number for the soft landing factor.
+  "IslandMode": { // Dc Link Voltage in Island mode
+    "AcDc": {
+      "MaxDcLinkVoltage": Number, 810, Max Dc Link Voltage,
+      "MinDcLinkVoltage": Number, 690, Min Dc Link Voltage,
+      "ReferenceDcLinkVoltage": Number, 750, Reference Dc Link
+    },
+    "DcDc": {
+      "LowerDcLinkVoltage": Number, 50, Lower Dc Link Window ,
+      "ReferenceDcLinkVoltage": 750, reference Dc Link
+      "UpperDcLinkVoltage": Number, 50, Upper Dc Link Window ,
+    }
+  },
+  "GridTie": {// Dc Link Voltage in GrieTie mode
+    "AcDc": {
+      "MaxDcLinkVoltage":Number, 780, Max Dc Link Voltage,
+      "MinDcLinkVoltage": Number, 690, Min Dc Link Voltage,
+      "ReferenceDcLinkVoltage": Number, 750, Reference Dc Link
+    },
+    "DcDc": {
+     "LowerDcLinkVoltage": Number, 20, Lower Dc Link Window ,
+      "ReferenceDcLinkVoltage": 750, reference Dc Link
+      "UpperDcLinkVoltage": Number, 20, Upper Dc Link Window ,
+    }
+  },
+  "MaxBatteryChargingCurrent":Number, 0 - 210, Max Charging current by DcDc
+  "MaxBatteryDischargingCurrent":Number, 0 - 210, Max Discharging current by DcDc
+  "MaxDcPower": Number, 0 - 10000, Max Power exported/imported by DcDc (10000 is the maximum)
+  "MaxChargeBatteryVoltage": Number, 57, Max Charging battery Voltage
+  "MinDischargeBatteryVoltage": Number, 0, Min Charging Battery Voltage
+  "Devices": { This is All Salimax devices (including offline ones)
+    "RelaysIp": {
+      "DeviceState": 1, // 0: is not present, 1: Present and Can be mesured, 2: Present but must be computed/calculted
+      "Host": "10.0.1.1", // Ip @ of the device in the local network
+      "Port": 502   // port
+    },
+    "GridMeterIp": {
+      "DeviceState": 1,
+      "Host": "10.0.4.1",
+      "Port": 502
+    },
+    "PvOnAcGrid": {
+      "DeviceState": 0, // If a device is not present
+      "Host": "false", // this is not important
+      "Port": 0 // this is not important
+    },
+    "LoadOnAcGrid": {
+      "DeviceState": 2, // this is a computed device
+      "Host": "true",
+      "Port": 0
+    },
+    "PvOnAcIsland": {
+      "DeviceState": 0,
+      "Host": "false",
+      "Port": 0
+    },
+    "IslandBusLoadMeterIp": {
+      "DeviceState": 1,
+      "Host": "10.0.4.2",
+      "Port": 502
+    },
+    "TruConvertAcIp": {
+      "DeviceState": 1,
+      "Host": "10.0.2.1",
+      "Port": 502
+    },
+    "PvOnDc": {
+      "DeviceState": 1,
+      "Host": "10.0.5.1",
+      "Port": 502
+    },
+    "LoadOnDc": {
+      "DeviceState": 0,
+      "Host": "false",
+      "Port": 0
+    },
+    "TruConvertDcIp": {
+      "DeviceState": 1,
+      "Host": "10.0.3.1",
+      "Port": 502
+    },
+    "BatteryIp": {
+      "DeviceState": 1,
+      "Host": "localhost",
+      "Port": 6855
+    },
+    "BatteryNodes": [ // this is a list of battery nodes
+      2,
+      3,
+      4,
+      5,
+      6
+    ]
+  },
+  "S3": { // this is parameters of S3 Buckets and co
+    "Bucket": "8-3e5b3069-214a-43ee-8d85-57d72000c19d",
+    "Region": "sos-ch-dk-2",
+    "Provider": "exo.io",
+    "Key": "EXO502627299197f83e8b090f63",
+    "Secret": "jUNYJL6B23WjndJnJlgJj4rc1i7uh981u5Aba5xdA5s",
+    "ContentType": "text/plain; charset=utf-8",
+    "Host": "8-3e5b3069-214a-43ee-8d85-57d72000c19d.sos-ch-dk-2.exo.io",
+    "Url": "https://8-3e5b3069-214a-43ee-8d85-57d72000c19d.sos-ch-dk-2.exo.io"
+  }