Skip to main content
Ctrl+K
Matter documentation - Home
  • GitHub

Contents

  • Matter Project Flow
  • Visual Studio Code Development
  • CI/CD Documentation
    • Daily Fail Summary
  • Development Controllers
    • chip-repl
      • Matter Python REPL
      • Using Python CHIP Controller advanced features
      • Working with Python CHIP Controller
    • chip-tool
      • Working with the CHIP Tool
  • Getting Started
    • Compiling, Running, and Controlling Matter examples
    • Changing Examples
    • SDK Architecture Overview
  • IDs and Codes
    • Matter SDK CHIP_ERROR enums values
    • List of currently defined spec clusters
    • List of currently defined ZAP clusters
  • Cluster and Device Type development
    • Implementing New Clusters & Device Types
    • Adding new clusters and device types to the codegen
    • Designing Clusters for Testing and Portability
  • Guides
    • Building Matter
    • Access Control Guide
    • Matter Development and Testing with/on Apple Devices
    • Fabric Synchronization Guide
    • The .matter IDL file format
    • Simulated Device How-To (Linux)
  • Platform Guides
    • Android
      • Building Android
    • ASR
      • ASR Getting Started Guide
    • Bouffalolab
      • Checking out the Matter code
      • Introduction to Matter factory data
      • Build OTA image
      • Bouffalo Lab SoCs
      • Bouffalo Lab with RPC console
    • Espressif (ESP32) Getting Started Guide
      • Bluetooth Low Energy (BLE)
      • ESP32 Application Usage Guide
      • Configuration options
      • Using ESP32 Factory Data Provider
      • Flash and NVS encryption
      • Matter OTA
      • Providers Implemented for ESP32 Platform
      • RPC Console and Device Tracing
      • Using esp_secure_cert partition
      • Setup ESP-IDF and Matter Environment
      • Visual Studio Code Development
    • Infineon
      • Matter Software Update with Infineon PSoC6 example applications
      • Infineon OPTIGA™ Trust M Provisioning for Matter
    • MbedOS
      • Mbed-OS add new hardware target
      • Matter Arm Mbed OS provisioning guide
      • Mbed-OS platform overview
    • NRF
      • Commissioning nRF Connect Accessory using Android CHIPTool
      • Using CLI in nRF Connect examples
      • Configuring nRF Connect examples
      • Performing Device Firmware Upgrade in the nRF Connect examples
      • Configuring factory data for the nRF Connect examples
      • nRF Connect platform overview
    • NXP
      • Matter Over-The-Air Software Update with NXP RTs example applications
      • Building and Running CHIP Linux Examples for i.MX 8M Mini EVK
      • NXP K32W0x1 OTA guide
      • Commissioning NXP K32W using Android CHIPTool
      • NXP Manufacturing data
      • NXP MCXW71/K32W1 OTA guide
      • Thread Border Router usage
      • Matter Over-The-Air Software Update with NXP using Zephyr example applications
    • OpenIoTSDK
      • Commissioning Open IoT SDK devices
      • Matter Open IoT SDK Example Application
      • Matter Open IoT SDK Example Device Firmware Upgrade
      • Open IoT SDK platform port
      • Matter Open IoT SDK unit tests
    • OpenThread
      • Setup OpenThread Border Router on Raspberry Pi
      • Configuring OpenThread Radio Co-processor on nRF52840 Dongle
    • Silabs
      • Silabs CLI Guide
      • Standard Application Behavior Guide
      • Matter Software Update with EFR32 example applications
      • Silicon Labs Matter Solution Guide
    • STM32
      • STM32 Getting Started Guide
    • TI
      • Running Matter Examples on the TI SimpleLink CC2674P10 and CC2674R10
      • Get started with SysConfig
      • Configure The Board Files with SysConfig
      • Configuring OpenThread libraries on TI CC13x4_CC26x4 Platforms
      • Texas Instruments Matter Factory Data Programming User Guide
      • Configuring Intermittently Connected Devices on TI SimpleLink CC13x4_CC26x4 Platforms
      • Texas Instruments platform overview
      • Running Matter Examples on the TI SimpleLink CC2674P10 and CC2674R10
      • Get started with SysConfig
      • Configure The Board Files with SysConfig
      • Configuring Intermittently Connected Devices on TI SimpleLink CC13x4_CC26x4 Platforms
      • Texas Instruments Matter Factory Data Programming User Guide
      • Configuring OpenThread libraries on TI CC13x4_CC26x4 Platforms
  • Style Guides
    • Coding Style Guide
    • CHIP Makefile Style Guide
    • Matter Documentation Style Guide
  • Examples
    • Air Purifier
      • CHIP Air Purifier Example
      • CHIP Ameba Air Purifier Example
      • Matter CC32XXSF Air Purifier Example Application
      • CHIP Linux Air Purifier Example
    • Air Quality
      • Matter Linux Air Quality Example
      • Matter Air Quality Sensor Example
      • Matter Telink Air Quality Sensor Example Application
    • All clusters
      • CHIP Ameba All Clusters Example
      • Matter ASR All Clusters Example
      • Matter ESP32 All Clusters Example
      • CHIP PSoC6 All Clusters Example
      • Matter Linux/Mac All Clusters Example
      • Matter Arm Mbed OS All Clusters Example Application
      • Matter nRF Connect All Clusters Example Application
      • Matter MW320 All Clusters Example Application
      • CHIP RT1060 All-clusters Application
      • CHIP RT1170 All-clusters Application
      • CHIP RW61x All-clusters Application
      • CHIP NXP Zephyr All-clusters Application
      • Matter Open IoT SDK All-Clusters-App Example Application
      • Matter Telink All Clusters Example Application
    • All clusters minimal
      • CHIP Ameba All Clusters Example
      • Matter ASR All Clusters Example
      • CHIP ESP32 All Clusters Example
      • CHIP PSoC6 All Clusters Example
      • Matter Arm Mbed OS All Clusters Example Application
      • Matter nRF Connect All Clusters Example Application
      • Matter Telink All Clusters Minimal Example Application
    • Bridge
      • Matter ASR Bridge Example
      • Matter ESP32 Bridge App Example
      • Matter Linux Bridge Example
      • Matter Telink Bridge Example Application
    • CHEF
      • MATTER CHEF APP
      • Matter Shell - Device Layer module
      • Matter Shell - OpenThread CLI pass-through
      • Matter Shell Reference
      • CHIP nRF Connect SDK Shell Application
      • Chef Build Conventions
    • CHIP Tool example
      • Matter Client Example
    • Contact Sensor
      • Matter Bouffalo Lab Contact Sensor Example
      • Matter Linux Contact Sensor Example
      • Matter NXP Contact Sensor Example Application
      • CHIP K32W061 Contact Sensor Example Application
      • Matter K32W1 Contact Sensor Example Application
      • Matter MCXW71 Contact Sensor Example Application
      • Matter Telink Contact Sensor Example Application
    • CHIP Tool Darwin
      • Matter darwin-framework-tool
    • Dishwasher
      • Matter Linux Dishwasher Example
      • Matter Silabs dishwasher Example
    • Energy Management
      • Matter ESP32 Energy Management Example
      • Matter Linux Energy Management Example
      • Matter EFR32 Energy Management Example
    • Fabric Admin
      • Matter Fabric Administrator Example
    • Fabric Bridge
      • Matter Linux Fabric Bridge Example
    • Fabric Sync
      • Matter Linux Fabric Sync Example
    • Java matter controller
      • Matter Controller Java App Example
    • Kotlin matter controller
      • Matter Controller Kotlin App Example
    • Laundry washer
      • CHIP RT1060 Thermostat Application
      • CHIP RT1170 Thermostat Application
      • CHIP RW61x Laundry washer Application
      • CHIP NXP Zephyr Laundry Washer Application
    • Light switch
      • CHIP Ameba Light Switch Example
      • Matter ASR Light Switch Example
      • Matter Light Switch Example Application
      • Matter ESP32 Light-switch Example
      • Matter Genio Light Switch Example
      • Matter CYW30739 Light Switch Example
      • Matter nRF Connect Light Switch Example Application
      • Matter QPG6105 SDK
      • Matter EFR32 Light Switch Example
      • Matter Telink Light Switch Example Application
      • Matter QPG6105 Light Switch Example Application
    • Lighting
      • CHIP Ameba Lighting Example
      • Matter ASR Lighting Example
      • Matter BEKEN Lighting Example
      • Matter Bouffalo Lab Lighting app Example
      • Matter Lighting Example Application
      • Matter ESP32 Lighting Example
      • Matter Genio Lighting Example
      • Matter CYW30739 Lighting Example
      • CHIP PSoC6 Lighting Example
      • CHIP Linux Lighting Example
      • Matter Arm Mbed OS Lighting Example Application
      • Matter nRF Connect Lighting Example Application
      • Matter NXP Lighting Example Application
      • CHIP K32W061 Lighting Example Application
      • Matter K32W1 Lighting Example Application
      • Matter MCXW71 Lighting Example Application
      • Python-based lighting example (bridge) device to DALI
      • Matter QPG6105 SDK
      • Matter EFR32 Lighting Example
      • Matter STM32 Lighting Example over thread
      • Matter Telink Lighting Example Application
      • CHIP Tizen Lighting Example
      • Matter QPG6105 Lighting Example Application
    • Lighting without unique id
      • CHIP Linux Lighting Example (Data Mode, No Unique ID)
    • Lit ICD
      • Matter ESP32 LIT ICD Example
      • Matter nRF Connect LIT ICD Example Application
      • Matter EFR32 Lit ICD Example
    • Lock
      • Matter ASR Lock Example
      • Matter Lock Example Application
      • Matter CC32XXSF Lock Example Application
      • Matter ESP32 Lock Example
      • Matter Genio Lock Example
      • Matter CYW30739 Lock Example
      • Matter PSoC6 Lock Example
      • Lock Application for Linux
      • Matter Arm Mbed OS Lock Example Application
      • Matter nRF Connect Lock Example Application
      • Matter NXP Door Lock Example Application
      • Matter K32W1 Door Lock Example Application
      • Matter MCXW71 Door Lock Example Application
      • Matter Open IoT SDK Lock-App Example Application
      • Matter QPG6105 SDK
      • Matter EFR32 Lock Example
      • Matter Telink Lock Example Application
      • Matter QPG6105 Lock Example Application
    • Log source
      • log-source-app
    • Microwave ovens
      • Matter Linux Microwave Oven Example
    • Minimal MDNS
      • Minimal mDNS example
    • Network Infrastructure Manager
      • network-manager-app
    • OTA Provider
      • CHIP ESP32 OTA Provider Example
      • ota-provider-app
    • OTA Requestor
      • CHIP Ameba OTA Requestor Example
      • Matter ASR OTA Requestor Example
      • CHIP ESP32 OTA Requestor Example
      • Matter Genio Lighting Example
      • ota-requestor-app (Linux)
      • Matter Arm Mbed OS Lock Example Application
      • Matter Open IoT SDK OTA-Requestor-App Example Application
      • Supported devices
    • Persistent storage
      • CHIP ESP32 Persistent Storage Example
      • CHIP PSoC6 Persistent Storage Example
      • CHIP Linux Persistent Storage Example
      • Matter QPG6105 SDK
      • CHIP QPG6105 Persistent Storage Application
    • Pigweed
      • CHIP Ameba Pigweed Example Application
      • CHIP ESP32 Pigweed Example Application
      • Matter Arm Mbed OS Pigweed Example Application
    • Pump
      • Matter Pump Example Application
      • Matter nRF Connect Pump Example Application
      • Matter EFR32 Pump Example
      • Matter Telink Pump Controller Example Application
    • Pump controller
      • Matter Pump Controller Example Application
      • Matter nRF Connect Pump Example Application
      • Matter Telink Pump Controller Example Application
    • Refrigerator
      • CHIP Linux Refrigerator Example
      • Matter Refrigerator and Temperature Controlled Example
    • RVC
      • RVC example app
    • Shell
      • Matter Shell Reference
      • Matter Shell - Device Layer module
      • Matter Shell - OpenThread CLI pass-through
      • Matter Shell - App Server module
      • Matter Shell Application
      • Matter Arm Mbed OS Shell Example Application
      • Matter nRF Connect SDK Shell Application
      • Matter Open IoT SDK Shell Example Application
      • Matter Telink Shell Example Application
    • Smoke CO Alarm example
      • Matter EFR32 Smoke CO Alarm Example
      • Matter Telink Smoke CO Alarm Example Application
    • Thread Border Router
      • Matter ESP32 Thread Border Router Example
    • Temperature measurement
      • Matter ASR Temperature Measurement Example
      • Matter ESP32 Temperature Sensor Example
      • Matter Telink Temperature Measurement Example Application
    • Thermostat
      • Matter ASR Thermostat Example
      • Matter Genio Thermostat Example
      • Matter CYW30739 Thermostat Example
      • CHIP RT1060 Thermostat Application
      • CHIP RT1170 Thermostat Application
      • CHIP RW61x Thermostat Application
      • CHIP NXP Zephyr Thermostat Application
      • Matter QPG6105 SDK
      • Matter EFR32 Thermostat Example
      • Matter Telink Thermostat Example Application
      • Matter QPG6105 Thermostat Example Application
    • TV
      • Matter tv app common-api
      • Content App
      • Matter TV Example
      • Matter Open IoT SDK TV-App Example Application
    • TV casting
      • Matter TV Casting Android App Example
      • Matter TV Casting iOS App Example
      • CHIP TV Casting App Example
      • Matter Casting APIs
    • Virtual Device App
      • Matter Android Virtual Device App Example
    • Window
      • Matter nRF Connect Window Covering Example Application
      • Matter EFR32 Window Covering Example
      • Matter Telink Window Example Application
  • Discussion
    • LwIP changes for Matter
  • Testing Guides
    • Table of Contents
    • CI testing
    • Fuzz testing
    • Integration Test utilities
    • Integration and Certification Tests
    • PICS and PIXITs
    • Python framework tests
    • Unit testing
    • YAML tests
    • YAML Pseudo-clusters
    • YAML Schema
  • Tips and Troubleshooting
    • Device discovery from a Host computer (mDNS Scanning)
    • Troubleshooting Avahi
  • Tools
    • CHIP Certificate Tool
    • SPAKE2P Parameters Tool
    • Memory usage scripts
    • SPAKE2+ Python Tool
    • NXP Factory Data Generator
    • NXP OTA image tool
    • FactoryDataProvider for EFR32 Matter device
    • Silabs OTA image tool
    • Silabs Factory Data Generator
    • Manufacturing Partition Generator Utility
  • ZAP and Codegen
    • Code generation
    • ZAP
  • Reporting bugs
  • Upgrading notes
  • Project issues
  • .md

Getting Started

Getting Started#

The following docs are a brief introduction to SDK development.

  • Running your first example

  • Changing examples

  • SDK Architecture Overview

previous

Working with the CHIP Tool

next

Compiling, Running, and Controlling Matter examples

By Matter Contributors

© Copyright 2020-2023, Matter Contributors.