SwiftBindings.Apple.Matter

SwiftBindings.Apple.Matter

Native .NET bindings for Apple's Matter framework — the Apple-provided client surface for the Matter smart-home protocol (MTRSetupPayload, MTRDeviceController, cluster types, etc.). Matter is a pure Objective-C framework; these bindings are generated through the SDK's ObjC pipeline so that the full Matter type surface is reachable from C# alongside the Swift-bridged frameworks.

📖 Full usage guide → — ObjC→C# naming, setup-payload parsing, the device-controller surface, and how the huge cluster catalog maps to C#.

Most production code reaches Matter via MatterSupport, which exposes the MatterAddDeviceRequest flow on top of the Matter types declared here. If you need that flow, install SwiftBindings.Apple.MatterSupport and this package will be pulled in transitively.

Installation

dotnet add package SwiftBindings.Apple.Matter

Requirements

• .NET 10.0+
• Target framework: net10.0-ios26.2 (or -macos26.2 / -maccatalyst26.2) or higher. The package is compiled against the iOS 26.2 SDK supplement, so your app's <TargetFramework> platform version must be ≥ 26.2 to restore it — an explicit lower TPV (e.g. net10.0-ios18.0) or a bare net10.0-ios whose installed workload defaults below 26.2 fails restore with NU1202. This is the compile-SDK pin, not your app's deployment minimum.
• Deployment minimum is separate — set your app's real minimum OS with <SupportedOSPlatformVersion> (independent of the TFM above). Matter's own runtime floor is iOS 16.1+ / macOS 13.0+ / Mac Catalyst 16.1+; individual APIs that need a newer OS are gated by generated [SupportedOSPlatform] attributes, and the C# compiler flags a call that isn't valid for your target.
• A Matter entitlement on the consuming app (Apple requires com.apple.developer.matter.allow-setup-payload for setup-payload usage)

Usage

using Matter;

// Parse a QR or manual setup payload string into an MTRSetupPayload.
var parser = new MTRQRCodeSetupPayloadParser("MT:U9VJ0OMV172PX813000");
NSError? error;
var payload = parser.PopulatePayload(out error);

Documentation

• Usage guide (wiki) — full C# walkthrough of the binding surface
• Apple Matter framework

How It Works

These bindings are auto-generated by Swift Dotnet Bindings using the SDK's ObjC pipeline. Matter ships with the OS, so this package contains the .NET binding assembly only — the framework itself is loaded from the device.

License

The bindings are MIT licensed. Matter is part of the Apple SDK; refer to Apple's licensing for the underlying framework.