Z-Wave Security API#

Modules#

Enumerations#

enum

SECURITY_KEY {

SECURITY_KEY_NONE = 0x00

SECURITY_KEY_S2_UNAUTHENTICATED = 0x01

SECURITY_KEY_S2_AUTHENTICATED = 0x02

SECURITY_KEY_S2_ACCESS = 0x03

SECURITY_KEY_S0 = 0x04

}

The security key a frame was received with or should be sent with.

enum

_E_APPLICATION_SECURITY_EVENT_ {

E_APPLICATION_SECURITY_EVENT_S2_INCLUSION_REQUEST_DSK_CSA

}

Definitions for Application bound Security events Delivered from protocol to Application through the SReceiveSecurityEvent notification being passed to application.

Typedefs#

typedef enum SECURITY_KEY

security_key_t

The security key a frame was received with or should be sent with.

typedef struct _S_SECURITY_S2_INCLUSION_CSA_PUBLIC_DSK_

s_SecurityS2InclusionCSAPublicDSK_t

typedef enum _E_APPLICATION_SECURITY_EVENT_

e_application_security_event_t

Definitions for Application bound Security events Delivered from protocol to Application through the SReceiveSecurityEvent notification being passed to application.

typedef struct _S_APPLICATION_SECURITY_EVENT_DATA_

s_application_security_event_data_t

Security Event Data.

Macros#

#define

SECURITY_KEY_S2_PUBLIC_DSK_LENGTH 16

Security S2 Public DSK Key length.

#define

SECURITY_KEY_S2_PUBLIC_CSA_DSK_LENGTH 4

Security S2 Public CSA DSK Key length.

Enumeration Documentation#

SECURITY_KEY#

SECURITY_KEY

The security key a frame was received with or should be sent with.

Special values:

Enumerator
SECURITY_KEY_NONE	SECURITY_KEY_NONE.
SECURITY_KEY_S2_UNAUTHENTICATED	SECURITY_KEY_S2_UNAUTHENTICATED.
SECURITY_KEY_S2_AUTHENTICATED	SECURITY_KEY_S2_AUTHENTICATED.
SECURITY_KEY_S2_ACCESS	SECURITY_KEY_S2_ACCESS.
SECURITY_KEY_S0	SECURITY_KEY_S0.

Definition at line 23 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_security_api.h

_E_APPLICATION_SECURITY_EVENT_#

_E_APPLICATION_SECURITY_EVENT_

Definitions for Application bound Security events Delivered from protocol to Application through the SReceiveSecurityEvent notification being passed to application.

Enumerator
E_APPLICATION_SECURITY_EVENT_S2_INCLUSION_REQUEST_DSK_CSA

Definition at line 71 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_security_api.h

Typedef Documentation#

security_key_t#

typedef enum SECURITY_KEY security_key_t

The security key a frame was received with or should be sent with.

Special values:

Definition at line 30 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_security_api.h

s_SecurityS2InclusionCSAPublicDSK_t#

typedef struct _S_SECURITY_S2_INCLUSION_CSA_PUBLIC_DSK_ s_SecurityS2InclusionCSAPublicDSK_t

Definition at line 63 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_security_api.h

e_application_security_event_t#

typedef enum _E_APPLICATION_SECURITY_EVENT_ e_application_security_event_t

Definitions for Application bound Security events Delivered from protocol to Application through the SReceiveSecurityEvent notification being passed to application.

Definition at line 74 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_security_api.h

s_application_security_event_data_t#

typedef struct _S_APPLICATION_SECURITY_EVENT_DATA_ s_application_security_event_data_t

Security Event Data.

Definition at line 83 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_security_api.h

Macro Definition Documentation#

SECURITY_KEY_S2_PUBLIC_DSK_LENGTH#

#define SECURITY_KEY_S2_PUBLIC_DSK_LENGTH

Value:

Security S2 Public DSK Key length.

Definition at line 52 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_security_api.h

SECURITY_KEY_S2_PUBLIC_CSA_DSK_LENGTH#

#define SECURITY_KEY_S2_PUBLIC_CSA_DSK_LENGTH

Value:

Security S2 Public CSA DSK Key length.

Definition at line 58 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_security_api.h