MCUXpresso SDK Documentation

Version: 25.12.00 25.12.00-pvw2 25.12.00-pvw1 25.09.00 25.09.00-pvw2 latest

Open on Repo Open an Issue

Source (.md/.rst) Page PDF (.pdf)

ZigBee 3.0 Devices User Guide

Table of Contents

• Overview
  • Conventions
  • Acronyms and abbreviations
  • Related documents and support resources
• Introduction
  • ZigBee device types
  • Software architecture
  • Shared device structure
  • Endpoint callback functions
  • Device initialization
  • Compile-time options
    • Number of Endpoints
    • Manufacturer Code
    • Enabled Clusters
    • Server and Client options
    • Support for attribute Read/Write
    • Optional attributes
• ZigBee Base Device
  • Initializing and starting the ZigBee Base Device
    • If the node was not on a network:
    • If the node was on a network:
  • Network commissioning
    • Touchlink
    • Network steering
      • Node is already on a network
      • Node is not on a network
    • Network Formation
    • Finding and Binding
      • Initiator Node
      • Target Node
    • Out-Of-Band Commissioning
  • Network security
    • Centralized security networks
      • Install Codes
    • Distributed security networks
  • ZigBee base device rejoin handling
  • Attributes and Constants
    • Attributes
      • u16bdbCommissioningGroupID
      • u8bdbCommissioningMode
      • ebdbCommissioningStatus
      • u64bdbJoiningNodeEui64
      • au8bdbJoiningNodeNewTCLinkKey
      • bbdbJoinUsesInstallCodeKey
      • u8bdbNodeCommissioningCapability
      • bbdbNodeIsOnANetwork
      • u8bdbNodeJoinLinkKeyType
      • u32bdbPrimaryChannelSet
      • u8bdbScanDuration
      • u32bdbSecondaryChannelSet
      • u8bdbTCLinkKeyExchangeAttempts
      • u8bdbTCLinkKeyExchangeAttemptsMax
      • u8bdbTCLinkKeyExchangeMethod
      • u8bdbTrustCenterNodeJoinTimeout
      • bbdbTrustCenterRequireKeyExchange
      • bTLStealNotAllowed
      • bLeaveRequested
    • Constants
      • General constants
      • Touchlink constants
  • Functions
    • BDB_vInit
      • Description
      • Parameters
      • Returns
    • BDB_vSetKeys
      • Description
      • Parameters
      • Returns
    • BDB_vStart
      • Description
      • Parameters
      • Returns
    • BDB_eNfStartNwkFormation
      • Description
      • Parameters
      • Returns
    • BDB_eNsStartNwkSteering
      • Description
      • Parameters
      • Returns
    • BDB_eFbTriggerAsInitiator
      • Description
      • Parameters
      • Returns
    • BDB_vFbExitAsInitiator
      • Description
      • Parameters
      • Returns
    • BDB_eFbTriggerAsTarget
      • Description
      • Parameters
      • Returns
    • BDB_vFbExitAsTarget
      • Description
      • Parameters
      • Returns
    • BDB_bIsBaseIdle
      • Description
      • Parameters
      • Returns
    • BDB_u8OutOfBandCommissionStartDevice
      • Description
      • Parameters
      • Returns
    • BDB_vOutOfBandCommissionGetData
      • Description
      • Parameters
      • Returns
    • BDB_eOutOfBandCommissionGetDataEncrypted
      • Description
      • Parameters
      • Returns
    • BDB_bOutOfBandCommissionGetKey
      • Description
      • Parameters
      • Returns
  • Structures
    • BDB_tsBdbEvent
    • BDB_tuBdbEventData
    • BDB_tsZpsAfEvent
    • BDB_tsFindAndBindEvent
    • BDB_tsOobWriteDataToCommission
    • BDB_tsOobReadDataToAuthenticate
    • BDB_tsOobWriteDataToAuthenticate
  • Enumerations
    • BDB_teStatus
    • BDB_teCommissioningStatus
  • Events
  • Compile-time Options
    • Attributes
    • Constants
• Lighting and Occupancy Device Types
  • On/Off light
    • Supported clusters
    • Device structure
    • Registration function
      • Description
      • Parameters
      • Returns
  • Dimmable Light
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Colour Dimmable Light
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • On/Off Light Switch
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Dimmer Switch
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Colour Dimmer Switch
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Light Sensor
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Occupancy Sensor
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • On/Off Ballast
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Dimmable Ballast
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • On/Off Plug-in Unit
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Dimmable Plug-in Unit
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Colour Temperature Light
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Extended Colour Light
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Light Level Sensor
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Colour Controller
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Color Scene Controller
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Non-Colour Controller
    • Supported clusters
    • Device structure
    • Registration function
      • Description
      • Parameters
      • Returns
  • Non-Colour Scene Controller
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • Control Bridge
    • Supported clusters
    • Device Structure
    • Registration Function
      • Description
      • Parameters
      • Returns
  • On/Off Sensor
    • Supported clusters
    • Device structure
    • Registration function
      • Description
      • Parameters
      • Returns
• Note about the source code in the document
• Revision history