INS13954 Instruction Z Wave 500 Series Appl Programmers Guide V6 81 0x
User Manual:
Open the PDF directly: View PDF
Page Count: 455 [warning: Documents this large are best viewed by clicking the View PDF Link!]
- 1 Abbreviations
- 2 Introduction
- 3 Z-Wave Software Architecture
- 3.1 Z-Wave System Startup Code
- 3.2 Z-Wave Main Loop
- 3.3 Z-Wave Protocol Layers
- 3.4 Z-Wave Routing Principles
- 3.5 Z-Wave Application Layer
- 3.6 Z-Wave Software Timers
- 3.7 Z-Wave Hardware Timers
- 3.8 Z-Wave Hardware Interrupts
- 3.9 Interrupt service routines.
- 3.10 Z-Wave Nodes
- 4 Z-Wave Application Interfaces
- 4.1 API usage guidelines
- 4.2 Z-Wave Libraries
- 4.3 Z-Wave Common API
- 4.3.1 Required Application Functions
- 4.3.1.1 ApplicationInitHW
- 4.3.1.2 ApplicationInitSW
- 4.3.1.3 ApplicationTestPoll
- 4.3.1.4 ApplicationPoll
- 4.3.1.5 ApplicationCommandHandler (Not Bridge Controller library)
- 4.3.1.6 ApplicationNodeInformation
- 4.3.1.7 ApplicationSlaveUpdate (Only slave libraries)
- 4.3.1.8 ApplicationControllerUpdate (Only controller libraries)
- 4.3.1.9 ApplicationCommandHandler_Bridge (Only bridge controller library)
- 4.3.1.10 ApplicationSlaveNodeInformation (Only bridge controller library)
- 4.3.1.11 ApplicationNetworkLearnModeCompleted (Only controller libraries)
- 4.3.1.12 ApplicationNetworkLearnModeCompleted (Only slave libraries)
- 4.3.1.13 ApplicationRfNotify
- 4.3.1.14 ApplicationSecureKeysRequested (Only slave libraries)
- 4.3.1.15 ApplicationSecureAuthenticationRequested (Only slave libraries)
- 4.3.2 Z-Wave Basis API
- 4.3.2.1 ZW_ExploreRequestInclusion
- 4.3.2.2 ZW_ExploreRequestExclusion
- 4.3.2.3 ZW_GetBackgroundRSSI
- 4.3.2.4 ZW_GetProtocolStatus
- 4.3.2.5 ZW_GetRandomWord
- 4.3.2.6 ZW_Random
- 4.3.2.7 ZW_RegisterBackgroundRSSICallback
- 4.3.2.8 ZW_RFPowerLevelSet
- 4.3.2.9 ZW_RFPowerLevelGet
- 4.3.2.10 ZW_RequestNetWorkUpdate
- 4.3.2.11 ZW_RFPowerlevelRediscoverySet
- 4.3.2.12 ZW_SendNodeInformation
- 4.3.2.13 ZW_SendTestFrame
- 4.3.2.14 ZW_SetExtIntLevel
- 4.3.2.15 ZW_SetPromiscuousMode (Only controller libraries)
- 4.3.2.16 ZW_SetRFReceiveMode
- 4.3.2.17 ZW_Type_Library
- 4.3.2.18 ZW_Version
- 4.3.2.19 ZW_VERSION_MAJOR / ZW_VERSION_MINOR / ZW_VERSION_BETA
- 4.3.2.20 ZW_WatchDogEnable
- 4.3.2.21 ZW_WatchDogDisable
- 4.3.2.22 ZW_WatchDogKick
- 4.3.2.23 ZW_GetTxTimer
- 4.3.2.24 ZW_ClearTxTimers
- 4.3.2.25 ZW_GetNetworkStats
- 4.3.2.26 ZW_ClearNetworkStats
- 4.3.2.27 ZW_Power_Management_Init
- 4.3.2.28 ZW_NetworkLearnModeStart
- 4.3.3 Z-Wave Transport API
- 4.3.3.1 ZW_SendData
- 4.3.3.2 ZW_SendDataEx (Only slave libraries)
- 4.3.3.3 ZW_SendData_Bridge
- 4.3.3.4 ZW_SendDataMulti
- 4.3.3.5 ZW_SendDataMultiEx (Only slave libraries)
- 4.3.3.6 ZW_SendDataMulti_Bridge
- 4.3.3.7 ZW_SendDataAbort
- 4.3.3.8 ZW_LockRoute (Only controllers)
- 4.3.3.9 ZW_LockRoute (Only slaves)
- 4.3.3.10 ZW_SendConst
- 4.3.3.11 ZW_SetListenBeforeTalkThreshold
- 4.3.3.12 ZW_Transport_CommandClassVersionGet
- 4.3.3.13 ZW_GetDefaultPowerLevels
- 4.3.3.14 ZW_SetDefaultPowerLevels
- 4.3.4 ZWave Firmware Update API
- 4.3.5 Z-Wave Node Mask API
- 4.3.6 IO API
- 4.3.7 GPIO macros
- 4.3.8 Z-Wave NVM Memory API
- 4.3.8.1 MemoryGetID
- 4.3.8.2 MemoryGetByte
- 4.3.8.3 MemoryPutByte
- 4.3.8.4 MemoryGetBuffer
- 4.3.8.5 MemoryPutBuffer
- 4.3.8.6 ZW_EepromInit
- 4.3.8.7 ZW_MemoryFlush
- 4.3.8.9 ZW_NVRCheck
- 4.3.8.10 NVM_get_id
- 4.3.8.11 NVM_ext_read_long_byte
- 4.3.8.12 NVM_ext_write_long_byte
- 4.3.8.13 NVM_ext_read_long_buffer
- 4.3.8.14 NVM_ext_write_long_buffer
- 4.3.9 Z-Wave Timer API
- 4.3.10 Power Control API
- 4.3.11 SPI interface API
- 4.3.11.1 Operation
- 4.3.11.2 ZW_SPI0_init
- 4.3.11.3 ZW_SPI0_enable
- 4.3.11.4 ZW_SPI0_rx_get
- 4.3.11.5 ZW_SPI0_tx_set
- 4.3.11.6 ZW_SPI0_active_get
- 4.3.11.7 ZW_SPI0_coll_get
- 4.3.11.8 ZW_SPI0_int_enable
- 4.3.11.9 ZW_SPI0_int_get
- 4.3.11.10 ZW_SPI0_int_clear
- 4.3.11.11 ZW_SPI1_init
- 4.3.11.12 ZW_SPI1_enable
- 4.3.11.13 ZW_SPI1_rx_get
- 4.3.11.14 ZW_SPI1_tx_set
- 4.3.11.15 ZW_SPI1_active_get
- 4.3.11.16 ZW_SPI1_coll_get
- 4.3.11.17 ZW_SPI1_int_enable
- 4.3.11.18 ZW_SPI1_int_get
- 4.3.11.19 ZW_SPI1_int_clear
- 4.3.12 ADC interface API
- 4.3.12.1 ZW_ADC_init
- 4.3.12.2 ZW_ADC_power_enable
- 4.3.12.3 ZW_ADC_enable
- 4.3.12.4 ZW_ADC_pin_select
- 4.3.12.5 ZW_ADC_threshold_mode_set
- 4.3.12.6 ZW_ADC_threshold_set
- 4.3.12.7 ZW_ADC_int_enable
- 4.3.12.8 ZW_ADC_int_clear
- 4.3.12.9 ZW_ADC_is_fired
- 4.3.12.10 ZW_ADC_result_get
- 4.3.12.11 ZW_ADC_buffer_enable
- 4.3.12.12 ZW_ADC_auto_zero_set
- 4.3.12.13 ZW_ADC_resolution_set
- 4.3.13 UART interface API
- 4.3.13.1 Transmission
- 4.3.13.2 Reception
- 4.3.13.3 RS232
- 4.3.13.4 Integration
- 4.3.13.5 Operation
- 4.3.13.6 ZW_UART0_init / ZW_UART1_init
- 4.3.13.7 ZW_UART0_rx_data_get / ZW_UART1_rx_data_get
- 4.3.13.8 ZW_UART0_rx_data_wait_get / ZW_UART1_rx_data_wait_get
- 4.3.13.9 ZW_UART0_tx_active_get / ZW_UART1_tx_active_get
- 4.3.13.10 ZW_UART0_tx_data_set / ZW_UART1_tx_data_set
- 4.3.13.11 ZW_UART0_tx_send_num / ZW_UART1_tx_send_num
- 4.3.13.12 ZW_UART0_tx_send_str / ZW_UART1_tx_send_str
- 4.3.13.13 ZW_UART0_INT_ENABLE / ZW_UART1_INT_ENABLE
- 4.3.13.14 ZW_UART0_INT_DISABLE / ZW_UART1_INT_DISABLE
- 4.3.13.15 ZW_UART0_tx_send_nl / ZW_UART1_tx_send_nl
- 4.3.13.16 ZW_UART0_tx_int_clear / ZW_UART1_tx_int_clear
- 4.3.13.17 ZW_UART0_rx_int_clear / ZW_UART1_rx_int_clear
- 4.3.13.18 ZW_UART0_tx_int_get / ZW_UART1_tx_int_get
- 4.3.13.19 ZW_UART0_rx_int_get / ZW_UART1_rx_int_get
- 4.3.13.20 ZW_UART0_rx_enable / ZW_UART1_rx_enable
- 4.3.13.21 ZW_UART0_tx_enable / ZW_UART1_tx_enable
- 4.3.14 Application HW Timers/PWM interface API
- 4.3.14.1 ZW_TIMER0_init
- 4.3.14.2 ZW_TIMER1_init
- 4.3.14.3 ZW_TIMER0_INT_CLEAR / ZW_TIMER1_INT_CLEAR
- 4.3.14.4 ZW_TIMER0_INT_ENABLE / ZW_TIMER1_INT_ENABLE
- 4.3.14.5 ZW_TIMER0_ENABLE / ZW_TIMER1_ENABLE
- 4.3.14.6 ZW_TIMER0_ext_clk / ZW_TIMER1_ext_clk
- 4.3.14.7 ZW_TIMER0_LOWBYTE_SET / ZW_TIMER1_LOWBYTE_SET
- 4.3.14.8 ZW_TIMER0_HIGHBYTE_SET / ZW_TIMER1_HIGHBYTE_SET
- 4.3.14.9 ZW_TIMER0_HIGHBYTE_GET / ZW_TIMER1_HIGHBYTE_GET
- 4.3.14.10 ZW_TIMER0_LOWBYTE_GET / ZW_TIMER1_LOWBYTE_GET
- 4.3.14.11 ZW_TIMER0_word_get / ZW_TIMER1_word_get
- 4.3.14.12 ZW_GPTIMER_init
- 4.3.14.13 ZW_GPTIMER_int_clear
- 4.3.14.14 ZW_GPTIMER_int_get
- 4.3.14.15 ZW_GPTIMER_int_enable
- 4.3.14.16 ZW_GPTIMER_enable
- 4.3.14.17 ZW_GPTIMER_pause
- 4.3.14.18 ZW_GPTIMER_reload_set
- 4.3.14.19 ZW_GPTIMER_reload_get
- 4.3.14.20 ZW_GPTIMER_get
- 4.3.14.21 ZW_PWM_init
- 4.3.14.22 ZW_PWM_enable
- 4.3.14.23 ZW_PWM_int_clear
- 4.3.14.24 ZW_PWM_int_get
- 4.3.14.25 ZW_PWM_int_enable
- 4.3.14.26 ZW_PWM_waveform_set
- 4.3.14.27 ZW_PWM_waveform_get
- 4.3.15 Security API
- 4.3.15.1 ZW_GetSecurityKeys (Only slave libraries)
- 4.3.15.2 ZW_s2_inclusion_init(Only slave libraries)
- 4.3.15.3 ZW_SetSecurityS2InclusionPublicDSK_CSA(Only slave libraries)
- 4.3.15.4 ZW_GetSecurityS2PublicDSK(Only slave libraries)
- 4.3.15.5 ZW_SetSecurityS2CriticalNodeID (Only routing slave library)
- 4.3.15.6 ZW_SetSecurityS0NetworkKey (Only enhanced 232 slave library)
- 4.3.16 AES API
- 4.3.17 TRIAC Controller API
- 4.3.18 LED Controller API
- 4.3.19 Infrared Controller API
- 4.3.19.1 Carrier Detector/Generator
- 4.3.19.2 Organization of Mark/Space data in Memory
- 4.3.19.3 IR Transmitter
- 4.3.19.4 IR Receiver
- 4.3.19.5 ZW_IR_tx_init
- 4.3.19.6 ZW_IR_tx_data
- 4.3.19.7 ZW_IR_tx_status_get
- 4.3.19.8 ZW_IR_learn_init
- 4.3.19.9 ZW_IR_learn_data
- 4.3.19.10 ZW_IR_learn_status_get
- 4.3.19.11 ZW_IR_status_clear
- 4.3.19.12 ZW_IR_disable
- 4.3.20 Keypad Scanner Controller API
- 4.3.21 USB/UART common API
- 4.3.22 Flash API
- 4.3.23 CRC API
- 4.3.1 Required Application Functions
- 4.4 Z-Wave Controller API
- 4.4.1 ZW_AddNodeToNetwork
- 4.4.1.1 bMode parameter
- 4.4.1.2 completedFunc parameter
- 4.4.1.2.1 ADD_NODE_STATUS_LEARN_READY status
- 4.4.1.2.2 ADD_NODE_STATUS_NODE_FOUND status
- 4.4.1.2.3 ADD_NODE_STATUS_ADDING_SLAVE status
- 4.4.1.2.4 ADD_NODE_STATUS_ADDING_CONTROLLER status
- 4.4.1.2.5 ADD_NODE_STATUS_PROTOCOL_DONE status
- 4.4.1.2.6 ADD_NODE_STATUS_DONE status
- 4.4.1.2.7 ADD_NODE_STATUS_FAILED status
- 4.4.1.2.8 ADD_NODE_STATUS_NOT_PRIMARY status
- 4.4.1.3 completedFunc callback timeouts
- 4.4.2 ZW_AddNodeDskToNetwork
- 4.4.3 ZW_AreNodesNeighbours
- 4.4.4 ZW_AssignReturnRoute
- 4.4.5 ZW_AssignSUCReturnRoute
- 4.4.6 ZW_AssignPriorityReturnRoute
- 4.4.7 ZW_AssignPrioritySUCReturnRoute
- 4.4.8 ZW_ControllerChange
- 4.4.9 ZW_DeleteReturnRoute
- 4.4.10 ZW_DeleteSUCReturnRoute
- 4.4.11 ZW_GetControllerCapabilities
- 4.4.12 ZW_GetNeighborCount
- 4.4.13 ZW_GetPriorityRoute
- 4.4.14 ZW_SetPriorityRoute
- 4.4.15 ZW_GetNodeProtocolInfo
- 4.4.16 ZW_GetRoutingInfo
- 4.4.17 ZW_GetSUCNodeID
- 4.4.18 ZW_IsFailedNode
- 4.4.19 ZW_IsPrimaryCtrl
- 4.4.20 ZW_RemoveFailedNode
- 4.4.21 ZW_ReplaceFailedNode
- 4.4.22 ZW_RemoveNodeFromNetwork
- 4.4.22.1 bMode parameter
- 4.4.22.2 completedFunc parameter
- 4.4.22.2.1 REMOVE_NODE_STATUS_LEARN_READY status
- 4.4.22.2.2 REMOVE_NODE_STATUS_NODE_FOUND status
- 4.4.22.2.3 REMOVE_NODE_STATUS_REMOVING_SLAVE status
- 4.4.22.2.4 REMOVE_NODE_STATUS_REMOVING_CONTROLLER status
- 4.4.22.2.5 REMOVE_NODE_STATUS_DONE status
- 4.4.22.2.6 REMOVE_NODE_STATUS_FAILED status
- 4.4.22.2.7 ADD_NODE_STATUS_NOT_PRIMARY status
- 4.4.22.3 completedFunc callback timeouts
- 4.4.23 ZW_RemoveNodeIDFromNetwork
- 4.4.24 ZW_ReplicationReceiveComplete
- 4.4.25 ZW_ReplicationSend
- 4.4.26 ZW_RequestNodeInfo
- 4.4.27 ZW_RequestNodeNeighborUpdate
- 4.4.28 ZW_SendSUCID
- 4.4.29 ZW_SetDefault
- 4.4.30 ZW_SetLearnMode
- 4.4.31 ZW_SetRoutingInfo
- 4.4.32 ZW_SetRoutingMAX
- 4.4.33 ZW_SetSUCNodeID
- 4.4.1 ZW_AddNodeToNetwork
- 4.5 Z-Wave Static Controller API
- 4.6 Z-Wave Bridge Controller API
- 4.7 Z-Wave Portable Controller API
- 4.8 Z-Wave Slave API
- 4.9 Z-Wave Routing and Enhanced 232 Slave API
- 4.10 Serial Command Line Debugger
- 4.11 RF Settings in App_RFSetup.c file
- 5 Application Note: SUC/SIS Implementation
- 6 Application Note: Controller Shift Implementation
- 7 Application Note: Z-Wave Protocol Versions etc
- 8 References
- Index