inc/resource/resource_ultrasonic_sensor.h

   1 /*
   2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   3  *
   4  * Contact: Jin Yoon <jinny.yoon@samsung.com>
   5  *          Geunsun Lee <gs86.lee@samsung.com>
   6  *          Eunyoung Lee <ey928.lee@samsung.com>
   7  *          Junkyu Han <junkyu.han@samsung.com>
   8  *
   9  * Licensed under the Flora License, Version 1.1 (the License);
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  * http://floralicense.org/license/
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an AS IS BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  */
  21
  22 #ifndef __POSITION_FINDER_RESOURCE_ULTRASONIC_SENSOR_H__
  23 #define __POSITION_FINDER_RESOURCE_ULTRASONIC_SENSOR_H__
  24
  25 /**
  26  * @brief Reads the value of gpio connected ultrasonic sensor(HC-SR04).
  27  * @param[in] trig_pin_num The number of the gpio pin connected to the trig of the ultrasonic sensor
  28  * @param[in] echo_pin_num The number of the gpio pin connected to the echo of the ultrasonic sensor
  29  * @param[in] cb A callback function to be invoked when the gpio interrupt is triggered
  30  * @param[in] data The data to be passed to the callback function
  31  * @return 0 on success, otherwise a negative error value
  32  * @see If the gpio pin is not open, creates gpio handle before reading the value of gpio.
  33  */
  34 extern int resource_read_ultrasonic_sensor(int trig_pin_num, int echo_pin_num, resource_read_cb cb, void *data);
  35
  36 #endif /* __POSITION_FINDER_RESOURCE_ULTRASONIC_SENSOR_H__ */