Matter For Swift

This repository contains the matter4swift code generator.

Code Generation

Make sure the connectedhomeip environment is active by executing

source <connectedhomeip-project-root>/scripts/active.sh

You can now execute the generator by invoking

$PW_PROJECT_ROOT/scripts/codegen.py \
    --generator custom:./matter4swift/Generator/:matter_trifork_idl_plugin \
    --option output:<output/path> \
    --option generate_views: \
    --option name:<package-name> \
    <path/to/your.matter>

This command will generate a swift package named <package-name> in the directory <output/path>.

Example:

$PW_PROJECT_ROOT/scripts/codegen.py \
    --generator custom:./Generator/:matter_trifork_idl_plugin \
    --option output:AllClusters \
    --option generate_views: \
    --option name:AllClusters \
    $PW_PROJECT_ROOT/examples/all-clusters-app/all-clusters-common/all-clusters-app.matter

You can omit generation of SwiftUI debug views by removing --option generate_views:.

Available Options

--option output:<output-path> (required)
Specifies the path to write generated files to.

--option name:<package-name> (required)
Specifies the name of the generated swift package

--option generate_views:
Also generates SwiftUI views that are useful for inspecting Matter devices

--option filter:{all|server_side|binding}:
Which clusters to include.

Using the Generated Package

Add the generated package to your app.

Example usage of an OnOffCluster from a generated AllClusters package to toggle a light on endpoint 1 of a Matter accessory:

let home: HMHome = ...
let controller = MTRDeviceController.sharedController(
    withID: home.matterControllerID as NSString,
    xpcConnect: home.matterControllerXPCConnectBlock
)

let accessory: HMAccessory = ...
let endpoint: matter4swift.EndpointNo = matter4swift.EndpointNo(1)

let cluster = AllClusters.OnOff.OnOffCluster(
    withController: controller,
    node: accessory.matterNodeID!,
    endpoint: endpoint
)
try await cluster.sendToggle()