yg1006.h File Reference

Include dependency graph for yg1006.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 <signal.h>

#include "yg1006.h"
#include "upm_utilities.h"

int shouldRun = true;

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


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

    // Instantiate a YG1006 sensor on digital pin D2
    yg1006_context sensor = yg1006_init(2);

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

    while (shouldRun)
    {
        if (yg1006_flame_detected(sensor))
            printf("Flame detected.\n");
        else
            printf("No flame detected.\n");

        upm_delay(1);
    }

    printf("Exiting...\n");

    yg1006_close(sensor);

    return 0;
}

Go to the source code of this file.

Data Structures
struct	_yg1006_context

Functions
yg1006_context	yg1006_init (unsigned int pin)
void	yg1006_close (yg1006_context dev)
bool	yg1006_flame_detected (const yg1006_context dev)

Typedefs
typedef struct _yg1006_context *	yg1006_context

Function Documentation

yg1006_context yg1006_init

(

unsigned int

pin

)

YG1006 initializer

Parameters

pin	Digital pin to use

Returns

an initialized device context on success, NULL on error.

Here is the call graph for this function:

void yg1006_close

(

yg1006_context

dev

)

YG1006 close function

Here is the caller graph for this function:

bool yg1006_flame_detected

(

const yg1006_context

dev

)

Determines whether a flame has been detected

Returns

true if a flame or another comparable light source has been detected

Here is the caller graph for this function:

Typedef Documentation

typedef struct _yg1006_context * yg1006_context

Device context