dfrorp.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/aio.h"
#include "mraa/gpio.h"

#ifdef __cplusplus
extern "C" {
#endif

  typedef struct _dfrorp_context {
    mraa_aio_context    aio;

    // analog ADC resolution
    float               a_res;

    // analog reference voltage
    float               a_ref;

    // for external offset and scaling of the results
    float               offset;
    float               scale;

    // For sensor interface board calibration
    float               orp_cal_offset;

    // our measurements

    // ORP measurement (mV)
    float               orp;

    // volts
    float               volts;

    // normalized ADC
    float               normalized;
  } *dfrorp_context;

  dfrorp_context dfrorp_init(unsigned int apin, float a_ref);

  void dfrorp_close(dfrorp_context dev);

  upm_result_t dfrorp_update(const dfrorp_context dev);

  void dfrorp_set_offset(const dfrorp_context dev, float offset);

  void dfrorp_set_scale(const dfrorp_context dev, float scale);

  float dfrorp_get_orp(const dfrorp_context dev);

  void dfrorp_set_calibration_offset(const dfrorp_context dev, float offset);

  float dfrorp_get_volts(const dfrorp_context dev);

  float dfrorp_get_normalized(const dfrorp_context dev);

#ifdef __cplusplus
}
#endif