file_handling.c

Go to the documentation of this file.

#include <stdint.h>
#include <stdio.h>
#include <time.h>

#include "pru.h"
#include "util.h"

#include "file_handling.h"

const char* channel_names[NUM_CHANNELS] = {"I1H", "I1L", "V1", "V2",
                                           "I2H", "I2L", "V3", "V4"};
const char* digital_input_names[NUM_DIGITAL_INPUTS] = {"DI1", "DI2", "DI3",
                                                       "DI4", "DI5", "DI6"};
const char* valid_info_names[NUM_I_CHANNELS] = {"I1L_valid", "I2L_valid"};

int i1l_valid_channel = 0;
int i2l_valid_channel = 0;

void file_setup_lead_in(struct rl_file_lead_in* lead_in, struct rl_conf* conf) {

    // number channels
    uint16_t channel_count = count_channels(conf->channels);
    // number binary channels
    uint16_t channel_bin_count = 0;
    if (conf->digital_inputs == DIGITAL_INPUTS_ENABLED) {
        channel_bin_count = NUM_DIGITAL_INPUTS;
    }
    if (conf->channels[I1L_INDEX] == CHANNEL_ENABLED) {
        i1l_valid_channel = channel_bin_count++;
    }
    if (conf->channels[I2L_INDEX] == CHANNEL_ENABLED) {
        i2l_valid_channel = channel_bin_count++;
    }

    // comment length
    uint32_t comment_length = RL_FILE_COMMENT_ALIGNMENT_BYTES;

    // timestamps
    struct time_stamp timestamp_realtime;
    struct time_stamp timestamp_monotonic;
    create_time_stamp(&timestamp_realtime, &timestamp_monotonic);

    // lead_in setup
    lead_in->magic = RL_FILE_MAGIC;
    lead_in->file_version = RL_FILE_VERSION;
    lead_in->header_length =
        sizeof(struct rl_file_lead_in) + comment_length +
        (channel_count + channel_bin_count) * sizeof(struct rl_file_channel);
    lead_in->data_block_size = conf->sample_rate / conf->update_rate;
    lead_in->data_block_count = 0; // needs to be updated
    lead_in->sample_count = 0;     // needs to be updated
    lead_in->sample_rate = conf->sample_rate;
    get_mac_addr(lead_in->mac_address);
    lead_in->start_time = timestamp_realtime;
    lead_in->comment_length = comment_length;
    lead_in->channel_bin_count = channel_bin_count;
    lead_in->channel_count = channel_count;
}

void file_setup_channels(struct rl_file_header* file_header,
                         struct rl_conf* conf) {
    int total_channel_count = file_header->lead_in.channel_bin_count +
                              file_header->lead_in.channel_count;

    // reset channels
    memset(file_header->channel, 0,
           total_channel_count * sizeof(struct rl_file_channel));

    // digital channels
    int ch = 0;
    if (conf->digital_inputs == DIGITAL_INPUTS_ENABLED) {
        for (int i = 0; i < NUM_DIGITAL_INPUTS; i++) {
            file_header->channel[ch].unit = RL_UNIT_BINARY;
            file_header->channel[ch].channel_scale = RL_SCALE_NONE;
            file_header->channel[ch].data_size = 0;
            file_header->channel[ch].valid_data_channel = NO_VALID_DATA;
            strcpy(file_header->channel[ch].name, digital_input_names[i]);
            ch++;
        }
    }

    // range valid channels
    if (conf->channels[I1L_INDEX] == CHANNEL_ENABLED) {
        file_header->channel[ch].unit = RL_UNIT_RANGE_VALID;
        file_header->channel[ch].channel_scale = RL_SCALE_NONE;
        file_header->channel[ch].data_size = 0;
        file_header->channel[ch].valid_data_channel = NO_VALID_DATA;
        strcpy(file_header->channel[ch].name, valid_info_names[0]);
        ch++;
    }
    if (conf->channels[I2L_INDEX] == CHANNEL_ENABLED) {
        file_header->channel[ch].unit = RL_UNIT_RANGE_VALID;
        file_header->channel[ch].channel_scale = RL_SCALE_NONE;
        file_header->channel[ch].data_size = 0;
        file_header->channel[ch].valid_data_channel = NO_VALID_DATA;
        strcpy(file_header->channel[ch].name, valid_info_names[1]);
        ch++;
    }

    // analog channels
    for (int i = 0; i < NUM_CHANNELS; i++) {
        if (conf->channels[i] == CHANNEL_ENABLED) {
            // current
            if (is_current(i)) {
                // low
                if (is_low_current(i)) {
                    file_header->channel[ch].channel_scale = RL_SCALE_TEN_PICO;
                    if (i == I1L_INDEX) {
                        file_header->channel[ch].valid_data_channel =
                            i1l_valid_channel;
                    } else {
                        file_header->channel[ch].valid_data_channel =
                            i2l_valid_channel;
                    }
                    // high
                } else {
                    file_header->channel[ch].channel_scale = RL_SCALE_NANO;
                    file_header->channel[ch].valid_data_channel = NO_VALID_DATA;
                }
                file_header->channel[ch].unit = RL_UNIT_AMPERE;
                // voltage
            } else {
                file_header->channel[ch].unit = RL_UNIT_VOLT;
                file_header->channel[ch].channel_scale = RL_SCALE_TEN_NANO;
                file_header->channel[ch].valid_data_channel = NO_VALID_DATA;
            }
            file_header->channel[ch].data_size = 4;
            strcpy(file_header->channel[ch].name, channel_names[i]);
            ch++;
        }
    }
}

