Feat/update docs (#545)

_docs/entities/electricity.md

@@ -40,17 +40,17 @@ You'll get the following entities for each electricity meter with an active agre
 
 The current rate that energy consumption is charged at (including VAT).
 
+This is in pounds and pence (e.g. 1.01 = £1.01).
+
 | Attribute | Type | Description |
 |-----------|------|-------------|
 | `mpan` | `string` | The mpan for the associated meter |
 | `serial_number` | `string` | The serial for the associated meter |
 | `is_export` | `boolean` | Determines if the meter exports energy rather than imports |
 | `is_smart_meter` | `boolean` | Determines if the meter is considered smart by Octopus Energy |
 | `tariff` | `string` | The tariff the meter/rates are associated with |
-| `all_rates` | `array` | Collection of latest rates for the previous day and next few days |
-| `applicable_rates` | `array` | Collection of rates where the current rate applies, in case it spans multiple time periods. |
-| `valid_from` | `datetime` | The date/time when the rate is valid from |
-| `valid_to` | `datetime` | The date/time when the rate is valid to |
+| `start` | `datetime` | The date/time when the rate started |
+| `end` | `datetime` | The date/time when the rate ends |
 | `is_capped` | `boolean` | Determines if the rate has been capped by the cap set when you setup your account |
 | `is_intelligent_adjusted` | `boolean` | Determines if the rate is the result of being adjusted for intelligent dispatches. This is only applicable for intelligent tariffs |
 | `current_day_min_rate` | `float` | The minimum rate available for the current day |
@@ -64,31 +64,33 @@ The current rate that energy consumption is charged at (including VAT).
 
 The previous rate that energy consumption was charged at (including VAT), that differs from the current rate. If there is no previous rate (e.g. rates before now are of the same value as the current rate), then this will be reported as `unknown`/`none`.
 
+This is in pounds and pence (e.g. 1.01 = £1.01).
+
 | Attribute | Type | Description |
 |-----------|------|-------------|
 | `mpan` | `string` | The mpan for the associated meter |
 | `serial_number` | `string` | The serial for the associated meter |
 | `is_export` | `boolean` | Determines if the meter exports energy rather than imports |
 | `is_smart_meter` | `boolean` | Determines if the meter is considered smart by Octopus Energy |
-| `applicable_rates` | `array` | Collection of rates where the previous rate applies, in case it spans multiple time periods. |
-| `valid_from` | `datetime` | The date/time when the rate is valid from |
-| `valid_to` | `datetime` | The date/time when the rate is valid to |
+| `start` | `datetime` | The date/time when the previous rate started |
+| `end` | `datetime` | The date/time when the previous rate ended |
 
 ## Next rate
 
 `sensor.octopus_energy_electricity_{{METER_SERIAL_NUMBER}}_{{MPAN_NUMBER}}_next_rate`
 
 The next/upcoming rate that energy consumption will be charged at (including VAT), that differs from the current rate. If there is no next rate (e.g. rates after now are of the same value as the current rate), then this will be reported as `unknown`/`none`.
 
+This is in pounds and pence (e.g. 1.01 = £1.01).
+
 | Attribute | Type | Description |
 |-----------|------|-------------|
 | `mpan` | `string` | The mpan for the associated meter |
 | `serial_number` | `string` | The serial for the associated meter |
 | `is_export` | `boolean` | Determines if the meter exports energy rather than imports |
 | `is_smart_meter` | `boolean` | Determines if the meter is considered smart by Octopus Energy |
-| `applicable_rates` | `array` | Collection of rates where the next rate applies, in case it spans multiple time periods. |
-| `valid_from` | `datetime` | The date/time when the rate is valid from |
-| `valid_to` | `datetime` | The date/time when the rate is valid to |
+| `start` | `datetime` | The date/time when the next rate starts |
+| `end` | `datetime` | The date/time when the next rate ends |
 
 ## Current Day Rates
 
@@ -100,6 +102,17 @@ The state of this sensor states when the current day's rates were last updated.
 |-----------|------|-------------|
 | `rates` | `list` | The list of rates applicable for the current day |
 | `tariff_code` | `string` | The tariff code associated with current day's rates |
+| `serial_number` | `string` | The serial number of the meter the rates are related to |
+| `mpan` | `string` | The MPAN of the meter the rates are related to |
+
+Each rate item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the rate starts |
+| `end` | `datetime` | The date/time when the rate ends |
+| `value_inc_vat` | `float` | The value of the rate including VAT. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `is_capped` | `boolean` | Indicates if the rate has been capped by a configured price cap |
 
 ## Previous Day Rates
 
@@ -111,6 +124,17 @@ The state of this sensor states when the previous day's rates were last updated.
 |-----------|------|-------------|
 | `rates` | `list` | The list of rates applicable for the previous day |
 | `tariff_code` | `string` | The tariff code associated with previous day's rates |
+| `serial_number` | `string` | The serial number of the meter the rates are related to |
+| `mpan` | `string` | The MPAN of the meter the rates are related to |
+
+Each rate item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the rate starts |
+| `end` | `datetime` | The date/time when the rate ends |
+| `value_inc_vat` | `float` | The value of the rate including VAT. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `is_capped` | `boolean` | Indicates if the rate has been capped by a configured price cap |
 
 ## Next Day Rates
 
@@ -122,6 +146,17 @@ The state of this sensor states when the next day's rates were last updated. The
 |-----------|------|-------------|
 | `rates` | `list` | The list of rates applicable for the next day |
 | `tariff_code` | `string` | The tariff code associated with today's rates |
+| `serial_number` | `string` | The serial number of the meter the rates are related to |
+| `mpan` | `string` | The MPAN of the meter the rates are related to |
+
+Each rate item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the rate starts |
+| `end` | `datetime` | The date/time when the rate ends |
+| `value_inc_vat` | `float` | The value of the rate including VAT. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `is_capped` | `boolean` | Indicates if the rate has been capped by a configured price cap |
 
 ## Off Peak
 
@@ -149,8 +184,17 @@ The total consumption reported by the meter for the previous day.
 | `serial_number` | `string` | The serial for the associated meter |
 | `is_export` | `boolean` | Determines if the meter exports energy rather than imports |
 | `is_smart_meter` | `boolean` | Determines if the meter is considered smart by Octopus Energy |
-| `total` | `float` | The total energy value for the previous day |
+| `total` | `float` | The total energy value for the previous day. |
 | `charges` | `array` | Collection of consumption periods for the previous day broken down into 30 minute periods. |
+| `last_evaluated` | `datetime` | The date/time that the consumption sensor was last evaluated. |
+
+Each charge item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the consumption starts |
+| `end` | `datetime` | The date/time when the consumption ends |
+| `consumption` | `float` | The consumption value of the specified period |
 
 ### Previous Accumulative Consumptions (Peak Rate) 
 
@@ -191,11 +235,21 @@ The total cost for the previous day, including the standing charge.
 | `is_export` | `boolean` | Determines if the meter exports energy rather than imports |
 | `is_smart_meter` | `boolean` | Determines if the meter is considered smart by Octopus Energy |
 | `tariff_code` | `string` | The tariff that determined the cost |
-| `standing_charge` | `float` | The standing charge included in the cost |
-| `total_without_standing_charge` | `float` | The total cost of the previous day excluding the standing charge |
-| `total` | `float` | The total cost for the previous day |
+| `standing_charge` | `float` | The standing charge included in the cost. This is in pounds and pence (e.g. 1.01 = £1.01)  |
+| `total_without_standing_charge` | `float` | The total cost of the previous day excluding the standing charge. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `total` | `float` | The total cost for the previous day. This is in pounds and pence (e.g. 1.01 = £1.01) |
 | `charges` | `array` | Collection of consumption periods and costs for the previous day broken down into 30 minute periods. |
-| `last_calculated_timestamp` | `datetime` | The timestamp determining when the cost was last calculated. |
+| `last_evaluated` | `datetime` | The timestamp determining when the cost was last evaluated. |
+
+Each charge item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the consumption starts |
+| `end` | `datetime` | The date/time when the consumption ends |
+| `rate` | `float` | The rate the consumption is charged at. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `consumption` | `float` | The consumption value of the specified period |
+| `cost` | `float` | The cost of the consumption at the specified rate. This is in pounds and pence (e.g. 1.01 = £1.01) |
 
 ### Previous Accumulative Cost (Peak Rate) 
 
@@ -234,6 +288,15 @@ The state of this sensor states when the previous consumption's rates were last
 | `rates` | `list` | The list of rates applicable for the previous consumption |
 | `tariff_code` | `string` | The tariff code associated with previous consumption's rates |
 
+Each rate item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the rate starts |
+| `end` | `datetime` | The date/time when the rate ends |
+| `value_inc_vat` | `float` | The value of the rate including VAT. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `is_capped` | `boolean` | Indicates if the rate has been capped by a configured price cap |
+
 ## Export Entities
 
 If you export energy, then in addition you'll gain the above entities with the name `export` present. E.g. `sensor.octopus_energy_electricity_{{METER_SERIAL_NUMBER}}_{{MPAN_NUMBER}}_export_current_rate`.
@@ -254,7 +317,7 @@ If current consumption data is unable to be retrieved, then the integration will
 
 | Attribute | Type | Description |
 |-----------|------|-------------|
-| `last_updated_timestamp` | `datetime` | The datetime the data was last retrieved |
+| `last_evaluated` | `datetime` | The datetime the data was last evaluated |
 
 ### Current Demand
 
@@ -266,7 +329,7 @@ The current demand reported by the Home Mini. This will try and update every min
 
 | Attribute | Type | Description |
 |-----------|------|-------------|
-| `last_updated_timestamp` | `datetime` | The datetime the data was last retrieved |
+| `last_evaluated` | `datetime` | The datetime the data was last evaluated |
 
 ### Current Accumulative Consumption
 
@@ -284,6 +347,14 @@ The total consumption reported by the meter for the current day.
 | `total` | `float` | The total energy value for the previous day |
 | `charges` | `array` | Collection of consumption periods for the previous day broken down into 30 minute periods. |
 
+Each charge item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the consumption starts |
+| `end` | `datetime` | The date/time when the consumption ends |
+| `consumption` | `float` | The consumption value of the specified period |
+
 ### Current Accumulative Consumptions (Peak Rate) 
 
 `sensor.octopus_energy_electricity_{{METER_SERIAL_NUMBER}}_{{MPAN_NUMBER}}_current_accumulative_consumption_peak`
@@ -323,11 +394,21 @@ The total cost for the current day, including the standing charge.
 | `is_export` | `boolean` | Determines if the meter exports energy rather than imports |
 | `is_smart_meter` | `boolean` | Determines if the meter is considered smart by Octopus Energy |
 | `tariff_code` | `string` | The tariff that determined the cost |
-| `standing_charge` | `float` | The standing charge included in the cost |
-| `total_without_standing_charge` | `float` | The total cost of the current day excluding the standing charge |
-| `total` | `float` | The total cost for the current day |
+| `standing_charge` | `float` | The standing charge included in the cost. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `total_without_standing_charge` | `float` | The total cost of the current day excluding the standing charge. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `total` | `float` | The total cost for the current day. This is in pounds and pence (e.g. 1.01 = £1.01) |
 | `charges` | `array` | Collection of consumption periods and costs for the current day broken down into 30 minute periods. |
 
+Each charge item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the consumption starts |
+| `end` | `datetime` | The date/time when the consumption ends |
+| `rate` | `float` | The rate the consumption is charged at. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `consumption` | `float` | The consumption value of the specified period |
+| `cost` | `float` | The cost of the consumption at the specified rate. This is in pounds and pence (e.g. 1.01 = £1.01) |
+
 ### Current Accumulative Cost (Peak Rate) 
 
 `sensor.octopus_energy_electricity_{{METER_SERIAL_NUMBER}}_{{MPAN_NUMBER}}_current_accumulative_cost_peak`
@@ -397,3 +478,12 @@ The state of this sensor states when the previous consumption override's rates w
 |-----------|------|-------------|
 | `rates` | `list` | The list of rates applicable for the previous consumption override |
 | `tariff_code` | `string` | The tariff code associated with previous consumption override's rates |
+
+Each rate item has the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The date/time when the rate starts |
+| `end` | `datetime` | The date/time when the rate ends |
+| `value_inc_vat` | `float` | The value of the rate including VAT. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `is_capped` | `boolean` | Indicates if the rate has been capped by a configured price cap |