Zigbee ZBOSS OSIF

The Zigbee ZBOSS OSIF layer subsystem acts as the linking layer between the ZBOSS Zigbee stack and the nRF Connect SDK.

Configuration

The ZBOSS OSIF layer implements a series of functions used by ZBOSS and is included in the nRF Connect SDK’s Zigbee subsystem.

The ZBOSS OSIF layer is automatically enabled when you enable the ZBOSS library with the CONFIG_ZIGBEE Kconfig option.

You can also configure the following OSIF-related Kconfig options:

  • CONFIG_ZIGBEE_APP_CB_QUEUE_LENGTH - Defines the length of the application callback and alarm queue. This queue is used to pass application callbacks and alarms from other threads or interrupts to the ZBOSS main loop context.

  • CONFIG_ZIGBEE_DEBUG_FUNCTIONS - Includes functions to suspend and resume the ZBOSS thread.

    Note

    These functions are useful for debugging, but they can cause instability of the device.

  • CONFIG_ZBOSS_RESET_ON_ASSERT - Configures the ZBOSS OSIF layer to reset the device when a ZBOSS assert occurs. This option is enabled by default. Use it for production-ready applications.

  • CONFIG_ZBOSS_HALT_ON_ASSERT - Configures the ZBOSS OSIF layer to halt the device when a ZBOSS assert occurs. Use this option only for testing and debugging your application.

  • CONFIG_ZIGBEE_HAVE_SERIAL - Enables the UART serial abstract for the ZBOSS OSIF layer and allows to configure the serial glue layer. For more information, see the ZBOSS OSIF serial abstract section.

  • CONFIG_ZIGBEE_USE_BUTTONS - Enables the buttons abstract for the ZBOSS OSIF layer. You can use this option if you want to test ZBOSS examples directly in the nRF Connect SDK.

  • CONFIG_ZIGBEE_USE_DIMMABLE_LED - Dimmable LED (PWM) abstract for the ZBOSS OSIF layer. You can use this option if you want to test ZBOSS examples directly in the nRF Connect SDK.

  • CONFIG_ZIGBEE_USE_LEDS - LEDs abstract for the ZBOSS OSIF layer. You can use this option if you want to test ZBOSS examples directly in the nRF Connect SDK.

  • CONFIG_ZIGBEE_USE_SOFTWARE_AES - Configures the ZBOSS OSIF layer to use the software encryption.

  • CONFIG_ZIGBEE_NVRAM_PAGE_COUNT - Configures the number of ZBOSS NVRAM logical pages.

  • CONFIG_ZIGBEE_NVRAM_PAGE_SIZE - Configures the size of the RAM-based ZBOSS NVRAM. This option is used only if the device does not have NVRAM storage.

  • CONFIG_ZIGBEE_TIME_COUNTER - Configures the ZBOSS OSIF layer to use a dedicated timer-based counter as the Zigbee time source.

  • CONFIG_ZIGBEE_TIME_KTIMER - Configures the ZBOSS OSIF layer to use Zephyr’s system time as the Zigbee time source.

Additionally, the following Kconfig option is available when setting Zephyr’s logger options:

  • CONFIG_ZBOSS_OSIF_LOG_LEVEL - Configures the custom logger options for the ZBOSS OSIF layer.

ZBOSS OSIF serial abstract

Setting the CONFIG_ZIGBEE_HAVE_SERIAL option enables the serial abstract for the ZBOSS OSIF layer.

The ZBOSS OSIF serial implements sets of backend functions that are used by the ZBOSS stack for serial communication:

  • Zigbee async serial

  • Zigbee serial logger

  • Zigbee logger

These backend functions serve one or both of the following purposes:

  • Logging ZBOSS traces - Used for handling stack logs that are useful for debugging and are provided in binary format.

  • Handling NCP communication with the host device - Used only for the NCP architecture.

The following table shows which sets of functions serve which purpose.

Async serial

Serial logger

Logger

Logging ZBOSS traces

Handling NCP communication

For more information about configuring ZBOSS stack logs, see Stack logs.

Zigbee async serial

The Zigbee async serial is the only backend that the ZBOSS OSIF serial supports for handling the NCP communication. This set of functions uses Zephyr UART API and can be configured to use UART peripheral or USB CDC ACM device. The data received is internally buffered.

You can also use the Zigbee async serial for logging ZBOSS traces. When enabled, it logs ZBOSS traces in the binary format. In such case, the transmission data is also buffered.

Zigbee async serial configuration options

To configure this set of functions, use the following options:

The Zigbee ZBOSS OSIF layer serial device needs to be provided in Devicetree like this:

chosen {
    ncs,zigbee-uart = &uart0;
};

Zigbee serial logger

This set of functions uses Zephyr’s UART API and can be configured to use either the UART peripheral or the USB CDC ACM device. Data is buffered internally in ring buffer and printed in the binary format. This ring buffer has a size of 4096 bytes by default.

Zigbee serial logger configuration options

Use the following options to configure the Zigbee serial logger:

The ZBOSS tracing serial device needs to be provided in Devicetree like this:

chosen {
    ncs,zboss-trace-uart = &uart1;
};

Zigbee logger

This set of functions uses Zephyr’s Logging API for logging hexdumps of received binary data. Data is buffered internally in ring buffer.

Zigbee logger configuration options

Use the following options to configure the Zigbee logger:

API documentation

Header files: subsys/zigbee/osif/zb_nrf_platform.h
Source files: subsys/zigbee/osif/
group zigbee_zboss_osif

Functions

bool zigbee_is_stack_started(void)

Function for checking if the Zigbee stack has been started.

Return values:

  • true – Zigbee stack has been started.

  • false – Zigbee stack has not been started yet.

void zigbee_enable(void)

Function for starting the Zigbee thread.

bool zigbee_debug_zboss_thread_is_created(void)

Function for checking if the ZBOSS thread has been created.

void zigbee_debug_suspend_zboss_thread(void)

Function for suspending the ZBOSS thread.

void zigbee_debug_resume_zboss_thread(void)

Function for resuming the ZBOSS thread.

bool zigbee_is_zboss_thread_suspended(void)

Function for getting the state of the Zigbee stack thread processing suspension.

Return values:

  • true – Scheduler processing is suspended or the ZBOSS thread is not yet created.

  • false – Scheduler processing is not suspended and the ZBOSS thread is created.