rl_file.h

Go to the documentation of this file.

 
#ifndef RL_FILE_H_
#define RL_FILE_H_
 
#include <stdint.h>
#include <stdio.h>
 
#include "pru.h"
#include "rl.h"
#include "util.h"
 
#define RL_FILE_MAGIC 0x444C5225
 
#define RL_FILE_VERSION 0x04
 
#define RL_FILE_CHANNEL_NAME_LENGTH 16
 
#define RL_FILE_CHANNEL_NO_LINK (UINT16_MAX)
 
#define RL_FILE_COMMENT_ALIGNMENT_BYTES sizeof(uint32_t)
 
#define RL_FILE_CSV_DELIMITER ","
 
#define RL_FILE_AMBIENT_SUFFIX "-ambient"
 
#define RL_FILE_AMBIENT_DATA_BLOCK_SIZE 1
 
#define RL_SCALE_PICO -12
#define RL_SCALE_TEN_PICO -11
#define RL_SCALE_NANO -9
#define RL_SCALE_TEN_NANO -8
#define RL_SCALE_MICRO -6
#define RL_SCALE_MILLI -3
#define RL_SCALE_UNIT 0
#define RL_SCALE_KILO 3
#define RL_SCALE_MEGA 6
#define RL_SCALE_GIGA 9
#define RL_SCALE_TERA 12
 
enum rl_unit {
    RL_UNIT_UNITLESS = 0,                   
    RL_UNIT_VOLT = 1,                       
    RL_UNIT_AMPERE = 2,                     
    RL_UNIT_BINARY = 3,                     
    RL_UNIT_RANGE_VALID = 4,                
    RL_UNIT_LUX = 5,                        
    RL_UNIT_DEG_C = 6,                      
    RL_UNIT_INTEGER = 7,                    
    RL_UNIT_PERCENT = 8,                    
    RL_UNIT_PASCAL = 9,                     
    RL_UNIT_SECOND = 10,                    
    RL_UNIT_UNDEFINED = (int)0xffffffff,    
};
 
typedef enum rl_unit rl_unit_t;
 
struct rl_file_lead_in {
    uint32_t file_magic;
    uint16_t file_version;
    uint16_t header_length;
    uint32_t data_block_size;
    uint32_t data_block_count;
    uint64_t sample_count;
    uint16_t sample_rate;
    uint8_t mac_address[MAC_ADDRESS_LENGTH];
    rl_timestamp_t start_time;
    uint32_t comment_length;
    uint16_t channel_bin_count;
    uint16_t channel_count;
};
 
typedef struct rl_file_lead_in rl_file_lead_in_t;
 
struct rl_file_channel {
    rl_unit_t unit;
    int32_t channel_scale;
    uint16_t data_size;
    uint16_t valid_data_channel;
    char name[RL_FILE_CHANNEL_NAME_LENGTH];
};
 
typedef struct rl_file_channel rl_file_channel_t;
 
struct rl_file_header {
    rl_file_lead_in_t lead_in;
    char const *comment;
    rl_file_channel_t *channel;
};
 
typedef struct rl_file_header rl_file_header_t;
 
char *rl_unit_to_string(rl_unit_t unit);
 
char *rl_file_get_ambient_file_name(char const *const data_file_name);
 
void rl_file_setup_data_lead_in(rl_file_lead_in_t *const lead_in,
                                rl_config_t const *const config);
 
void rl_file_setup_ambient_lead_in(rl_file_lead_in_t *const lead_in,
                                   rl_config_t const *const config);
 
void rl_file_setup_data_header(rl_file_header_t *const file_header,
                               rl_config_t const *const config);
 
void rl_file_setup_ambient_header(rl_file_header_t *const file_header,
                                  rl_config_t const *const config);
 
void rl_file_store_header_bin(FILE *file_handle,
                              rl_file_header_t *const file_header);
 
void rl_file_store_header_csv(FILE *file_handle,
                              rl_file_header_t const *const file_header);
 
void rl_file_update_header_bin(FILE *file_handle,
                               rl_file_header_t const *const file_header);
 
void rl_file_update_header_csv(FILE *file_handle,
                               rl_file_header_t const *const file_header);
 
int rl_file_add_data_block(FILE *data_file, int32_t const *analog_buffer,
                           uint32_t const *digital_buffer, size_t buffer_size,
                           rl_timestamp_t const *const timestamp_realtime,
                           rl_timestamp_t const *const timestamp_monotonic,
                           rl_config_t const *const config);
 
int rl_file_add_ambient_block(FILE *ambient_file, int32_t const *ambient_buffer,
                              size_t buffer_size,
                              rl_timestamp_t const *const timestamp_realtime,
                              rl_timestamp_t const *const timestamp_monotonic,
                              rl_config_t const *const config);
 
#endif /* RL_FILE_H_ */