zwave_network_management.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 *
 *
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 */
 
#ifndef ZWAVE_NETWORK_MANAGEMENT_H
#define ZWAVE_NETWORK_MANAGEMENT_H
 
// Generic includes
#include <stdint.h>
#include <stdbool.h>
 
#include "zwave_controller_types.h"
#include "zwave_generic_types.h"
#include "zwave_network_management_types.h"
 
#include "zwave_controller_keyset.h"
#include "zwave_network_management_types.h"
// Interfaces
#include "zwave_generic_types.h"
 
// Unify includes
#include "sl_status.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
zwave_network_management_state_t zwave_network_management_get_state();
 
sl_status_t zwave_network_management_abort();
 
sl_status_t zwave_network_management_add_node();
 
sl_status_t zwave_network_management_add_node_with_dsk(
  const zwave_dsk_t dsk,
  zwave_keyset_t granted_keys,
  zwave_protocol_t preferred_inclusion);
 
void zwave_network_management_enable_smart_start_add_mode(bool enabled);
 
void zwave_network_management_enable_smart_start_learn_mode(bool enabled);
 
sl_status_t zwave_network_management_keys_set(bool accept,
                                              bool csa,
                                              zwave_keyset_t granted_keys);
 
sl_status_t zwave_network_management_dsk_set(zwave_dsk_t dsk);
 
sl_status_t zwave_network_management_remove_node();
 
sl_status_t zwave_network_management_learn_mode(zwave_learn_mode_t mode);
 
sl_status_t zwave_network_management_set_default(void);
 
sl_status_t zwave_network_management_remove_failed(zwave_node_id_t nodeid);
 
zwave_home_id_t zwave_network_management_get_home_id();
 
zwave_node_id_t zwave_network_management_get_node_id();
 
uint16_t zwave_network_management_get_network_size();
 
void zwave_network_management_get_network_node_list(zwave_nodemask_t node_list);
 
zwave_keyset_t zwave_network_management_get_granted_keys();
 
bool zwave_network_management_is_zpc_sis();
 
bool zwave_network_management_is_protocol_sending_frames_to_node(
  zwave_node_id_t node_id);
 
sl_status_t zwave_network_management_request_node_neighbor_discovery(
  zwave_node_id_t node_id);
 
sl_status_t zwave_network_management_start_proxy_inclusion(
  zwave_node_id_t node_id, zwave_node_info_t nif, uint8_t inclusion_step);
 
sl_status_t zwave_network_management_assign_return_route(
  zwave_node_id_t node_id, zwave_node_id_t destination_node_id);
 
bool zwave_network_management_is_busy();
 
bool we_have_return_routes_to_assign(zwave_node_id_t node_id);
 
sl_status_t zwave_network_management_set_priority_route(
  zwave_node_id_t node_id, const uint8_t *const priority_route);
 
/* An application MUST time out waiting for the
 * ADD_NODE_STATUS_NODE_FOUND status if it does not receive the indication
 * after calling AddNodeToNetwork(ADD_NODE_ANY).
 * Value: 60 seconds (60000 ms) Refer: Z-wave Appl. Programmers Guide */
#define ADD_REMOVE_TIMEOUT                60000
#define NOP_FOR_REMOVE_FAILED_TIMEOUT     65000
#define SMART_START_SELF_DESTRUCT_TIMEOUT 3000  //3 seconds
 
// How long do we wait for the Z-Wave API to callback after set default?
#define SET_DEFAULT_TIMEOUT 15000
 
// How long do we stay in Learn Mode before timing out and returning to IDLE in ms.
#define LEARN_MODE_TIMEOUT 30000
 
#define SEND_DATA_TIMEOUT 125000
 
/* An application MUST time out waiting for the ADD_NODE_STATUS_ADDING_END_NODE
 * status if it does not receive the indication within a time period after
 * receiving the ADD_NODE_STATUS_NODE_FOUND status.
 * The RECOMMENDED timeout interval is 60 sec. */
#define ADD_NODE_STATUS_ADDING_END_NODE_TIMEOUT 60000
 
/*
 * INS13954 indicates that the timeout should be as follows:
 * 1. for including an End Node:
 * timeout = 76000 ms + listening nodes * 217 ms + FLiRS Nodes * 3517 ms
 * 2. for including a Controller Node:
 * timeout = 76000 ms + listening nodes * 217 ms + FLiRS Nodes * 3517 ms + network nodes * 732 ms
 *
 * This is the worst case scenario time out, we do not bother calculating the right timeout
 */
#define ADD_NODE_PROTOCOL_NEIGHBOR_DISCOVERY_TIMEOUT \
  (76000 + ZW_MAX_NODES * (3517 + 732))
 
#define PRIORITY_ROUTE_SIZE 5
 
#ifdef __cplusplus
}
#endif
 
#endif  //ZWAVE_NETWORK_MANAGEMENT_H