Tc_swap

Macros
#define	ZB_TCLK_UPDATED_SIGNAL   55U
#define	ZB_SIGNAL_JOIN_DONE   56U
#define	ZB_BUFFER_TEST_REQ_SIGNAL   57U
#define	ZB_BDB_SIGNAL_TC_REJOIN_DONE   58U
#define	ZB_NWK_SIGNAL_PERMIT_JOIN_STATUS   59U
#define	ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_FINISHED   60U
#define	ZB_BDB_SIGNAL_STEERING_CANCELLED   61U
#define	ZB_BDB_SIGNAL_FORMATION_CANCELLED   62U
#define	ZB_SIGNAL_READY_TO_SHUT   63U
#define	ZB_SIGNAL_INTERPAN_PREINIT   64U
#define	ZB_ZGP_SIGNAL_MODE_CHANGE   65U
#define	ZB_ZDO_DEVICE_UNAVAILABLE   66U
#define	ZB_ZGP_SIGNAL_APPROVE_COMMISSIONING   67U
#define	ZB_DEBUG_SIGNAL_TCLK_READY   68U

Signals passed to application signal handler
Note If an application requires the parameters to be passed to the zboss_signal_handler, it is recommended to introduce the structure according to the pattern below: typedef struct zb_zdo_app_my_custom_signal_s { zb_zdo_app_signal_type_t super; zb_my_custom_data_type_t my_custom_data; }
#define	ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL   53U
#define	ZB_TC_SWAPPED_SIGNAL   54U

Detailed Description

Macro Definition Documentation

ZB_BDB_SIGNAL_FORMATION_CANCELLED

#define ZB_BDB_SIGNAL_FORMATION_CANCELLED   62U

BDB formation cancel request processed

When generated:

• after the cancel request called with bdb_cancel_formation() is processed

Status codes:

• RET_INVALID_STATE: formation is not in progress
• RET_PENDING: it is too late to cancel a formation, it will be completed soon
• RET_IGNORE: cancellation was already requested
• RET_OK: formation is cancelled successfully

Signal parameters:

• none

ZB_BDB_SIGNAL_STEERING_CANCELLED

#define ZB_BDB_SIGNAL_STEERING_CANCELLED   61U

BDB steering cancel request processed

When generated:

• after the cancel request called with bdb_cancel_steering() is processed

Status codes:

• RET_ILLEGAL_REQUEST: device is a ZC
• RET_INVALID_STATE: steering for a node not a network is not in progress
• RET_PENDING: it is too late to cancel a steering, it will be completed soon
• RET_IGNORE: cancellation was already requested
• RET_OK: steering is cancelled successfully

Signal parameters:

• none

ZB_BDB_SIGNAL_TC_REJOIN_DONE

#define ZB_BDB_SIGNAL_TC_REJOIN_DONE   58U

TC rejoin is completed

When generated:

• Device completes TC rejoin procedure.

Status codes:

• RET_OK: TC rejoin completed successful
• RET_ERROR: An error of any type.

Signal parameters:

• none

      case ZB_BDB_SIGNAL_TC_REJOIN_DONE:
        TRACE_MSG(TRACE_APP1, "TC rejoin failed, so try it again with interval", (FMT__0));
 
        ZB_SCHEDULE_APP_ALARM(zb_bdb_initiate_tc_rejoin, 0, 3 * ZB_TIME_ONE_SECOND);
        break; /* ZB_BDB_SIGNAL_TC_REJOIN_DONE */

ZB_BUFFER_TEST_REQ_SIGNAL

#define ZB_BUFFER_TEST_REQ_SIGNAL   57U

Test Profile 2 Buffer Test Req received. To be used in certification tests .

Parameters

zb_buffer_test_response_t

ZB_DEBUG_SIGNAL_TCLK_READY

#define ZB_DEBUG_SIGNAL_TCLK_READY   68U

When generated: Unverified aps key created, and verify_key_req has been sent or received.

Status codes:

• RET_OK.

This signal uses during debugging to broadcast aps key by calling zb_debug_broadcast_aps_key().

Signal parameters:

• zb_debug_signal_tclk_ready_params_t

ZB_NWK_SIGNAL_PERMIT_JOIN_STATUS

