Skip to content
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

Jump to bottom

Do not double IKEA battery percentage by default #3176

Merged
merged 1 commit into from
May 29, 2024
Merged

Do not double IKEA battery percentage by default #3176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions tests/test_ikea.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,14 +159,14 @@ def mock_read(attributes, manufacturer=None):
@pytest.mark.parametrize(
"firmware, pct_device, pct_correct, expected_pct_updates, expect_log_warning",
(
("1.0.024", 50, 100, 1, False), # old firmware, doubling
("2.3.075", 50, 100, 1, False), # old firmware, doubling
("2.4.5", 50, 50, 2, False), # new firmware, no doubling
("3.0.0", 50, 50, 2, False), # new firmware, no doubling
("24.4.5", 50, 50, 2, False), # new firmware, no doubling
("invalid_fw_string_1", 50, 50, 2, False), # treated as new, no doubling
("invalid.fw.string.2", 50, 50, 2, True), # treated as new, no doubling + log
("", 50, 100, 1, False), # treated as old fw, doubling
("1.0.024", 50, 100, 2, False), # old firmware, doubling
("2.3.075", 50, 100, 2, False), # old firmware, doubling
("2.4.5", 50, 50, 1, False), # new firmware, no doubling
("3.0.0", 50, 50, 1, False), # new firmware, no doubling
("24.4.5", 50, 50, 1, False), # new firmware, no doubling
("invalid_fw_string_1", 50, 50, 1, False), # treated as new, no doubling
("invalid.fw.string.2", 50, 50, 1, True), # treated as new, no doubling + log
("", 50, 50, 1, False), # treated as new fw, no doubling
),
)
async def test_double_power_config_firmware(
Expand Down Expand Up @@ -206,10 +206,10 @@ def mock_read(attributes, manufacturer=None):
)

with p1 as mock_task, p2 as request_mock:
# update battery percentage with no firmware in attr cache, check pct doubled for now
# update battery percentage with no firmware in attr cache, check pct not doubled for now
power_cluster.update_attribute(battery_pct_id, pct_device)
assert len(power_listener.attribute_updates) == 1
assert power_listener.attribute_updates[0] == (battery_pct_id, pct_device * 2)
assert power_listener.attribute_updates[0] == (battery_pct_id, pct_device)

# but also check that sw_build_id read is requested in the background for next update
assert mock_task.call_count == 1
Expand Down
22 changes: 11 additions & 11 deletions zhaquirks/ikea/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,9 +215,9 @@ def _is_firmware_new(self):
# get sw_build_id from attribute cache if available
sw_build_id = self.endpoint.basic.get(Basic.AttributeDefs.sw_build_id.id)

# sw_build_id is not cached or empty, so we consider it old firmware for now
# sw_build_id is not cached or empty, so we consider it new firmware for now
if not sw_build_id:
return False
return True

# split sw_build_id into parts to check for new firmware
split_fw_version = sw_build_id.split(".")
Expand Down Expand Up @@ -247,19 +247,19 @@ async def _read_fw_and_update_battery_pct(self, reported_battery_pct):
# read sw_build_id from device
await self.endpoint.basic.read_attributes([Basic.AttributeDefs.sw_build_id.id])

# check if sw_build_id was read successfully and new firmware is installed
# if so, update cache with reported battery percentage (non-doubled)
if self._is_firmware_new():
# check if sw_build_id was read successfully and old firmware is installed
# if so, update cache with reported battery percentage (doubled)
if not self._is_firmware_new():
self._update_attribute(
PowerConfiguration.AttributeDefs.battery_percentage_remaining.id,
reported_battery_pct,
reported_battery_pct * 2,
)

def _update_attribute(self, attrid, value):
"""Update attribute to double battery percentage if firmware is old/unknown.
"""Update attribute to double battery percentage if firmware is old.

If the firmware version is unknown, a background task to read the firmware version is also started,
but the percentage is also doubled for now then, as that task happens asynchronously.
but the percentage is not doubled for now then, as that task happens asynchronously.
"""
if attrid == PowerConfiguration.AttributeDefs.battery_percentage_remaining.id:
# if sw_build_id is not cached, create task to read from device, since it should be awake now
Expand All @@ -269,9 +269,9 @@ def _update_attribute(self, attrid, value):
):
self.create_catching_task(self._read_fw_and_update_battery_pct(value))

# double percentage if the firmware is old or unknown
# the coroutine above will not have executed yet if the firmware is unknown,
# so we double for now in that case too, and it updates again later if our doubling was wrong
# double percentage if the firmware is confirmed old
# The coroutine above will not have executed yet if the firmware is unknown,
# so we don't double for now. The coro doubles the value later if needed.
if not self._is_firmware_new():
value = value * 2
super()._update_attribute(attrid, value)
Expand Down
Loading