void file_setup_header(struct rl_file_header* file_header, struct rl_conf* conf,
                       char* comment) {

    // comment
    if (comment == NULL) {
        file_header->comment = "";
    } else {
        file_header->comment = comment;
    }

    // channels
    file_setup_channels(file_header, conf);
}

void file_store_header_bin(FILE* data_file,
                           struct rl_file_header* file_header) {

    int total_channel_count = file_header->lead_in.channel_bin_count +
                              file_header->lead_in.channel_count;

    // check if alignment bytes are needed after header comment
    int comment_length = strlen(file_header->comment) + 1;
    int comment_align_bytes = 0;
    if (comment_length % RL_FILE_COMMENT_ALIGNMENT_BYTES > 0) {
        comment_align_bytes =
            RL_FILE_COMMENT_ALIGNMENT_BYTES -
            (comment_length % RL_FILE_COMMENT_ALIGNMENT_BYTES);
    }

    file_header->lead_in.comment_length = comment_length + comment_align_bytes;

    file_header->lead_in.header_length =
        sizeof(struct rl_file_lead_in) + file_header->lead_in.comment_length +
        total_channel_count * sizeof(struct rl_file_channel);

    // write lead-in
    fwrite(&(file_header->lead_in), sizeof(struct rl_file_lead_in), 1,
           data_file);

    // write comment, add zero bytes for proper header alignment if necessary
    fwrite(file_header->comment, comment_length, 1, data_file);
    if (comment_align_bytes > 0) {
        uint8_t zero_bytes[RL_FILE_COMMENT_ALIGNMENT_BYTES] = {0};
        fwrite(zero_bytes, comment_align_bytes, 1, data_file);
    }

    // write channel information
    fwrite(file_header->channel, sizeof(struct rl_file_channel),
           total_channel_count, data_file);
    fflush(data_file);
}

