zwapi_internal.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 ZWAPI_INTERNAL_H
#define ZWAPI_INTERNAL_H
 
#include "zwapi_init.h"
#include "zwapi_protocol_transport.h"  //zwapi_tx_report_t definition
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Forward declarations
struct LEARN_INFO;
 
extern void (*zwapi_send_data_callback)(uint8_t, zwapi_tx_report_t *);
extern void (*zwapi_send_nop_callback)(uint8_t, zwapi_tx_report_t *);
extern void (*zwapi_send_data_multi_callback)(uint8_t);
extern void (*zwapi_send_test_frame_callback)(uint8_t);
extern void (*zwapi_send_data_bridge_callback)(uint8_t, zwapi_tx_report_t *);
extern void (*zwapi_send_data_multi_bridge_callback)(uint8_t);
extern void (*zwapi_send_node_information_callback)(uint8_t txStatus);
extern void (*zwapi_memory_put_buffer_callback)(void);
extern void (*zwapi_set_default_callback)(void);
extern void (*zwapi_create_new_primarly_ctrl_callback)(struct LEARN_INFO *);
extern void (*zwapi_remove_node_from_network_callback)(struct LEARN_INFO *);
extern void (*zwapi_add_node_to_network_callback)(struct LEARN_INFO *);
extern void (*zwapi_transfer_primary_ctrl_role_callback)(struct LEARN_INFO *);
extern void (*zwapi_send_controller_replication_callback)(uint8_t txStatus);
extern void (*zwapi_assign_return_route_callback)(uint8_t bStatus);
extern void (*zwapi_assign_suc_return_route_callback)(uint8_t bStatus);
extern void (*zwapi_delete_suc_return_route_callback)(uint8_t bStatus);
extern void (*zwapi_delete_return_route_callback)(uint8_t bStatus);
extern void (*zwapi_set_learn_mode_callback)(struct LEARN_INFO *);
extern void (*zwapi_set_virtual_node_to_learn_mode_callback)(
  uint8_t bStatus, zwave_node_id_t orgID, zwave_node_id_t newID);
extern void (*zwapi_request_neighbor_update_callback)(uint8_t bStatus);
extern void (*zwapi_set_suc_node_id_callback)(uint8_t bStatus);
extern void (*zwapi_request_network_update_callback)(uint8_t txStatus);
extern void (*zwapi_remove_failed_node_callback)(uint8_t txStatus);
extern void (*zwapi_replace_failed_node_callback)(uint8_t txStatus);
 
#define REQUEST_BUFFER_SIZE 180
#define SERIAL_BUFFER_SIZE  0xFF
#define FRAME_LENGTH_MIN    3
#define FRAME_LENGTH_MAX    SERIAL_BUFFER_SIZE
 
// Some commands have a Return Value given by the Z-Wave Module
#define ZW_COMMAND_RETURN_VALUE_FALSE \
  0  
#define ZW_COMMAND_RETURN_VALUE_TRUE 1  
 
void zwave_api_protocol_rx_dispatch(uint8_t *pData, uint16_t len);
 
void zwave_api_protocol_init_callbacks(void);
 
sl_status_t zwapi_send_command(uint8_t command,
                               const uint8_t *payload_buffer,
                               uint8_t payload_buffer_length);
 
sl_status_t zwapi_send_command_with_response(uint8_t command,
                                             const uint8_t *payload_buffer,
                                             uint8_t payload_buffer_length,
                                             uint8_t *response_buffer,
                                             uint8_t *response_length);
 
sl_status_t zwapi_send_command_no_ack(uint8_t command,
                                      const uint8_t *payload_buffer,
                                      uint8_t payload_buffer_length);
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAPI_INTERNAL_H