API Reference

nRF5 SDK for Thread and Zigbee v4.2.0

Here is a list of all modules:
[detail level 1234567]
 OpenThread APIApplication Programming Interface for the OpenThread stack
 APIThis module includes the application programming interface to the OpenThread stack
 ErrorThis module includes error definitions used in OpenThread
 Execution
 InstanceThis module includes functions that control the OpenThread Instance
 TaskletsThis module includes functions that control the Thread stack's execution
 IPv6 Networking
 DNSv6This module includes functions that control DNS communication
 ICMPv6This module includes functions that control ICMPv6 communication
 IPv6This module includes functions that control IPv6 communication
 UDP
 UDPThis module includes functions that control UDP communication
 UDP ForwardThis module includes functions for UDP forward feature
 Link
 LinkThis module includes functions that control link-layer configuration
 Raw LinkThis module includes functions that control the raw link-layer configuration
 MessageThis module includes functions that manipulate OpenThread message buffers
 Thread
 Border AgentThis module includes functions for the Thread Border Agent role
 Border RouterThis module includes functions to manage local network data with the OpenThread Border Router
 CommissionerThis module includes functions for the Thread Commissioner role
 GeneralThis module includes functions for all Thread roles
 JoinerThis module includes functions for the Thread Joiner role
 Router/LeaderThis module includes functions for Thread Routers and Leaders
 ServerThis module includes functions to manage local network data with the OpenThread Server
 Add-Ons
 Backbone RouterThis module includes functions for the OpenThread Backbone Router Service
 Channel ManagerThis module includes functions for Channel Manager
 Channel MonitoringThis module includes functions for channel monitoring feature
 Child SupervisionThis module includes functions for child supervision feature
 CoAP
 CoAPThis module includes functions that control CoAP communication
 CoAP SecureThis module includes functions that control CoAP Secure (CoAP over DTLS) communication
 Command Line InterfaceThis module includes functions that control the Thread stack's execution
 CryptoThis module includes cryptographic functions
 Entropy SourceThis module includes functions that manages entropy source
 Factory DiagnosticsThis module includes functions that control the Thread stack's execution
 HeapThis module includes functions that set the external OpenThread heap
 Jam DetectionThis module includes functions for signal jamming detection feature
 LoggingThis module includes OpenThread logging related definitions
 Network Co-ProcessorThis module includes functions that control the Thread stack's execution
 Network Time SynchronizationThis module includes functions that control network time synchronization service
 Random Number Generator
 RNG CryptographicThis module includes functions that generates cryptographic random numbers
 RNG Non-cryptographicThis module includes functions that generates non cryptographic random numbers
 SNTPThis module includes functions that control SNTP communication
 Platform AbstractionThis module includes the platform abstraction used by the OpenThread stack
 AlarmThis module includes the platform abstraction for the alarm service
 BLE HostThis module includes the platform abstraction for BLE Host communication. The platform needs to implement Bluetooth LE 4.2 or higher
 EntropyThis module includes the platform abstraction for entropy generation
 Factory DiagnosticsThis module includes the platform abstraction for diagnostics features
 LoggingThis module includes the platform abstraction for the debug log service
 MemoryThis module includes the platform abstraction for dynamic memory allocation
 Message PoolThis module includes the platform abstraction for the message pool
 MiscellaneousThis module includes platform abstractions for miscellaneous behaviors
 RadioThis module includes the platform abstraction for radio communication
 TypesThis module includes the platform abstraction for a radio frame
 ConfigurationThis module includes the platform abstraction for radio configuration
 OperationThis module includes the platform abstraction for radio operations
 SettingsThis module includes the platform abstraction for non-volatile storage of settings
 SPI SlaveThis module includes the platform abstraction for SPI slave communication
 Time ServiceThis module includes the platform abstraction for the time service
 ToolchainThis module defines a toolchain abstraction layer through macros
 UARTThis module includes the platform abstraction for UART communication
 OpenThread Network SimulatorThis module includes the platform abstraction for OTNS
 Zigbee stack APIApplication Programming Interface for the Zigbee stack
 HA API
 HA Device types
 HA Devices
 Configuration Tool
 Dimmable Light
 Dimmer Switch
 Range Extender
 Door Lock
 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 client attributes and enumerations
 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 Water Content Measurement 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
 Tier Label
 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
 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
 ZCL Control4 Network cluster
 ZCL Work With All Hubs (WWAH) cluster
 WWAH cluster attributes
 WWAH cluster commands
 ZCL Occupancy Sensing cluster
 ZCL Pressure Measurement cluster
 ZCL Keep Alive 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 distributed security
 BDB commissioning API
 BDB commissioning parameters
 BDB commissioning start & status
 BDB Finding and Binding
 AF functions visible to applications
 AF data service
 AF device types
 AF common constants
 AF management service
 APS functions visible to applications
 APS common constants
 APS data service
 APS management service
 APS user payload
 NWK functions visible to applications
 NWK common constants
 NWK management service
 NWK PAN ID conflicts
 NWK MTORR functionality
 Security subsystem API
 NWK keys settings
 TC rejoin settings
 Install code usage
 Application structure & commissioning start
 General parameters to be set before start
 ZBOSS kernel initialization and 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
 Nordic Semiconductor special functions
 Configurable ZBOSS memory sizes
 Sleep API
 Packet buffers pool
 Scheduler
 Time
 Random numbers generator
 NVRAM
 HW platform support - misc
 Low level API for OTA
 ZBOSS debug capabilities
 Debug trace
 Trace configuration
 MAC traffic dump
 Switching dump on and off
 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 door lock add-ons
 ZCL group add-ons
 ZCL identify add-ons
 ZCL level control add-ons
 ZCL on/off add-ons
 ZCL scenes add-ons
 ZCL temperature measurement add-ons
 AF API add-ons
 802.15.4 driver APIApplication Programming Interface for the IEEE 802.15.4 radio driver
 Nrf_802154
 nRF 802.15.4 Platform Abstraction LayerApplication Programming Interface for the IEEE 802.15.4 radio driver inteded for use with the nRF SoCs
 Nrf_802154_clock
 Nrf_802154_hp_timer
 Nrf_802154_timer
 Nrf_802154_temperature
 Nrf_802154_random