跳到主要内容

Overview

The Matter SDK (@espressif/rainmaker-matter-sdk) helps your app add Matter smart-home devices to ESP RainMaker — create a home (fabric), scan a QR code to add a device, then control it from the app.

It builds on the RainMaker Base SDK. You still use the base SDK for login, storage, and cloud APIs. This package adds Matter-specific pieces on top.

npm

What you can build

You want to…This SDK covers
Make a RainMaker home Matter-readyFabrics (Matter-enabled groups)
Add a Matter device with a QR codeCommissioning
Let the user manage that home’s Matter devicesCertificates (user / device NoCs)
Show device features on a control screenMatter nodes + cluster config
Toggle / dim devices on the same Wi‑FiLocal Control
Control when the phone is away from homeRemote Control (via a RainMaker Controller)

Typical path for a new app:

  1. Install and configure → Getting Started
  2. Plug in Home app adapters → Matter Adapters
  3. Create or convert a fabric → Fabric Management
  4. Commission a device → Device Commissioning
  5. Control and render UI → Controlling · Cluster Config

Before you start

You do not need to write native Matter bridges from scratch if you follow the Home app adapters.


How the pieces fit

This package extends the Base SDK. Reuse the same base adapter config, then add Matter fields (commission / control / subscription / discovery adapters, matterVendorId, clusterConfig).

Home app reference — getMatterSDKConfig():

export function getMatterSDKConfig(): ESPRMMatterBaseConfig {
return {
...getRMSDKConfig(), // base adapters + cloud URL
matterCommissioningAdaptor,
matterControlAdapter: ESPMatterControlAdapter,
matterSubscriptionAdapter: ESPMatterSubscriptionAdapter,
matterLocalDiscoveryAdapter,
matterVendorId: matterSdk.vendorId ?? "0x131B",
clusterConfig: matterClusterConfig,
};
}

Find a topic

TopicPage
Install and configureGetting Started
Adapters (Home app implementations)Matter Adapters
Homes / fabricsFabric Management
Add a deviceCommissioning
CertificatesCertificate Management
Control devicesControlling
Live attribute updatesMatter Subscription
Nodes and control UIMatter Nodes · Cluster Config

More

On this page