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.
Description of reset reason.
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.
Description of reset reason.
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. |
_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 | |
EResetReason_t#
EResetReason_t
Description of reset reason.
Enum is defined in ZW API as its not HW platform specific. Warnings
For backwards compatibility the enum values must comply with the values from ZW_WAKEUP below.
| Enumerator | |
|---|---|
| ERESETREASON_PIN | Reset triggered by reset pin. |
| ERESETREASON_DEEP_SLEEP_WUT | Reset triggered by wake up by timer from deep sleep state |
| ERESETREASON_WATCHDOG | Reset triggered by watchdog. |
| ERESETREASON_DEEP_SLEEP_EXT_INT | Reset triggered by external interrupt event in deep sleep state. |
| ERESETREASON_POWER_ON | Reset triggered by power on. |
| ERESETREASON_SOFTWARE | Reset triggered by software. |
| ERESETREASON_BROWNOUT | Reset triggered by brownout circuit. |
| ERESETREASON_TAMPER | Reset triggered by tamper attempt. |
| ERESETREASON_OTHER | Reset triggered by none of the above. |
_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 | |
Typedef Documentation#
ZW_APPLICATION_STATUS#
typedef enum _APPLICATION_STATUS_ ZW_APPLICATION_STATUS
Return values of ApplicationInit.
APPL_NODE_TYPE#
typedef struct _APPL_NODE_TYPE_ APPL_NODE_TYPE
Node type structure used in ApplicationNodeInformation.
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.
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.
EResetReason_t#
typedef enum EResetReason_t EResetReason_t
Description of reset reason.
Enum is defined in ZW API as its not HW platform specific. Warnings
For backwards compatibility the enum values must comply with the values from ZW_WAKEUP below.
E_SYSTEM_TYPE#
typedef enum _E_SYSTEM_TYPE_ E_SYSTEM_TYPE
DeprecatedUse Application Node Info instead
DeprecatedUse APPLICATION_NODEINFO_LISTENING instead
Function Documentation#
ApplicationInit#
ZW_APPLICATION_STATUS ApplicationInit (EResetReason_t eResetReason)
ApplicationInit() MUST be defined by the application.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EResetReason_t | [in] | eResetReason | The reason that triggered a reset/boot of the firmware. For instance, external pin, wake up timer, power on, etc. Please see EResetReason_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.
sl_zwave_protocol_startup#
void sl_zwave_protocol_startup (void )
Initialize the Z-Wave protocol stack.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
sl_zwave_platform_startup#
void sl_zwave_platform_startup (void )
Early startup of Z-Wave platform features.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
ZW_GetProtocolBuildNumber#
uint16_t ZW_GetProtocolBuildNumber (void )
Gets Z-Wave Protocol Build number.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
Z-Wave Protocol Build number
ZW_GetProtocolGitHash#
uint8_t * ZW_GetProtocolGitHash (void )
Gets Z-Wave Protocol git hash.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
uint8_t* Z-Wave Protocol git hash