Collaboration diagram for Z-Wave Basis API:

Topics
	Application Node Info

Data Structures
struct	_APPL_NODE_TYPE_
	Node type structure used in ApplicationNodeInformation. More...

struct	_NODE_TYPE_

struct	_NODEINFO_

struct	RSSI_LEVELS
	RSSI levels for 100kbps, 40kbps, 9.6kbps and LRA/LRB. More...

Macros
#define	SYSTEM_TYPE_LISTENING_MASK E_SYSTEM_TYPE_LISTENING

#define	SYSTEM_TYPE_FLIRS_MASK E_SYSTEM_TYPE_FLIRS

Typedefs
typedef enum _APPLICATION_STATUS_	ZW_APPLICATION_STATUS

typedef struct _APPL_NODE_TYPE_	APPL_NODE_TYPE
	Node type structure used in ApplicationNodeInformation.

typedef struct _NODE_TYPE_	NODE_TYPE

typedef struct _NODEINFO_	NODEINFO

typedef enum _E_NETWORK_LEARN_MODE_ACTION_	E_NETWORK_LEARN_MODE_ACTION

typedef enum _E_SYSTEM_TYPE_	E_SYSTEM_TYPE

Enumerations
enum	_APPLICATION_STATUS_ { APPLICATION_RUNNING , APPLICATION_POWER_DOWN , APPLICATION_TEST }

enum	_E_NETWORK_LEARN_MODE_ACTION_ { E_NETWORK_LEARN_MODE_DISABLE = 0 , E_NETWORK_LEARN_MODE_INCLUSION = 1 , E_NETWORK_LEARN_MODE_EXCLUSION = 2 , E_NETWORK_LEARN_MODE_EXCLUSION_NWE = 3 , E_NETWORK_LEARN_MODE_INCLUSION_SMARTSTART = 4 , E_NETWORK_LEARN_MODE_COUNT }

enum	_E_SYSTEM_TYPE_ { E_SYSTEM_TYPE_NON_LISTENING = APPLICATION_NODEINFO_NOT_LISTENING , E_SYSTEM_TYPE_LISTENING = APPLICATION_NODEINFO_LISTENING , E_SYSTEM_TYPE_FLIRS = 0x02 }

Functions
ZW_APPLICATION_STATUS	ApplicationInit (zpal_reset_reason_t eResetReason)

void	sl_zwave_protocol_startup (void)

void	sl_zwave_platform_startup (void)

uint16_t	ZW_GetProtocolBuildNumber (void)

uint8_t *	ZW_GetProtocolGitHash (void)

Detailed Description

This section defines functions that are implemented in all Z Wave nodes.

Macro Definition Documentation

◆ SYSTEM_TYPE_FLIRS_MASK

#define SYSTEM_TYPE_FLIRS_MASK E_SYSTEM_TYPE_FLIRS

◆ SYSTEM_TYPE_LISTENING_MASK

#define SYSTEM_TYPE_LISTENING_MASK E_SYSTEM_TYPE_LISTENING

Deprecated: Use APPLICATION_FREQ_LISTENING_MODE_1000ms or APPLICATION_FREQ_LISTENING_MODE_250ms instead

Typedef Documentation

◆ APPL_NODE_TYPE

typedef struct _APPL_NODE_TYPE_ APPL_NODE_TYPE

Node type structure used in ApplicationNodeInformation.

◆ E_NETWORK_LEARN_MODE_ACTION

typedef enum _E_NETWORK_LEARN_MODE_ACTION_ E_NETWORK_LEARN_MODE_ACTION

Network modes that can be used with the EZWAVECOMMANDTYPE_NETWORK_LEARN_MODE_START command.

◆ E_SYSTEM_TYPE

typedef enum _E_SYSTEM_TYPE_ E_SYSTEM_TYPE

Deprecated: Use Application Node Info instead

Deprecated: Use APPLICATION_NODEINFO_LISTENING instead

◆ NODE_TYPE

typedef struct _NODE_TYPE_ NODE_TYPE

◆ 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

◆ ZW_APPLICATION_STATUS

typedef enum _APPLICATION_STATUS_ ZW_APPLICATION_STATUS

Return values of ApplicationInit

Enumeration Type Documentation

◆ _APPLICATION_STATUS_

enum _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_

enum _E_NETWORK_LEARN_MODE_ACTION_

Network modes that can be used with the EZWAVECOMMANDTYPE_NETWORK_LEARN_MODE_START command.

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

◆ _E_SYSTEM_TYPE_

enum _E_SYSTEM_TYPE_

Deprecated: Use Application Node Info instead

Enumerator
E_SYSTEM_TYPE_NON_LISTENING
E_SYSTEM_TYPE_LISTENING
E_SYSTEM_TYPE_FLIRS

Function Documentation

◆ ApplicationInit()

ZW_APPLICATION_STATUS ApplicationInit ( zpal_reset_reason_t eResetReason )

extern

ApplicationInit() MUST be defined by the application. 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.

Parameters

[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.

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_platform_startup()

void sl_zwave_platform_startup ( void )

Early startup of Z-Wave platform features

◆ sl_zwave_protocol_startup()

void sl_zwave_protocol_startup ( void )

Initialize the Z-Wave protocol stack.

◆ ZW_GetProtocolBuildNumber()

uint16_t ZW_GetProtocolBuildNumber ( void )

Gets Z-Wave Protocol Build number

Returns: Z-Wave Protocol Build number

◆ ZW_GetProtocolGitHash()

uint8_t * ZW_GetProtocolGitHash ( void )

Gets Z-Wave Protocol git hash

Returns: uint8_t* Z-Wave Protocol git hash

Trident IoT Z-Wave SDK

Topics

Data Structures

Macros

Typedefs

Enumerations

Functions