ph_oem.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 University of Applied Sciences Emden / Leer
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef PH_OEM_H
#define PH_OEM_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "periph/i2c.h"
#include "periph/gpio.h"
 
typedef enum {
    PH_OEM_OK                   =  0,   
    PH_OEM_NODEV                = -1,   
    PH_OEM_READ_ERR             = -2,   
    PH_OEM_WRITE_ERR            = -3,   
    PH_OEM_NOT_PH               = -4,   
    PH_OEM_INTERRUPT_GPIO_UNDEF = -5,   
    PH_OEM_GPIO_INIT_ERR        = -6,   
    PH_OEM_TEMP_OUT_OF_RANGE    = -7    
} ph_oem_named_returns_t;
 
typedef enum {
    PH_OEM_LED_ON   = 0x01, 
    PH_OEM_LED_OFF  = 0x00, 
} ph_oem_led_state_t;
 
typedef enum {
    PH_OEM_TAKE_READINGS    = 0x01, 
    PH_OEM_STOP_READINGS    = 0x00, 
} ph_oem_device_state_t;
typedef enum {
    PH_OEM_IRQ_RISING   = 0x02, 
    PH_OEM_IRQ_FALLING  = 0x04, 
    PH_OEM_IRQ_BOTH     = 0x08, 
} ph_oem_irq_option_t;
 
typedef enum {
    PH_OEM_CALIBRATE_LOW_POINT  = 0x02,     
    PH_OEM_CALIBRATE_MID_POINT  = 0x03,     
    PH_OEM_CALIBRATE_HIGH_POINT = 0x04,     
} ph_oem_calibration_option_t;
 
typedef struct ph_oem_params {
    i2c_t i2c;                      
    uint8_t addr;                   
    gpio_t interrupt_pin;           
    gpio_mode_t gpio_mode;          
    ph_oem_irq_option_t irq_option; 
} ph_oem_params_t;
 
typedef void (*ph_oem_interrupt_pin_cb_t)(void *);
 
typedef struct ph_oem {
    ph_oem_params_t params;         
    ph_oem_interrupt_pin_cb_t cb;   
    void *arg;                      
} ph_oem_t;
 
int ph_oem_init(ph_oem_t *dev, const ph_oem_params_t *params);
 
int ph_oem_set_i2c_address(ph_oem_t *dev, uint8_t addr);
 
int ph_oem_enable_interrupt(ph_oem_t *dev, ph_oem_interrupt_pin_cb_t cb,
                            void *arg);
 
int ph_oem_reset_interrupt_pin(const ph_oem_t *dev);
 
int ph_oem_set_led_state(const ph_oem_t *dev, ph_oem_led_state_t state);
 
int ph_oem_set_device_state(const ph_oem_t *dev, ph_oem_device_state_t state);
 
int ph_oem_start_new_reading(const ph_oem_t *dev);
 
int ph_oem_clear_calibration(const ph_oem_t *dev);
 
int ph_oem_set_calibration(const ph_oem_t *dev, uint16_t calibration_value,
                           ph_oem_calibration_option_t option);
 
int ph_oem_read_calibration_state(const ph_oem_t *dev, uint16_t *calibration_state);
 
int ph_oem_set_compensation(const ph_oem_t *dev,
                            uint16_t temperature_compensation);
 
int ph_oem_read_compensation(const ph_oem_t *dev,
                             uint16_t *temperature_compensation);
 
int ph_oem_read_ph(const ph_oem_t *dev, uint16_t *ph_value);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PH_OEM_H */