9.0.1 (2023-11-22)
- Fixed issue where all previous day rates are not retrieved for agile tariff (1ff0ce9)
- Fixed issue where restore state was set to invalid unknown value (24c09d6)
- Fixed refresh_previous_consumption_data for gas to populate kwh data (e5b3a3e)
- Removed stale last_updated_timestamp attributes (763842f)
- Updated previous/current/next event rate sensors to not be disabled by default (e10c6dd)
9.0.0 (2023-11-20)
- custom: updated value_inc_vat and rates to be in pounds/pence for consistency (439c081)
- Fixed issue calculating off peak costs when rate information isn't available (fc155a1)
- Fixed issue when failing to retrieve account during setup (c9d04fb)
- fixed issue where sensor attributes were always strings when restored after reload/restart (53964ae)
- Fixed issue where unit of measurement couldn't be changed/converted within HA (f07da9d)
- removed all_rates and applicable_rates attributes from rate sensors to fix statistics warning (280e6d2)
- updated standing charge attribute on cost sensors to be in pound/pence for consistency (913336a)
- Added new events for new and all saving sessions (b2b44b5)
- added new sensor for octoplus points (800fc85)
- Added sensors for available wheel of fortune spins (6273784)
- Added service for joining a saving session (01342b5)
- Added service for spinning wheel of fortune (effcc21)
- Added two new attributes to various sensors determining when the underlying data was last retrieved and when the value was last evaluated. These will slowly be added to other entities. (11f8878)
- created new event entity to capture available and joined octoplus saving session events (b402c06)
- standardised attributes around time periods across the integration (89a6985)
- standardised attributes around time periods across the integration (#535) (7f6712f)
- Updated config entry for account to have the account id as the title (02ef313)
- updated intelligent sensors to include account id. This is to support future functionality (57e3d79)
- updated last_calculated_timestamp attributes to last_evaluated for consistency (702eb4a)
- Updated saving session sensor to include account id. This is to support future functionality (3136005)
- Updated underlying config with some missing fields (82e4564)
- updated various attributes to be their numberic value instead of strings with symbols (727db53)
- all_rates and applicable_rates attributes are no longer accessible in rate sensors. All rate information is available in the events attribute. See BottlecapDave#444 for more information
- Any previous references to valid_from/valid_to, interval_start/interval_end or from/to have now been changed to start/end. This change may take a little while to propagate while old data is replaced. Any reliances on these attribute names will need to be updated.
- The joined events attribute has been removed from the saving session binary sensor in favour of the event entity
- Any references to last_calculated_timestamp attribute should be updated to last_evaluated
- saving session points sensor has been removed in favour of octoplus points sensor
- Any references to saving session entities will need to be updated based on name change including account id
- Any references to intelligent sensors will need to be updated based on name changes including account id
- All references to value_inc_vat and rates are now in pounds/pence. If you are relying on this structure, you may need to update your logic
- Standing charge attribute on cost sensors are now in pound/pence. If you are using this, then you may need to adjust any calculations etc.
- Various attributes have been updated to be numeric instead of strings with symbols (e.g. £1.50 -> 1.50). Any logic that was used to remove these symbols will now break. In addition, some attributes had raw representations, which have now been removed. Please review docs for more information.
8.5.2 (2023-11-08)
- Fixed previous consumption peak/off peak sensors (b3d4f6f)
8.5.1 (2023-11-02)
- Fixed retrieving previous electricity consumption for intelligent tariffs (40651a2)
- Fixed target rate sensor restoring old settings (ec40fe2)
8.5.0 (2023-10-29)
- Added check when configuring home mini, to make sure home mini support is actually available (770edc4)
- Fixed clearing of price caps without needing checkbox (f5fbc0c)
- Fixed off peak detection for octopus flex (should never be applicable) (912efd7)
- Added last evaluated attribute to target rate sensor for more clarity (fd5395d)
8.4.4 (2023-10-14)
- Added explicit timeout to OE server requests (b516e4a)
- Fixed intelligent coordinator update frequency (thanks @Pixel-Gavin) (8e1f80c)
- Fixed update interval for data coordinators to be minutes not hours (830604d)
8.4.3 (2023-10-12)
- Fixed intelligent settings reverting if multiple changed in quick succession (0a4c95b)
8.4.2 (2023-10-09)
- Updated minimum version of Home Assistant to 2023.09 (30157c0)
8.4.1 (2023-10-07)
- Fixed error in dispatching sensor (0799002)
8.4.0 (2023-10-07)
- Added additional checks in cost override sensors (ba41e73)
- Fixed entry already configured error (6be5ea6)
- Fixed issue where export rates were adjusted during intelligent hours (df74d13)
- Fixed previous consumption to run calls in parallel (e621af1)
- Removed tracker tariff potentially looking at wrong API for standing charges (82fecf1)
- Added new sensors and events to expose various rate information (1e0315e)
- Added service to support manually refreshing previous consumption data/costs (a84a91d)
8.3.0 (2023-09-23)
- Added service for removing custom external statistics for meters with no active tariff (2fe1d19)
- binary-sensor: Fixed intelligent dispatching sensor not turning on during off peak times (0901bfd)
- Fixed target rate sensor not restoring state between restarts (75bcc8f)
- Raise error on startup if account information is not available, which will cause HA to retry (4799400)
- Added location data to intelligent dispatches (4e1a9bd)
- Added support to adjust the day offset for previous consumption sensors beyond the previous day (062ec3f)
- sensor: Added sensor for indicating if rate is currently off peak (94a5151)
- Separated Home mini electricity and gas refresh rates (6651ebf)
8.2.0 (2023-08-26)
- Fixed accumulative consumption sensors not starting until 1am (dd2997b)
- Fixed retrieving standing charges that have no end date (41b913d)
- Removed unused/undocumented attribute from intelligent dispatching sensor (56657a2)
- Added repair notification when target rate sensor becomes invalid (fd52777)
- config: Added more validation around target rates, including around agile tariffs (8a00c1c)
8.1.0 (2023-08-12)
- Added more checks around coordinators (31205c5)
- Fixed issue with accumulative cost sensors when used in the energy dashboard (3db7228)
- Moved various sensor updates out of update loop and into state property which should stabilize updates (662a32b)
- Removed coordinator setup skipping if already setup (54bb347)
- Change order of rates/applicable rates attributes so they're last on rate sensors (b4d0c6b)
- Updated intelligent dispatching sensor to include vehicle battery size information and charge point power (b7e0294)
- Updated planned/completed intelligent dispatches to include charge in kwh (4fec0cf)
8.0.0 (2023-08-05)
- api-client: removed tracker fall-back API (fd095cb)
- Fixed "ignoring invalid device info" error (c6219d7)
- intelligent: Fixed ready time state when initial value is returned (8296fce)
- Removed empty gas meter devices (f0c4258)
- Removed last reset from current demand based on state class warning (f452ee7)
- sensor: fixed issue with previous rate sensor going unknown when crossing midnight (45b7e43)
- sensors: Fixed deprecated warning for charge limit sensor (6b0e894)
- Added peak/offpeak consumption/cost sensors for current accumlative elec/gas (e0c756f)
- Added sensors for current elec/gas accumulative consumption (d3315a5)
- Added sensors for current elec/gas accumulative cost (f6971f3)
- Added sensors for current elec/gas accumulative cost (0dec111)
- config: Added refresh rate configuration for Home Mini (dbfe805)
- config: Improved target rate sensor config to show if an import or export meter is being picked (e415b41)
- sensor: Added next/previous rate sensors for gas (dceb784)
- sensors: Added functions for retrieving next/previous rates (79e5471)
- sensor: updated next/previous electricity sensors to find rates that have a different value to current rate (37ad6c1)
- target-rate: Added ability to invert normal behaviour of target rate sensors when finding target rates (080d2cc)
- Updated charges in cost sensors to include raw representation (e981c27)
- api-client: While this shouldn't have a negative effect on anyone, I'm marking the removal of the tracker fallback API as a breaking change. This is because I believe it's cause bugs to be raised and there are several threads within the OE forums that don't suggest using it for various reasons https://forum.octopus.energy/t/finding-the-latest-gas-tracker-api/6021/9. This original tariff that introduced this work around is now properly supported by the API.
- sensor: These sensors no longer look at the next/previous 30 minute rate so behaviour will change for all tariffs. This is to make them more useful for non agile tariffs. Attributes of these sensors have also changed. Please review docs for more information.
- sensor: The rates attribute on the previous/current/next rate sensors will now contain the previous days rates. If you are using this attribute, you may need to adjust your use.
7.5.2 (2023-07-21)
- sensor: Fixes to various sensors and how they update their values (92d8a57)
7.5.1 (2023-07-20)
- sensors: Fixed issue with saving session evaluating incorrectly … (#317) (66dc168)
- sensors: Fixed issue with saving session evaluating incorrectly when data is unavailable (94a03fb)
7.5.0 (2023-07-14)
- sensor: Added various sensors for Octopus Intelligent to support various configurations (0380377)
7.4.5 (2023-07-04)
- Fixed issue with dispatch times and electricity rates (7a5b470)
7.4.4 (2023-07-01)
- api-client: Fixed api client to handle graphql errors (78414d2)
- sensor: Fixed inclusion of intelligent dispatches in consumption costs and pricings (34ef0e8)
- sensor: Fixed issue during BST with rate sensors (dcfd1b6)
- sensor: Updated retrieving of rates to try more frequently if rates are out of date (a50e0bc)
- Updated various sensors to update via coordinator callback (16c1c75)
7.4.3 (2023-06-16)
- api_client: Improved detection of smart meters (d614210)
7.4.2 (2023-06-04)
- binary-sensor: Fixed next_time on target rate sensors to take account of configured offsets (9673b4e)
- sensor: Fixed recovery of electricity rates if new rates fail to be retrieved (210f6c4)
7.4.1 (2023-06-03)
- sensors: Fixed handling the retrieving of tracker tariff data for non tracker tariffs (6c277d4)
7.4.0 (2023-06-03)
- config: Updated mini configuration to have link to minimise confusion (9d277af)
- Updated api client to throw errors based on responses and caught appropriately in the coordinators (c1c031a)
- sensors: Updated sensors to appear in disabled state if account info determines no smart meter is present (b1f123a)
7.3.0 (2023-05-28)
- binary-sensor: Added the ability to force target rate sensors to find the latest applicable set of rates (dc2e456)
7.2.0 (2023-05-21)
- Fixed issue when Octopus Home Mini data can't be retrieved for 1 week or beyond. (1c05ea7)
- sensor: Added missing last reset attribute restoration (d596b3b)
- sensor: Fixed last_reset of previous electricity consumption/cost (3996ab7)
- sensor: Added support for comparing previous consumption cost with another tariff (44ef244)
7.1.3 (2023-05-13)
- sensor: Fixed peak/off peak calculations when off peak cost exceeds peak costs (317e916)
7.1.2 (2023-05-11)
- sensor: Added additional checks around previous consumptions and costs when data is not available (28b31b5)
7.1.1 (2023-05-11)
- Added check for when standing charge can't be retrieved (383ec65)
- Added more checks around retrieving previous rates and consumption (a1ec6fe)
7.1.0 (2023-05-11)
- sensor: Fixed icon for previous gas consumption sensor (91f9096)
- sensor: Fixed rate sensors not having long term statistics (07db8f8)
- config: Added detail around target rate hours (9b084c9)
- sensor: Added disabled sensors for representing electricity peak/off peak consumption and cost for previous day (76de3fb)
- sensor: Added min/max/average rates to electricity rate sensors (df82983)
- sensors: Added support for external statistics for previous consumption sensors (see energy dashboard instructions) (4d4e460)
7.0.0 (2023-04-18)
- Added check when gas rates are unavailable (b90131a)
- fixed entity names to match documentation and include octopus_energy domain (f6f589b)
- The name of the entity should stay how it was formed when the entities were first created, however the names might change in either your HA instance or other dependent services.
6.6.1 (2023-04-10)
- Fixed average cost on target rate sensors to handle when no rates are available (b67989e)
6.6.0 (2023-04-08)
- Fixed fallback onto make/model if import/export meter not available (2940e73)
- binary-sensor: Added overall average, min and max costs for target rate sensors (060ea63)
6.5.0 (2023-04-08)
- config: Updated target rate sensor to support type and name to be updated (4888976)
- Fixed consumption sensors to not be created for users with no smart meters (34003f4)
- Updated tariff extraction to be more flexible with beta tariffs (e.g V2G) (3a9c2fb)
- binary-sensor: Added cost attributes to target rate sensors (98c0db9)
- sensor: Updated saving session entity to display current event start/end/duration (97b49d0)
- Update device to include make, model and firmware where available (f65c34a)
6.4.1 (2023-04-01)
- Added more robust checks when retrieving account information (5898f41)
- api-client: Added more checks for when meters have no agreements (ee86fe0)
6.4.0 (2023-04-01)
- config: Added checks for tariffs to report repair errors if not valid (3f7dc86)
6.3.2 (2023-03-29)
- Added missing requirement for repairs (69a4bcb)
- Updated current rate sensors to indicate if prices are capped (1368349)
6.3.1 (2023-03-28)
- Handle when account cant be found and display repair message (7c7801a)
6.3.0 (2023-03-21)
- Updated diagnostics to redact device id (093fc5a)
- Updated account to retrieve tariff product code (3cdb4b5)
6.2.0 (2023-03-18)
- binary-sensor: Fixed offset incorrectly being applied to target times upon discovery (94ed934)
- sensor: Updated names of sensors to not include Octopus Energy (07fdd8b)
6.1.1 (2023-03-18)
- sensor: Fixed kwh gas sensor device class (6a25058)
6.1.0 (2023-03-18)
- binary-sensor: Fixed issue with offset being applied twice for "next_time" in target rate sensors (d8596fb)
- sensor: Added current consumption for gas through octopus mini (df7b3dc)
- sensor: Added the ability to configure current gas consumption for octopus mini (6c6868a)
6.0.1 (2023-03-02)
- sensor: Fixed handling of tracker products (2911ebb)
- sensor: Fixed rate sensors to update on the half hour (2e2d795)
6.0.0 (2023-02-25)
- fix(sensor): Added "export" to export based sensors (3df28bb)
- Added option to configure gas calorific value (d3e3333)
- Added price cap configuration (fdd856a)
- Added support for home mini (3f811e3)
- sensor: The name of export based electricity sensors have been updated to include the term "export". This is to make it more discoverable for new users.
5.4.1 (2023-02-07)
- api-client: Fixed tracker lookup logic (c59085a)
5.4.0 (2023-02-05)
- sensor: Fixed restoring attributes from restart (fdfd72e)
- sensor: Fixed restoring attributes so they're not read only (bbb3ef8)
- api_client: Updated rates and standing charge logic to route to tracker endpoint where appropriate (3be23d0)
5.3.1 (2023-01-28)
- sensor: Fixed gas rates to work with tracker products (b2419dc)
5.3.0 (2023-01-20)
- Added more defensive code for account retrieval (a01513c)
- binary-sensor: Updated target rates to skip if not enough applicable rates exist for specified period (e2a2376)
- sensor: Fixed restoring rate sensors to not default to 0. (85c38cc)
- binary-sensor: Added next duration in minutes for target rates (bae76b2)
- binary-sensor: Added rolling target as attribute (f1eaac9)
- binary-sensor: Updated target rate sensors to display how long the current active block is (2bd037b)
- sensor: Added next rate sensor for electricity meters (8167baf)
5.2.1 (2023-01-16)
- binary-sensor: Fixed issues with using update service through automations (70d101d)
5.2.0 (2023-01-15)
- binary-sensor: Fixed issue when start/end spans multiple dates (a4d9550)
- Removed "export" from name of target rate sensors (1b22958)
- Added service for updating target rate config (4c6a2bb)
- binary-sensor: Added support for end time being before start time (8431801)
- sensor: Added new sensor to expose gas as kwh (d365c45)
5.1.0 (2022-12-28)
- sensor: Added back m3/kWh calculations for gas sensors (820abde)
- sensor: Added last_reset attribute to cost/reading sensors (2861796)
- sensor: Removed SMETS1 configuration as it's no longer used (eb49841)
- sensor: Updated min consumption data to be in calculation (4f55e8d)
- binary-sensor: Updated next saving session to include end date and duration in minutes (4d78a00)
- sensor: Added sensors for current standing charges for electricity and gas (24641f8)
- sensor: Updated standing charge to be more specific (521d9fc)
5.0.0 (2022-12-17)
- sensor: Fixed state class for sensors to "total" (fda8df6)
- sensor: This fix causes long term statistics for the sensors to break. To rectify this, visit BottlecapDave#108
4.7.1 (2022-12-08)
- sensor: Only set latest date on gas rate sensor if rates are successfully retrieved. (11f275f)
4.7.0 (2022-12-04)
- binary-sensor: Fixed issue with rates mismatch and multiple meters (1050fd4)
- binary-sensor: Updated target rate sensors to work with export based meters (0d4757b)
- sensor: Fixed issue with rates update (a2fead5)
- sensor: Updated sensors to support being restored after reboots (1f04b14)
- binary-sensor: Added sensor for when joined saving sessions is active (93dbd9e)
- sensor: Added saving sessions points sensor (94e465c)
4.6.4 (2022-10-27)
- Fixed issue with increased debug logging. Also reduced default logging to debug level (2add166)
4.6.3 (2022-10-26)
- Added additional logging around target rates (6228020)
4.6.2 (2022-10-25)
- api-client: Fixed api_client incorrectly absorbing not found requests (2a96c51)
- sensor: Update rate sensors to report back None if no current rate can be found (86376ac)
4.6.1 (2022-10-22)
- config: Updated rates retrieval to take account of local time (ccf67ee)
4.6.0 (2022-10-16)
- binary-sensor: Fixed issue when sensor is active and calculated on the end date of the last rate (917f9b5)
- api-client: Moved conversion of rates to 30 minute increments to separate testable function (412599f)
4.5.1 (2022-10-02)
- binary-sensor: Fixed text of rolling_target to reflect behaviour (4840ff3)
- config: Fixed issue with configuring when star/end/offset not set (4916f68)
- config: Fixed loading binary sensor when start/end is not set (dcafda4)
4.5.0 (2022-10-01)
- binary-sensor: Fixed issue when start/end time isn't set (7ab9b2d)
- Fixed day/night times for economy 7 tariffs when using a smart meter. Thanks @696GrocuttT (c860a8a)
- Updated consumption sensors to wait for more than 2 charges to be present (aa97647)
- binary-sensor: Added facility to restrict target rates sensors from only reaching the target once a day (67d2993)
4.4.0 (2022-07-23)
- device: Added debug logging for account information (not redacted) (576c93d)
- device: Added support to download diagnostics which includes redacted account information (01fdf4e)
4.3.0 (2022-07-04)
- api-client: Updated get_account to use graphql so that inactive meters are ignored (f05dcd9)
- sensor: Fixed gas sensor (975f4fe)
- Updated translations to not include title as not needed (43d1a0e)
- sensor: Added rate information to current electricity rate sensor (cfb4043)
- sensor: Updated electricity and gas sensors to be associated with devices (38d8adb)
4.2.1 (2022-06-18)
- Fixed incorrect logging for debugging entries (d5fad1d)
- sensor: Fixed issue where gas consumption was being incorrectly calculated for SMETS1 sensors (065ec88)
4.2.0 (2022-05-07)
- binary_sensor: Updated target rate sensors to be updatable (a6fbcca)
- binary-sensor: Added ability to apply offsets to target rate sensors (faafa1b)
- sensor: Moved targeting sensor update logic to external functions (74908e1)
- sensor: Updated sensor icons to be gbp instead of usd (66dfc54)
4.1.3 (2022-03-23)
- sensor: Fixed issue where active agreement was not being found, causing sensors to not appear (85acdac)
4.1.2 (2022-03-22)
- sensor: More fixes to sensor logging. (b0c4213)
4.1.1 (2022-03-22)
- sensor: Fixed log when no active agreement present (75af243)
4.1.0 (2022-03-22)
- sensor: added info logs to indicate why sensors aren't added (cc3fbeb)
4.0.0 (2022-03-07)
- config: Updated selecting target meters for target sensors to be more user friendly (b1dc00f)
- sensor: Added tariff code to electricity and gas consumption sensors (a728652)
- sensor: Updated electricity sensors to include is_export attribute (d35967e)
- sensor: updated gas sensors to include mprn in name (af528ef)
- sensor: Updated previous gas consumption to display kwh and m3 values in attributes (745c51f)
- sensor: This has been updated for consistency with the electricity sensor changes
- Unfortunately in order to support import/exports, electricity sensors now include both the mpan and serial number in their name. This means you will need to update any automations or dashboards that rely on these sensors.
3.1.0 (2022-01-15)
- sensors: Fixed current gas rate period to be for the day (7a62150)
- sensor: added current gas rate sensor (ecfe774)
3.0.4 (2022-01-01)
- sensor: Updated consumption to not require 48 entries (9bd6790)
- sensor: Updated sensors to not require 48 entries for consumption (15fd45c)
3.0.3 (2022-01-01)
- api-client: fixed retrieving rates for agile and go tariffs (9a12ac5)
- api-client: updated to treat server errors as not receiving any data (c111463)
3.0.2 (2021-12-28)
- api-client: Added additional logging for failing to read json response (fa3b33d)
- sensor: Added more logging around failing to retrieve consumption rate. (dbec7a5)
3.0.1 (2021-12-23)
- sensor: updated tariff code in sensor setup to be retrieved after it's been setup in the rate coordinator (9caade9)
3.0.0 (2021-12-22)
- sensor: Removed code for falling back on fixed tariffs if no agreement is found (9a5045b)
- sensor: Added sensors for accumulative cost of gas for the previous day (42a1408)
- sensor: Created coordinator for retrieving current reading and created initial electricity consumption cost (4f09269)
- sensor: removed current consumption sensors due to insufficient data provided by Octopus Energy (0470ff3)
- sensor: Removed registering of current consumption sensors (d263a68)
- sensor: Updated previous day consumption to only be valid if enough data points are available (9e71ef2)
- sensor: Updated previous day cost sensor to include breakdown and standing charges (6618246)
- updated docs (dff4d16)
- We no longer fall back to fixed rate agreements if an active agreement can't be found. This was added by mistake when people were not receiving sensors when they had moved home and therefore an inactive house was being picked up. This means that some sensors may disapper, but these should just be inactive meters.
- sensor: Latest consumption sensors are no longer available, which may cause issues anywhere they are used.
2.0.0 (2021-11-10)
- api-client: fixed get_account to find the first property that hasn't been moved out of (970a7a5)
- api-client: This change could cause the sensors associated with your meters to change, as they may have been associated with a property you had moved out of
1.2.0 (2021-10-30)
- Updated how we determine if we're on an expired fixed tariff (075766f)
- Updated to move to variable tariffs if a meter's latest agreement was fixed term (37ee143)