upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
Data Structures | Functions | Typedefs
Include dependency graph for dfrph.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 "dfrph.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 dfrph sensor on analog pin A0
if (!sensor)
{
printf("dfrph_init() failed.\n");
return(1);
}
// Every half a second, sample the sensor output
while (shouldRun)
{
float volts = 0.0, pH = 0.0;
dfrph_get_raw_volts(sensor, &volts);
dfrph_get_ph(sensor, &pH);
printf("Detected volts: %0.03f\n", volts);
printf("pH value: %0.03f\n", pH);
upm_delay_ms(500);
}
printf("Exiting\n");
dfrph_close(sensor);
return 0;
}

Go to the source code of this file.

Data Structures

struct  _dfrph_context
 

Functions

dfrph_context dfrph_init (int16_t pin)
 
void dfrph_close (dfrph_context dev)
 
upm_result_t dfrph_set_aref (const dfrph_context dev, float aref)
 
float dfrph_get_aref (const dfrph_context dev)
 
upm_result_t dfrph_set_offset (const dfrph_context dev, float offset)
 
upm_result_t dfrph_set_scale (const dfrph_context dev, float scale)
 
upm_result_t dfrph_get_raw_volts (const dfrph_context dev, float *volts)
 
upm_result_t dfrph_get_ph (const dfrph_context dev, float *value)
 

Typedefs

typedef struct _dfrph_contextdfrph_context
 

Function Documentation

dfrph_context dfrph_init ( int16_t  pin)

Initialize analog sensor

Parameters
pinis Analog pin
Returns
sensor context as void pointer
void dfrph_close ( dfrph_context  dev)

Analog sensor destructor

Parameters
sensorcontext pointer deallocate memory

Here is the caller graph for this function:

upm_result_t dfrph_set_aref ( const dfrph_context  dev,
float  aref 
)

Set ADC reference voltage

Parameters
devsensor context pointer
arefADC reference voltage
Returns
Function result code
float dfrph_get_aref ( const dfrph_context  dev)

Get sensor aref

Parameters
devsensor context pointer
Returns
Sensor ADC reference voltage
upm_result_t dfrph_set_offset ( const dfrph_context  dev,
float  offset 
)

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

Parameters
devsensor context pointer
offsetcount offset value used
Returns
Function result code

Here is the caller graph for this function:

upm_result_t dfrph_set_scale ( const dfrph_context  dev,
float  scale 
)

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

Parameters
devsensor context pointer
scalecount scale value used
Returns
Function result code

Here is the caller graph for this function:

upm_result_t dfrph_get_raw_volts ( const dfrph_context  dev,
float *  volts 
)

Get raw volts

Parameters
devsensor context pointer
voltsRaw sensor voltage
Returns
Function result code

Here is the caller graph for this function:

upm_result_t dfrph_get_ph ( const dfrph_context  dev,
float *  value 
)

Read value from sensor

Parameters
devsensor context pointer
valuepointer to returned pH value from sensor
Returns
Function result code

Here is the caller graph for this function:

Typedef Documentation

typedef struct _dfrph_context * dfrph_context

device context