Documentations and translations

antibill51 · Jan 11, 2024 · 657012e · 657012e
1 parent 116415f
commit 657012e
Show file tree

Hide file tree

Showing 9 changed files with 178 additions and 34 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -42,20 +42,6 @@ Report a bug by [opening a new issue](../../issues/new/choose); it's that easy!
 
 People *love* thorough bug reports. I'm not even kidding.
 
-## Use a Consistent Coding Style
-
-Use [black](https://github.com/ambv/black) to make sure the code follows the style.
-
-## Test your code modification
-
-This custom component is based on [blueprint template](https://github.com/custom-components/blueprint).
-
-It comes with development environment in a container, easy to launch
-if you use Visual Studio Code. With this container you will have a stand alone
-Home Assistant instance running and already configured with the included
-[`.devcontainer/configuration.yaml`](https://github.com/oncleben31/ha-pool_pump/blob/master/.devcontainer/configuration.yaml)
-file.
-
 ## License
 
 By contributing, you agree that your contributions will be licensed under its MIT License.
diff --git a/README.md b/README.md
@@ -11,8 +11,9 @@ Platform | Description
 
 ## Installation
 
-Use [hacs](https://hacs.xyz/).
+Use [hacs](https://hacs.xyz/). (Recommended method)
 [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=antibill51&repository=rika-firenet-custom-component)
+
 or:
 
 1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).
@@ -29,26 +30,184 @@ or:
 
 ![alt text](https://raw.githubusercontent.com/antibill51/rika-firenet-custom-component/main/Screenshot/capture.png)
 
-### Cards :
+### HA config :
+```
+sensor:
+  - platform: template
+    sensors:
+      stove_activity:
+        friendly_name: Stove activity
+        value_template: >
+          {% if states.sensor.rika_domo_stove_burning.state == 'True' %}
+            {{states.number.rika_domo_heating_power.state}}
+          {%else %}
+            {{0}}
+          {% endif %}
+        unit_of_measurement: "%"
+```
+
+### Cards needed :
 
 custom:config-template-card
 custom:stack-in-card
 custom:bar-card
 custom:mini-graph-card
 custom:simple-thermostat
 
-Pellet in stock, tank level.
+For pellet in stock : 
 I use GSG2.0 for Pellet stock. https://domotique-home.fr/gestion-de-chauffage-stock-de-granules-gsg/
 
+### Lovelace card basic example : 
+
+```
+type: custom:config-template-card
+variables:
+  IMG: states['climate.rika_domo'].attributes.entity_picture
+  POWER: |
+    { (states['number.rika_domo_heating_power'].state)*1 }
+  STEP: states['number.rika_domo_heating_power'].attributes.step
+entities:
+  - climate.rika_domo
+  - number.rika_domo_heating_power
+card:
+  type: custom:stack-in-card
+  cards:
+    - type: picture-elements
+      image: https://upload.wikimedia.org/wikipedia/commons/5/59/Empty.png
+      elements:
+        - type: image
+          entity: climate.rika_domo
+          image: ${IMG}
+          filter: none
+          style:
+            top: 42%
+            left: 50%
+            width: 30%
+        - type: state-label
+          entity: sensor.rika_domo_stove_status
+          tap_action: none
+          hold_action: none
+          style:
+            top: 17%
+            left: 50%
+            font-size: 15px
+        - type: state-label
+          entity: climate.rika_domo
+          attribute: friendly_name
+          tap_action: none
+          hold_action: none
+          style:
+            top: 08%
+            left: 17%
+            font-size: 18px
+        - type: state-label
+          entity: sensor.stove_activity
+          prefix: 'Puissance de chauffe : '
+          tap_action: none
+          hold_action: none
+          style:
+            top: 97%
+            left: 50%
+            font-size: 15px
+            color: red
+        - type: state-label
+          entity: sensor.rika_domo_pellets_before_service
+          prefix: 'Service : '
+          tap_action: none
+          hold_action: none
+          style:
+            top: 97%
+            left: 90%
+            font-size: 11px
+        
+        - type: state-label
+          entity: climate.rika_domo
+          attribute: current_temperature
+          suffix: °C
+          tap_action: none
+          hold_action: none
+          style:
+            color: '#3498db'
+            top: 88%
+            left: 50%
+            font-size: 27px
+        - type: state-label
+          entity: number.rika_domo_heating_power
+          tap_action: none
+          hold_action: none
+          style:
+            top: 42%
+            left: 85%
+            font-size: 35px
+            color: orange
+        - type: icon
+          icon: mdi:chevron-up
+          title: ${POWER+STEP}
+          tap_action:
+            action: call-service
+            service: number.set_value
+            service_data:
+              entity_id: number.rika_domo_heating_power
+              value: ${POWER+STEP}
+          hold_action: none
+          style:
+            top: 20%
+            left: 79%
+            transform: scale(1,1)
+        - type: icon
+          icon: mdi:chevron-down
+          title: ${POWER-STEP}
+          tap_action:
+            action: call-service
+            service: number.set_value
+            service_data:
+              entity_id: number.rika_domo_heating_power
+              value: ${POWER-STEP}
+          hold_action: none
+          style:
+            top: 54%
+            left: 79%
+            transform: scale(1,1)
+    - type: custom:simple-thermostat
+      style: |
+        ha-card {
+          --st-spacing: 1.5px;
+        }
+      entity: climate.rika_domo
+      show_header: true
+      decimals: '1'
+      unit: °c
+      step_size: '0.5'
+      setpoints: false
+      header: false
+      control: true
+      hide:
+        state: true
+        temperature: true
+      layout:
+        mode:
+          names: true
+          icons: false
+          headings: false
+      control:control:
+        - hvac
+        - preset
+      step_layout: column
+    - type: entities
+      entities:
+        - entity: switch.rika_domo_eco_mode
+```
+
 ### Informations: 
 
 I bypass Rika built'in thermostat with PID Thermostat.
 
-Examples in HA config folder. (lovelace / automations / ...)
+More examples are in HA config folder. (lovelace / automations / ...)
+
+rika_domo: name of the stove from this component. Replace with your's.
 
-rika_domo: name of the stove from this component. Replace with your.
 climate.rika: PID thermostat using https://github.com/antibill51/HASmartThermostat (fork of https://github.com/ScratMan/HASmartThermostat with toggle_header for hvac_action with pwm: 0 ).
-climate.rika_z2: PID thermostat.
+climate.rika_z2: PID thermostat for multiair2.
 
 If I forgot elements, ask for it ;)
 
@@ -87,6 +246,8 @@ utility_meter:
 
 If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)
 
+Si besoin, les échanges en français sont également acceptés.
+
 ***
 
 [rikafirenet]: https://github.com/antibill51/rika-firenet-custom-component

diff --git a/custom_components/rika_firenet/const.py b/custom_components/rika_firenet/const.py
@@ -21,7 +21,7 @@
 
 SUPPORT_PRESET = [PRESET_NONE, PRESET_COMFORT]
 
-VERSION = "2.29.2"
+VERSION = "2.29.2a"
 DOMAIN = "rika_firenet"
 
 UNIQUE_ID = "unique_id"

diff --git a/custom_components/rika_firenet/manifest.json b/custom_components/rika_firenet/manifest.json
@@ -1,7 +1,7 @@
 {
   "domain": "rika_firenet",
   "name": "Rika Firenet",
-  "codeowners": ["@antibill51"],
+  "codeowners": ["@Fockaert,@antibill51"],
   "config_flow": true,
   "dependencies": [],
   "documentation": "https://github.com/antibill51/rika-firenet-custom-component/",
@@ -11,5 +11,5 @@
     "bs4",
     "requests"
   ],
-  "version": "2.29.2"
+  "version": "2.29.2a"
 }
diff --git a/custom_components/rika_firenet/translations/de.json b/custom_components/rika_firenet/translations/de.json
@@ -48,6 +48,7 @@
           "burn_off": "Ausbrand",
           "split_log_check": "Scheitholzcheck",
           "split_log_mode": "Scheitholzbetrieb",
+          "split_log_stop_refuel": "Kein Holz hinzufügen",
           "unknown": "Unbekanntes Problem",
           "offline": "Verlassen",
           "smoke_fan": "Error smoke fan",

diff --git a/custom_components/rika_firenet/translations/en.json b/custom_components/rika_firenet/translations/en.json
@@ -48,6 +48,7 @@
           "burn_off": "Burn off",
           "split_log_check": "Split log check",
           "split_log_mode": "Split log mode",
+          "split_log_stop_refuel": "Split log stop refuel",
           "unknown": "Unknown",
           "offline": "Offline",
           "smoke_fan": "Error smoke fan",

diff --git a/custom_components/rika_firenet/translations/fr.json b/custom_components/rika_firenet/translations/fr.json
@@ -48,6 +48,7 @@
           "burn_off": "Fin de combustion",
           "split_log_check": "Contrôle de la présence du bois",
           "split_log_mode": "Mode bois",
+          "split_log_stop_refuel": "Ne pas réalimenter",
           "unknown": "Inconnu",
           "offline": "Déconnecté",
           "smoke_fan": "Erreur ventil. fumée",

diff --git a/custom_components/rika_firenet/translations/nl.json b/custom_components/rika_firenet/translations/nl.json
@@ -48,6 +48,7 @@
           "burn_off": "Uitdoven",
           "split_log_check": "Hout check",
           "split_log_mode": "Regeling Hout",
+          "split_log_stop_refuel": "Niet opnieuw voeden",
           "unknown": "Onbekend",
           "offline": "Losgekoppeld",
           "smoke_fan": "Error smoke fan",

diff --git a/info.md b/info.md
@@ -2,7 +2,6 @@
 [![GitHub Activity][commits-shield]][commits]
 [![Community Forum][forum-shield]][forum]
 
-_Component to integrate with [blueprint][blueprint]._
 
 **This component will set up the following platforms.**
 
@@ -21,7 +20,8 @@ Platform | Description
 
 ## Configuration is done in the UI
 
-Data list : 
+## Data list : 
+```
 {
    "name":"Rika DOMO",
    "stoveID":"27252457",
@@ -89,20 +89,16 @@ Data list :
       "inputUpperTemperatureLimiter":true,
       "inputPressureSwitch":true,
       "inputPressureSensor":0,
-
       "inputGridContact":true,
       "inputDoor":true,
       "inputCover":true,
       "inputExternalRequest":true,
       "inputBurnBackFlapSwitch":true,
       "inputFlueGasFlapSwitch":true,
-
       "inputBoardTemperature":"2.7",
-
       "inputCurrentStage":30,
       "inputTargetStagePID":70,
       "inputCurrentStagePID":30,
-
       "statusMainState":3,
       "statusSubState":1,
       "statusWifiStrength":-67,
@@ -123,9 +119,7 @@ Data list :
       "parameterRuntimeLogs":0,
       "parameterFeedRateTotal":4500,
       "parameterFeedRateService":978,
-
       "parameterServiceCountdownKg":22,
-
       "parameterServiceCountdownTime":0,
       "parameterIgnitionCount":2087,
       "parameterOnOffCycleCount":197,
@@ -165,20 +159,19 @@ Data list :
    },
    "stoveType":"DOMO MultiAir",
    "stoveFeatures":{
-
       "multiAir1":true,
       "multiAir2":true,
-
       "insertionMotor":false,
       "airFlaps":false,
       "logRuntime":false,
       "bakeMode":false
    },
    "oem":"RIKA"
 }
+```
 <!---->
 ***
-
+Si besoin, les échanges en français sont également acceptés.
 [rika_firenet]: https://github.com/antibill51/rika-firenet-custom-component
 [commits]: https://github.com/antibill51/rika-firenet-custom-component/commits/main
 [forum]: https://community.home-assistant.io/