V10.0.0 Breaking changes

[andyblac]

BREAKING CHANGES
The current and previous accumulative gas consumptions meter entity ids have been updated to include suffixes representing the reported unit of measurement. Any references to these entities will need to be updated.

does this if I'm using sensor.octopus_energy_gas_xxxxx_current_accumulative_consumption, in my my Energy Dashboard, I will loose my history after updating to the new entity name ?

I hope not, else I will be stuck on the old version.

[BottlecapDave]

This was the case unfortunately for v10.0.0, however I believe I've managed to find an undocumented API that will support the migration. The breaking change will still be applicable as the names will still change, but the history should come along for the ride. For anyone coming to this thread, this means you might need to do some additional work to see the history.

If you are on a version below v10.0.0, then you should upgrade straight to v10.0.1 (or above). This will mean the migration process will take effect and you shouldn't need to do anything

If you are on version v10.0.0 and migrate to v10.0.1, you will likely see some warnings stating that the migration failed. This is because you have two entities present, one with the old name and old historic data and one with the new name and no history. In this scenario you have two options

1. Delete the old entity and live with the historic data being gone. If you restart HA the warning should be gone
2. Downgrade to a version before v10.0.0 and delete the unavailable entities that were created as part of v10.0.0 (sensor.octopus_energy_gas_{{METER_SERIAL_NUMBER}}_{{MPRN_NUMBER}}_previous_accumulative_consumption_m3 and sensor.octopus_energy_gas_{{METER_SERIAL_NUMBER}}_{{MPRN_NUMBER}}_current_accumulative_consumption_kwh). If you have already deleted the old entities you should be able to get them back if you restore from a backup. Once these entities have been removed, you should then upgrade to v10.0.1 or above and restart HA which should update the names of the entities and bring the historic data with it.

Issues have been discovered with the migration logic. This is still being investigated if it's actually possible as the HA APIs that are available don't seem to be migrating as intended. A new update with this migration logic removed has been released and v10.0.1 has been removed to avoid any further damage.

[andyblac]

thanks for your work, I will try upgrading to v10.0,1 tomorrow (ill take backup just before just incase), and report back how it goes.

[ksimuk]

Ahh 😫, the second breaking change in the row, I've renamed the sensor to keep the history, and now the breaking change again.

[BottlecapDave]

If this now works (I don't remember it working when I made the last name change), then that would be ideal and I can focus my available time on other issues/features.

[andyblac]

It seems to have worked, still got my history data, and new data is updating.

[BottlecapDave]

This is excellent to hear. It sounds like this is the safest migration solution, so I'll park any automated approach which might produce undesired effects (the solution in 10.0.1 should have gone through the same flow as editing via the UI but something obviously went wrong).

I try and keep name changes to a minimum, but the inconsistency got me this time :( I'm sorry for the inconvience.

[andyblac]

btw I had to do the same with sensor.octopus_energy_gas_xxx_xxx_previous_accumulative_consumption_m3, delete, sensor.octopus_energy_gas_xxx_xxx_previous_accumulative_consumption and rename sensor.octopus_energy_gas_xxx_xxx_previous_accumulative_consumption_m3 to sensor.octopus_energy_gas_xxx_xxx_previous_accumulative_consumption

[gcoan]

Deleting an entity definitely doesn’t delete the history. Maybe it gets purged after a period of time but I’ve successfully deleted and recreated entities that retain their history

[andyblac]

hmm, did not work for me, I get no history in Energy page after changing it to the new sensor name (this is updating from v9 to v10.0.1)

also no history in the entity

[granthgh]

I have the same issue with the energy page with 10.0.0.2, so downgraded back to 9.2.1.

[BottlecapDave]

Have you followed the process @alfwro13 outlined here to rename your entities?

[granthgh]

Sorry, I hadn't followed the delete/rename. Done that now and it seems to work.
Only have one issue now with the _previous_accumulative_consumption_m3 entity giving an unknown value. However its not that important.

[BottlecapDave]

That should populate once yesterday's rates come in.

[andyblac]

I had same issue, I had to do the same with sensor.octopus_energy_gas_xxx_xxx_previous_accumulative_consumption_m3, delete, sensor.octopus_energy_gas_xxxx_xxx_previous_accumulative_consumption and rename sensor.octopus_energy_gas_xxx_xxx_previous_accumulative_consumption_m3 to sensor.octopus_energy_gas_xxx_xxx_previous_accumulative_consumption

take backup before just incase it don't work.

[jtetzlaff]

would those changes affect / cause some sensors to dissapear?
After updating tot he latest version, i've got a number of sensors unavailable;
Electricity Current Rate, Previous Rate, Next rate, Off Peak

And the following log message:
`This error originated from a custom integration.

Logger: custom_components.octopus_energy.coordinators.electricity_rates
Source: helpers/update_coordinator.py:300
Integration: Octopus Energy (documentation, issues)
First occurred: 16:24:19 (17 occurrences)
Last logged: 16:40:19

Unexpected error fetching ELECTRICITY_RATES_101zzzzzzzzz_zzzzzzzzzz data: 'NoneType' object has no attribute 'completed'
Traceback (most recent call last):
File "/usr/src/homeassistant/homeassistant/helpers/update_coordinator.py", line 300, in _async_refresh
self.data = await self._async_update_data()
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/src/homeassistant/homeassistant/helpers/update_coordinator.py", line 256, in _async_update_data
return await self.update_method()
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/config/custom_components/octopus_energy/coordinators/electricity_rates.py", line 133, in async_update_electricity_rates_data
dispatches.dispatches.completed
AttributeError: 'NoneType' object has no attribute 'completed'
`

[BottlecapDave]

Hi. This should be resolved in the latest version (v10.0.3)