Z-Wave Serial API#

Modules#

Frame Types

GET_INIT_DATA_FLAG

FUNC_ID

Enumerations#

enum
FIRMWARE_UPDATE_NVM_T {
FIRMWARE_UPDATE_NVM_INIT = 0
FIRMWARE_UPDATE_NVM_SET_NEW_IMAGE = 1
FIRMWARE_UPDATE_NVM_GET_NEW_IMAGE = 2
FIRMWARE_UPDATE_NVM_UPDATE_CRC16 = 3
FIRMWARE_UPDATE_NVM_IS_VALID_CRC16 = 4
FIRMWARE_UPDATE_NVM_WRITE = 5
FIRMWARE_UPDATE_NVM_UNKNOWN = 0xFF
}

Firmware update functionality specifics Enum definitions for Firmware Update functionality selector; firmwareUpdateFunction.

enum
nvm_backup_restore_addr_size_t {
NVM_BACKUP_RESTORE_ADDR_SIZE = 2
NVM_EXT_BACKUP_RESTORE_ADDR_SIZE = 4
}

size of the address field of NVM_BACKUP_RESTORE or NVM_EXT_BACKUP_RESTORE frames.

Macros#

#define
SOF 0x01

Start Of Frame.

#define
ACK 0x06

Acknowledge successful frame reception.

#define
NAK 0x15

Not Acknowledge successful frame reception - please retransmit...

#define
CAN 0x18

Frame received (from host) was dropped - waiting for ACK.

Enumeration Documentation#

FIRMWARE_UPDATE_NVM_T#

FIRMWARE_UPDATE_NVM_T

Firmware update functionality specifics Enum definitions for Firmware Update functionality selector; firmwareUpdateFunction.

Enumerator
FIRMWARE_UPDATE_NVM_INIT
FIRMWARE_UPDATE_NVM_SET_NEW_IMAGE
FIRMWARE_UPDATE_NVM_GET_NEW_IMAGE
FIRMWARE_UPDATE_NVM_UPDATE_CRC16
FIRMWARE_UPDATE_NVM_IS_VALID_CRC16
FIRMWARE_UPDATE_NVM_WRITE
FIRMWARE_UPDATE_NVM_UNKNOWN

Definition at line 41 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/Apps/zwave_ncp_serial_api/SerialAPI.h

nvm_backup_restore_addr_size_t#

nvm_backup_restore_addr_size_t

size of the address field of NVM_BACKUP_RESTORE or NVM_EXT_BACKUP_RESTORE frames.

Item value is the size in byte of the address field.

Enumerator
NVM_BACKUP_RESTORE_ADDR_SIZE

2 bytes for the legacy NVM backup & restore command

NVM_EXT_BACKUP_RESTORE_ADDR_SIZE

4 bytes for the extended NVM backup & restore command


Definition at line 375 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/Apps/zwave_ncp_serial_api/SerialAPI.h

Macro Definition Documentation#

SOF#

#define SOF
Value:
0x01

Start Of Frame.


Definition at line 16 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/Apps/zwave_ncp_serial_api/SerialAPI.h

ACK#

#define ACK
Value:
0x06

Acknowledge successful frame reception.


Definition at line 17 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/Apps/zwave_ncp_serial_api/SerialAPI.h

NAK#

#define NAK
Value:
0x15

Not Acknowledge successful frame reception - please retransmit...


Definition at line 18 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/Apps/zwave_ncp_serial_api/SerialAPI.h

CAN#

#define CAN
Value:
0x18

Frame received (from host) was dropped - waiting for ACK.


Definition at line 19 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/Apps/zwave_ncp_serial_api/SerialAPI.h