mqx.h

Go to the documentation of this file.

/*
 * Author: Noel Eck <noel.eck@intel.com>
 * Copyright (c) 2015 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 "upm.h"
#include "mraa/aio.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _mqx_context {
    /* mraa aio pin context */
    mraa_aio_context aio;
    /* Analog voltage reference */
    float m_aRef;
    /* Scale */
    float m_scale;
    /* Offset in sensor units */
    float m_offset;
} *mqx_context;

mqx_context mqx_init(int16_t pin);

void mqx_close(mqx_context dev);

upm_result_t mqx_set_aref(const mqx_context dev, float aref);

upm_result_t mqx_set_scale(const mqx_context dev, float scale);

upm_result_t mqx_set_offset(const mqx_context dev, float offset);

float mqx_get_aref(const mqx_context dev);

float mqx_get_scale(const mqx_context dev);

float mqx_get_offset(const mqx_context dev);

upm_result_t mqx_get_normalized(const mqx_context dev, float *value);

upm_result_t mqx_get_raw_volts(const mqx_context dev, float *value);

upm_result_t mqx_get_volts(const mqx_context dev, float *value);
#ifdef __cplusplus
}
#endif