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

Update matter-lock driver for U-tec #1812

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+347 −4
Open

Update matter-lock driver for U-tec #1812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3c60f45
Update matter-lock driver for U-tec
HunsupJung Dec 10, 2024
aa47454
Update test cases for matter-lock
HunsupJung Dec 20, 2024
4592168
Update handle_power_source_attribute_list function
HunsupJung Dec 24, 2024
fa76eda
Add test cases for matter-lock driver
HunsupJung Dec 24, 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
29 changes: 29 additions & 0 deletions drivers/SmartThings/matter-lock/profiles/lock-user-pin-battery.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: lock-user-pin-battery
components:
- id: main
capabilities:
- id: lock
version: 1
config:
values:
- key: "lock.value"
enabledValues:
- locked
- unlocked
- not fully locked
- id: lockAlarm
version: 1
- id: remoteControlStatus
version: 1
- id: lockUsers
version: 1
- id: lockCredentials
version: 1
- id: battery
version: 1
- id: firmwareUpdate
version: 1
- id: refresh
version: 1
categories:
- name: SmartLock
29 changes: 29 additions & 0 deletions drivers/SmartThings/matter-lock/profiles/lock-user-pin-batteryLevel.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: lock-user-pin-batteryLevel
components:
- id: main
capabilities:
- id: lock
version: 1
config:
values:
- key: "lock.value"
enabledValues:
- locked
- unlocked
- not fully locked
- id: lockAlarm
version: 1
- id: remoteControlStatus
version: 1
- id: lockUsers
version: 1
- id: lockCredentials
version: 1
- id: batteryLevel
version: 1
- id: firmwareUpdate
version: 1
- id: refresh
version: 1
categories:
- name: SmartLock
31 changes: 31 additions & 0 deletions drivers/SmartThings/matter-lock/profiles/lock-user-pin-schedule-battery.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: lock-user-pin-schedule-battery
components:
- id: main
capabilities:
- id: lock
version: 1
config:
values:
- key: "lock.value"
enabledValues:
- locked
- unlocked
- not fully locked
- id: lockAlarm
version: 1
- id: remoteControlStatus
version: 1
- id: lockUsers
version: 1
- id: lockCredentials
version: 1
- id: lockSchedules
version: 1
- id: battery
version: 1
- id: firmwareUpdate
version: 1
- id: refresh
version: 1
categories:
- name: SmartLock
83 changes: 79 additions & 4 deletions drivers/SmartThings/matter-lock/src/new-matter-lock/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,19 @@ if version.api < 10 then
end

local DoorLock = clusters.DoorLock
local PowerSource = clusters.PowerSource
local INITIAL_COTA_INDEX = 1
local ALL_INDEX = 0xFFFE

local NEW_MATTER_LOCK_PRODUCTS = {
{0x115f, 0x2802}, -- AQARA, U200
{0x115f, 0x2801}, -- AQARA, U300
{0x10E1, 0x2002} -- VDA
{0x147F, 0x0001}, -- U-tec
{0x10E1, 0x2002} -- VDA
}

local PROFILE_BASE_NAME = "__profile_base_name"

