Next Release (#1194)

Author: BottlecapDave

.cz-config.js

@@ -1,9 +1,4 @@
-var scopes = [
-  'api-client',
-  'sensor', 
-  'binary-sensor', 
-  'config'
-]
+var scopes = []
 
 module.exports = {
   types: [
@@ -25,6 +20,7 @@ module.exports = {
     },
     { value: 'test', name: 'test: Adding missing tests' },
     { value: 'build', name: 'build: Changes to the build system' },
+    { value: 'chore', name: 'chore: Changes that does not fit into another category' },
     { value: 'ci', name: 'ci: Changes to the ci system' },
     { value: 'revert', name: 'revert: Revert to a commit' },
     { value: 'release', name: 'release: a release of the project' },
@@ -49,11 +45,11 @@ module.exports = {
     confirmCommit: 'Are you sure you want to proceed with the commit above?',
   },
 
-  allowCustomScopes: true,
+  allowCustomScopes: false,
   allowBreakingChanges: ['feat', 'fix'],
   // skip any questions you want
   skipQuestions: ['body'],
 
   // limit subject length
-  subjectLimit: 100,
+  subjectLimit: 500,
 };

.github/workflows/docs.yml

@@ -12,6 +12,7 @@ concurrency:
 
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  HUSKY: 0
 
 jobs:
   build_docs:

.github/workflows/main.yml

@@ -1,5 +1,6 @@
 name: Main
 on:
+  workflow_dispatch:
   schedule:
     - cron:  '0 1 * * *'
   push:
@@ -21,6 +22,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  HUSKY: 0
+
 jobs:
   validate:
     if: ${{ github.event_name != 'schedule' || github.repository_owner == 'BottlecapDave' }}

.husky/prepare-commit-msg

@@ -0,0 +1 @@
+exec < /dev/tty && npx cz --hook || true

_docs/blueprints/octopus_energy_octoplus_redeem_points_for_account_credit.yml

@@ -15,7 +15,7 @@ blueprint:
             integration: octopus_energy
           multiple: false
     threshold:
-      name: Threshold hours
+      name: Threshold points
       description: The minimum number of redeemable points to be available for the automatic redemption to occur
       default: 1
       selector:

_docs/entities/electricity.md

@@ -386,7 +386,10 @@ If you export energy, then unless specified otherwise, in addition you'll gain t
 !!! info
     An export equivalent of this sensor does not exist because the data is not available
 
-The delta of the accumulative electricity consumption since the last update (e.g. if the previous accumulative consumption update reported 1kWh and the current accumulative consumption update reported 1.1kWh, then this sensor will report 0.1kWh). 
+!!! note
+    This is [disabled by default](../faq.md#there-are-entities-that-are-disabled-why-are-they-disabled-and-how-do-i-enable-them).
+
+The delta of the accumulative electricity consumption since the last update (e.g. if the previous accumulative consumption update reported 1kWh and the current accumulative consumption update reported 1.1kWh, then this sensor will report 0.1kWh). The time period the data for this sensor represents will depend on the frequency the underlying data is retrieved. If the data takes longer to refresh, then the time period of this sensor will be extended.
 
 This is a legacy sensor which was been built to see the accumulation within the energy dashboard. This _may_ be removed in the future.
 

_docs/entities/gas.md

@@ -266,9 +266,16 @@ Each rate item has the following attributes
 !!! warning
     This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini). Do not set unless you have one.
 
-The latest gas consumption sent to Octopus Energy. By default, this will update every minute. This has been built to see the accumulation within the energy dashboard. If you are wanting a sensor to see the current day's accumulation, then you will need to use something like [utility meter](https://www.home-assistant.io/integrations/utility_meter/). It has been noticed that daily consumption reported in Home Assistant can differ to when looking at past data within Octopus Energy. It looks like this is because Octopus Energy will favour "official" data from your smart meter over the data they collect.
+!!! note
+    This is [disabled by default](../faq.md#there-are-entities-that-are-disabled-why-are-they-disabled-and-how-do-i-enable-them).
+
+The delta of the accumulative gas consumption since the last update (e.g. if the previous accumulative consumption update reported 1kWh and the current accumulative consumption update reported 1.1kWh, then this sensor will report 0.1kWh). The time period the data for this sensor represents will depend on the frequency the underlying data is retrieved. If the data takes longer to refresh, then the time period of this sensor will be extended.
+
+This is a legacy sensor which was been built to see the accumulation within the energy dashboard. This _may_ be removed in the future.
+
+It has been noticed that daily consumption reported in Home Assistant can differ to when looking at past data within Octopus Energy. It looks like this is because Octopus Energy will favour "official" data from your smart meter over the data they collect.
 
-If current consumption data is unable to be retrieved, then the integration will attempt to retrieve missing data. This will be done up to 5 days behind to give a buffer before the API requires a higher interval and will not be changed.
+If current consumption data is unable to be retrieved, then the integration will attempt to retrieve missing data. This will be done for the current day only. This is due to it sharing the same data for the accumulation sensors and will not be changed. 
 
 | Attribute | Type | Description |
 |-----------|------|-------------|

_docs/entities/heat_pump.md

@@ -87,3 +87,7 @@ This represents the current outdoor temperature as observed by the heat pump.
 
 !!! note
     As the integration uses cloud polling this will inherently have a delay.
+
+## Services
+
+There are some services available relating to these entities that you might find useful. They can be found in the [services docs](../services.md#heat-pump).

_docs/entities/intelligent.md

@@ -121,11 +121,11 @@ This sensor is used to see and set the charge target for your future intelligent
 
     You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
-### Target Time
+### Target Time (Select)
 
 `select.octopus_energy_{{ACCOUNT_ID}}_intelligent_target_time`
 
-This sensor is used to see and set the target time for your future intelligent charges.
+This sensor is used to see and set the target time for your future intelligent charges. This is limited to 30 minute increments between 4 and 11 to match the Octopus Energy app. This is useful if you use the app or have non-technical people interacting with the integration.
 
 !!! info
 
@@ -137,9 +137,28 @@ This sensor is used to see and set the target time for your future intelligent c
 
     You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
-!!! warning
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `raw_value` | `time` | The raw target time. This is useful if the time is set to a value outside of the range available in the select options (e.g. from another integration) |
+
+### Target Time (Time)
+
+`time.octopus_energy_{{ACCOUNT_ID}}_intelligent_target_time`
+
+This sensor is used to see and set the target time for your future intelligent charges. This gives you finer control over the times (still within valid time periods), but may have unintended consequences with other apps (e.g. the Octopus Energy app) that use the data.
+
+!!! info
+
+    This entity is not available for the following intelligent providers
+
+    * OHME
+
+!!! info
+
+    You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
-    There is a time based sensor called `time.octopus_energy_{{ACCOUNT_ID}}_intelligent_target_time` which represents this functionality. This is a legacy sensor which will be removed in the future. 
+!!! note
+    This is [disabled by default](../faq.md#there-are-entities-that-are-disabled-why-are-they-disabled-and-how-do-i-enable-them). If enabled, it is advised to disable the [select based sensor](#target-time-select) as the two can get out of sync. 
 
 ## Migrating from megakid/ha_octopus_intelligent?
 
@@ -152,5 +171,5 @@ If you're moving to this integration from [megakid/ha_octopus_intelligent](https
 * `sensor.octopus_intelligent_offpeak_end` - The default off peak end date/time can be found as an attribute on the [off peak sensor](./electricity.md#off-peak). This can be extracted using a [template sensor](https://www.home-assistant.io/integrations/template/).
 * `switch.octopus_intelligent_bump_charge` - Use the [bump charge sensor](#bump-charge)
 * `switch.octopus_intelligent_smart_charging` - Use the [smart charge sensor](#smart-charge)
-* `select.octopus_intelligent_target_time` - Use the [target time sensor](#target-time)
+* `select.octopus_intelligent_target_time` - Use the [target time (time) sensor](#target-time-time) or [target time (select) sensor](#target-time-select)
 * `select.octopus_intelligent_target_soc` - Use the [charge target sensor](#charge-target)

_docs/entities/octoplus.md

@@ -51,7 +51,7 @@ Each available event item will include the following attributes
 | Attribute | Type | Description |
 |-----------|------|-------------|
 | `id` | `integer` | The id of the event |
-| `code` | `string` | The event code of the event. This will be required to join via the [join service](../services.md) |
+| `code` | `string` | The event code of the event. This will be required to join via the [join service](../services.md#octopus_energyjoin_octoplus_saving_session_event) |
 | `start` | `datetime` | The date/time the event starts |
 | `end` | `datetime` | The date/time the event starts |
 | `duration_in_minutes` | `integer` | The duration of the event in minutes |
@@ -208,5 +208,5 @@ Each item within `baselines` consists of the following attributes
 
 ## Services
 
-There are some services available relating to these entities that you might find useful. They can be found in the [services docs](../services.md).
+There are some services available relating to these entities that you might find useful. They can be found in the [services docs](../services.md#octoplus).