nRF5 SDK for Thread and Zigbee v3.2.0
Copy URL
API Reference
Here is a list of all modules:
[detail level
1
2
3
4
5
6
7
]
▼
OpenThread API
Application Programming Interface for the OpenThread stack
►
API
This module includes the application programming interface to the OpenThread stack
Error
This module includes error definitions used in OpenThread
►
Execution
Instance
This module includes functions that control the OpenThread Instance
Tasklets
This module includes functions that control the Thread stack's execution
►
IPv6 Networking
DNSv6
This module includes functions that control DNS communication
ICMPv6
This module includes functions that control ICMPv6 communication
IPv6
This module includes functions that control IPv6 communication
►
UDP
UDP
This module includes functions that control UDP communication
UDP Forward
This module includes functions for UDP forward feature
►
Link
Link
This module includes functions that control link-layer configuration
Raw Link
This module includes functions that control the raw link-layer configuration
Message
This module includes functions that manipulate OpenThread message buffers
►
Thread
Border Agent
This module includes functions for the Thread Border Agent role
Border Router
This module includes functions to manage local network data with the OpenThread Border Router
Commissioner
This module includes functions for the Thread Commissioner role
General
This module includes functions for all Thread roles
Joiner
This module includes functions for the Thread Joiner role
Router/Leader
This module includes functions for Thread Routers and Leaders
Server
This module includes functions to manage local network data with the OpenThread Server
►
Add-Ons
Channel Manager
This module includes functions for Channel Manager
Channel Monitoring
This module includes functions for channel monitoring feature
Child Supervision
This module includes functions for child supervision feature
►
CoAP
CoAP
This module includes functions that control CoAP communication
CoAP Secure
This module includes functions that control CoAP Secure (CoAP over DTLS) communication
Command Line Interface
This module includes functions that control the Thread stack's execution
Crypto
This module includes cryptographic functions
Entropy Source
This module includes functions that manages entropy source
Factory Diagnostics
This module includes functions that control the Thread stack's execution
Jam Detection
This module includes functions for signal jamming detection feature
Logging
This module includes OpenThread logging related definitions
Network Co-Processor
This module includes functions that control the Thread stack's execution
Network Time Synchronization
This module includes functions that control network time synchronization service
Random Number Generator
This module includes functions that generates cryptographic random numbers
SNTP
This module includes functions that control SNTP communication
►
Platform Abstraction
This module includes the platform abstraction used by the OpenThread stack
Alarm
This module includes the platform abstraction for the alarm service
BLE Host
This module includes the platform abstraction for BLE Host communication. The platform needs to implement Bluetooth LE 4.2 or higher
Entropy
This module includes the platform abstraction for entropy generation
Factory Diagnostics
This module includes the platform abstraction for diagnostics features
Logging
This module includes the platform abstraction for the debug log service
Memory
This module includes the platform abstraction for dynamic memory allocation
Message Pool
This module includes the platform abstraction for the message pool
Miscellaneous
This module includes platform abstractions for miscellaneous behaviors
►
Radio
This module includes the platform abstraction for radio communication
Types
This module includes the platform abstraction for a radio frame
Configuration
This module includes the platform abstraction for radio configuration
Operation
This module includes the platform abstraction for radio operations
Settings
This module includes the platform abstraction for non-volatile storage of settings
SPI Slave
This module includes the platform abstraction for SPI slave communication
Time Service
This module includes the platform abstraction for the time service
Toolchain
This module defines a toolchain abstraction layer through macros
UART
This module includes the platform abstraction for UART communication
▼
Zigbee stack API
Application Programming Interface for the Zigbee stack
►
HA API
HA Device types
►
HA Devices
Configuration Tool
Dimmable Light
Dimmer Switch
Door Lock Controller
IAS Ancillary Control Equipment
IAS Control and Indicating Equipment
IAS Zone
Level Controllable Output
Mains Power Outlet
On/Off Switch
Range Extender
Scene Selector
Shade
Shade Controller
Simple Sensor
Smart Plug
Temperature Sensor
Thermostat
Window Covering
Window Covering Controller
Combined Interface
Door Lock
►
IAS Warning Device
ZB_HA_IAS_WARNING_H
On/Off Output
EZ-Mode comissioning (HA legacy conflicting with BDB)
►
ZCL API
ZCL initialization data and API
►
ZCL common types and definitions
►
ZCL common types
General attributes' description
General frame description
Fill ZCL packet low-level API
ZCL attributes reporting
►
ZCL commands shared by all clusters
Default response command sending and parsing.
Read attributes request and response sending and parsing.
Write attributes command sending and parsing.
Discover attributes request and response sending and parsing.
Configure reporting command sending and parsing
Report attribute command parsing
Read reporting configuration command sending and parsing
►
ZCL clusters
ZCL Basic cluster
ZCL Binary Input cluster
ZCL Color control cluster
ZCL Diagnostics cluster
ZCL DoorLock cluster
ZCL Electrical Measurement cluster
►
ZCL Groups cluster
Add group command definitions
View group command definitions
Get Group Membership command definitions
Remove Group command definitions
Remove All Groups command definitions
Add group if identifying command definitions
ZCL IAS ACE cluster
ZCL IAS WD cluster
ZCL IAS Zone cluster
ZCL Identify cluster
ZCL Illuminance Measurement cluster
ZCL Level control cluster
►
ZCL Metering Cluster
Metering cluster server attributes and enumerations
Metering cluster commands
ZCL On/Off cluster
ZCL On/Off switch configuration cluster
ZCL OTA Upgrade cluster
ZCL Poll Control cluster
ZCL Power Configuration cluster
ZCL Relative Humidity Measurement cluster
ZCL Occupancy Sensing cluster
ZCL Scenes cluster
ZCL Shade Configuration cluster
ZCL Temperature Measurement cluster
ZCL Thermostat cluster
ZCL Fan Control cluster
ZCL Thermostat UI Control cluster
ZCL Window Covering cluster
ZCL Meter Identification cluster
►
ZCL Time cluster
Time cluster attributes
Time cluster commands
►
ZCL Tunneling cluster
Tunneling cluster attributes
Tunneling cluster commands
►
ZCL Price cluster
►
Price cluster attributes
►
Price cluster server attributes
Tier Label
Block Threshold
Block Period
Commodity
Block Price Information
Extended Price Information
Tariff Information
Billing Information
Credit Payment
Received Block Threshold
Received Block Period
Received Block Price Information
Received Extended Price Information
Received Tariff Information
Received Billing Information
Price cluster client attributes
Price cluster commands
Tier Label
►
ZCL Messaging cluster
Messaging cluster commands
ZCL Dehumidification cluster
ZCL Alarms cluster
►
ZCL Demand Response and Load Control (DRLC) cluster
DRLC attributes and enumerations
DRLC commands
EN50523 Appliance events and alerts cluster
►
ZDO API
ZDO base constants and definitions
ZDO address discovery
ZDO services discovery
ZDO binding management
ZDO groups management
ZDO miscellaneous management services
ZDO poll control
ZDO rejoin backoff procedure
ZDO distributed security
►
BDB commissioning API
BDB commissioning parameters
BDB commissioning start & status
BDB Finding and Binding
►
AF functions visible to applications
Device types
APS functions visible to applications
Security subsystem API
►
Application structure & commissioning start
Set general parameters before zboss_start() call
ZBOSS kernel init & start
ZBOSS main loop
ZBOSS commissioning signals handler
Get general parameters
NWK Address translation table access
►
ZBOSS framework
Compile-time configuration parameters
Base typedefs
Internal ZBOSS error codes
Configurable ZBOSS memory sizes
Sleep API
Packet buffers pool
Scheduler
Time
Special Functions For NRF52840
LEDs and buttons
Random numbers generator
NVRAM
HW platform support - misc
Low level API for UART
Low level API for OTA
►
ZBOSS Debug capabilities
Debug trace
►
MAC traffic dump
Switching dump on and off
win_com_dump terminal utility
Dump converter
Wireshark usage
Dynamic (run-time) asserts
Static (compile-time) asserts
►
API add-ons
►
ZCL API add-ons
ZCL basic API add-ons
ZCL color control add-ons
ZCL common add-ons
ZCL door lock add-ons
ZCL group add-ons
ZCL identify add-ons
ZCL level control add-ons
ZCL on/off add-ons
ZCL OTA device firmware upgrade add-ons
ZCL scenes add-ons
ZCL temperature measurement add-ons
AF API add-ons
▼
802.15.4 driver API
Application Programming Interface for the IEEE 802.15.4 radio driver
►
802.15.4 radio driver
Thermometer Abstraction Layer for the 802.15.4 driver
This module defines Thermometer Abstraction Layer for the 802.15.4 driver
Front-end module management
Setting addresses and PAN ID of the device
Functions to calculate data given by the driver
Functions to request FSM transitions and check current state
Calls to higher layer
Driver memory management
RSSI measurement function
Promiscuous mode
Auto ACK management
CCA configuration management
CSMA-CA procedure
ACK timeout procedure
►
802.15.4 driver configuration
Configuration of the 802.15.4 radio driver for nRF SoCs
Radio driver configuration
Clock driver configuration
RTC driver configuration
CSMA/CA procedure configuration
ACK timeout feature configuration
Transmission start notification feature configuration
Type definitions used in the 802.15.4 driver.
Definitions of types used in the 802.15.4 driver
►
nRF 802.15.4 Platform Abstraction Layer
Application Programming Interface for the IEEE 802.15.4 radio driver inteded for use with the nRF SoCs
Clock Abstraction Layer for the 802.15.4 driver
This module defines Clock Abstraction Layer for the 802.15.4 driver
High Precision Timer for the 802.15.4 driver
This module defines API or High Precision Timer for the 802.15.4 driver
Low Power Timer Abstraction Layer for the 802.15.4 driver
This module defines Low Power Timer Abstraction Layer for the 802.15.4 driver
Thermometer Abstraction Layer for the 802.15.4 driver
This module defines Thermometer Abstraction Layer for the 802.15.4 driver