twr_soil_sensor.h

#ifndef _TWR_SOIL_SENSOR_H
#define _TWR_SOIL_SENSOR_H
 
#include <twr_ds28e17.h>
#include <twr_scheduler.h>
#include <twr_onewire.h>
 
 
 
typedef enum
{
    TWR_SOIL_SENSOR_EVENT_ERROR = 0,
 
    TWR_SOIL_SENSOR_EVENT_UPDATE = 1,
 
} twr_soil_sensor_event_t;
 
 
typedef enum
{
    TWR_SOIL_SENSOR_ERROR_NONE = 0,
 
    TWR_SOIL_SENSOR_ERROR_SENSOR_MODULE_INITIALIZE = 1,
 
    TWR_SOIL_SENSOR_ERROR_SENSOR_MODULE_POWER_UP = 2,
 
    TWR_SOIL_SENSOR_ERROR_NO_SENSOR_FOUND = 3,
 
    TWR_SOIL_SENSOR_ERROR_TMP112_INITIALIZE = 4,
 
    TWR_SOIL_SENSOR_ERROR_EEPROM_HEADER_READ = 5,
 
    TWR_SOIL_SENSOR_ERROR_EEPROM_SIGNATURE= 6,
 
    TWR_SOIL_SENSOR_ERROR_EEPROM_VERSION = 7,
 
    TWR_SOIL_SENSOR_ERROR_EEPROM_PAYLOAD_LENGTH = 8,
 
    TWR_SOIL_SENSOR_ERROR_EEPROM_PAYLOAD_READ = 9,
 
    TWR_SOIL_SENSOR_ERROR_EEPROM_PAYLOAD_CRC = 10,
 
    TWR_SOIL_SENSOR_ERROR_ZSSC3123_INITIALIZE = 11,
 
    TWR_SOIL_SENSOR_ERROR_TMP112_MEASUREMENT_REQUEST = 12,
 
    TWR_SOIL_SENSOR_ERROR_ZSSC3123_MEASUREMENT_REQUEST = 13,
 
    TWR_SOIL_SENSOR_ERROR_TMP112_DATA_FETCH = 14,
 
    TWR_SOIL_SENSOR_ERROR_ZSSC3123_DATA_FETCH = 15
 
} twr_soil_sensor_error_t;
 
 
typedef struct twr_soil_sensor_t twr_soil_sensor_t;
 
typedef struct twr_soil_sensor_sensor_t twr_soil_sensor_sensor_t;
 
#pragma pack(push, 1)
 
typedef struct
{
    uint32_t signature;
    uint8_t version;
    uint8_t length;
    uint16_t crc;
 
} twr_soil_sensor_eeprom_header_t;
 
typedef struct
{
    uint8_t product;
 
    uint16_t revision;
 
    char label[16 + 1];
 
    uint16_t calibration[11];
 
} twr_soil_sensor_eeprom_t;
 
#pragma pack(pop)
 
 
typedef enum
{
    TWR_SOIL_SENSOR_STATE_ERROR = -1,
    TWR_SOIL_SENSOR_STATE_PREINITIALIZE = 0,
    TWR_SOIL_SENSOR_STATE_INITIALIZE = 1,
    TWR_SOIL_SENSOR_STATE_READY = 2,
    TWR_SOIL_SENSOR_STATE_MEASURE = 3,
    TWR_SOIL_SENSOR_STATE_READ = 4,
    TWR_SOIL_SENSOR_STATE_UPDATE = 5
 
} twr_soil_sensor_state_t;
 
struct twr_soil_sensor_t
{
    twr_scheduler_task_id_t _task_id_interval;
    twr_scheduler_task_id_t _task_id_measure;
    twr_soil_sensor_state_t _state;
    bool _measurement_active;
    twr_tick_t _update_interval;
    void (*_event_handler)(twr_soil_sensor_t *, uint64_t, twr_soil_sensor_event_t, void *);
    void *_event_param;
 
    twr_onewire_t *_onewire;
    twr_soil_sensor_sensor_t *_sensor;
    int _sensor_count;
    int _sensor_found;
    twr_soil_sensor_error_t _error;
};
 
struct twr_soil_sensor_sensor_t
{
    twr_ds28e17_t _ds28e17;
    bool _temperature_valid;
    int16_t _temperature_raw;
    bool _cap_valid;
    uint16_t _cap_raw;
    twr_soil_sensor_eeprom_t _eeprom;
};
 
 
 
void twr_soil_sensor_init(twr_soil_sensor_t *self);
 
 
void twr_soil_sensor_init_multiple(twr_soil_sensor_t *self, twr_soil_sensor_sensor_t *sensors, int sensor_count);
 
 
void twr_soil_sensor_set_event_handler(twr_soil_sensor_t *self, void (*event_handler)(twr_soil_sensor_t *, uint64_t, twr_soil_sensor_event_t, void *), void *event_param);
 
 
void twr_soil_sensor_set_update_interval(twr_soil_sensor_t *self, twr_tick_t interval);
 
 
int twr_soil_sensor_get_sensor_found(twr_soil_sensor_t *self);
 
 
bool twr_soil_sensor_measure(twr_soil_sensor_t *self);
 
 
bool twr_soil_sensor_get_temperature_raw(twr_soil_sensor_t *self, uint64_t device_address, int16_t *raw);
 
 
bool twr_soil_sensor_get_temperature_celsius(twr_soil_sensor_t *self, uint64_t device_address, float *celsius);
 
 
bool twr_soil_sensor_get_temperature_fahrenheit(twr_soil_sensor_t *self, uint64_t device_address, float *fahrenheit);
 
 
bool twr_soil_sensor_get_temperature_kelvin(twr_soil_sensor_t *self, uint64_t device_address, float *kelvin);
 
 
bool twr_soil_sensor_get_cap_raw(twr_soil_sensor_t *self, uint64_t device_address, uint16_t *raw);
 
 
bool twr_soil_sensor_get_moisture(twr_soil_sensor_t *self, uint64_t device_address, int *moisture);
 
 
int twr_soil_sensor_get_index_by_device_address(twr_soil_sensor_t *self, uint64_t device_address);
 
 
uint64_t twr_soil_sensor_get_device_address_by_index(twr_soil_sensor_t *self, int index);
 
 
char *twr_soil_sensor_get_label(twr_soil_sensor_t *self, uint64_t device_address);
 
 
bool twr_soil_sensor_set_label(twr_soil_sensor_t *self, uint64_t device_address, const char *label);
 
 
bool twr_soil_sensor_calibration_set_point(twr_soil_sensor_t *self, uint64_t device_address, uint8_t point, uint16_t value);
 
 
bool twr_soil_sensor_eeprom_save(twr_soil_sensor_t *self, uint64_t device_address);
 
 
twr_soil_sensor_error_t twr_soil_sensor_get_error(twr_soil_sensor_t *self);
 
 
#endif // _TWR_SOIL_SENSOR_H