#define ZB_NWK_SIGNAL_PERMIT_JOIN_STATUS   59U

Notifies the Zigbee Trust center or router application about permit join status changed.

When generated:

• Network was just open
• Network was just closed

Status codes:

• RET_OK: Device information updated.
• Does not return error status.

Signal parameters:

• zb_uint8_t - Open time or zero if network closed. Value of zb_zdo_mgmt_permit_joining_req_param_t::permit_duration

Signal handling:

      case ZB_NWK_SIGNAL_PERMIT_JOIN_STATUS:
      {
        zb_uint8_t *permit_duration = ZB_ZDO_SIGNAL_GET_PARAMS(sg_p, zb_uint8_t);
        TRACE_MSG(TRACE_APP1, "Permit Join Received. Duration: %hd", (FMT__D, (*permit_duration)));
        break; /* ZB_NWK_SIGNAL_PERMIT_JOIN_STATUS */
      }

Signal generation:

• To self:

  void permit_join_request_local(zb_uint8_t buf, zb_uint16_t time)
  {
    TRACE_MSG(TRACE_APP3, ">> permit_join_request_local : param %hd", (FMT__D, buf));
   
    if (buf == 0U)
    {
      zb_buf_get_out_delayed_ext(permit_join_request_local, time, 0U);
    }
    else
    {
      zb_zdo_mgmt_permit_joining_req_param_t *req_param
          = ZB_BUF_GET_PARAM(buf, zb_zdo_mgmt_permit_joining_req_param_t);
   
      TRACE_MSG(TRACE_APP1, "permit_join_request_local_cb: requesting permit join", (FMT__0));
   
      req_param->dest_addr = zb_get_short_address();
      req_param->permit_duration = (zb_uint8_t) time;
      req_param->tc_significance = ZB_TRUE;
   
      zb_zdo_mgmt_permit_joining_req(buf, &permit_join_request_local_cb);
    }
  }
   
  void permit_join_request_local_cb(zb_uint8_t param)
  {
    if (param != 0U)
    {
      zb_buf_free(param);
    }
   
    TRACE_MSG(TRACE_APP1, "permit_join_request_local_cb: callback called", (FMT__0));
    return;
  }

• To other devices:

  void permit_join_request_broadcast(zb_uint8_t buf, zb_uint16_t time)
  {
    TRACE_MSG(TRACE_APP3, ">> permit_join_request_broadcast : param %hd", (FMT__D, buf));
    if (buf == 0U)
    {
      zb_buf_get_out_delayed_ext(permit_join_request_broadcast, time, 0U);
    }
    else
    {
      zb_zdo_mgmt_permit_joining_req_param_t *req_param
          = ZB_BUF_GET_PARAM(buf, zb_zdo_mgmt_permit_joining_req_param_t);
   
      TRACE_MSG(TRACE_APP1, "permit_join_request_broadcast_cb: requesting permit join", (FMT__0));
   
      req_param->dest_addr = ZB_NWK_BROADCAST_ROUTER_COORDINATOR;
      req_param->permit_duration = (zb_uint8_t) time;
      req_param->tc_significance = ZB_TRUE;
   
      zb_zdo_mgmt_permit_joining_req(buf, &permit_join_request_broadcast_cb);
    }
  }
   
  void permit_join_request_broadcast_cb(zb_uint8_t param)
  {
    if (param != 0U)
    {
      zb_buf_free(param);
    }
   
    TRACE_MSG(TRACE_APP1, "permit_join_request_broadcast_confirm_cb: callback called", (FMT__0));
    return;
  }

ZB_SIGNAL_INTERPAN_PREINIT

#define ZB_SIGNAL_INTERPAN_PREINIT   64U

ZBOSS interpan preinit done signal

When generated:

• after ZBOSS preinit enough to send interpan initiated by zboss_preinit_for_interpan() is done

After receiving that signal application can use zb_intrp_data_request_with_chan_change() API

Signal parameters:

• none

ZB_SIGNAL_JOIN_DONE

#define ZB_SIGNAL_JOIN_DONE   56U

Signal indicating that device just joined/rejoined, but not authorized yet

To be used mainly for certification testing, when run-time visibility setting is required

      case ZB_SIGNAL_JOIN_DONE:
        if (status == 0)
        {
          TRACE_MSG(TRACE_APP1, "Joined/rejoined ok", (FMT__0));
        }
        break;

