Change peripheral io APIs

[apps/native/position-finder-server.git] / inc / resource / resource_infrared_motion_sensor.h

diff --git a/inc/resource/resource_infrared_motion_sensor.h b/inc/resource/resource_infrared_motion_sensor.h
index 7914678..311f4db 100644 (file)
--- a/inc/resource/resource_infrared_motion_sensor.h
+++ b/inc/resource/resource_infrared_motion_sensor.h
@@ -22,6 +22,13 @@
 #ifndef __POSITION_FINDER_RESOURCE_INFRARED_MOTION_SENSOR_H__
 #define __POSITION_FINDER_RESOURCE_INFRARED_MOTION_SENSOR_H__
 
-extern int resource_read_infrared_motion_sensor(int pin_num, int *out_value);
+/**
+ * @brief Reads the value of gpio connected infrared motion sensor(HC-SR501).
+ * @param[in] pin_num The number of the gpio pin connected to the infrared motion sensor
+ * @param[out] out_value The vaule of the gpio (zero or non-zero)
+ * @return 0 on success, otherwise a negative error value
+ * @see If the gpio pin is not open, creates gpio handle before reading the value of gpio.
+ */
+extern int resource_read_infrared_motion_sensor(int pin_num, uint32_t *out_value);
 
 #endif /* __POSITION_FINDER_RESOURCE_INFRARED_MOTION_SENSOR_H__ */