hcsr04.h File Reference

Include dependency graph for hcsr04.h:

API Description

/*
 * Author: Abhishek Malik <abhishek.malik@intel.com>
 * Copyright (c) 2017 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 <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>

#include "upm_utilities.h"
#include "hcsr04.h"

int main() {
    hcsr04_context dev = hcsr04_init(2,4);
    if(dev == NULL) {
        printf("Unable to intialize the sensor\n");
        return 0;
    }

    double distance;
    while(1) {
        distance = hcsr04_get_distance(dev, HCSR04_CM);
        printf("Distance detected: %f\n", distance);
        upm_delay(1);
    }

    return 0;
}

Go to the source code of this file.

Data Structures
struct	_hcsr04_context

Functions
hcsr04_context	hcsr04_init (int triggerPin, int echoPin)
void	hcsr04_close (hcsr04_context dev)
double	hcsr04_get_distance (hcsr04_context dev, HCSR04_U unit)

Typedefs
typedef struct _hcsr04_context *	hcsr04_context

Enumerations
enum	HCSR04_U { HCSR04_CM = 0, HCSR04_INCH }

Function Documentation

hcsr04_context hcsr04_init	(	int	triggerPin,
		int	echoPin
	)

HCSR04 Initialization function

Parameters

triggerPin	GPIO pin for trigger
echoPin	GPIO pin used for output from sensor

Returns

hcsr04_context

void hcsr04_close

(

hcsr04_context

dev

)

HCSR04 Close function

Parameters

dev	hcsr04_context pointer

Here is the caller graph for this function:

double hcsr04_get_distance	(	hcsr04_context	dev,
		HCSR04_U	unit
	)

Function to get the distance from the HCSR04 sensor

Parameters

unit

cm/inches

Returns

distance in specified unit

Here is the caller graph for this function: