Z-Wave Basis API#
This section defines functions that are implemented in all Z Wave nodes.
Modules#
Enumerations#
Network modes that can be set by ZAF_setNetworkLearnMode.
Typedefs#
Return values of ApplicationInit.
Node type structure used in ApplicationNodeInformation.
Node info stored within the non-volatile memory This are the first (protocol part) payload bytes from the Node Infomation frame.
Network modes that can be set by ZAF_setNetworkLearnMode.
Functions#
ApplicationInit() MUST be defined by the application.
Initialize the Z-Wave protocol stack.
Early startup of Z-Wave platform features.
Gets Z-Wave Protocol Build number.
Gets Z-Wave Protocol git hash.
Macros#
Enumeration Documentation#
_APPLICATION_STATUS_#
_APPLICATION_STATUS_
Return values of ApplicationInit.
Enumerator | |
---|---|
APPLICATION_RUNNING | Application started normally. |
APPLICATION_POWER_DOWN | Application started in special mode: Scheduler started, but Z-Wave protocol task did not. |
APPLICATION_TEST | Test only, not to be used in production. |
30
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
_E_NETWORK_LEARN_MODE_ACTION_#
_E_NETWORK_LEARN_MODE_ACTION_
Network modes that can be set by ZAF_setNetworkLearnMode.
Enumerator | |
---|---|
E_NETWORK_LEARN_MODE_DISABLE | Disable learn process. |
E_NETWORK_LEARN_MODE_INCLUSION | Enable the learn process to do an inclusion. |
E_NETWORK_LEARN_MODE_EXCLUSION | Enable the learn process to do an exclusion. |
E_NETWORK_LEARN_MODE_EXCLUSION_NWE | Enable the learn process to do an network wide exclusion. |
E_NETWORK_LEARN_MODE_INCLUSION_SMARTSTART | Enable the learn process to do an SMARTSTART inclusion. |
E_NETWORK_LEARN_MODE_COUNT |
72
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
_E_SYSTEM_TYPE_#
_E_SYSTEM_TYPE_
DeprecatedUse Application Node Info instead
Enumerator | |
---|---|
E_SYSTEM_TYPE_NON_LISTENING | |
E_SYSTEM_TYPE_LISTENING | |
E_SYSTEM_TYPE_FLIRS |
98
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
Typedef Documentation#
ZW_APPLICATION_STATUS#
typedef enum _APPLICATION_STATUS_ ZW_APPLICATION_STATUS
Return values of ApplicationInit.
36
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
APPL_NODE_TYPE#
typedef struct _APPL_NODE_TYPE_ APPL_NODE_TYPE
Node type structure used in ApplicationNodeInformation.
43
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
NODE_TYPE#
typedef struct _NODE_TYPE_ NODE_TYPE
51
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
NODEINFO#
typedef struct _NODEINFO_ NODEINFO
Node info stored within the non-volatile memory This are the first (protocol part) payload bytes from the Node Infomation frame.
62
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
E_NETWORK_LEARN_MODE_ACTION#
typedef enum _E_NETWORK_LEARN_MODE_ACTION_ E_NETWORK_LEARN_MODE_ACTION
Network modes that can be set by ZAF_setNetworkLearnMode.
80
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
E_SYSTEM_TYPE#
typedef enum _E_SYSTEM_TYPE_ E_SYSTEM_TYPE
DeprecatedUse Application Node Info instead
DeprecatedUse APPLICATION_NODEINFO_LISTENING instead
105
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
Function Documentation#
ApplicationInit#
ZW_APPLICATION_STATUS ApplicationInit (zpal_reset_reason_t eResetReason)
ApplicationInit() MUST be defined by the application.
[in] | eResetReason | The reason that triggered a reset/boot of the firmware. For instance, external pin, wake up timer, power on, etc. Please see zpal_reset_reason_t. |
This function will be invoked by the Z-Wave stack during boot.
ApplicationInit() is invoked before the scheduler starts.
ApplicationInit() MUST invoke ZW_ApplicationRegisterTask() as a minimum.
Returns
The Z-Wave stack acts differently depending on the returned value. If APPLICATION_RUNNING is returned, everything will boot normally. If APPLICATION_POWER_DOWN is returned, the Z-Wave stack will NOT start, but the scheduler will start.
128
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
sl_zwave_protocol_startup#
void sl_zwave_protocol_startup (void )
Initialize the Z-Wave protocol stack.
N/A |
135
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
sl_zwave_platform_startup#
void sl_zwave_platform_startup (void )
Early startup of Z-Wave platform features.
N/A |
140
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
ZW_GetProtocolBuildNumber#
uint16_t ZW_GetProtocolBuildNumber (void )
Gets Z-Wave Protocol Build number.
N/A |
Returns
Z-Wave Protocol Build number
146
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
ZW_GetProtocolGitHash#
const uint8_t * ZW_GetProtocolGitHash (void )
Gets Z-Wave Protocol git hash.
N/A |
Returns
uint8_t* Z-Wave Protocol git hash
153
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
Macro Definition Documentation#
SYSTEM_TYPE_LISTENING_MASK#
#define SYSTEM_TYPE_LISTENING_MASKValue:
E_SYSTEM_TYPE_LISTENING
DeprecatedUse APPLICATION_FREQ_LISTENING_MODE_1000ms or APPLICATION_FREQ_LISTENING_MODE_250ms instead
106
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h
SYSTEM_TYPE_FLIRS_MASK#
#define SYSTEM_TYPE_FLIRS_MASKValue:
E_SYSTEM_TYPE_FLIRS
108
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_basis_api.h