Make services transaltable, be more elaborate in the descriptions. (#59)

- Add a few warnings to the usage of manual charging - Fix sample device IDs
torbennehmer · Sep 19, 2023 · 16fa3e4 · 16fa3e4
2 parents c712191 + 8babb7f
commit 16fa3e4
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -189,8 +189,15 @@ to take advantage of dynamic electricity providers like Tibber. Charge your
 battery when electricity is cheap even if you have no solar power available, for
 example in windy winter nights/days.
 
+Keep conversion losses and battery wear in your mind as well, you'll probably
+need at least a 40-50% difference in costs to make it worth if you actually
+charge from the grid.
+
 Be aware, that calls to this operation seem to be limited, however, this is not
-documented. As always, use at your own risk and discretion.
+documented. Additionally, there may be local laws that regulate if you may
+charge a larger battery from the grid.
+
+Use this feature at your own risk and discretion.
 
 ## Upstream source
 

diff --git a/custom_components/e3dc_rscp/services.yaml b/custom_components/e3dc_rscp/services.yaml
@@ -1,33 +1,23 @@
 clear_power_limits:
-  name: Clear power limits
-  description: Clears any active power limit of the E3DC unit
   fields:
     device_id:
-      name: E3DC Device ID
-      description: E3DC Device ID
       required: true
-      example: "S10-412345678"
+      example: "64d3b74a1bcf319288844ff9e93e4010"
       selector:
         device:
           filter:
             integration: e3dc_rscp
 
 set_power_limits:
-  name: Set power limits
-  description: Sets the maximum charge/discharge limits of the E3DC unit
   fields:
     device_id:
-      name: E3DC Device ID
-      description: E3DC Device ID
       required: true
-      example: "S10-412345678"
+      example: "64d3b74a1bcf319288844ff9e93e4010"
       selector:
         device:
           filter:
             integration: e3dc_rscp
     max_charge:
-      name: Maximum Charge (W)
-      description: Maximum allowed battery charge in Watts
       required: false
       example: "1000"
       selector:
@@ -37,8 +27,6 @@ set_power_limits:
           mode: box
           step: 100
     max_discharge:
-      name: Maximum Discharge (W)
-      description: Maximum allowed battery discharge in Watts
       required: false
       example: "1000"
       selector:
@@ -50,21 +38,15 @@ set_power_limits:
 
 
 manual_charge:
-  name: Control manual charging
-  description: Starts or stops manual charging, set charge amount to zero to stop charging if it is running.
   fields:
     device_id:
-      name: E3DC Device ID
-      description: E3DC Device ID
       required: true
-      example: "S10-412345678"
+      example: "64d3b74a1bcf319288844ff9e93e4010"
       selector:
         device:
           filter:
             integration: e3dc_rscp
     charge_amount:
-      name: Charge amount (Wh)
-      description: Amount to charge in Wh
       required: true
       example: "1000"
       selector:

diff --git a/custom_components/e3dc_rscp/strings.json b/custom_components/e3dc_rscp/strings.json
@@ -152,5 +152,49 @@
         "name": "SmartPower powersaving"
       }
     }
+  },
+  "services": {
+    "clear_power_limits": {
+      "name": "Clear power limits",
+      "description": "Clears any active power limit of the E3DC unit.",
+      "fields": {
+        "device_id": {
+          "name": "E3DC Device ID",
+          "description": "E3DC Device ID, take it either from the YAML-Mode on the website of out of the URL of the device configuration page."
+        }
+      }
+    },
+    "set_power_limits": {
+      "name": "Set power limits",
+      "description": "Sets the maximum charge/discharge limits of the E3DC unit.",
+      "fields": {
+        "device_id": {
+          "name": "E3DC Device ID",
+          "description": "E3DC Device ID, take it either from the YAML-Mode on the website of out of the URL of the device configuration page."
+        },
+        "max_charge": {
+          "name": "Maximum Charge (W)",
+          "description": "Maximum allowed battery charge in Watts."
+        },
+        "max_discharge": {
+          "name": "Maximum Discharge (W)",
+          "description": "Maximum allowed battery discharge in Watts."
+        }
+      }
+    },
+    "manual_charge": {
+      "name": "Control manual charging",
+      "description": "Starts or stops manual charging, set charge amount to zero to stop charging if it is running. Keep conversion losses and battery wear in your mind. Additionally, there may be local laws regualting charging your battery fro the grid. Use this feature at your own risk and discretion.",
+      "fields": {
+        "device_id": {
+          "name": "E3DC Device ID",
+          "description": "E3DC Device ID, take it either from the YAML-Mode on the website of out of the URL of the device configuration page."
+        },
+        "charge_amount": {
+          "name": "Charge amount (Wh)",
+          "description": "Amount to charge in Wh."
+        }
+      }
+    }
   }
 }
diff --git a/custom_components/e3dc_rscp/translations/en.json b/custom_components/e3dc_rscp/translations/en.json
@@ -37,7 +37,7 @@
                 "name": "Power limits"
             },
             "manual-charge-active": {
-              "name": "Manual charge"
+                "name": "Manual charge"
             }
         },
         "sensor": {
@@ -141,7 +141,7 @@
                 "name": "Self consumption - today"
             },
             "manual-charge-energy": {
-              "name": "Energy charged from grid"
+                "name": "Energy charged from grid"
             }
         },
         "switch": {
@@ -152,5 +152,49 @@
                 "name": "SmartPower powersaving"
             }
         }
+    },
+    "services": {
+        "clear_power_limits": {
+            "name": "Clear power limits",
+            "description": "Clears any active power limit of the E3DC unit.",
+            "fields": {
+                "device_id": {
+                    "name": "E3DC Device ID",
+                    "description": "E3DC Device ID, take it either from the YAML-Mode on the website of out of the URL of the device configuration page."
+                }
+            }
+        },
+        "set_power_limits": {
+            "name": "Set power limits",
+            "description": "Sets the maximum charge/discharge limits of the E3DC unit.",
+            "fields": {
+                "device_id": {
+                    "name": "E3DC Device ID",
+                    "description": "E3DC Device ID, take it either from the YAML-Mode on the website of out of the URL of the device configuration page."
+                },
+                "max_charge": {
+                    "name": "Maximum Charge (W)",
+                    "description": "Maximum allowed battery charge in Watts."
+                },
+                "max_discharge": {
+                    "name": "Maximum Discharge (W)",
+                    "description": "Maximum allowed battery discharge in Watts."
+                }
+            }
+        },
+        "manual_charge": {
+            "name": "Control manual charging",
+            "description": "Starts or stops manual charging, set charge amount to zero to stop charging if it is running. Be aware, that this feature is officially only targeted for testing purposes. Depending on your local laws you might actually be required to register the battery at your electric company. Use this feature at your own risk.",
+            "fields": {
+                "device_id": {
+                    "name": "E3DC Device ID",
+                    "description": "E3DC Device ID, take it either from the YAML-Mode on the website of out of the URL of the device configuration page."
+                },
+                "charge_amount": {
+                    "name": "Charge amount (Wh)",
+                    "description": "Amount to charge in Wh."
+                }
+            }
+        }
     }
 }