ecezo.h

Go to the documentation of this file.

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2016 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include <stdint.h>
#include <upm.h>
#include <mraa/uart.h>
#include <mraa/i2c.h>
#include <mraa/gpio.h>

#include "ecezo_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

    typedef struct _ecezo_context {
        mraa_uart_context        uart;
        mraa_i2c_context         i2c;

        // our values
        float                    ec;          // electrical conductivity
        float                    tds;         // total dissolved solids
        float                    salinity;
        float                    sg;          // specific gravity

    } *ecezo_context;

    ecezo_context ecezo_uart_init(unsigned int uart, unsigned int baudrate);

    ecezo_context ecezo_i2c_init(unsigned int bus, uint8_t addr);

    void ecezo_close(ecezo_context dev);

    upm_result_t ecezo_update(const ecezo_context dev);

    upm_result_t ecezo_set_temperature(const ecezo_context dev, float temp);

    upm_result_t ecezo_set_k_value(const ecezo_context dev, float k);

    upm_result_t ecezo_set_sleep(const ecezo_context dev, bool enable);

    float ecezo_get_ec(const ecezo_context dev);

    float ecezo_get_tds(const ecezo_context dev);

    float ecezo_get_salinity(const ecezo_context dev);

    float ecezo_get_sg(const ecezo_context dev);

    upm_result_t ecezo_calibrate(const ecezo_context dev,
                                 ECEZO_CALIBRATION_T cal,
                                 float ec);

    upm_result_t ecezo_set_continuous(const ecezo_context dev, bool enable);

    int ecezo_send_command(const ecezo_context dev, char *cmd,
                           char *buffer, int len);

    int ecezo_read(const ecezo_context dev, char *buffer, size_t len);

    upm_result_t ecezo_write(const ecezo_context dev, char *buffer, size_t len);


#ifdef __cplusplus
}
#endif