Skip to content

Modular Profiles: Gate HubCore 0.58 Release Required Logic #2350

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 5 commits into
base: main
Choose a base branch
from
Open

Modular Profiles: Gate HubCore 0.58 Release Required Logic #2350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5af44f8
gate pre-57 required logic
hcarter-775 Aug 18, 2025
77f297d
fixup! respond to comments
hcarter-775 Aug 19, 2025
e781113
fixup! remove whitespace
hcarter-775 Aug 19, 2025
235213e
remove table after 58 update
hcarter-775 Aug 22, 2025
89618f1
Merge branch 'main' into update-modular-profile-logic
hcarter-775 Aug 29, 2025
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: 19 additions & 10 deletions drivers/SmartThings/matter-sensor/src/air-quality-sensor/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,13 +401,17 @@ local function match_modular_profile(driver, device)

device:try_update_metadata({profile = profile_name, optional_component_capabilities = optional_supported_component_capabilities})

-- add mandatory capabilities for subscription
local total_supported_capabilities = optional_supported_component_capabilities
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.airQualityHealthConcern.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.refresh.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.firmwareUpdate.ID)

device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, { persist = true })
-- earlier modular profile gating (min api v14, rpc 8) ensures we are running >= 0.57 FW.
-- This gating specifies a workaround required only for 0.57 FW, which is not needed for 0.58 and higher.
if version.api < 15 or version.rpc < 9 then
-- add mandatory capabilities for subscription
local total_supported_capabilities = optional_supported_component_capabilities
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.airQualityHealthConcern.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.refresh.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.firmwareUpdate.ID)

device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, { persist = true })
Copy link
Contributor

Choose a reason for hiding this comment

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

We should be able to remove this table for drivers that no longer would need it after the hub updates to 58, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that's true, table removal logic added in latest commit

end
end

local function do_configure(driver, device)
Expand Down Expand Up @@ -436,9 +440,14 @@ end

local function device_init(driver, device)
if device:get_field(SUPPORTED_COMPONENT_CAPABILITIES) then
-- assume that device is using a modular profile, override supports_capability_by_id
-- library function to utilize optional capabilities
device:extend_device("supports_capability_by_id", supports_capability_by_id_modular)
if version.api >= 15 and version.rpc >= 9 then
-- the device used this modular profile workaround on 0.57 FW but no longer requires this table with >=0.58 FW
device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, nil)
else
-- assume that device is using a modular profile on 0.57 FW, override supports_capability_by_id
-- library function to utilize optional capabilities
device:extend_device("supports_capability_by_id", supports_capability_by_id_modular)
end
end
device:subscribe()
end
Expand Down
67 changes: 42 additions & 25 deletions drivers/SmartThings/matter-thermostat/src/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,9 +492,14 @@ end

local function device_init(driver, device)
if device:get_field(SUPPORTED_COMPONENT_CAPABILITIES) then
-- assume that device is using a modular profile, override supports_capability_by_id
-- library function to utilize optional capabilities
device:extend_device("supports_capability_by_id", supports_capability_by_id_modular)
if version.api >= 15 and version.rpc >= 9 then
-- the device used this modular profile workaround on 0.57 FW but no longer requires this table with >=0.58 FW
device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, nil)
else
-- assume that device is using a modular profile on 0.57 FW, override supports_capability_by_id
-- library function to utilize optional capabilities
device:extend_device("supports_capability_by_id", supports_capability_by_id_modular)
end
end
device:subscribe()
device:set_component_to_endpoint_fn(component_to_endpoint)
Expand Down Expand Up @@ -985,14 +990,18 @@ local function match_modular_profile_air_purifer(driver, device)

device:try_update_metadata({profile = profile_name, optional_component_capabilities = optional_supported_component_capabilities})

-- add mandatory capabilities for subscription
local total_supported_capabilities = optional_supported_component_capabilities
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.airPurifierFanMode.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.fanSpeedPercent.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.refresh.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.firmwareUpdate.ID)
-- earlier modular profile gating (min api v14, rpc 8) ensures we are running >= 0.57 FW.
-- This gating specifies a workaround required only for 0.57 FW, which is not needed for 0.58 and higher.
if version.api < 15 or version.rpc < 9 then
-- add mandatory capabilities for subscription
local total_supported_capabilities = optional_supported_component_capabilities
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.airPurifierFanMode.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.fanSpeedPercent.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.refresh.ID)
table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.firmwareUpdate.ID)

device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, { persist = true })
device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, { persist = true })
end
end

local function match_modular_profile_thermostat(driver, device)
Expand Down Expand Up @@ -1035,14 +1044,18 @@ local function match_modular_profile_thermostat(driver, device)
table.insert(optional_supported_component_capabilities, {"main", main_component_capabilities})
device:try_update_metadata({profile = profile_name, optional_component_capabilities = optional_supported_component_capabilities})

-- add mandatory capabilities for subscription
local total_supported_capabilities = optional_supported_component_capabilities
table.insert(main_component_capabilities, capabilities.thermostatMode.ID)
table.insert(main_component_capabilities, capabilities.temperatureMeasurement.ID)
table.insert(main_component_capabilities, capabilities.refresh.ID)
table.insert(main_component_capabilities, capabilities.firmwareUpdate.ID)
-- earlier modular profile gating (min api v14, rpc 8) ensures we are running >= 0.57 FW.
-- This gating specifies a workaround required only for 0.57 FW, which is not needed for 0.58 and higher.
if version.api < 15 or version.rpc < 9 then
-- add mandatory capabilities for subscription
local total_supported_capabilities = optional_supported_component_capabilities
table.insert(main_component_capabilities, capabilities.thermostatMode.ID)
table.insert(main_component_capabilities, capabilities.temperatureMeasurement.ID)
table.insert(main_component_capabilities, capabilities.refresh.ID)
table.insert(main_component_capabilities, capabilities.firmwareUpdate.ID)

device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, { persist = true })
device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, { persist = true })
end
end

local function match_modular_profile_room_ac(driver, device)
Expand Down Expand Up @@ -1086,15 +1099,19 @@ local function match_modular_profile_room_ac(driver, device)
table.insert(optional_supported_component_capabilities, {"main", main_component_capabilities})
device:try_update_metadata({profile = profile_name, optional_component_capabilities = optional_supported_component_capabilities})

-- add mandatory capabilities for subscription
local total_supported_capabilities = optional_supported_component_capabilities
table.insert(main_component_capabilities, capabilities.switch.ID)
table.insert(main_component_capabilities, capabilities.temperatureMeasurement.ID)
table.insert(main_component_capabilities, capabilities.thermostatMode.ID)
table.insert(main_component_capabilities, capabilities.refresh.ID)
table.insert(main_component_capabilities, capabilities.firmwareUpdate.ID)
-- earlier modular profile gating (min api v14, rpc 8) ensures we are running >= 0.57 FW.
-- This gating specifies a workaround required only for 0.57 FW, which is not needed for 0.58 and higher.
if version.api < 15 or version.rpc < 9 then
-- add mandatory capabilities for subscription
local total_supported_capabilities = optional_supported_component_capabilities
table.insert(main_component_capabilities, capabilities.switch.ID)
table.insert(main_component_capabilities, capabilities.temperatureMeasurement.ID)
table.insert(main_component_capabilities, capabilities.thermostatMode.ID)
table.insert(main_component_capabilities, capabilities.refresh.ID)
table.insert(main_component_capabilities, capabilities.firmwareUpdate.ID)

device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, { persist = true })
device:set_field(SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, { persist = true })
end
end

local function match_modular_profile(driver, device, device_type)
Expand Down
Loading