Z-Wave Protocol Controller Reference
Classes | Macros | Enumerations | Functions
zwapi_protocol_basis.h File Reference

Z-Wave API for basis controller/end node application interface. More...

#include <stdint.h>
#include <stdbool.h>
#include "sl_status.h"
#include "zwave_rf_region.h"
#include "zwave_node_id_definitions.h"
Include dependency graph for zwapi_protocol_basis.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  tx_power_level_t
 

Macros

#define ZW_INT_MASK_EXT1   0x02
 
#define ZW_AV_VERSION_MAJOR   1
 
#define ZW_AV_VERSION_MINOR   0
 
zwapi_get_zw_protocol_status() return value masks
#define ZW_PROTOCOL_STATUS_ROUTING   0x01
 
#define ZW_PROTOCOL_STATUS_SUC   0x02
 
Z-Wave Library Chip type
#define ZW_500_SERIES_CHIP_TYPE   5
 
#define ZW_500_SERIES_CHIP_REVISION   0
 
Chip type definitions for 700-series
#define ZW_GECKO_CHIP_TYPE(x)   ((x == 7) || (x == 8))
 
#define ZW_GECKO_CHIP_700   7
 
#define ZW_GECKO_CHIP_REVISION   0
 
Device option mask values
#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
 

Enumerations

enum  serial_api_setup_cmd_t {
  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
}
 Bitflag definitions for FUNC_ID_SERIAL_API_SETUP command. More...
 
enum  rf_power_level_t {
  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
}
 
zwapi_nodeid_basetype_t

These definitions represent possible node id basetype settings for the Z-Wave module They are used with zwapi_set_node_id_basetype()

enum  zwave_node_id_basetype_t { NODEID_8BITS = 1 , NODEID_16BITS = 2 }
 

Functions

sl_status_t zwapi_set_rf_receive_mode (uint8_t mode)
 Initialize the Z-Wave RF chip. More...
 
sl_status_t zwapi_send_node_information (zwave_node_id_t destNode, uint8_t txOptions, void(*completedFunc)(uint8_t))
 Create and transmit a "Node Information" frame. More...
 
uint8_t zwapi_get_zw_library_version (uint8_t *dst)
 Get the Z-Wave library basis version. More...
 
uint8_t zwapi_get_zw_library_type (void)
 Get the Z-Wave library type. More...
 
rf_power_level_t zwapi_set_rf_power_level (rf_power_level_t powerLevel)
 Set the power level to used in RF transmissions. More...
 
rf_power_level_t zwapi_get_rf_power_level (void)
 Get the current power level used in RF transmitting. More...
 
sl_status_t zwapi_set_tx_status_reporting (bool enable)
 Configure whether zwapi_send_data callbacks should contain tx_status report information. More...
 
sl_status_t zwapi_set_tx_power_level (tx_power_level_t zw_txpowerlevel)
 Set the current TX power level. More...
 
tx_power_level_t zwapi_get_tx_power_level (void)
 Get the current TX power level in effect. More...
 
sl_status_t zwapi_set_max_lr_tx_power_level (int16_t level)
 Set the current MAX Long Range TX power level. More...
 
int16_t zwapi_get_max_lr_tx_power_level (void)
 Get the current MAX Long Range TX power level in effect. More...
 
sl_status_t zwapi_set_rf_region (zwave_rf_region_t rfregion)
 Set the current RF region. More...
 
zwave_rf_region_t zwapi_get_rf_region (void)
 Get the current RF region. More...
 
bool zwapi_is_pti_supported ()
 Check if PTI supported. More...
 
bool zwapi_is_pti_enabled ()
 Get the current state of pti. More...
 
sl_status_t zwapi_set_radio_pti (bool state)
 Enable/disable the PTI on Z-Wave Radio. More...
 
sl_status_t zwapi_get_maximum_payload_size (uint8_t *maximum_size)
 Get the maximum payload size allowed for sending frames in Z-Wave. More...
 
sl_status_t zwapi_get_lr_maximum_payload_size (uint8_t *maximum_size)
 Get the maximum payload size allowed for sending frames in Z-Wave Long Range. More...
 
sl_status_t zwapi_set_node_id_basetype (zwave_node_id_basetype_t basetype)
 Set Z-Wave node ID basetype, either 8 bits or 16 bits used to store a node ID. More...
 
zwave_node_id_basetype_t zwapi_get_node_id_basetype ()
 Get the current node ID basetype setting. More...
 
sl_status_t zwapi_soft_reset (void)
 Reset the Z-Wave module. More...
 
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))
 Send a test frame to specified NodeID. More...
 
uint8_t zwapi_get_zw_protocol_status (void)
 Report the status of the Z-Wave protocol. More...
 
sl_status_t zwapi_enable_watchdog ()
 Enable the Watchdog. More...
 
sl_status_t zwapi_disable_watchdog ()
 Disable the Watchdog. More...
 
sl_status_t zwapi_start_watchdog ()
 Enable Watchdog and start kicking it in the Z-Wave chip. More...
 
sl_status_t zwapi_get_random_word (uint8_t *random_buffer, uint8_t number_of_random_bytes)
 Generate an array of random bytes using the random number generator (RNG) on the Z-Wave module. More...
 
sl_status_t zwapi_get_random_byte (uint8_t *user_byte)
 Generate a random byte using the random number generator (RNG) on the Z-Wave module. More...
 
sl_status_t zwapi_explore_request_inclusion ()
 Transmit a request for inclusion via an explore frame. More...
 
sl_status_t zwapi_explore_request_exclusion ()
 Transmit a request for exclusion via an explore frame. More...
 
sl_status_t zwapi_get_background_rssi (uint8_t *rssi_values, uint8_t *values_length)
 Get the latest value of the background RSSI. More...
 
sl_status_t zwapi_set_application_node_information (uint8_t listening, node_type_t node_type, const uint8_t *nodeParm, uint8_t parmLength)
 Set ApplicationNodeInformation data to be used in subsequent calls to zwapi_send_node_information(). More...
 
sl_status_t zwapi_get_long_range_nodes (uint16_t *number_of_bytes, zwave_nodemask_t lr_node_list)
 Get Z-Wave Long Range node list in ZW_LR_NODEMASK_OFFSET offset of zwave_nodemask_t. More...
 
sl_status_t zwapi_get_full_node_list (zwave_nodemask_t node_list)
 Get the entire list of nodes in our network (both Z-Wave and Z-Wave Long Range) More...
 
sl_status_t zwapi_get_long_range_channel (uint8_t *lr_channel)
 Get the Z-Wave Long Range radio channel in use. More...
 
sl_status_t zwapi_set_long_range_channel (uint8_t lr_channel)
 Set the Z-Wave Long Range radio channel in use. More...
 
sl_status_t zwapi_enable_auto_program_mode (void)
 Enable Auto Programming mode. More...
 
bool zwapi_supports_long_range ()
 Return whether the Z-Wave module supports Long Range. More...
 
bool zwapi_supports_nls (void)
 Return whether the Z-Wave module supports Network Layer Security. More...
 

Detailed Description

Z-Wave API for basis controller/end node application interface.