homekit-matter
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseHomeKit + MatterSupport
HomeKit + MatterSupport
Control home automation accessories and commission Matter devices. HomeKit manages
the home/room/accessory model, action sets, and triggers. MatterSupport handles
device commissioning into your ecosystem. Targets Swift 6.2 / iOS 26+.
控制家庭自动化配件并部署Matter设备。HomeKit负责管理家庭/房间/配件模型、动作集和触发器。MatterSupport则处理设备到您的生态系统的部署流程。目标环境为Swift 6.2 / iOS 26+。
Contents
目录
Setup
配置
HomeKit Configuration
HomeKit配置
- Enable the HomeKit capability in Xcode (Signing & Capabilities)
- Add to Info.plist:
NSHomeKitUsageDescription
xml
<key>NSHomeKitUsageDescription</key>
<string>This app controls your smart home accessories.</string>- 在Xcode的「签名与功能」中启用HomeKit功能
- 向Info.plist中添加键:
NSHomeKitUsageDescription
xml
<key>NSHomeKitUsageDescription</key>
<string>This app controls your smart home accessories.</string>MatterSupport Configuration
MatterSupport配置
For Matter commissioning into your own ecosystem:
- Enable the MatterSupport capability
- Add a MatterSupport Extension target to your project
- Add the entitlement if your app provides the setup code directly
com.apple.developer.matter.allow-setup-payload
若要将Matter设备部署到您的自有生态系统中:
- 启用MatterSupport功能
- 为项目添加MatterSupport扩展目标
- 如果您的应用直接提供配置代码,需添加权限
com.apple.developer.matter.allow-setup-payload
Availability Check
可用性检查
swift
import HomeKit
let homeManager = HMHomeManager()
// HomeKit is available on iPhone, iPad, Apple TV, Apple Watch, Mac, and Vision Pro.
// Authorization is handled through the delegate:
homeManager.delegate = selfswift
import HomeKit
let homeManager = HMHomeManager()
// HomeKit is available on iPhone, iPad, Apple TV, Apple Watch, Mac, and Vision Pro.
// Authorization is handled through the delegate:
homeManager.delegate = selfHomeKit Data Model
HomeKit数据模型
HomeKit organizes home automation in a hierarchy:
text
HMHomeManager
-> HMHome (one or more)
-> HMRoom (rooms in the home)
-> HMAccessory (devices in a room)
-> HMService (functions: light, thermostat, etc.)
-> HMCharacteristic (readable/writable values)
-> HMZone (groups of rooms)
-> HMActionSet (grouped actions)
-> HMTrigger (time or event-based triggers)HomeKit将家庭自动化按层级结构组织:
text
HMHomeManager
-> HMHome (one or more)
-> HMRoom (rooms in the home)
-> HMAccessory (devices in a room)
-> HMService (functions: light, thermostat, etc.)
-> HMCharacteristic (readable/writable values)
-> HMZone (groups of rooms)
-> HMActionSet (grouped actions)
-> HMTrigger (time or event-based triggers)Initializing the Home Manager
初始化家庭管理器
Create a single and implement the delegate to know when
data is loaded. HomeKit loads asynchronously -- do not access until
the delegate fires.
HMHomeManagerhomesswift
import HomeKit
final class HomeStore: NSObject, HMHomeManagerDelegate {
let homeManager = HMHomeManager()
override init() {
super.init()
homeManager.delegate = self
}
func homeManagerDidUpdateHomes(_ manager: HMHomeManager) {
// Safe to access manager.homes now
let homes = manager.homes
let primaryHome = manager.primaryHome
print("Loaded \(homes.count) homes")
}
func homeManager(
_ manager: HMHomeManager,
didUpdate status: HMHomeManagerAuthorizationStatus
) {
if status.contains(.authorized) {
print("HomeKit access granted")
}
}
}创建单个实例并实现代理,以知晓数据何时加载完成。HomeKit采用异步加载方式——在代理触发前请勿访问属性。
HMHomeManagerhomesswift
import HomeKit
final class HomeStore: NSObject, HMHomeManagerDelegate {
let homeManager = HMHomeManager()
override init() {
super.init()
homeManager.delegate = self
}
func homeManagerDidUpdateHomes(_ manager: HMHomeManager) {
// Safe to access manager.homes now
let homes = manager.homes
let primaryHome = manager.primaryHome
print("Loaded \\(homes.count) homes")
}
func homeManager(
_ manager: HMHomeManager,
didUpdate status: HMHomeManagerAuthorizationStatus
) {
if status.contains(.authorized) {
print("HomeKit access granted")
}
}
}Accessing Rooms
访问房间
swift
guard let home = homeManager.primaryHome else { return }
let rooms = home.rooms
let kitchen = rooms.first { $0.name == "Kitchen" }
// Room for accessories not assigned to a specific room
let defaultRoom = home.roomForEntireHome()swift
guard let home = homeManager.primaryHome else { return }
let rooms = home.rooms
let kitchen = rooms.first { $0.name == "Kitchen" }
// Room for accessories not assigned to a specific room
let defaultRoom = home.roomForEntireHome()Managing Accessories
配件管理
Discovering and Adding Accessories
发现并添加配件
swift
// System UI for accessory discovery
home.addAndSetupAccessories { error in
if let error {
print("Setup failed: \(error)")
}
}swift
// System UI for accessory discovery
home.addAndSetupAccessories { error in
if let error {
print("Setup failed: \\(error)")
}
}Listing Accessories and Services
列出配件与服务
swift
for accessory in home.accessories {
print("\(accessory.name) in \(accessory.room?.name ?? "unassigned")")
for service in accessory.services {
print(" Service: \(service.serviceType)")
for characteristic in service.characteristics {
print(" \(characteristic.characteristicType): \(characteristic.value ?? "nil")")
}
}
}swift
for accessory in home.accessories {
print("\\(accessory.name) in \\(accessory.room?.name ?? "unassigned")")
for service in accessory.services {
print(" Service: \\(service.serviceType)")
for characteristic in service.characteristics {
print(" \\(characteristic.characteristicType): \\(characteristic.value ?? "nil")")
}
}
}Moving an Accessory to a Room
将配件移至指定房间
swift
guard let accessory = home.accessories.first,
let bedroom = home.rooms.first(where: { $0.name == "Bedroom" }) else { return }
home.assignAccessory(accessory, to: bedroom) { error in
if let error {
print("Failed to move accessory: \(error)")
}
}swift
guard let accessory = home.accessories.first,
let bedroom = home.rooms.first(where: { $0.name == "Bedroom" }) else { return }
home.assignAccessory(accessory, to: bedroom) { error in
if let error {
print("Failed to move accessory: \\(error)")
}
}Reading and Writing Characteristics
特性读写
Reading a Value
读取值
swift
let characteristic: HMCharacteristic = // obtained from a service
characteristic.readValue { error in
guard error == nil else { return }
if let value = characteristic.value as? Bool {
print("Power state: \(value)")
}
}swift
let characteristic: HMCharacteristic = // obtained from a service
characteristic.readValue { error in
guard error == nil else { return }
if let value = characteristic.value as? Bool {
print("Power state: \\(value)")
}
}Writing a Value
写入值
swift
// Turn on a light
characteristic.writeValue(true) { error in
if let error {
print("Write failed: \(error)")
}
}swift
// Turn on a light
characteristic.writeValue(true) { error in
if let error {
print("Write failed: \\(error)")
}
}Observing Changes
监听变更
Enable notifications for real-time updates:
swift
characteristic.enableNotification(true) { error in
guard error == nil else { return }
}
// In HMAccessoryDelegate:
func accessory(
_ accessory: HMAccessory,
service: HMService,
didUpdateValueFor characteristic: HMCharacteristic
) {
print("Updated: \(characteristic.value ?? "nil")")
}启用通知以获取实时更新:
swift
characteristic.enableNotification(true) { error in
guard error == nil else { return }
}
// In HMAccessoryDelegate:
func accessory(
_ accessory: HMAccessory,
service: HMService,
didUpdateValueFor characteristic: HMCharacteristic
) {
print("Updated: \\(characteristic.value ?? "nil")")
}Action Sets and Triggers
动作集与触发器
Creating an Action Set
创建动作集
An groups characteristic writes that execute together:
HMActionSetswift
home.addActionSet(withName: "Good Night") { actionSet, error in
guard let actionSet, error == nil else { return }
// Turn off living room light
let lightChar = livingRoomLight.powerCharacteristic
let action = HMCharacteristicWriteAction(
characteristic: lightChar,
targetValue: false as NSCopying
)
actionSet.addAction(action) { error in
guard error == nil else { return }
print("Action added to Good Night scene")
}
}HMActionSetswift
home.addActionSet(withName: "Good Night") { actionSet, error in
guard let actionSet, error == nil else { return }
// Turn off living room light
let lightChar = livingRoomLight.powerCharacteristic
let action = HMCharacteristicWriteAction(
characteristic: lightChar,
targetValue: false as NSCopying
)
actionSet.addAction(action) { error in
guard error == nil else { return }
print("Action added to Good Night scene")
}
}Executing an Action Set
执行动作集
swift
home.executeActionSet(actionSet) { error in
if let error {
print("Execution failed: \(error)")
}
}swift
home.executeActionSet(actionSet) { error in
if let error {
print("Execution failed: \\(error)")
}
}Creating a Timer Trigger
创建定时器触发器
swift
var dateComponents = DateComponents()
dateComponents.hour = 22
dateComponents.minute = 30
let trigger = HMTimerTrigger(
name: "Nightly",
fireDate: Calendar.current.nextDate(
after: Date(),
matching: dateComponents,
matchingPolicy: .nextTime
)!,
timeZone: .current,
recurrence: dateComponents, // Repeats daily at 22:30
recurrenceCalendar: .current
)
home.addTrigger(trigger) { error in
guard error == nil else { return }
// Attach the action set to the trigger
trigger.addActionSet(goodNightActionSet) { error in
guard error == nil else { return }
trigger.enable(true) { error in
print("Trigger enabled: \(error == nil)")
}
}
}swift
var dateComponents = DateComponents()
dateComponents.hour = 22
dateComponents.minute = 30
let trigger = HMTimerTrigger(
name: "Nightly",
fireDate: Calendar.current.nextDate(
after: Date(),
matching: dateComponents,
matchingPolicy: .nextTime
)!,
timeZone: .current,
recurrence: dateComponents, // Repeats daily at 22:30
recurrenceCalendar: .current
)
home.addTrigger(trigger) { error in
guard error == nil else { return }
// Attach the action set to the trigger
trigger.addActionSet(goodNightActionSet) { error in
guard error == nil else { return }
trigger.enable(true) { error in
print("Trigger enabled: \\(error == nil)")
}
}
}Creating an Event Trigger
创建事件触发器
swift
let motionDetected = HMCharacteristicEvent(
characteristic: motionSensorCharacteristic,
triggerValue: true as NSCopying
)
let eventTrigger = HMEventTrigger(
name: "Motion Lights",
events: [motionDetected],
predicate: nil
)
home.addTrigger(eventTrigger) { error in
// Add action sets as above
}swift
let motionDetected = HMCharacteristicEvent(
characteristic: motionSensorCharacteristic,
triggerValue: true as NSCopying
)
let eventTrigger = HMEventTrigger(
name: "Motion Lights",
events: [motionDetected],
predicate: nil
)
home.addTrigger(eventTrigger) { error in
// Add action sets as above
}Matter Commissioning
Matter设备部署
Use to commission a Matter device into your ecosystem.
This is separate from HomeKit -- it handles the pairing flow.
MatterAddDeviceRequest使用将Matter设备部署到您的生态系统中。这与HomeKit是独立的流程——它负责处理配对流程。
MatterAddDeviceRequestBasic Commissioning
基础部署
swift
import MatterSupport
func addMatterDevice() async throws {
guard MatterAddDeviceRequest.isSupported else {
print("Matter not supported on this device")
return
}
let topology = MatterAddDeviceRequest.Topology(
ecosystemName: "My Smart Home",
homes: [
MatterAddDeviceRequest.Home(displayName: "Main House")
]
)
let request = MatterAddDeviceRequest(
topology: topology,
setupPayload: nil,
showing: .allDevices
)
// Presents system UI for device pairing
try await request.perform()
}swift
import MatterSupport
func addMatterDevice() async throws {
guard MatterAddDeviceRequest.isSupported else {
print("Matter not supported on this device")
return
}
let topology = MatterAddDeviceRequest.Topology(
ecosystemName: "My Smart Home",
homes: [
MatterAddDeviceRequest.Home(displayName: "Main House")
]
)
let request = MatterAddDeviceRequest(
topology: topology,
setupPayload: nil,
showing: .allDevices
)
// Presents system UI for device pairing
try await request.perform()
}Filtering Devices
过滤设备
swift
// Only show devices from a specific vendor
let criteria = MatterAddDeviceRequest.DeviceCriteria.vendorID(0x1234)
let request = MatterAddDeviceRequest(
topology: topology,
setupPayload: nil,
showing: criteria
)swift
// Only show devices from a specific vendor
let criteria = MatterAddDeviceRequest.DeviceCriteria.vendorID(0x1234)
let request = MatterAddDeviceRequest(
topology: topology,
setupPayload: nil,
showing: criteria
)Combining Device Criteria
组合设备筛选条件
swift
let criteria = MatterAddDeviceRequest.DeviceCriteria.all([
.vendorID(0x1234),
.not(.productID(0x0001)) // Exclude a specific product
])swift
let criteria = MatterAddDeviceRequest.DeviceCriteria.all([
.vendorID(0x1234),
.not(.productID(0x0001)) // Exclude a specific product
])MatterAddDeviceExtensionRequestHandler
MatterAddDeviceExtensionRequestHandler
For full ecosystem support, create a MatterSupport Extension. The extension
handles commissioning callbacks:
swift
import MatterSupport
final class MatterHandler: MatterAddDeviceExtensionRequestHandler {
override func validateDeviceCredential(
_ deviceCredential: DeviceCredential
) async throws {
// Validate the device attestation certificate
// Throw to reject the device
}
override func rooms(
in home: MatterAddDeviceRequest.Home?
) async -> [MatterAddDeviceRequest.Room] {
// Return rooms in the selected home
return [
MatterAddDeviceRequest.Room(displayName: "Living Room"),
MatterAddDeviceRequest.Room(displayName: "Kitchen")
]
}
override func configureDevice(
named name: String,
in room: MatterAddDeviceRequest.Room?
) async {
// Save the device configuration to your backend
print("Configuring \(name) in \(room?.displayName ?? "no room")")
}
override func commissionDevice(
in home: MatterAddDeviceRequest.Home?,
onboardingPayload: String,
commissioningID: UUID
) async throws {
// Use the onboarding payload to commission the device
// into your fabric using the Matter framework
}
}如需完整的生态系统支持,请创建MatterSupport扩展。该扩展负责处理部署回调:
swift
import MatterSupport
final class MatterHandler: MatterAddDeviceExtensionRequestHandler {
override func validateDeviceCredential(
_ deviceCredential: DeviceCredential
) async throws {
// Validate the device attestation certificate
// Throw to reject the device
}
override func rooms(
in home: MatterAddDeviceRequest.Home?
) async -> [MatterAddDeviceRequest.Room] {
// Return rooms in the selected home
return [
MatterAddDeviceRequest.Room(displayName: "Living Room"),
MatterAddDeviceRequest.Room(displayName: "Kitchen")
]
}
override func configureDevice(
named name: String,
in room: MatterAddDeviceRequest.Room?
) async {
// Save the device configuration to your backend
print("Configuring \\(name) in \\(room?.displayName ?? "no room")")
}
override func commissionDevice(
in home: MatterAddDeviceRequest.Home?,
onboardingPayload: String,
commissioningID: UUID
) async throws {
// Use the onboarding payload to commission the device
// into your fabric using the Matter framework
}
}Common Mistakes
常见错误
DON'T: Access homes before the delegate fires
错误做法:在代理触发前访问homes属性
swift
// WRONG -- homes array is empty until delegate is called
let manager = HMHomeManager()
let homes = manager.homes // Always empty here
// CORRECT -- wait for delegate
func homeManagerDidUpdateHomes(_ manager: HMHomeManager) {
let homes = manager.homes // Now populated
}swift
// WRONG -- homes array is empty until delegate is called
let manager = HMHomeManager()
let homes = manager.homes // Always empty here
// CORRECT -- wait for delegate
func homeManagerDidUpdateHomes(_ manager: HMHomeManager) {
let homes = manager.homes // Now populated
}DON'T: Confuse HomeKit setup with Matter commissioning
错误做法:混淆HomeKit配置与Matter部署
swift
// WRONG -- using HomeKit accessory setup for a Matter ecosystem app
home.addAndSetupAccessories { error in }
// CORRECT -- use MatterAddDeviceRequest for Matter ecosystem commissioning
let request = MatterAddDeviceRequest(
topology: topology,
setupPayload: nil,
showing: .allDevices
)
try await request.perform()swift
// WRONG -- using HomeKit accessory setup for a Matter ecosystem app
home.addAndSetupAccessories { error in }
// CORRECT -- use MatterAddDeviceRequest for Matter ecosystem commissioning
let request = MatterAddDeviceRequest(
topology: topology,
setupPayload: nil,
showing: .allDevices
)
try await request.perform()DON'T: Forget required entitlements
错误做法:遗漏必要权限
swift
// WRONG -- calling Matter APIs without the MatterSupport entitlement
// Results in runtime error
// CORRECT -- ensure these are set up:
// 1. HomeKit capability for HMHomeManager access
// 2. MatterSupport Extension target for ecosystem commissioning
// 3. com.apple.developer.matter.allow-setup-payload if providing setup codesswift
// WRONG -- calling Matter APIs without the MatterSupport entitlement
// Results in runtime error
// CORRECT -- ensure these are set up:
// 1. HomeKit capability for HMHomeManager access
// 2. MatterSupport Extension target for ecosystem commissioning
// 3. com.apple.developer.matter.allow-setup-payload if providing setup codesDON'T: Create multiple HMHomeManager instances
错误做法:创建多个HMHomeManager实例
swift
// WRONG -- each instance loads the full database independently
class ScreenA { let manager = HMHomeManager() }
class ScreenB { let manager = HMHomeManager() }
// CORRECT -- single shared instance
@Observable
final class HomeStore {
static let shared = HomeStore()
let homeManager = HMHomeManager()
}swift
// WRONG -- each instance loads the full database independently
class ScreenA { let manager = HMHomeManager() }
class ScreenB { let manager = HMHomeManager() }
// CORRECT -- single shared instance
@Observable
final class HomeStore {
static let shared = HomeStore()
let homeManager = HMHomeManager()
}DON'T: Write characteristics without checking metadata
错误做法:未检查元数据就写入特性值
swift
// WRONG -- writing a value outside the valid range
characteristic.writeValue(500) { _ in }
// CORRECT -- check metadata first
if let metadata = characteristic.metadata,
let maxValue = metadata.maximumValue?.intValue {
let safeValue = min(brightness, maxValue)
characteristic.writeValue(safeValue) { _ in }
}swift
// WRONG -- writing a value outside the valid range
characteristic.writeValue(500) { _ in }
// CORRECT -- check metadata first
if let metadata = characteristic.metadata,
let maxValue = metadata.maximumValue?.intValue {
let safeValue = min(brightness, maxValue)
characteristic.writeValue(safeValue) { _ in }
}Review Checklist
审核检查清单
- HomeKit capability enabled in Xcode
- present in Info.plist
NSHomeKitUsageDescription - Single instance shared across the app
HMHomeManager - implemented; homes not accessed before
HMHomeManagerDelegatehomeManagerDidUpdateHomes - set on homes to receive accessory and room changes
HMHomeDelegate - set on accessories to receive characteristic updates
HMAccessoryDelegate - Characteristic metadata checked before writing values
- Error handling in all completion handlers
- MatterSupport capability and extension target added for Matter commissioning
- checked before performing requests
MatterAddDeviceRequest.isSupported - Matter extension handler implements
commissionDevice(in:onboardingPayload:commissioningID:) - Action sets tested with the HomeKit Accessory Simulator before shipping
- Triggers enabled after creation ()
trigger.enable(true)
- 已在Xcode中启用HomeKit功能
- Info.plist中已添加
NSHomeKitUsageDescription - 应用中使用单个共享的实例
HMHomeManager - 已实现,未在
HMHomeManagerDelegate触发前访问homes属性homeManagerDidUpdateHomes - 已为家庭设置以接收配件和房间变更通知
HMHomeDelegate - 已为配件设置以接收特性更新通知
HMAccessoryDelegate - 写入特性值前已检查元数据
- 所有完成回调中均包含错误处理
- 已添加MatterSupport功能与扩展目标以支持Matter部署
- 执行请求前已检查
MatterAddDeviceRequest.isSupported - Matter扩展处理器已实现方法
commissionDevice(in:onboardingPayload:commissioningID:) - 上线前已使用HomeKit配件模拟器测试动作集
- 创建触发器后已启用()
trigger.enable(true)
References
参考资料
- Extended patterns (Matter extension, delegate wiring, SwiftUI):
references/matter-commissioning.md - HomeKit framework
- HMHomeManager
- HMHome
- HMAccessory
- HMRoom
- HMActionSet
- HMTrigger
- MatterSupport framework
- MatterAddDeviceRequest
- MatterAddDeviceExtensionRequestHandler
- Enabling HomeKit in your app
- Adding Matter support to your ecosystem
- 扩展模式(Matter扩展、代理配置、SwiftUI):
references/matter-commissioning.md - HomeKit framework
- HMHomeManager
- HMHome
- HMAccessory
- HMRoom
- HMActionSet
- HMTrigger
- MatterSupport framework
- MatterAddDeviceRequest
- MatterAddDeviceExtensionRequestHandler
- Enabling HomeKit in your app
- Adding Matter support to your ecosystem ",