ZB_SIGNAL_READY_TO_SHUT

#define ZB_SIGNAL_READY_TO_SHUT   63U

ZBOSS is ready to shutdown signal

When generated:

• after ZBOSS preparations to shutdown initiated by zboss_start_shut() is done

After receiving that signal application MUST complete ZBOSS shutdown by calling zboss_complete_shut(). It is impossible to continue ZBOSS work without a restart after calling zboss_start_shut().

Signal parameters:

• none

ZB_TC_SWAPPED_SIGNAL

#define ZB_TC_SWAPPED_SIGNAL   54U

TC is swapped (signal at Joiner)

      case ZB_TC_SWAPPED_SIGNAL:
      {
        TRACE_MSG(TRACE_APP1, "ZB_TC_SWAPPED_SIGNAL, status %hd", (FMT__H, status));
        s_tc_swapped = ZB_TRUE;
      }
      break;

ZB_TCLK_UPDATED_SIGNAL

#define ZB_TCLK_UPDATED_SIGNAL   55U

TCLK update completed (signal at Joiner)

      case ZB_TCLK_UPDATED_SIGNAL:
      {
        TRACE_MSG(TRACE_APP1, "ZB_TCLK_UPDATED_SIGNAL, status %hd", (FMT__H, status));
        if (s_tc_swapped)
        {
          TRACE_MSG(TRACE_APP1, "TCLK updated after TC swap", (FMT__0));
        }
        break;
      }

ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL

#define ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL   53U

it is time to backup TC database (signal at TC)

    case ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL:
      TRACE_MSG(TRACE_APP1, "Signal ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL, status %d", (FMT__D, status));
      app_backup_tc_db();
    break;

static void app_backup_tc_db(void)
{
  zb_uint_t portion_len;
  zb_uint_t nvram_buf_pos = 0U;
  zb_ret_t ret = zb_tcsw_start_backup_db();
 
  TRACE_MSG(TRACE_APP1, "app_backup_tc_db, ret %x, need_backup %hd",
    (FMT__D_H, ret, zb_tcsw_need_backup()));
 
  do
  {
    portion_len = zb_tcsw_get_portion((zb_uint8_t*)g_nvram_buf + nvram_buf_pos, TCSW_PORTION_SIZE);
    nvram_buf_pos += portion_len;
  }
  while (portion_len != 0);
 
  zb_nvram_write_dataset(ZB_NVRAM_APP_DATA1);
}

ZB_ZDO_DEVICE_UNAVAILABLE

#define ZB_ZDO_DEVICE_UNAVAILABLE   66U

Notifies an application a device unavailable.

When generated:

• ZBOSS could not send a packet over NWK, for example: there is no ACK on the MAC layer; there is no response to a network address request;
• ZBOSS could not send a packet over APS, for example: there is no APS-ACK to an APS packet.

Signal parameters:

• zb_zdo_device_unavailable_params_t

ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_FINISHED

#define ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_FINISHED   60U

Notifies the TC that Device Interview was finished

Status codes:

• RET_OK: DDevice interview finished succeed
• RET_ERROR: Device interview failed and the device was removed.

Signal parameters:

