o2.h File Reference

Include dependency graph for o2.h:

API Description

/*
 * Author: Noel Eck <noel.eck@intel.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.
 */

#include <unistd.h>
#include <signal.h>

#include "o2.h"
#include "upm_utilities.h"

bool shouldRun = true;

void sig_handler(int signo)
{
    if (signo == SIGINT)
        shouldRun = false;
}

int main()
{
    signal(SIGINT, sig_handler);


    // Instantiate a o2 sensor on analog pin A0
    o2_context sensor = o2_init(0);

    if (!sensor)
    {
        printf("o2_init() failed.\n");
        return -1;
    }

    // Every half a second, sample the sensor output
    while (shouldRun)
    {
        float raw_volts = 0.0;
        float o2_percent = 0.0;

        o2_get_raw_volts(sensor, &raw_volts);
        o2_get_value(sensor, &o2_percent);

        printf("O2 raw volts: %0.03f v, o2: %0.03f %%\n",
                raw_volts, o2_percent);

        upm_delay_ms(500);
    }


    printf("Exiting\n");

    o2_close(sensor);

    return 0;
}

Go to the source code of this file.

Data Structures
struct	_o2_context

Functions
o2_context	o2_init (int16_t pin)
void	o2_close (o2_context dev)
upm_result_t	o2_set_aref (const o2_context dev, float aref)
float	o2_get_aref (const o2_context dev)
upm_result_t	o2_set_offset (const o2_context dev, float offset)
float	o2_get_offset (const o2_context dev)
upm_result_t	o2_set_scale (const o2_context dev, float scale)
float	o2_get_scale (const o2_context dev)
upm_result_t	o2_get_counts (const o2_context dev, int *value)
upm_result_t	o2_get_raw_volts (const o2_context dev, float *value)
upm_result_t	o2_get_value (const o2_context dev, float *value)

Typedefs
typedef struct _o2_context *	o2_context

Function Documentation

o2_context o2_init

(

int16_t

pin

)

Initialize analog sensor

Parameters

pin	is Analog pin

Returns

sensor context as void pointer

void o2_close

(

o2_context

dev

)

Analog sensor destructor

Parameters

sensor

context pointer deallocate memory

upm_result_t o2_set_aref	(	const o2_context	dev,
		float	aref
	)

Set sensor adc vref.

Parameters

dev	sensor context pointer
aref	Voltage reference routed to ADC ref pin

Returns

Function result code

float o2_get_aref

(

const o2_context

dev

)

Get sensor adc vref

Parameters

dev	sensor context pointer

Returns

Current adc vref

upm_result_t o2_set_offset	(	const o2_context	dev,
		float	offset
	)

Set sensor offset. This offset is applied to the return value: counts = counts * scale + offset * scale

Parameters

dev	sensor context pointer
offset	count offset value used

Returns

Function result code

float o2_get_offset

(

const o2_context

dev

)

Get sensor offset

Parameters

dev	sensor context pointer

Returns

Current sensor offset

upm_result_t o2_set_scale	(	const o2_context	dev,
		float	scale
	)

Set sensor scale. This scale is applied to the return value: counts = counts * scale + offset * scale

Parameters

dev	sensor context pointer
scale	count scale value used

Returns

Function result code

float o2_get_scale

(

const o2_context

dev

)

Get sensor scale

Parameters

dev	sensor context pointer

Returns

Current sensor scale

upm_result_t o2_get_counts	(	const o2_context	dev,
		int *	value
	)

Read raw adc counts from sensor

Parameters

dev	sensor context pointer
*value	Raw adc value

Returns

Function result code

upm_result_t o2_get_raw_volts	(	const o2_context	dev,
		float *	value
	)

Read voltage from sensor

Parameters

dev	sensor context pointer
*value	Voltage (v)

Returns

Function result code

upm_result_t o2_get_value	(	const o2_context	dev,
		float *	value
	)

Read value from sensor

Parameters

dev	sensor context pointer
*value	O2 percentage

Returns

Function result code

Typedef Documentation

typedef struct _o2_context * o2_context

device context