zwapi_protocol_nvm.h File Reference

Z-Wave API for NVM manipulation. More...

#include <stdint.h>

Include dependency graph for zwapi_protocol_nvm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
NVM operations
#define	ZWAVE_API_NVM_OPEN_OPERATION   0x00
#define	ZWAVE_API_NVM_READ_OPERATION   0x01
#define	ZWAVE_API_NVM_WRITE_OPERATION   0x02
#define	ZWAVE_API_NVM_CLOSE_OPERATION   0x03
NVM return codes from Z-Wave module
#define	ZWAVE_API_NVM_RETURN_CODE_OK   0x00
#define	ZWAVE_API_NVM_RETURN_CODE_ERROR   0x01
#define	ZWAVE_API_NVM_RETURN_CODE_ERROR_OPERATION_MISMATCH   0x02
#define	ZWAVE_API_NVM_RETURN_CODE_ERROR_OPERATION_DISTURBED   0x03
#define	ZWAVE_API_NVM_RETURN_CODE_END_OF_FILE   0xFF

Enumerations
enum	zwapi_protocol_nvm_status_t { ZWAPI_PROTOCOL_NVM_STATUS_OK = 0 , ZWAPI_PROTOCOL_NVM_STATUS_ERROR = 1 , ZWAPI_PROTOCOL_NVM_STATUS_EOF = 2 }
	NVM read and write status codes. More...

Functions
uint8_t	zwapi_nvm_close (void)
	Close the NVM (restart the radio) after a read or write operation. More...
uint32_t	zwapi_nvm_open (void)
	Open the NVM (stops the radio) before read or write operation. More...
zwapi_protocol_nvm_status_t	zwapi_nvm_read (uint32_t offset, uint8_t *buf, uint8_t length, uint8_t *length_read)
	Read a chunk of the 500-series NVM or 700-series NVM3. More...
zwapi_protocol_nvm_status_t	zwapi_nvm_write (uint32_t offset, const uint8_t *buf, uint8_t length, uint8_t *length_written)
	Write a chunk of the 500-series NVM or 700-series NVM3. More...

Detailed Description

Z-Wave API for NVM manipulation.