svm41_i2c.c

/*
 * THIS FILE IS AUTOMATICALLY GENERATED
 *
 * I2C-Generator: 0.3.0
 * Yaml Version: 0.7.1
 * Template Version: 0.7.0-84-g1150250
 */
/*
 * Copyright (c) 2021, Sensirion AG
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of Sensirion AG nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include "svm41_i2c.h"
#include "sensirion_common.h"
#include "sensirion_i2c.h"
#include "sensirion_i2c_hal.h"

#define SVM41_I2C_ADDRESS 0x6A

int16_t svm41_start_measurement(void) {
    int16_t error;
    uint8_t buffer[2];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x10);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }
    sensirion_i2c_hal_sleep_usec(1000);
    return NO_ERROR;
}

int16_t svm41_stop_measurement(void) {
    int16_t error;
    uint8_t buffer[2];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x104);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }
    sensirion_i2c_hal_sleep_usec(50000);
    return NO_ERROR;
}

int16_t svm41_read_measured_values_as_integers(int16_t* humidity,
                                               int16_t* temperature,
                                               int16_t* voc_index,
                                               int16_t* nox_index) {
    int16_t error;
    uint8_t buffer[12];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x405);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(50000);

    error = sensirion_i2c_read_data_inplace(SVM41_I2C_ADDRESS, &buffer[0], 8);
    if (error) {
        return error;
    }
    *humidity = sensirion_common_bytes_to_int16_t(&buffer[0]);
    *temperature = sensirion_common_bytes_to_int16_t(&buffer[2]);
    *voc_index = sensirion_common_bytes_to_int16_t(&buffer[4]);
    *nox_index = sensirion_common_bytes_to_int16_t(&buffer[6]);
    return NO_ERROR;
}

int16_t svm41_read_measured_values(float* humidity, float* temperature,
                                   float* voc_index, float* nox_index) {
    int16_t error;
    int16_t humidity_ticks;
    int16_t temperature_ticks;
    int16_t voc_ticks;
    int16_t nox_ticks;

    error = svm41_read_measured_values_as_integers(
        &humidity_ticks, &temperature_ticks, &voc_ticks, &nox_ticks);
    if (error) {
        return error;
    }

    *humidity = humidity_ticks / 100.0f;
    *temperature = temperature_ticks / 200.0f;
    *voc_index = voc_ticks / 10.0f;
    *nox_index = nox_ticks / 10.0f;

    return NO_ERROR;
}

int16_t svm41_read_measured_raw_values(int16_t* raw_humidity,
                                       int16_t* raw_temperature,
                                       uint16_t* raw_voc_ticks,
                                       uint16_t* raw_nox_ticks) {
    int16_t error;
    uint8_t buffer[12];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x3D2);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(50000);

    error = sensirion_i2c_read_data_inplace(SVM41_I2C_ADDRESS, &buffer[0], 8);
    if (error) {
        return error;
    }
    *raw_humidity = sensirion_common_bytes_to_int16_t(&buffer[0]);
    *raw_temperature = sensirion_common_bytes_to_int16_t(&buffer[2]);
    *raw_voc_ticks = sensirion_common_bytes_to_uint16_t(&buffer[4]);
    *raw_nox_ticks = sensirion_common_bytes_to_uint16_t(&buffer[6]);
    return NO_ERROR;
}

int16_t
svm41_set_temperature_offset_for_rht_measurements_ticks(int16_t t_offset) {
    int16_t error;
    uint8_t buffer[5];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x6014);

    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset, t_offset);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(10000);
    return NO_ERROR;
}

int16_t svm41_set_temperature_offset_for_rht_measurements(float t_offset) {
    int16_t t_offset_ticks = (int16_t)(t_offset * 200.0f + 0.5f);
    return svm41_set_temperature_offset_for_rht_measurements_ticks(
        t_offset_ticks);
}

int16_t
svm41_get_temperature_offset_for_rht_measurements_ticks(int16_t* t_offset) {
    int16_t error;
    uint8_t buffer[3];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x6014);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(1000);

    error = sensirion_i2c_read_data_inplace(SVM41_I2C_ADDRESS, &buffer[0], 2);
    if (error) {
        return error;
    }
    *t_offset = sensirion_common_bytes_to_int16_t(&buffer[0]);
    return NO_ERROR;
}

int16_t svm41_get_temperature_offset_for_rht_measurements(float* t_offset) {
    int16_t error;
    int16_t t_offset_ticks;

    error = svm41_get_temperature_offset_for_rht_measurements_ticks(
        &t_offset_ticks);
    if (error) {
        return error;
    }

    *t_offset = (float)t_offset_ticks / 200.0f;

    return NO_ERROR;
}

int16_t svm41_set_voc_algorithm_tuning_parameters(
    int16_t voc_index_offset, int16_t learning_time_offset_hours,
    int16_t learning_time_gain_hours, int16_t gating_max_duration_minutes,
    int16_t std_initial, int16_t gain_factor) {
    int16_t error;
    uint8_t buffer[20];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x60D0);

    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset,
                                                 voc_index_offset);
    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset,
                                                 learning_time_offset_hours);
    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset,
                                                 learning_time_gain_hours);
    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset,
                                                 gating_max_duration_minutes);
    offset =
        sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset, std_initial);
    offset =
        sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset, gain_factor);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }
    sensirion_i2c_hal_sleep_usec(50000);
    return NO_ERROR;
}

int16_t svm41_get_voc_algorithm_tuning_parameters(
    int16_t* voc_index_offset, int16_t* learning_time_offset_hours,
    int16_t* learning_time_gain_hours, int16_t* gating_max_duration_minutes,
    int16_t* std_initial, int16_t* gain_factor) {
    int16_t error;
    uint8_t buffer[18];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x60D0);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(50000);

    error = sensirion_i2c_read_data_inplace(SVM41_I2C_ADDRESS, &buffer[0], 12);
    if (error) {
        return error;
    }
    *voc_index_offset = sensirion_common_bytes_to_int16_t(&buffer[0]);
    *learning_time_offset_hours = sensirion_common_bytes_to_int16_t(&buffer[2]);
    *learning_time_gain_hours = sensirion_common_bytes_to_int16_t(&buffer[4]);
    *gating_max_duration_minutes =
        sensirion_common_bytes_to_int16_t(&buffer[6]);
    *std_initial = sensirion_common_bytes_to_int16_t(&buffer[8]);
    *gain_factor = sensirion_common_bytes_to_int16_t(&buffer[10]);
    return NO_ERROR;
}

int16_t svm41_set_nox_algorithm_tuning_parameters(
    int16_t nox_index_offset, int16_t learning_time_offset_hours,
    int16_t learning_time_gain_hours, int16_t gating_max_duration_minutes,
    int16_t std_initial, int16_t gain_factor) {
    int16_t error;
    uint8_t buffer[20];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x60E1);

    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset,
                                                 nox_index_offset);
    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset,
                                                 learning_time_offset_hours);
    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset,
                                                 learning_time_gain_hours);
    offset = sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset,
                                                 gating_max_duration_minutes);
    offset =
        sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset, std_initial);
    offset =
        sensirion_i2c_add_int16_t_to_buffer(&buffer[0], offset, gain_factor);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }
    sensirion_i2c_hal_sleep_usec(50000);
    return NO_ERROR;
}

int16_t svm41_get_nox_algorithm_tuning_parameters(
    int16_t* nox_index_offset, int16_t* learning_time_offset_hours,
    int16_t* learning_time_gain_hours, int16_t* gating_max_duration_minutes,
    int16_t* std_initial, int16_t* gain_factor) {
    int16_t error;
    uint8_t buffer[18];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x60E1);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(50000);

    error = sensirion_i2c_read_data_inplace(SVM41_I2C_ADDRESS, &buffer[0], 12);
    if (error) {
        return error;
    }
    *nox_index_offset = sensirion_common_bytes_to_int16_t(&buffer[0]);
    *learning_time_offset_hours = sensirion_common_bytes_to_int16_t(&buffer[2]);
    *learning_time_gain_hours = sensirion_common_bytes_to_int16_t(&buffer[4]);
    *gating_max_duration_minutes =
        sensirion_common_bytes_to_int16_t(&buffer[6]);
    *std_initial = sensirion_common_bytes_to_int16_t(&buffer[8]);
    *gain_factor = sensirion_common_bytes_to_int16_t(&buffer[10]);
    return NO_ERROR;
}

int16_t svm41_store_nv_data(void) {
    int16_t error;
    uint8_t buffer[2];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x6002);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }
    sensirion_i2c_hal_sleep_usec(500000);
    return NO_ERROR;
}

int16_t svm41_set_voc_algorithm_state(const uint8_t* state,
                                      uint8_t state_size) {
    int16_t error;
    uint8_t buffer[14];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x6181);

    offset = sensirion_i2c_add_bytes_to_buffer(&buffer[0], offset, state,
                                               state_size);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }
    sensirion_i2c_hal_sleep_usec(50000);
    return NO_ERROR;
}

int16_t svm41_get_voc_algorithm_state(uint8_t* state, uint8_t state_size) {
    int16_t error;
    uint8_t buffer[12];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0x6181);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(50000);

    error = sensirion_i2c_read_data_inplace(SVM41_I2C_ADDRESS, &buffer[0], 8);
    if (error) {
        return error;
    }
    sensirion_common_copy_bytes(&buffer[0], state, state_size);
    return NO_ERROR;
}

int16_t svm41_get_version(uint8_t* firmware_major, uint8_t* firmware_minor,
                          bool* firmware_debug, uint8_t* hardware_major,
                          uint8_t* hardware_minor, uint8_t* protocol_major,
                          uint8_t* protocol_minor) {
    int16_t error;
    uint8_t buffer[12];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0xD100);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(1000);

    error = sensirion_i2c_read_data_inplace(SVM41_I2C_ADDRESS, &buffer[0], 8);
    if (error) {
        return error;
    }
    *firmware_major = buffer[0];
    *firmware_minor = buffer[1];
    *firmware_debug = buffer[2];
    *hardware_major = buffer[3];
    *hardware_minor = buffer[4];
    *protocol_major = buffer[5];
    *protocol_minor = buffer[6];
    return NO_ERROR;
}

int16_t svm41_get_serial_number(unsigned char* serial_number,
                                uint8_t serial_number_size) {
    int16_t error;
    uint8_t buffer[39];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0xD033);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }

    sensirion_i2c_hal_sleep_usec(1000);

    error = sensirion_i2c_read_data_inplace(SVM41_I2C_ADDRESS, &buffer[0], 26);
    if (error) {
        return error;
    }
    sensirion_common_copy_bytes(&buffer[0], serial_number, serial_number_size);
    return NO_ERROR;
}

int16_t svm41_device_reset(void) {
    int16_t error;
    uint8_t buffer[2];
    uint16_t offset = 0;
    offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0xD304);

    error = sensirion_i2c_write_data(SVM41_I2C_ADDRESS, &buffer[0], offset);
    if (error) {
        return error;
    }
    sensirion_i2c_hal_sleep_usec(100000);
    return NO_ERROR;
}