local subscribed_attributes = {
[capabilities.lock.ID] = {
DoorLock.attributes.LockState
Expand All @@ -53,6 +57,12 @@ local subscribed_attributes = {
[capabilities.lockSchedules.ID] = {
DoorLock.attributes.NumberOfWeekDaySchedulesSupportedPerUser,
DoorLock.attributes.NumberOfYearDaySchedulesSupportedPerUser
},
[capabilities.battery.ID] = {
PowerSource.attributes.BatPercentRemaining
},
[capabilities.batteryLevel.ID] = {
PowerSource.attributes.BatChargeLevel
}
}

Expand Down Expand Up @@ -126,6 +136,7 @@ local function do_configure(driver, device)
local pin_eps = device:get_endpoints(DoorLock.ID, {feature_bitmap = DoorLock.types.Feature.PIN_CREDENTIAL})
local week_schedule_eps = device:get_endpoints(DoorLock.ID, {feature_bitmap = DoorLock.types.Feature.WEEK_DAY_ACCESS_SCHEDULES})
local year_schedule_eps = device:get_endpoints(DoorLock.ID, {feature_bitmap = DoorLock.types.Feature.YEAR_DAY_ACCESS_SCHEDULES})
local battery_eps = device:get_endpoints(PowerSource.ID, {feature_bitmap = PowerSource.types.PowerSourceFeature.BATTERY})

local profile_name = "lock"
if #user_eps > 0 then
Expand All @@ -137,8 +148,16 @@ local function do_configure(driver, device)
profile_name = profile_name .. "-schedule"
end
end
device.log.info(string.format("Updating device profile to %s.", profile_name))
device:try_update_metadata({profile = profile_name})

if #battery_eps > 0 then
device:set_field(PROFILE_BASE_NAME, profile_name, {persist = true})
local req = im.InteractionRequest(im.InteractionRequest.RequestType.READ, {})
req:merge(clusters.PowerSource.attributes.AttributeList:read())
device:send(req)
else
device.log.info(string.format("Updating device profile to %s.", profile_name))
device:try_update_metadata({profile = profile_name})
end
end

local function info_changed(driver, device, event, args)
Expand Down Expand Up @@ -340,6 +359,55 @@ local function max_year_schedule_of_user_handler(driver, device, ib, response)
device:emit_event(capabilities.lockSchedules.yearDaySchedulesPerUser(ib.data.value, {visibility = {displayed = false}}))
end

---------------------------------
-- Power Source Attribute List --
---------------------------------
local function handle_power_source_attribute_list(driver, device, ib, response)
local support_battery_percentage = false
local support_battery_level = false
for _, attr in ipairs(ib.data.elements) do
-- Re-profile the device if BatPercentRemaining (Attribute ID 0x0C) is present.
if attr.value == 0x0C then
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add an explicit check for the BatChargeLevel attribute here?

if attr.value == 0x0C then
  support_battery_percentage = true
end
if attr.value == 0x0E then
    support_battery_level = true
end
------then later add this :-----------
  if support_battery_percentage then
    profile_name = profile_name .. "-battery"
  elseif support_battery_level
    profile_name = profile_name .. "-batteryLevel"
  end

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I will

support_battery_percentage = true
end
if attr.value == 0x0E then
support_battery_level = true
end
end
local profile_name = device:get_field(PROFILE_BASE_NAME)
if profile_name ~= nil then
if support_battery_percentage then
profile_name = profile_name .. "-battery"
elseif support_battery_level then
profile_name = profile_name .. "-batteryLevel"
end
device.log.info(string.format("Updating device profile to %s.", profile_name))
device:try_update_metadata({profile = profile_name})
end
end

-------------------------------
-- Battery Percent Remaining --
-------------------------------
local function handle_battery_percent_remaining(driver, device, ib, response)
if ib.data.value ~= nil then
device:emit_event(capabilities.battery.battery(math.floor(ib.data.value / 2.0 + 0.5)))
end
end

--------------------------
-- Battery Charge Level --
--------------------------
local function handle_battery_charge_level(driver, device, ib, response)
if ib.data.value == PowerSource.types.BatChargeLevelEnum.OK then
device:emit_event(capabilities.batteryLevel.battery.normal())
elseif ib.data.value == PowerSource.types.BatChargeLevelEnum.WARNING then
device:emit_event(capabilities.batteryLevel.battery.warning())
elseif ib.data.value == PowerSource.types.BatChargeLevelEnum.CRITICAL then
device:emit_event(capabilities.batteryLevel.battery.critical())
end
end

-- Capability Handler
-----------------
-- Lock/Unlock --
Expand Down Expand Up @@ -1634,6 +1702,11 @@ local new_matter_lock_handler = {
[DoorLock.attributes.RequirePINforRemoteOperation.ID] = require_remote_pin_handler,
[DoorLock.attributes.NumberOfWeekDaySchedulesSupportedPerUser.ID] = max_week_schedule_of_user_handler,
[DoorLock.attributes.NumberOfYearDaySchedulesSupportedPerUser.ID] = max_year_schedule_of_user_handler,
},
[PowerSource.ID] = {
[PowerSource.attributes.AttributeList.ID] = handle_power_source_attribute_list,
[PowerSource.attributes.BatPercentRemaining.ID] = handle_battery_percent_remaining,
[PowerSource.attributes.BatChargeLevel.ID] = handle_battery_charge_level,
}
},
event = {
Expand Down Expand Up @@ -1685,7 +1758,9 @@ local new_matter_lock_handler = {
capabilities.lock,
capabilities.lockUsers,
capabilities.lockCredentials,
capabilities.lockSchedules
capabilities.lockSchedules,
capabilities.battery,
capabilities.batteryLevel
},
can_handle = is_new_matter_lock_products
}
Expand Down
Loading
Loading