zwapi_init.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_INIT_H
#define ZWAPI_INIT_H
 
#include <stdint.h>
#include <stdbool.h>
#include "sl_status.h"
#include "zwapi_protocol_basis.h"
#include "zwave_rf_region.h"
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
  ZWAVE_LIBRARY_TYPE_CONTROLLER_STATIC
  = 0x01,  
  ZWAVE_LIBRARY_TYPE_CONTROLLER        = 0x02,  
  ZWAVE_LIBRARY_TYPE_END_NODE_ENHANCED = 0x03,  
  ZWAVE_LIBRARY_TYPE_END_NODE          = 0x04,  
  ZWAVE_LIBRARY_TYPE_INSTALLER         = 0x05,  
  ZWAVE_LIBRARY_TYPE_END_NODE_ROUTING  = 0x06,  
  ZWAVE_LIBRARY_TYPE_CONTROLLER_BRIDGE
  = 0x07,                              
  ZWAVE_LIBRARY_TYPE_DUT      = 0x08,  
  ZWAVE_LIBRARY_TYPE_AVREMOTE = 0x0A,  
  ZWAVE_LIBRARY_TYPE_AVDEVICE = 0x0B   
} zwapi_library_type_t;
 
typedef enum {
  ZWAVE_LONG_RANGE_CHANNEL_NOT_SUPPORTED
  = 0x00,                             
  ZWAVE_LONG_RANGE_CHANNEL_A = 0x01,  
  ZWAVE_LONG_RANGE_CHANNEL_B = 0x02   
} zwave_lr_channel_t;
 
#define ZWAPI_MAXIMUM_BITMASK_LENGTH (255 / 8)
#define GET_INIT_DATA_FLAG_END_NODE_API  0x01
#define GET_INIT_DATA_FLAG_TIMER_SUPPORT 0x02
#define GET_INIT_DATA_FLAG_CONTROLLER_STATUS 0x04
#define GET_INIT_DATA_FLAG_SECONDARY_CTRL    0x04
#define GET_INIT_DATA_FLAG_IS_SUC            0x08
 
typedef struct {
  uint8_t chip_type;      
  uint8_t chip_revision;  
  uint8_t version_major;
  uint8_t version_minor;
  zwapi_library_type_t library_type;
  uint16_t manufacturer_id;
  uint16_t product_type;
  uint16_t product_id;
  uint8_t supported_bitmask[ZWAPI_MAXIMUM_BITMASK_LENGTH];
  uint8_t supported_setup_bitmask[ZWAPI_MAXIMUM_BITMASK_LENGTH];
  zwave_rf_region_t rf_region;
  uint8_t capability_flag;
  zwave_nodemask_t node_list;
} zwapi_chip_data_t;
 
// Size of a git commit hash
#define GIT_COMMIT_HASH_SIZE 16
 
/* Protocol version structure used in zwapi_get_protocol_version() */
typedef struct _zwapi_protocol_version_information_t_ {
  uint8_t type;  // Type is a strange field that is not really used
  uint8_t major_version;
  uint8_t minor_version;
  uint8_t revision_version;
  uint16_t build_number;
  uint8_t git_commit[GIT_COMMIT_HASH_SIZE];
} zwapi_protocol_version_information_t;
 
typedef void (*application_command_handler_function)(
  uint8_t rx_status,
  zwave_node_id_t destination_node_id,
  zwave_node_id_t source_node_id,
  const uint8_t *received_frame,
  uint8_t received_frame_length,
  int8_t rssi_value);
 
typedef void (*protocol_cc_encryption_command_handler_function)(
  zwave_node_id_t destination_node_id,
  uint8_t payload_length,
  const uint8_t *payload,
  uint8_t protocol_metadata_length,
  const uint8_t *const protocol_metadata,
  uint8_t use_supervision,
  uint8_t session_id);
 
typedef void (*application_controller_update_function)(
  uint8_t status,
  zwave_node_id_t node_id,
  const uint8_t *zwave_nif,
  uint8_t zwave_nif_length,
  zwave_home_id_t nwi_home_id);
 
typedef struct zwapi_callbacks {
  application_command_handler_function application_command_handler;
  application_controller_update_function application_controller_update;
  application_command_handler_function application_command_handler_bridge;
  protocol_cc_encryption_command_handler_function protocol_cc_encryption_request;
  void (*zwapi_started)(const uint8_t *pData, uint8_t pLen);
  void (*poll_request)();
} zwapi_callbacks_t;
 
sl_status_t zwapi_init(const char *serial_port,
                       int *serial_fd,
                       const zwapi_callbacks_t *callbacks);
 
void zwapi_destroy(void);
 
sl_status_t zwapi_log_to_file_enable(const char *filename);
 
sl_status_t zwapi_log_to_file_disable();
 
bool zwapi_poll(void);
 
bool zwapi_support_command_func(uint8_t func_id);
 
bool zwapi_support_setup_func(serial_api_setup_cmd_t setup_cmd);
 
sl_status_t zwapi_refresh_capabilities(void);
 
sl_status_t zwapi_get_init_data(uint8_t *ver,
                                uint8_t *capabilities,
                                uint8_t *len,
                                zwave_nodemask_t node_list,
                                uint8_t *chip_type,
                                uint8_t *chip_version);
 
sl_status_t zwapi_get_node_list(zwave_nodemask_t node_list);
 
void zwapi_get_chip_type_version(uint8_t *type, uint8_t *version);
 
void zwapi_get_app_version(uint8_t *major, uint8_t *minor);
 
void zwapi_get_chip_data(zwapi_chip_data_t *user_chip_data);
 
zwapi_library_type_t zwapi_get_library_type();
 
sl_status_t zwapi_get_protocol_version(
  zwapi_protocol_version_information_t *protocol_version);
 
zwave_lr_channel_t zwapi_get_zwave_lr_channel();
 
sl_status_t zwapi_set_zwave_lr_channel(zwave_lr_channel_t new_channel);
 
bool zwapi_is_awaiting_zwave_api_started();
 
void zwapi_set_awaiting_zwave_api_started(bool value);
 
zwapi_callbacks_t *zwave_api_get_callbacks();
 
// CLEANUP: Moved form sdk_versioning.h
const char *
  zwapi_generate_sdk_version_from_protocol_version(const char *version_string);
 
const char *
  zwapi_generate_nvm_id_from_sdk_version(const char *sdk_ver,
                                         zwapi_library_type_t library_type);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAPI_INIT_H