void file_store_header_csv(FILE* data_file,
                           struct rl_file_header* file_header) {
    // lead-in
    fprintf(data_file, "RocketLogger CSV File\n");
    fprintf(data_file, "File Version,%u\n",
            (uint32_t)file_header->lead_in.file_version);
    fprintf(data_file, "Block Size,%u\n",
            (uint32_t)file_header->lead_in.data_block_size);
    fprintf(data_file, "Block Count,%-20u\n",
            (uint32_t)file_header->lead_in.data_block_count);
    fprintf(data_file, "Sample Count,%-20llu\n",
            (uint64_t)file_header->lead_in.sample_count);
    fprintf(data_file, "Sample Rate,%u\n",
            (uint32_t)file_header->lead_in.sample_rate);
    fprintf(data_file, "MAC Address,%02x",
            (uint32_t)file_header->lead_in.mac_address[0]);

    for (int i = 1; i < MAC_ADDRESS_LENGTH; i++) {
        fprintf(data_file, ":%02x",
                (uint32_t)file_header->lead_in.mac_address[i]);
    }
    fprintf(data_file, "\n");

    time_t time = (time_t)file_header->lead_in.start_time.sec;
    fprintf(data_file, "Start Time,%s", ctime(&time));
    fprintf(data_file, "Comment,%s\n", file_header->comment);
    fprintf(data_file, "\n");

    // channels
    for (int i = 0; i < (file_header->lead_in.channel_count +
                         file_header->lead_in.channel_bin_count);
         i++) {
        fprintf(data_file, ",%s", file_header->channel[i].name);
        switch (file_header->channel[i].channel_scale) {
        case RL_SCALE_MILLI:
            fprintf(data_file, " [m");
            break;
        case RL_SCALE_MICRO:
            fprintf(data_file, " [u");
            break;
        case RL_SCALE_TEN_NANO:
            fprintf(data_file, " [10n");
            break;
        case RL_SCALE_NANO:
            fprintf(data_file, " [n");
            break;
        case RL_SCALE_TEN_PICO:
            fprintf(data_file, " [10p");
            break;
        default:
            break;
        }
        switch (file_header->channel[i].unit) {
        case RL_UNIT_VOLT:
            fprintf(data_file, "V]");
            break;
        case RL_UNIT_AMPERE:
            fprintf(data_file, "A]");
            break;
        default:
            break;
        }
    }
    fprintf(data_file, "\n");
    fflush(data_file);
}

void file_update_header_bin(FILE* data_file,
                            struct rl_file_header* file_header) {

    // seek to beginning and rewrite lead_in
    rewind(data_file);
    fwrite(&(file_header->lead_in), sizeof(struct rl_file_lead_in), 1,
           data_file);
    fflush(data_file);
    fseek(data_file, 0, SEEK_END);
}

void file_update_header_csv(FILE* data_file,
                            struct rl_file_header* file_header) {
    rewind(data_file);
    fprintf(data_file, "RocketLogger CSV File\n");
    fprintf(data_file, "File Version,%u\n",
            (uint32_t)file_header->lead_in.file_version);
    fprintf(data_file, "Block Size,%u\n",
            (uint32_t)file_header->lead_in.data_block_size);
    fprintf(data_file, "Block Count,%-20u\n",
            (uint32_t)file_header->lead_in.data_block_count);
    fprintf(data_file, "Sample Count,%-20llu\n",
            (uint64_t)file_header->lead_in.sample_count);
    fflush(data_file);
    fseek(data_file, 0, SEEK_END);
}

