Skip to content

feat: add latest_meter_reading_date sensor #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: add latest_meter_reading_date sensor #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bdb1099
feat: add `latest_meter_reading_date` sensor
GuyKh Apr 28, 2024
4e747d5
fix: duplicate in Hebrew
GuyKh Apr 28, 2024
7322e6d
feat: read consumption from tomorrow (gives better results)
GuyKh Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 36 additions & 34 deletions custom_components/iec/coordinator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,23 +227,24 @@ async def _async_update_data(
for device in devices:
attributes_to_add[METER_ID_ATTR_NAME] = device.device_number

remote_reading = await self._get_readings(contract_id, device.device_number, device.device_code,
monthly_report_req_date,
ReadingResolution.MONTHLY)
if remote_reading:
future_consumption[device.device_number] = remote_reading.future_consumption_info
daily_readings[device.device_number] = remote_reading.data
this_month_daily_readings = await self._get_readings(contract_id, device.device_number,
device.device_code,
monthly_report_req_date,
ReadingResolution.MONTHLY)
if this_month_daily_readings:
daily_readings[device.device_number] = this_month_daily_readings.data

weekly_future_consumption = None
if TIMEZONE.localize(datetime.today()).day == 1:
# if today's the 1st of the month, "yesterday" is on a different month
yesterday: datetime = monthly_report_req_date - timedelta(days=1)
remote_reading = await self._get_readings(contract_id, device.device_number, device.device_code,
yesterday,
ReadingResolution.WEEKLY)
if remote_reading:
daily_readings[device.device_number] += remote_reading.data
weekly_future_consumption = remote_reading.future_consumption_info
weekly_remote_reading = await self._get_readings(contract_id, device.device_number,
device.device_code,
yesterday,
ReadingResolution.WEEKLY)
if weekly_remote_reading:
daily_readings[device.device_number] += weekly_remote_reading.data
weekly_future_consumption = weekly_remote_reading.future_consumption_info

# Remove duplicates
daily_readings[device.device_number] = (
Expand All @@ -252,6 +253,12 @@ async def _async_update_data(
# Sort by Date
daily_readings[device.device_number].sort(key=lambda x: x.date)

# Tomorrow weekly readings - for getting the future consumption
tomorrow_readings = await self._get_readings(contract_id, device.device_number,
device.device_code,
monthly_report_req_date,
ReadingResolution.WEEKLY)

await self._verify_daily_readings_exist(daily_readings[device.device_number],
TIMEZONE.localize(datetime.today()) - timedelta(days=1),
device, contract_id)
Expand All @@ -266,28 +273,23 @@ async def _async_update_data(
self._today_readings[today_reading_key] = today_reading

await self._verify_daily_readings_exist(daily_readings[device.device_number],
TIMEZONE.localize(datetime.today()), device, contract_id, today_reading)

# fallbacks for future consumption since IEC api is broken :/
if not future_consumption[device.device_number].future_consumption:
if weekly_future_consumption and weekly_future_consumption.future_consumption:
future_consumption[device.device_number] = weekly_future_consumption
elif (self._today_readings.get(today_reading_key)
and self._today_readings.get(today_reading_key)
.future_consumption_info.future_consumption):
future_consumption[device.device_number] = (
self._today_readings.get(today_reading_key).future_consumption_info)
else:
req_date = TIMEZONE.localize(datetime.today()) - timedelta(days=2)
two_days_ago_reading = await self._get_readings(contract_id, device.device_number,
device.device_code,
req_date,
ReadingResolution.DAILY)

if two_days_ago_reading:
future_consumption[device.device_number] = two_days_ago_reading.future_consumption_info
else:
_LOGGER.debug("Failed fetching FutureConsumption, data in IEC API is corrupted")
TIMEZONE.localize(datetime.today()), device, contract_id,
today_reading)

# fallbacks for future consumption since IEC api is inconsistent....
if tomorrow_readings:
future_consumption[device.device_number] = tomorrow_readings.future_consumption_info
elif weekly_future_consumption:
future_consumption[device.device_number] = weekly_future_consumption
elif this_month_daily_readings:
future_consumption[device.device_number] = this_month_daily_readings.future_consumption_info
elif (self._today_readings.get(today_reading_key)
and self._today_readings.get(today_reading_key)
.future_consumption_info.future_consumption):
future_consumption[device.device_number] = (
self._today_readings.get(today_reading_key).future_consumption_info)
else:
_LOGGER.debug("Failed fetching FutureConsumption, data in IEC API is corrupted")

data[str(contract_id)] = {CONTRACT_DICT_NAME: contracts.get(contract_id),
INVOICE_DICT_NAME: last_invoice,
Expand Down
6 changes: 6 additions & 0 deletions custom_components/iec/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ def _get_reading_by_date(readings: list[RemoteReading] | None, desired_date: dat
value_fn=lambda data: (data[FUTURE_CONSUMPTIONS_DICT_NAME][data[ATTRIBUTES_DICT_NAME][METER_ID_ATTR_NAME]]
.total_import or 0) if (data[FUTURE_CONSUMPTIONS_DICT_NAME]) else None
),
IecEntityDescription(
key="elec_latest_meter_reading_date",
device_class=SensorDeviceClass.DATE,
value_fn=lambda data: (data[FUTURE_CONSUMPTIONS_DICT_NAME][data[ATTRIBUTES_DICT_NAME][METER_ID_ATTR_NAME]]
.total_import_date or 0) if (data[FUTURE_CONSUMPTIONS_DICT_NAME]) else None
),
)

ELEC_SENSORS: tuple[IecEntityDescription, ...] = (
Expand Down
3 changes: 3 additions & 0 deletions custom_components/iec/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
"elec_latest_meter_reading": {
"name": "IEC latest meter reading {multi_contract}"
},
"elec_latest_meter_reading_date": {
"name": "IEC latest meter reading date {multi_contract}"
},
"iec_last_elec_usage": {
"name": "Last IEC bill electric usage to date {multi_contract}"
},
Expand Down
3 changes: 3 additions & 0 deletions custom_components/iec/translations/he.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
"elec_latest_meter_reading": {
"name": "קריאת מונה אחרונה {multi_contract}"
},
"elec_latest_meter_reading_date": {
"name": "תאריך קריאת מונה אחרונה {multi_contract}"
},
"iec_last_elec_usage": {
"name": "סך צריכת החשמל בחשבונית האחרונה {multi_contract}"
},
Expand Down