guvas12d.h File Reference

Include dependency graph for guvas12d.h:

API Description

/*
 * 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.
 */

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

#include <upm_utilities.h>
#include <guvas12d.h>

bool shouldRun = true;

// analog voltage, usually 3.3 or 5.0
#define GUVAS12D_AREF   5.0

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

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

    // This was tested with the Grove UV Sensor module.
    // It has a sensing range from between 240-370nm.  It's strongest
    // response is around 320-360nm.

    // Instantiate a GUVAS12D on analog pin A0
    guvas12d_context uv = guvas12d_init(0, GUVAS12D_AREF);

    if (!uv)
    {
        printf("guvas12d_init() failed\n");
        return 1;
    }

    // The higher the voltage the more intense the UV radiation.
    while (shouldRun)
    {
        float volts = 0;
        float intensity = 0;

        if (guvas12d_get_volts(uv, &volts))
        {
            printf("guvas12d_get_volts() failed\n");
            return 1;
        }

        if (guvas12d_get_intensity(uv, &intensity))
        {
            printf("guvas12d_get_intensity() failed\n");
            return 1;
        }

        printf("Volts: %f, Intensity %f mW/m^2\n", volts, intensity);

        upm_delay(1);
    }

    printf("Exiting\n");

    guvas12d_close(uv);
    return 0;
}

Go to the source code of this file.

Data Structures
struct	_guvas12d_context

Functions
guvas12d_context	guvas12d_init (int pin, float aref)
void	guvas12d_close (guvas12d_context dev)
upm_result_t	guvas12d_get_volts (const guvas12d_context dev, float *volts)
upm_result_t	guvas12d_get_intensity (const guvas12d_context dev, float *intensity)
void	guvas12d_set_offset (const guvas12d_context dev, float offset)
void	guvas12d_set_scale (const guvas12d_context dev, float scale)

Typedefs
typedef struct _guvas12d_context *	guvas12d_context

Function Documentation

guvas12d_context guvas12d_init	(	int	pin,
		float	aref
	)

GUVA-S12D UV sensor constructor

Parameters

pin	Analog pin to use

Here is the call graph for this function:

void guvas12d_close

(

guvas12d_context

dev

)

GUVAS12D destructor

Here is the caller graph for this function:

upm_result_t guvas12d_get_volts	(	const guvas12d_context	dev,
		float *	volts
	)

Gets the voltage value from the sensor

Parameters

volts

Pointer to average voltage reading

Returns

UPM status.

Here is the caller graph for this function:

upm_result_t guvas12d_get_intensity	(	const guvas12d_context	dev,
		float *	intensity
	)

Gets the illumination intensity in mW/m^2

Parameters

volts

Pointer to average voltage reading

Returns

UPM status.

illumination intensity in mW/m^2

Here is the call graph for this function:

Here is the caller graph for this function:

void guvas12d_set_offset	(	const guvas12d_context	dev,
		float	offset
	)

Set sensor offset. This offset is applied to the illumination intensity value before scaling. Default is 0.0.

Parameters

dev	sensor context pointer
offset	Offset to apply.

Here is the caller graph for this function:

void guvas12d_set_scale	(	const guvas12d_context	dev,
		float	scale
	)

Set sensor scale. This offset is applied to the illumination intensity value before scaling. Default is 1.0.

Parameters

dev	sensor context pointer
scale	Scale to apply.

Here is the caller graph for this function:

Typedef Documentation

typedef struct _guvas12d_context * guvas12d_context

Device context