void file_handle_data(FILE* data_file, void* buffer_addr,
                      uint32_t sample_data_size, uint32_t samples_count,
                      struct time_stamp* timestamp_realtime,
                      struct time_stamp* timestamp_monotonic,
                      struct rl_conf* conf) {

    // write timestamp to file
    if (conf->file_format == BIN) {
        fwrite(timestamp_realtime, sizeof(struct time_stamp), 1, data_file);
        fwrite(timestamp_monotonic, sizeof(struct time_stamp), 1, data_file);
    } else if (conf->file_format == CSV) {
        fprintf(data_file, "%lli.%09lli", timestamp_realtime->sec,
                timestamp_realtime->nsec);
    }

    // count channels
    int num_channels = count_channels(conf->channels);

    // aggregation
    int32_t aggregate_count = MIN_ADC_RATE / conf->sample_rate;
    int32_t aggregate_channel_data[NUM_CHANNELS] = {0};
    uint32_t aggregate_bin_data = 0xffffffff;

    // HANDLE BUFFER //
    for (uint32_t i = 0; i < samples_count; i++) {

        // channel data variables
        int32_t channel_data[NUM_CHANNELS] = {0};
        uint32_t bin_data = 0x00000000;

        // read binary channels
        uint8_t bin_adc1 = (*((int8_t*)(buffer_addr)));
        uint8_t bin_adc2 = (*((int8_t*)(buffer_addr + 1)));

        buffer_addr += PRU_DIG_SIZE;

        // read and scale values (if channel selected)
        int ch = 0;
        for (int j = 0; j < NUM_CHANNELS; j++) {
            if (conf->channels[j] == CHANNEL_ENABLED) {
                int32_t adc_value;
                if (sample_data_size == 4) {
                    adc_value =
                        *((int32_t*)(buffer_addr + sample_data_size * j));
                } else {
                    adc_value =
                        *((int16_t*)(buffer_addr + sample_data_size * j));
                }
                channel_data[ch] =
                    (int32_t)((adc_value + calibration.offsets[j]) *
                              calibration.scales[j]);
                ch++;
            }
        }
        buffer_addr += NUM_CHANNELS * sample_data_size;

        // BINARY CHANNELS //

        // mask and combine digital inputs, if requestet
        int bin_channel_pos = 0;
        if (conf->digital_inputs == DIGITAL_INPUTS_ENABLED) {
            bin_data = ((bin_adc1 & BINARY_MASK) >> 1) |
                       ((bin_adc2 & BINARY_MASK) << 2);
            bin_channel_pos = NUM_DIGITAL_INPUTS;
        }

        // mask and combine valid info
        uint8_t valid1 = (~bin_adc1) & VALID_MASK;
        uint8_t valid2 = (~bin_adc2) & VALID_MASK;

        if (conf->channels[I1L_INDEX] == CHANNEL_ENABLED) {
            bin_data = bin_data | (valid1 << bin_channel_pos);
            bin_channel_pos++;
        }
        if (conf->channels[I2L_INDEX] == CHANNEL_ENABLED) {
            bin_data = bin_data | (valid2 << bin_channel_pos);
            bin_channel_pos++;
        }

        // handle data aggregation for low sampling rates
        if (conf->sample_rate < MIN_ADC_RATE) {

            switch (conf->aggregation) {
            case AGGREGATE_NONE:
                rl_log(ERROR, "Low sampling rates not supported without "
                              "data aggregation.");
                exit(ERROR);
                break;

            case AGGREGATE_AVERAGE:
                // accumulate intermediate samples only (skip writing)
                if ((i + 1) % aggregate_count > 0) {
                    for (int i = 0; i < num_channels; i++) {
                        aggregate_channel_data[i] += channel_data[i];
                    }
                    aggregate_bin_data = aggregate_bin_data & bin_data;
                    continue;
                }

                // calculate average for writing to file
                for (int i = 0; i < num_channels; i++) {
                    channel_data[i] =
                        aggregate_channel_data[i] / aggregate_count;
                    aggregate_channel_data[i] = 0;
                }

                bin_data = aggregate_bin_data;
                aggregate_bin_data = 0xffffffff;
                break;

            case AGGREGATE_DOWNSAMPLE:
                // drop intermediate samples (skip writing to file)
                if (i % aggregate_count > 0) {
                    continue;
                }
            }
        }

        // write data to file

        // write binary channels if enabled
        if (bin_channel_pos > 0) {
            if (conf->file_format == BIN) {
                fwrite(&bin_data, sizeof(uint32_t), 1, data_file);
            } else if (conf->file_format == CSV) {
                uint32_t MASK = 0x01;
                for (int j = 0; j < bin_channel_pos; j++) {
                    fprintf(data_file, (CSV_DELIMITER "%i"),
                            (bin_data & MASK) > 0);
                    MASK = MASK << 1;
                }
            }
        }

        // write analog channels
        if (conf->file_format == BIN) {
            fwrite(channel_data, sizeof(int32_t), num_channels, data_file);
        } else if (conf->file_format == CSV) {
            for (int j = 0; j < num_channels; j++) {
                fprintf(data_file, (CSV_DELIMITER "%d"), channel_data[j]);
            }
            fprintf(data_file, "\n");
        }
    }

    // flush processed data if data is stored
    if (conf->file_format != NO_FILE && data_file != NULL) {
        fflush(data_file);
    }
}