• zb_zdo_signal_device_ready_for_interview_params_t

 
  /* Switch ON device interview. Now ZC app receives
   * ZB_ZDO_SIGNAL_DEVICE_READY_FOR_INTERVIEW signal and must explicitly finish
   * the interview by calling zb_tc_auth_device_after_interview() */
  zb_tc_enable_device_interview(ZB_TRUE);
 
  /* Initiate the stack start with starting the commissioning */
  if (zboss_start_no_autostart() != RET_OK)
  {
    TRACE_MSG(TRACE_ERROR, "ERROR zboss_start failed", (FMT__0));
  }
  else
  {
    /* Call the main loop */
    zboss_main_loop();
  }

 
    case ZB_ZDO_SIGNAL_DEVICE_READY_FOR_INTERVIEW:
    {
      zb_zdo_signal_device_ready_for_interview_params_t *dev_interview_params =
        ZB_ZDO_SIGNAL_GET_PARAMS(sg_p, zb_zdo_signal_device_ready_for_interview_params_t);
 
      TRACE_MSG(TRACE_APP1, "ZB_ZDO_SIGNAL_DEVICE_READY_FOR_INTERVIEW, short_addr 0x%x, ieee_addr " TRACE_FORMAT_64,
                (FMT__D_A, dev_interview_params->short_addr, TRACE_ARG_64(dev_interview_params->long_addr)));
 
      if (ZB_IEEE_ADDR_CMP(dev_interview_params->long_addr, g_r23_zed_ieee_addr))
      {
        TRACE_MSG(TRACE_APP1, "Start device interview for 0x%x", (FMT__D, dev_interview_params->short_addr));
 
        app_start_device_interview(param, dev_interview_params->short_addr);
        param = ZB_UNDEFINED_BUFFER;
      }
      else
      {
        TRACE_MSG(TRACE_APP1, "Authenticate device 0x%x without interview", (FMT__D, dev_interview_params->short_addr));
        zb_tc_auth_device_after_interview(dev_interview_params->long_addr);
        param = ZB_UNDEFINED_BUFFER;
      }
 
      break;
    } /* ZB_ZDO_SIGNAL_DEVICE_READY_FOR_INTERVIEW */
 
 
    case ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_FINISHED:
    {
      TRACE_MSG(TRACE_APP1, "ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_FINISHED, status %hd", (FMT__H, status));
      break;
    } /* ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_FINISHED */
 

 
  /* To continue the device interview, the TC can send another requests.
   * To close the device interview and reject the device do nothing - after apsSecurityTimeOutPeriod (10s by default)
   * the device will be removed automatically.
   * To close the device interview and authorize the device call zb_tc_auth_device_after_interview() .
   */
  if (resp->hdr.status == ZB_ZDP_STATUS_SUCCESS)
  {
    zb_ieee_addr_t ieee_addr;
    if (RET_OK == zb_address_ieee_by_short(resp->hdr.nwk_addr, ieee_addr))
    {
      if (RET_OK == zb_tc_auth_device_after_interview(ieee_addr))
      {
        TRACE_MSG(TRACE_APP1, "device authorized " TRACE_FORMAT_64, (FMT__A, TRACE_ARG_64(ieee_addr)));
      }
    }
  }

ZB_ZGP_SIGNAL_APPROVE_COMMISSIONING

#define ZB_ZGP_SIGNAL_APPROVE_COMMISSIONING   67U

ZGP Approve Commissioning signal.

When generated:

• ZGP subsystem is ready to create new pairing but APP should check if GPD application functionality matches to continue pairing.

Status codes:

• RET_OK.

After receiving that signal application SHALL decide whether to connect GP device or not. After that, application SHALL send acceptance status by calling zb_zgps_accept_commissioning(). It is impossible to continue GP commissioning operation without a calling zb_zgps_accept_commissioning(), and the sink will exit commissioning mode after commissioning timeout expired.

Signal parameters:

• zb_zgp_signal_approve_comm_params_t

      case ZB_ZGP_SIGNAL_APPROVE_COMMISSIONING:
      {
        zb_zgp_signal_approve_comm_params_t *app_comm_params = ZB_ZDO_SIGNAL_GET_PARAMS(sg_p, zb_zgp_signal_approve_comm_params_t);
        TRACE_MSG(TRACE_APP1, "ZB_ZGP_SIGNAL_APPROVE_COMMISSIONING", (FMT__0));
        accept_comm_cb(app_comm_params->params);
      }
      break;

ZB_ZGP_SIGNAL_MODE_CHANGE

#define ZB_ZGP_SIGNAL_MODE_CHANGE   65U

ZGP Mode change signal.

When generated:

• GPCB Sink change mode between operational mode and commissioning mode.

Status codes:

• RET_OK: mode changed.
  • Does not return error status.

Signal parameters:

• zb_zgp_signal_mode_change_params_s

      case ZB_ZGP_SIGNAL_MODE_CHANGE:
      {
        zb_zgp_signal_mode_change_params_t *signal_params = ZB_ZDO_SIGNAL_GET_PARAMS(sg_p, zb_zgp_signal_mode_change_params_t);
        mode_change_cb(signal_params->new_mode, signal_params->reason);
      }
      break;