zwapi_protocol_basis.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_PROTOCOL_BASIS_H
#define ZWAPI_PROTOCOL_BASIS_H
 
#include <stdint.h>
#include <stdbool.h>
#include "sl_status.h"
#include "zwave_rf_region.h"
#include "zwave_node_id_definitions.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
  SERIAL_API_SETUP_CMD_UNSUPPORTED                 = 0x00,
  SERIAL_API_SETUP_CMD_SUPPORTED                   = 0x01,
  SERIAL_API_SETUP_CMD_TX_STATUS_REPORT            = 0x02,
  SERIAL_API_SETUP_CMD_MAX_LR_TX_PWR_SET           = 0x03,
  SERIAL_API_SETUP_CMD_TX_POWERLEVEL_SET           = 0x04,
  SERIAL_API_SETUP_CMD_MAX_LR_TX_PWR_GET           = 0x05,
  SERIAL_API_SETUP_CMD_TX_POWERLEVEL_GET           = 0x08,
  SERIAL_API_SETUP_CMD_MAXIMUM_PAYLOAD_SIZE_GET    = 0x10,
  SERIAL_API_SETUP_CMD_LR_MAXIMUM_PAYLOAD_SIZE_GET = 0x11,
  SERIAL_API_SETUP_CMD_RF_REGION_GET               = 0x20,
  SERIAL_API_SETUP_CMD_RF_REGION_SET               = 0x40,
  SERIAL_API_SETUP_CMD_NODEID_BASETYPE_SET         = 0x80
} serial_api_setup_cmd_t;
 
typedef enum { NODEID_8BITS = 1, NODEID_16BITS = 2 } zwave_node_id_basetype_t;
 
#define ZW_PROTOCOL_STATUS_ROUTING 0x01
#define ZW_PROTOCOL_STATUS_SUC     0x02
 
#define ZW_INT_MASK_EXT1 0x02
 
#define ZW_AV_VERSION_MAJOR 1
#define ZW_AV_VERSION_MINOR 0
 
#define ZW_500_SERIES_CHIP_TYPE     5
#define ZW_500_SERIES_CHIP_REVISION 0
 
#define ZW_GECKO_CHIP_TYPE(x) ((x == 7) || (x == 8))
#define ZW_GECKO_CHIP_700 7
#define ZW_GECKO_CHIP_REVISION 0
 
typedef struct {
  int8_t normal;  
  int8_t
    measured0dBm;  
} tx_power_level_t;
 
typedef enum {
  NORMAL_POWER = 0,            
  MINUS_1_DBM,                 
  MINUS_2_DBM,                 
  MINUS_3_DBM,                 
  MINUS_4_DBM,                 
  MINUS_5_DBM,                 
  MINUS_6_DBM,                 
  MINUS_7_DBM,                 
  MINUS_8_DBM,                 
  MINUS_9_DBM,                 
  MINIMUM_POWER = MINUS_9_DBM  
} rf_power_level_t;
 
#define APPLICATION_NODEINFO_NOT_LISTENING          0x00
#define APPLICATION_NODEINFO_LISTENING              0x01
#define APPLICATION_NODEINFO_OPTIONAL_FUNCTIONALITY 0x02
#define APPLICATION_FREQ_LISTENING_MODE_1000ms      0x10
#define APPLICATION_FREQ_LISTENING_MODE_250ms       0x20
 
sl_status_t zwapi_set_rf_receive_mode(uint8_t mode);
 
sl_status_t zwapi_send_node_information(zwave_node_id_t destNode,
                                        uint8_t txOptions,
                                        void (*completedFunc)(uint8_t));
 
uint8_t zwapi_get_zw_library_version(uint8_t *dst);
 
uint8_t zwapi_get_zw_library_type(void);
 
rf_power_level_t zwapi_set_rf_power_level(rf_power_level_t powerLevel);
 
rf_power_level_t zwapi_get_rf_power_level(void);
 
sl_status_t zwapi_set_tx_status_reporting(bool enable);
 
sl_status_t zwapi_set_tx_power_level(tx_power_level_t zw_txpowerlevel);
 
tx_power_level_t zwapi_get_tx_power_level(void);
sl_status_t zwapi_set_max_lr_tx_power_level(int16_t level);
int16_t zwapi_get_max_lr_tx_power_level(void);
 
sl_status_t zwapi_set_rf_region(zwave_rf_region_t rfregion);
 
zwave_rf_region_t zwapi_get_rf_region(void);
 
bool zwapi_is_pti_supported();
 
bool zwapi_is_pti_enabled();
sl_status_t zwapi_set_radio_pti(bool state);
 
sl_status_t zwapi_get_maximum_payload_size(uint8_t *maximum_size);
 
sl_status_t zwapi_get_lr_maximum_payload_size(uint8_t *maximum_size);
 
sl_status_t zwapi_set_node_id_basetype(zwave_node_id_basetype_t basetype);
 
zwave_node_id_basetype_t zwapi_get_node_id_basetype();
 
sl_status_t zwapi_soft_reset(void);
 
sl_status_t zwapi_send_test_frame(zwave_node_id_t node_id,
                                  rf_power_level_t power_level,
                                  void (*callback_function)(uint8_t tx_status));
 
uint8_t zwapi_get_zw_protocol_status(void);
 
sl_status_t zwapi_enable_watchdog();
 
sl_status_t zwapi_disable_watchdog();
 
sl_status_t zwapi_start_watchdog();
 
sl_status_t zwapi_get_random_word(uint8_t *random_buffer,
                                  uint8_t number_of_random_bytes);
 
sl_status_t zwapi_get_random_byte(uint8_t *user_byte);
 
sl_status_t zwapi_explore_request_inclusion();
 
sl_status_t zwapi_explore_request_exclusion();
 
sl_status_t zwapi_get_background_rssi(uint8_t *rssi_values,
                                      uint8_t *values_length);
 
sl_status_t zwapi_set_application_node_information(uint8_t listening,
                                                   node_type_t node_type,
                                                   const uint8_t *nodeParm,
                                                   uint8_t parmLength);
 
sl_status_t zwapi_get_long_range_nodes(uint16_t *number_of_bytes,
                                       zwave_nodemask_t lr_node_list);
 
sl_status_t zwapi_get_full_node_list(zwave_nodemask_t node_list);
sl_status_t zwapi_get_long_range_channel(uint8_t *lr_channel);
 
sl_status_t zwapi_set_long_range_channel(uint8_t lr_channel);
 
sl_status_t zwapi_enable_auto_program_mode(void);
 
bool zwapi_supports_long_range();
 
bool zwapi_supports_nls(void);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAPI_PROTOCOL_BASIS_H