Flash

Functions
bool	get (uint32_t offset, uint8_t *buf, uint32_t len)
bool	set (uint32_t offset, uint8_t *buf, uint32_t len)

Detailed Description

Function Documentation

get()

bool get	(	uint32_t	offset,
		uint8_t *	buf,
		uint32_t	len
	)

Description

Read a range of data from user flash partition.

Syntax

api.system.flash.get(offset, buf, len)

Parameters

offset	the offset to the start of user flash partition (The sum of offset and length can't exceed 0x7800. If the chip is nRF52840(e.g. RAK4631), this limitation becomes 0x20000.)
buf	the buffer for reading the data
len	the length of data (The sum of offset and length can't exceed 0x7800. If the chip is nRF52840(e.g. RAK4631), this limitation becomes 0x20000.)

Returns

bool

Return values

TRUE	for reading data successfully
FALSE	for reading data failure

set()

bool set	(	uint32_t	offset,
		uint8_t *	buf,
		uint32_t	len
	)

Description

Write a range of data from user flash partition.

Syntax

api.system.flash.set(offset, buf, len)

Parameters

offset	the offset to the start of user flash partition (The sum of offset and length can't exceed 0x7800. If the chip is nRF52840(e.g. RAK4631), this limitation becomes 0x20000.)
buf	the buffer for writing the data
len	the length of data (The sum of offset and length can't exceed 0x7800. If the chip is nRF52840(e.g. RAK4631), this limitation becomes 0x20000.)

Returns

bool

Return values

TRUE	for writing data successfully
FALSE	for writing data failure