RE: Using CLI but disabling the need for "bdb start" cli command.

AndrewDF — Tue, 25 Jul 2023 14:08:59 GMT

Marte,

Thank you. This is what I needed. I have tried both zboss_start_no_autostart() and m_stack_is_started = ZB_TRUE in the past but never at the same time.

-Andrew

RE: Using CLI but disabling the need for "bdb start" cli command.

Marte Myrvold — Tue, 25 Jul 2023 11:59:13 GMT

Hi Andrew,

To do this you will have to change the files of the Zigbee CLI library, which I would not recommend. I will still explain how to do it.

First of all, to start the stack in main.c you need to add zboss_start_no_autostart(). Additionally, make sure that you have changed zb_set_bdb_primary_channel_set(IEEE_CHANNEL_MASK) to zb_set_network_coordinator_role(IEEE_CHANNEL_MASK). This is an example of how main() will look:

/**@brief Function for application main entry.
 */
int main(void)
{
    ret_code_t     ret;
    zb_ieee_addr_t ieee_addr;

    /* Intiialise the leds */
    bsp_board_init(BSP_INIT_LEDS);
    bsp_board_leds_off();

    /* Initialize loging system and GPIOs. */
    log_init();

#if defined(APP_USBD_ENABLED) && APP_USBD_ENABLED
    ret = nrf_drv_clock_init();
    APP_ERROR_CHECK(ret);
    nrf_drv_clock_lfclk_request(NULL);
#endif

    ret = app_timer_init();
    APP_ERROR_CHECK(ret);

    /* Initialize the Zigbee CLI subsystem */
    zb_cli_init(ZIGBEE_CLI_ENDPOINT);

    /* Set Zigbee stack logging level and traffic dump subsystem. */
    ZB_SET_TRACE_LEVEL(ZIGBEE_TRACE_LEVEL);
    ZB_SET_TRACE_MASK(ZIGBEE_TRACE_MASK);
    ZB_SET_TRAF_DUMP_OFF();

    /* Initialize Zigbee stack. */
    ZB_INIT("cli_agent_coordinator");

    /* Set device address to the value read from FICR registers. */
    zb_osif_get_ieee_eui64(ieee_addr);
    zb_set_long_address(ieee_addr);

    zb_set_network_coordinator_role(IEEE_CHANNEL_MASK);
    zb_set_max_children(MAX_CHILDREN);

    zigbee_erase_persistent_storage(ERASE_PERSISTENT_CONFIG);

    /* Register CLI Agent device context (endpoints). */
    ZB_AF_REGISTER_DEVICE_CTX(&cli_agent_ctx);

    /* Set the endpoint receive hook */
    ZB_AF_SET_ENDPOINT_HANDLER(ZIGBEE_CLI_ENDPOINT, cli_agent_ep_handler);

    /* Register handlers to identify notifications */
    ZB_AF_SET_IDENTIFY_NOTIFICATION_HANDLER(ZIGBEE_CLI_ENDPOINT, identify_handler);

    /** Start Zigbee Stack. */
    ret = zboss_start_no_autostart();
    APP_ERROR_CHECK(ret);

    /* Start Zigbee CLI subsystem. */
    zb_cli_start();

    /* Start Zigbee stack. */
    while(1)
    {
        if (zb_cli_is_stack_started())
        {
#ifdef ZIGBEE_CLI_DEBUG
            if (!zb_cli_stack_is_suspended())
            {
                zboss_main_loop_iteration();
            }
#else
            zboss_main_loop_iteration();
#endif
        }
        UNUSED_RETURN_VALUE(NRF_LOG_PROCESS());
        UNUSED_RETURN_VALUE(zb_cli_process());
    }
}

The variable that checks if the stack is started for CLI, m_stack_is_started, is local to zigbee_cli_cmd_bdb.c and is only set to true if you issue the command 'bdb start'. Since there is no other way to change this variable, and it needs to be true for several of the CLI commands to work, the easiest option is to simply set m_stack_is_started = ZB_TRUE at the top of zigbee_cli_cmd_bdb.c instead of ZB_FALSE. Please be aware that this will affect the behavior of CLI for other projects as well.

This code is not thoroughly tested or qualified and should be considered provided “as-is”. Please test it with your application and let me know if you find any issues.

Please be aware that for new development we recommend using nRF Connect SDK instead of nRF5 SDK, see nRF Connect SDK and nRF5 SDK statement .
In nRF Connect SDK you can easily add shell to existing Zigbee examples, so you could use our generic Zigbee network coordinator sample have the device configured as a coordinator by default and automatically start the Zigbee network on startup, in addition to CLI/shell functionality.

Best regards,
Marte