UserCode#

Modules#

Enumerations#

enum

user_id_status_t {

USER_ID_AVAILABLE = 0x00

USER_ID_OCCUPIED = 0x01

USER_ID_RESERVED = 0x02

USER_ID_NO_STATUS = 0xFE

}

Typedefs#

typedef user_id_status_t

USER_ID_STATUS

typedef struct SUserCode

SUserCode

typedef struct s_CC_userCode_data_t_

s_CC_userCode_data_t

Struct used to pass operational data to TSE module.

Functions#

e_cmd_handler_return_code_t

CC_UserCode_Set_handler(uint8_t identifier, USER_ID_STATUS id, uint8_t *pUserCode, uint8_t len, uint8_t endpoint)

The User Code Set Command used to set a User Code in the device.

bool

CC_UserCode_getId_handler(uint8_t identifier, USER_ID_STATUS *pId, uint8_t endpoint)

The User Code Get ID.

bool

CC_UserCode_Report_handler(uint8_t identifier, uint8_t *pUserCode, size_t *pLen, uint8_t endpoint)

The User Code Report Command can be used by e.g.

uint8_t

CC_UserCode_UsersNumberReport_handler(uint8_t endpoint)

The Users Number Report Command used to report the maximum number of USER CODES the given node supports.

void

CC_UserCode_reset_data(void)

Resets the data used by the command class.

JOB_STATUS

CC_UserCode_SupportReport(AGI_PROFILE *pProfile, uint8_t sourceEndpoint, uint8_t userIdentifier, uint8_t userIdStatus, uint8_t *pUserCode, uint8_t userCodeLen, void(*pCallback)(TRANSMISSION_RESULT *pTransmissionResult))

Send a Command Class User code support report.

void

CC_UserCode_Migrate()

bool

CC_UserCode_Write(uint8_t identifier, SUserCode *userCodeData)

bool

CC_UserCode_Read(uint8_t identifier, SUserCode *userCodeData)

Macros#

#define

USERCODE_MIN_LEN 4

Minimum length of a user code as defined in SDS12652.

#define

USERCODE_MAX_LEN 10

Maximum length of a user code as defined in SDS12652.

Enumeration Documentation#

user_id_status_t#

user_id_status_t

User ID Status.#

The User ID Status field indicates the state of the User Identifier. All other values not mentioned in below list are reserved for future implementation.


Hex	Description
00	Available (not set)
01	Occupied
02	Reserved by administrator
FE	Status not available

Enumerator
USER_ID_AVAILABLE	Available (not set)
USER_ID_OCCUPIED	Occupied.
USER_ID_RESERVED	Reserved by administrator.
USER_ID_NO_STATUS	Status not available.

Definition at line 57 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

Typedef Documentation#

USER_ID_STATUS#

typedef user_id_status_t USER_ID_STATUS

Definition at line 66 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

SUserCode#

typedef struct SUserCode SUserCode

Definition at line 84 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

s_CC_userCode_data_t#

typedef struct s_CC_userCode_data_t_ s_CC_userCode_data_t

Struct used to pass operational data to TSE module.

Definition at line 93 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

Function Documentation#

CC_UserCode_Set_handler#

e_cmd_handler_return_code_t CC_UserCode_Set_handler (uint8_t identifier, USER_ID_STATUS id, uint8_t * pUserCode, uint8_t len, uint8_t endpoint)

The User Code Set Command used to set a User Code in the device.

Parameters

[in]	identifier	User Identifier.
[in]	id	user Id status.
[in]	pUserCode	pointer to UserCode data.
[in]	len	UserCode data.
[in]	endpoint	is the destination endpoint

Returns

command handler return code

Definition at line 135 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

CC_UserCode_getId_handler#

bool CC_UserCode_getId_handler (uint8_t identifier, USER_ID_STATUS * pId, uint8_t endpoint)

The User Code Get ID.

Parameters

[in]	identifier	User Identifier.
[out]	pId	pointer to return Id.
[in]	endpoint	is the destination endpoint

Returns

status valid boolean.

Definition at line 149 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

CC_UserCode_Report_handler#

bool CC_UserCode_Report_handler (uint8_t identifier, uint8_t * pUserCode, size_t * pLen, uint8_t endpoint)

The User Code Report Command can be used by e.g.

Parameters

[in]	identifier	User Identifier.
[out]	pUserCode	pointer to UserCode data.
[out]	pLen	length UserCode data.
[in]	endpoint	is the destination endpoint

a door lock device to send a report either unsolicited or requested by the User Code Get Command. Returns

status valid boolean.

Definition at line 164 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

CC_UserCode_UsersNumberReport_handler#

uint8_t CC_UserCode_UsersNumberReport_handler (uint8_t endpoint)

The Users Number Report Command used to report the maximum number of USER CODES the given node supports.

Parameters

[in]

endpoint

is the destination endpoint

The Users Number Report Command can be send requested by the Users Number Get Command. Returns

maximum number of USER CODES.

Definition at line 178 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

CC_UserCode_reset_data#

void CC_UserCode_reset_data (void )

Resets the data used by the command class.

Parameters

N/A

Definition at line 184 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

CC_UserCode_SupportReport#

JOB_STATUS CC_UserCode_SupportReport (AGI_PROFILE * pProfile, uint8_t sourceEndpoint, uint8_t userIdentifier, uint8_t userIdStatus, uint8_t * pUserCode, uint8_t userCodeLen, void(*)(TRANSMISSION_RESULT *pTransmissionResult) pCallback)

Send a Command Class User code support report.

Parameters

[in]	pProfile	pointer to AGI profile
[in]	sourceEndpoint	source endpoint
[in]	userIdentifier	user identifier
[in]	userIdStatus	user Id status
[in]	pUserCode	user code
[in]	userCodeLen	length of user code
[out]	pCallback	callback function returning status destination node receive job.

Returns

status on the job.

Definition at line 198 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

CC_UserCode_Migrate#

void CC_UserCode_Migrate ()

Definition at line 20 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/src/cc_user_code_io.h

CC_UserCode_Write#

bool CC_UserCode_Write (uint8_t identifier, SUserCode * userCodeData)

Parameters

N/A	identifier
N/A	userCodeData

Definition at line 22 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/src/cc_user_code_io.h

CC_UserCode_Read#

bool CC_UserCode_Read (uint8_t identifier, SUserCode * userCodeData)

Parameters

N/A	identifier
N/A	userCodeData

Definition at line 24 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/src/cc_user_code_io.h

Macro Definition Documentation#

USERCODE_MIN_LEN#

#define USERCODE_MIN_LEN

Value:

Minimum length of a user code as defined in SDS12652.

Definition at line 71 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h

USERCODE_MAX_LEN#

#define USERCODE_MAX_LEN

Value:

Maximum length of a user code as defined in SDS12652.

Definition at line 76 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/UserCode/inc/CC_UserCode.h