types.h

Go to the documentation of this file.

#ifndef TYPES_H_
#define TYPES_H_

// INCLUDES

// standard
#include <ctype.h>
#include <errno.h>
#include <stdarg.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

// ipc, memory mapping, multithreading
#include <pthread.h>
#include <signal.h>
#include <sys/mman.h>
#include <sys/shm.h>

// files
#include <fcntl.h>
#include <poll.h>
#include <sys/stat.h>

// time
#include <sys/time.h>
#include <time.h>

// pru
#include <pruss_intc_mapping.h>
#include <prussdrv.h>

// ncurses (text-based UI)
#include <ncurses.h>

// DEFINES

// return codes
#define SUCCESS 1
#define UNDEFINED 0
#define TIME_OUT 0
#define FAILURE -1

// files
#define PID_FILE "/var/run/rocketlogger.pid"
#define LOG_FILE "/var/www/log/log.txt"
#define MAC_ADDRESS_FILE "/sys/class/net/eth0/address"
#define CALIBRATION_FILE "/etc/rocketlogger/calibration.dat"

#define MAX_LOG_FILE_SIZE 1000000

#define SHMEM_STATUS_KEY 1111
#define SHMEM_DATA_KEY 4443
#define SHMEM_PERMISSIONS 0666

// constants
#define MAX_PATH_LENGTH 256
#define NUM_CHANNELS 8
#define NUM_I_CHANNELS 2
#define NUM_V_CHANNELS 4
#define NUM_DIGITAL_INPUTS 6
#define METER_UPDATE_RATE 5
#define PRU_DIG_SIZE 2
#define PRU_BUFFER_STATUS_SIZE 4

#define KSPS 1000

#define I1L_VALID_BIT 1
#define I2L_VALID_BIT 1
#define DIGIN1_BIT 2
#define DIGIN2_BIT 4
#define DIGIN3_BIT 8
#define DIGIN4_BIT 2
#define DIGIN5_BIT 4
#define DIGIN6_BIT 8

#define MIN_ADC_RATE 1000

// ROCKETLOGGER
typedef enum state {
    RL_OFF = 0,     
    RL_RUNNING = 1, 
    RL_ERROR = -1,  
} rl_state;

typedef enum sampling {
    SAMPLING_OFF = 0, 
    SAMPLING_ON = 1,  
} rl_sampling;

typedef enum mode {
    LIMIT, 
    CONTINUOUS,    
    METER,         
    STATUS,        
    STOPPED,       
    SET_DEFAULT,   
    PRINT_DEFAULT, 
    PRINT_VERSION, 
    HELP,          
    NO_MODE        
} rl_mode;

typedef enum aggregation {
    AGGREGATE_NONE = 0,       
    AGGREGATE_DOWNSAMPLE = 1, 
    AGGREGATE_AVERAGE = 2     
} rl_aggregation;

typedef enum file_format {
    NO_FILE = 0, 
    CSV = 1,     
    BIN = 2      
} rl_file_format;

typedef enum use_cal {
    CAL_IGNORE = 0, 
    CAL_USE = 1     
} rl_use_cal;

typedef enum log_type {
    ERROR,   
    WARNING, 
    INFO     
} rl_log_type;

#define RL_CONF_VERSION 0x01

// AMBIENT CONF //
#define AMBIENT_MAX_SENSOR_COUNT 128
#define AMBIENT_DISABLED 0
#define AMBIENT_ENABLED 1
struct rl_ambient {
    int enabled;
    int sensor_count;
    int available_sensors[AMBIENT_MAX_SENSOR_COUNT];
    char file_name[MAX_PATH_LENGTH];
} ambient;

// channel properties
#define CHANNEL_DISABLED 0
#define CHANNEL_ENABLED 1

// channel indices in channels array
#define I1H_INDEX 0
#define I1L_INDEX 1
#define V1_INDEX 2
#define V2_INDEX 3
#define I2H_INDEX 4
#define I2L_INDEX 5
#define V3_INDEX 6
#define V4_INDEX 7

// digital inputs
#define DIGITAL_INPUTS_DISABLED 0
#define DIGITAL_INPUTS_ENABLED 1

struct rl_conf {
    int version;
    rl_mode mode;
    int sample_rate;
    rl_aggregation aggregation;
    int update_rate;
    int sample_limit;
    int channels[NUM_CHANNELS];
    int force_high_channels[NUM_I_CHANNELS];
    int digital_inputs;
    int enable_web_server;
    rl_use_cal calibration;
    rl_file_format file_format;
    uint64_t max_file_size;
    char file_name[MAX_PATH_LENGTH];
    struct rl_ambient ambient;
};

struct rl_status {
    rl_state state;
    rl_sampling sampling;
    uint64_t samples_taken;
    uint32_t buffer_number;
    struct rl_conf conf;
    uint64_t calibration_time;
};

struct rl_calibration {
    uint64_t time;
    int offsets[NUM_CHANNELS];
    double scales[NUM_CHANNELS];
};

// SEMAPHORES
#define SEM_KEY 2222
#define NUM_SEMS 2
#define SEM_TIME_OUT 3
#define SEM_WRITE_TIME_OUT 1
#define SEM_SET_TIME_OUT 1

#define DATA_SEM 0
#define WAIT_SEM 1

#define NO_FLAG 0

// ----- GLOBAL VARIABLES ----- //
struct rl_status status;
struct rl_calibration calibration;
extern const char* channel_names[NUM_CHANNELS];
extern const char* digital_input_names[NUM_DIGITAL_INPUTS];
extern const char* valid_info_names[NUM_I_CHANNELS];

#endif /* TYPES_H_ */