summaryrefslogtreecommitdiff
path: root/inc/resource/resource_infrared_motion.h
blob: 993a9737aa908b53b4211a6cf08013c9fbf88876 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __RESOURCE_INFRARED_MOTION_H__
#define __RESOURCE_INFRARED_MOTION_H__

typedef enum {
	PERIPHERAL_HANDLE_ERROR_NONE = 0,                /**< Successful */
	PERIPHERAL_HANDLE_ERROR_NOT_OPEN,
	PERIPHERAL_HANDLE_ERROR_INVALID_PIN
} peripheral_handle_error_e;

typedef void (*resource_infrared_motion_interrupted_cb) (uint32_t motion_value, void *user_data);

typedef struct resource_infrared_motion_interrupted_data_s {
	resource_infrared_motion_interrupted_cb interrupted_cb;
	void *interrupted_cb_user_data;
	uint32_t motion_value;
	int is_called_first_time;
} resource_infrared_motion_interrupted_data;

/**
 * @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, create gpio handle before reading the value
 */
extern int resource_read_infrared_motion(int pin_num, uint32_t *out_value);

/**
 * @brief Releases the gpio handle
 */
extern void resource_close_infrared_motion(void);

/**
 * @brief Sets an interrupted callback to be invoked when interrupt is triggered on motion sensor
 * @param[in] pin_num The gpio pin number for the infrared motion sensor
 * @param[in] interrupted_cb interrupted user callback to be invoked
 * @return 0 on success, otherwise a negative error value
 * @see If the gpio pin is not open, create gpio handle before reading the value
 */
extern int resource_set_interrupted_cb_infrared_motion(int pin_num, resource_infrared_motion_interrupted_cb interrupted_cb, void *user_data);

/**
 * @brief Unsets the interrupted callback for motion sensor
 * @param[in] pin_num The gpio pin number for the infrared motion sensor
 */
extern int resource_unset_interrupted_cb_infrared_motion(int pin_num);

#endif /* __RESOURCE_INFRARED_MOTION_H__ */