rl_file.h

Go to the documentation of this file.

#ifndef RL_FILE_H_
#define RL_FILE_H_

#include <stdint.h>

#include "types.h"
#include "util.h"

// Defines

#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_NONE 0
#define RL_SCALE_KILO 3
#define RL_SCALE_MEGA 6
#define RL_SCALE_GIGA 9
#define RL_SCALE_TERA 12

// Constants

#define RL_FILE_MAGIC 0x444C5225 // const uint32_t RL_FILE_MAGIC = 0x25524C42;

#define RL_FILE_VERSION 0x03 // const uint8_t RL_FILE_VERSION = 0x01;

#define RL_FILE_CHANNEL_NAME_LENGTH                                            \
    16 // const uint8_t RL_FILE_CHANNEL_NAME_LENGTH = 16;

#define NO_VALID_DATA 0xFFFF // const uint16_t NO_VALID_DATA = 0xFFFF;

#define RL_FILE_COMMENT "This is a comment"

#define RL_FILE_COMMENT_ALIGNMENT_BYTES sizeof(uint32_t)

// Types

typedef enum 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_UNDEFINED = 0xffffffff, 
} rl_unit;

struct rl_file_lead_in {
    uint32_t magic; // = RL_FILE_MAGIC;

    uint16_t file_version; // = RL_FILE_VERSION;

    uint16_t header_length; // = 0;

    uint32_t data_block_size; // = 0;

    uint32_t data_block_count; // = 0;

    uint64_t sample_count; // = 0;

    uint16_t sample_rate; // = 0;

    uint8_t mac_address[MAC_ADDRESS_LENGTH];

    struct time_stamp start_time; // = 0;

    uint32_t comment_length; // = 0;

    uint16_t channel_bin_count; // = 0;

    uint16_t channel_count; // = 0;
};

struct rl_file_channel {

    rl_unit unit; // = RL_UNIT_UNDEFINED;

    int32_t channel_scale; // = RL_SCALE_NONE;

    uint16_t data_size; // = 0;

    uint16_t valid_data_channel; // = NO_VALID_DATA;

    char name[RL_FILE_CHANNEL_NAME_LENGTH];
};

struct rl_file_header {

    struct rl_file_lead_in lead_in;

    char* comment; // = NULL;

    struct rl_file_channel* channel; // = NULL;
};

#endif /* RL_FILE_H_ */