ruuvi_task_flash.h File Reference

#include "ruuvi_driver_error.h"
#include "ruuvi_driver_sensor.h"
#include "ruuvi_interface_flash.h"
#include "ruuvi_interface_log.h"

Go to the source code of this file.

Functions
rd_status_t	rt_flash_init (void)
	Initialize flash storage. More...
rd_status_t	rt_flash_store (const uint16_t file_id, const uint16_t record_id, const void *const message, const size_t message_length)
	Store data to flash. More...
rd_status_t	rt_flash_load (const uint16_t file_id, const uint16_t record_id, void *const message, const size_t message_length)
	Load data from flash. More...
rd_status_t	rt_flash_free (const uint16_t file_id, const uint16_t record_id)
	Free data from flash. More...
rd_status_t	rt_flash_gc_run (void)
	Trigger garbage collection. More...
bool	rt_flash_busy (void)
	Check if flash is running an operation. More...

Detailed Description

Author

Otso Jousimaa otso@.nosp@m.ojou.nosp@m.sima..nosp@m.net

Date

2020-02-11

Copyright

Ruuvi Innovations Ltd, license BSD-3-Clause.

Store and load data to/from persistent storage. Typical usage:

rd_status_t err_code = RD_SUCCESS;
err_code = rt_flash_init();
RD_ERROR_CHECK(err_code, RD_SUCCESS;
char data[] = "Hello Flash!"
err_code = rt_flash_store(1, 1, data, sizeof(data));
RD_ERROR_CHECK(err_code, RD_SUCCESS;
while(rt_flash_busy());
char load[20];
err_code = rt_flash_load(1, 1, load, sizeof(data));
RD_ERROR_CHECK(err_code, RD_SUCCESS;
while(rt_flash_busy());
err_code = rt_flash_free(1, 1);
RD_ERROR_CHECK(err_code, RD_SUCCESS;
err_code = rt_flash_gc_run();
RD_ERROR_CHECK(err_code, RD_SUCCESS;

Definition in file ruuvi_task_flash.h.