gazpar2haws 0.2.1__py3-none-any.whl → 0.3.0b15__py3-none-any.whl

{gazpar2haws-0.2.1.dist-info → gazpar2haws-0.3.0b15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gazpar2haws
-Version: 0.2.1
+Version: 0.3.0b15
 Summary: Gazpar2HAWS is a gateway that reads data history from the GrDF (French gas provider) meter and send it to Home Assistant using WebSocket interface
 License: MIT License
          
@@ -29,6 +29,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pydantic-extra-types (>=2.10.2,<3.0.0)
+Requires-Dist: pydantic[email] (>=2.10.6,<3.0.0)
 Requires-Dist: pygazpar (>=1.2.7)
 Requires-Dist: pyyaml (>=6.0.2)
 Requires-Dist: websockets (>=14.1)
@@ -216,6 +218,262 @@ The history is uploaded on the entities with names:
 
 `${name}` is 'gazpar2haws' defined in the above configuration file. It can be replaced by any other name.
 
+### Cost configuration
+
+Gazpar2HAWS is able to compute and publish cost history to Home Assistant.
+
+The cost computation is based in gas prices defined in the configuration files.
+
+The section 'Pricing' is broken into 5 sub-sections:
+- vat: Value added tax definition.
+- consumption_prices: All the gas price history in €/kWh.
+- subscription_prices: The subscription prices in €/month (or year).
+- transport_prices: The fixed prices in €/month (or year) to transport the gas.
+- energy_taxes: Various taxes on energy in €/kWh.
+
+Below, many examples illustrates how to use pricing configuration for use cases from the simplest to the most complex.
+
+
+Example 1: A fixed consumption price
+---
+
+The given price applies at the given date, after and before.
+
+The default unit is € per kWh.
+
+**Formula:**
+```math
+cost[€] = quantity[kWh] * price[€/kWh]
+```
+
+
+```yaml
+pricing:
+  consumption_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.07790 # Default unit is €/kWh.
+```
+
+Example 2: A fixed consumption price in another unit
+---
+
+*value_unit* is the price unit (default: €).
+*base_unit* is the denominator unit (default: kWh).
+
+**Formula:**
+```math
+cost[€] = \frac{quantity[kWh] * price[¢/MWh] * converter\_factor[¢->€]} {converter\_factor[MWh->kWh]}
+```
+
+
+```yaml
+pricing:
+  consumption_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 7790.0 # Unit is now ¢/MWh.
+      value_unit: "¢"
+      base_unit: "MWh"
+```
+
+Example 3: Multiple prices over time
+---
+
+```yaml
+pricing:
+  consumption_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.07790 # Default unit is €/kWh.
+    - start_date: "2024-01-01"
+      value: 0.06888 # Default unit is €/kWh.
+```
+
+Price is 0.07790 before 2024-01-01.
+
+Price is 0.06888 on 2024-01-01 and after.
+
+
+Example 4: Price is given excluding tax
+---
+
+The *normal* value added tax (*vat*) rate is 20%.
+
+```yaml
+pricing:
+  vat:
+    - id: normal
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.20 # It is the tax rate in [0, 1.0] <==> [0% - 100%].
+  consumption_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.07790 # Default unit is €/kWh.
+      vat_id: "normal" # Reference to the vat rate that is applied for this period.
+```
+
+**Formula:**
+```math
+cost[€] = quantity[kWh] * price[€/kWh] * (1 + vat[normal])
+```
+
+Example 5: Subscription price
+---
+
+A fixed montly subscription is due over consumption.
+
+Subscription *vat* tax may be different than the consumption *vat* tax.
+
+```yaml
+pricing:
+  vat:
+    - id: normal
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.20 # It is the tax rate in [0, 1.0] <==> [0% - 100%].
+    - id: reduced
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.0550
+  consumption_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.07790 # Default unit is €/kWh.
+      vat_id: "normal" # Reference to the vat rate that is applied for this period.
+  subscription_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 19.83
+      value_unit: "€"
+      base_unit: "month"
+      vat_id: "reduced"
+```
+
+**Formula:**
+```math
+cost[€] = quantity[kWh] * cons\_price[€/kWh] * (1 + vat[normal]) + sub\_price * (1 + vat[reduced])
+```
+
+
+Example 6: Transport price
+---
+
+A fixed yearly transport may be charged as well.
+
+```yaml
+pricing:
+  vat:
+    - id: normal
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.20 # It is the tax rate in [0, 1.0] <==> [0% - 100%].
+    - id: reduced
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.0550
+  consumption_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.07790 # Default unit is €/kWh.
+      vat_id: "normal" # Reference to the vat rate that is applied for this period.
+  transport_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 34.38
+      value_unit: "€"
+      base_unit: "year"
+      vat_id: reduced
+```
+**Formula:**
+```math
+cost[€] = quantity[kWh] * cons\_price[€/kWh] * (1 + vat[normal]) + trans\_price * (1 + vat[reduced])
+```
+
+Example 7: Energy taxes
+---
+
+Consumption may be taxed by additional taxes (known as energy taxes).
+
+```yaml
+pricing:
+  vat:
+    - id: normal
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.20 # It is the tax rate in [0, 1.0] <==> [0% - 100%].
+    - id: reduced
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.0550
+  consumption_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.07790 # Default unit is €/kWh.
+      vat_id: "normal" # Reference to the vat rate that is applied for this period.
+  energy_taxes:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.00837
+      value_unit: "€"
+      base_unit: "kWh"
+      vat_id: normal
+```
+**Formula:**
+```math
+cost[€] = quantity[kWh] * (cons\_price[€/kWh] + ener\_taxes[€/kWh])* (1 + vat[normal])
+```
+
+Example 8: All in one
+---
+
+In the price list, the first item properties are propagated to the next items in the list. If their values does not change, it is not required to repeat them.
+
+```yaml
+pricing:
+  vat:
+    - id: reduced
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.0550
+    - id: normal
+      start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.20
+  consumption_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.07790
+      value_unit: "€"
+      base_unit: "kWh"
+      vat_id: normal
+    - start_date: "2023-07-01"
+      value: 0.05392
+    - start_date: "2023-08-01"
+      value: 0.05568
+    - start_date: "2023-09-01"
+      value: 0.05412
+    - start_date: "2023-10-01"
+      value: 0.06333
+    - start_date: "2023-11-01"
+      value: 0.06716
+    - start_date: "2023-12-01"
+      value: 0.07235
+    - start_date: "2024-01-01"
+      value: 0.06888
+    - start_date: "2024-02-01"
+      value: 0.05972
+    - start_date: "2024-03-01"
+      value: 0.05506
+    - start_date: "2024-04-01"
+      value: 0.04842
+    - start_date: "2025-01-01"
+      value: 0.07807
+  subscription_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 19.83
+      value_unit: "€"
+      base_unit: "month"
+      vat_id: reduced
+    - start_date: "2023-07-01"
+      value: 20.36
+  transport_prices:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 34.38
+      value_unit: "€"
+      base_unit: "year"
+      vat_id: reduced
+  energy_taxes:
+    - start_date: "2023-06-01" # Date of the price. Format is "YYYY-MM-DD".
+      value: 0.00837
+      value_unit: "€"
+      base_unit: "kWh"
+      vat_id: normal
+    - start_date: "2024-01-01"
+      value: 0.01637
+```
+
 ### Environment variable for Docker
 
 In a Docker environment, the configurations files are instantiated by replacing the environment variables below in the template files:

gazpar2haws-0.3.0b15.dist-info/RECORD

@@ -0,0 +1,15 @@
+gazpar2haws/__init__.py,sha256=3MCDQdGGmT3FQMKaAB3mBJq7L75T_bJSdpDRjE-pado,58
+gazpar2haws/__main__.py,sha256=wD28dqa3weiz5cj9--hgLLN7FnW0eeA9ZmlIvriKXNk,3125
+gazpar2haws/bridge.py,sha256=VEl22xt2Szgk_FVrxSvZNxp3T5Q2JXc9ulfrunHHkmo,3685
+gazpar2haws/config_utils.py,sha256=yT2G-naMA2Vst6bQdm1bD2oVsPTU3Q_RuukCs-dZ6Ak,2280
+gazpar2haws/configuration.py,sha256=24q8FUBMS1vpqU6RYAv5Au179HbiBk1CZIEMiBGuXq0,722
+gazpar2haws/date_array.py,sha256=XQ8gwTl0w97ADjs6igdMZLxtPPrDWTLQzhhzTDVjC4M,8761
+gazpar2haws/gazpar.py,sha256=o2YT9M1m7YRhuk7TBuUOOwf9ZElPASjTpUwRpHpDsss,12574
+gazpar2haws/haws.py,sha256=1ELdompdACNf5XkpjCN6Bdiw7stPfzar3x8OjoBmhxQ,7969
+gazpar2haws/model.py,sha256=-1yhLNNcEvEtW67GMVLZ4lcXw6Lk75kWvrdjoVgjKCw,7055
+gazpar2haws/pricer.py,sha256=YhMfvAKSxQhE2JGgrkNOpqQZdTWjGZ_bUtNsYA0u2fs,21932
+gazpar2haws/version.py,sha256=9Iq5Jm63Ev7QquCjhDqa9_KAgHdKl9FJHynq8M6JNrY,83
+gazpar2haws-0.3.0b15.dist-info/LICENSE,sha256=ajApZPyhVx8AU9wN7DXeRGhoWFqY2ylBZUa5GRhTmok,1073
+gazpar2haws-0.3.0b15.dist-info/METADATA,sha256=qtXzqYtd_Wl0p8TGEzYI1z7WsUbtlR6BVVOwq7a0NXs,17406
+gazpar2haws-0.3.0b15.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+gazpar2haws-0.3.0b15.dist-info/RECORD,,

gazpar2haws-0.2.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-gazpar2haws/__init__.py,sha256=3MCDQdGGmT3FQMKaAB3mBJq7L75T_bJSdpDRjE-pado,58
-gazpar2haws/__main__.py,sha256=KdhkowqJP6L8WTF9FNpTy4ZzDf1OPARm6mVtMclxGFk,3265
-gazpar2haws/bridge.py,sha256=IDunENo7bQ9NDov76IEefAkMOen-6Wc_2NZcHGyk_XI,4601
-gazpar2haws/config_utils.py,sha256=r8BvrA1r8huF-qjvQb0P1JYDLqzDleirLjOcj0xOyyU,2253
-gazpar2haws/gazpar.py,sha256=29RfLxBaBCpoopOBpCX3xh681Ksm5pjZlLu9l3PqTAI,10321
-gazpar2haws/haws.py,sha256=H--UWGECYq9JYlbU6IHLO2btaRXInwoVRZnHIXSA1ts,8169
-gazpar2haws/version.py,sha256=9Iq5Jm63Ev7QquCjhDqa9_KAgHdKl9FJHynq8M6JNrY,83
-gazpar2haws-0.2.1.dist-info/LICENSE,sha256=ajApZPyhVx8AU9wN7DXeRGhoWFqY2ylBZUa5GRhTmok,1073
-gazpar2haws-0.2.1.dist-info/METADATA,sha256=Fbf6evtMKByRJCEWcE179YQHhmtsa4COSYluCIcGaKo,10050
-gazpar2haws-0.2.1.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
-gazpar2haws-0.2.1.dist-info/RECORD,,