simple FS  v0.1.0
sensor_FS.h
Go to the documentation of this file.
1 
27 #ifndef INC_SENSOR_FS_H_
28 #define INC_SENSOR_FS_H_
29 
30 #include "module_time.h"
31 #include "module_adc.h"
32 #include "module_data.h"
33 #include "module_ow_bus.h"
34 #include "FS_lowLevel.h"
35 
36 
37 void FS_init(void *hw_obj1, void *hw_obj2, uint16_t hw_obj3);
38 uint8_t FS_create_file();
39 SimpleFS_t* FS_open_file(uint8_t id_file);
40 SimpleFS_t* FS_open_last_file(void);
41 FS_state FS_write_preamble(void);
42 uint8_t FS_num_files();
43 uint8_t FS_detect_num_files(void);
44 FS_state FS_commit_file_header(void);
45 uint8_t FS_is_empty(void);
46 SensorInterface_t *FS_sensor_driver(uint8_t sensor_part);
47 
48 FS_state file_add_sensor(uint8_t index, uint8_t index_in_driver, SensorInterface_t *sensor);
49 uint8_t file_get_num_parts(SimpleFS_t *fileP);
50 uint32_t file_data_row_begin(SimpleFS_t *fs);
51 FS_state file_store_data(SimpleFS_t *fs, uint8_t index, SensorValue_t *value);
52 void file_data_row_commit(SimpleFS_t *fs);
53 uint16_t file_record_length(SimpleFS_t *fileP);
54 RecordDescriptor_t file_column_format(SimpleFS_t *fileP, uint8_t index_part);
55 uint32_t file_size(SimpleFS_t *fs);
56 void file_data_prepare(void);
57 
58 
59 void file_dump_memory(void);
60 
61 #endif /* INC_SENSOR_FS_H_ */
62 
file_get_num_parts
uint8_t file_get_num_parts(SimpleFS_t *fileP)
Return number parts of opened file.
Definition: sensor_FS.c:249
FS_is_empty
uint8_t FS_is_empty(void)
Check, that sensorFS/FLASH is empty.
Definition: sensor_FS.c:370
module_adc.h
Module for communication Analog-digital peripheral used on MCU.
FS_open_last_file
SimpleFS_t * FS_open_last_file(void)
Open last file on sensorFS.
Definition: sensor_FS.c:226
FS_init
void FS_init(void *hw_obj1, void *hw_obj2, uint16_t hw_obj3)
Init the sensorFS filesystem.
Definition: sensor_FS.c:86
module_data.h
Module for manipulating with primitive data types. Supported modes:
module_time.h
Module for communication Real Time Clock (RTC) peripheral used on MCU. Supported modes:
file_data_prepare
void file_data_prepare(void)
Start value measure on all sensors.
Definition: sensor_FS.c:295
FS_open_file
SimpleFS_t * FS_open_file(uint8_t id_file)
Try open to file with given ID.
Definition: sensor_FS.c:217
FS_state
enum state FS_state
State definition for memory operations.
FS_commit_file_header
FS_state FS_commit_file_header(void)
Finish write information about created file.
Definition: sensor_FS.c:204
RecordDescriptor_t
Describes internal structure of file.
Definition: file_format.h:228
SensorInterface_t
The interface, that defines list of functions, tha have to be implemented for each type of value (or ...
Definition: sensor.h:66
file_size
uint32_t file_size(SimpleFS_t *fs)
Return file size in Bytes.
Definition: sensor_FS.c:356
FS_num_files
uint8_t FS_num_files()
Return number of files, that is stored in internal info structure.
Definition: sensor_FS.c:268
SensorValue_t
Sensor value is stored as array of bytes.
Definition: sensor.h:42
FS_sensor_driver
SensorInterface_t * FS_sensor_driver(uint8_t sensor_part)
Return driver for attached sensor.
Definition: sensor_FS.c:287
FS_lowLevel.h
Low-level functions to communicate with simpleFileSystem.
file_record_length
uint16_t file_record_length(SimpleFS_t *fileP)
Return length of record.
Definition: sensor_FS.c:240
SimpleFS_t
Base structure for sFS.
Definition: file_format.h:271
file_data_row_commit
void file_data_row_commit(SimpleFS_t *fs)
Write prepared measured values (by file_store_data} function) to FLASH.
Definition: sensor_FS.c:347
file_column_format
RecordDescriptor_t file_column_format(SimpleFS_t *fileP, uint8_t index_part)
Return format of i-th sensor inf datafile.
Definition: sensor_FS.c:259
file_add_sensor
FS_state file_add_sensor(uint8_t index, uint8_t index_in_driver, SensorInterface_t *sensor)
Add new sensor to created file.
Definition: sensor_FS.c:180
file_data_row_begin
uint32_t file_data_row_begin(SimpleFS_t *fs)
Initialize internal data structures for new data record.
Definition: sensor_FS.c:321
FS_write_preamble
FS_state FS_write_preamble(void)
Write preamble aprt in sensorFS, if not exists.
Definition: sensor_FS.c:384
FS_create_file
uint8_t FS_create_file()
Begin file creation procedure.
Definition: sensor_FS.c:114
module_ow_bus.h
Module for communication with sensors in One-Wire bus. Supported modes:
FS_detect_num_files
uint8_t FS_detect_num_files(void)
Return number of files.
Definition: sensor_FS.c:277
file_store_data
FS_state file_store_data(SimpleFS_t *fs, uint8_t index, SensorValue_t *value)
Prepare measured value to file buffer.
Definition: sensor_FS.c:337
Generated by   doxygen 1.8.17