diff options
Diffstat (limited to 'inc/resource/resource_infrared_motion_sensor.h')
| -rwxr-xr-x | inc/resource/resource_infrared_motion_sensor.h | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/inc/resource/resource_infrared_motion_sensor.h b/inc/resource/resource_infrared_motion_sensor.h index 612db3f..49062e6 100755 --- a/inc/resource/resource_infrared_motion_sensor.h +++ b/inc/resource/resource_infrared_motion_sensor.h @@ -18,17 +18,16 @@ #define __POSITION_FINDER_RESOURCE_INFRARED_MOTION_SENSOR_H__ /** - * @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 + * @brief Reads value of gpio connected infrared motion sensor (HC-SR501) + * @param[in] pin_num The gpio pin number for the infrared motion sensor * @param[out] out_value The value 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. + * @see If the gpio pin is not open, create gpio handle before reading the value */ extern int resource_read_infrared_motion_sensor(int pin_num, uint32_t *out_value); /** - * @brief Releases the gpio handle and changes the gpio pin state to the close(0). - * @param[in] pin_num The number of the gpio pin connected to the infrared motion sensor + * @brief Releases the gpio handle */ extern void resource_close_infrared_motion_sensor(void); |