add some comments
[apps/native/gear-racing-car.git] / inc / resource / resource_servo_motor.h
1 /*
2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
3  *
4  * Contact: Jeonghoon Park <jh1979.park@samsung.com>
5  *
6  * Licensed under the Flora License, Version 1.1 (the License);
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://floralicense.org/license/
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an AS IS BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 #ifndef __RESOURCE_SERVO_MOTOR_H__
20 #define __RESOURCE_SERVO_MOTOR_H__
21
22 /**
23  * This module is sample codes to handling Servo motors in Tizen platform.
24  * HW is configured with PCA9685(PWM controller).
25  */
26
27 /**
28  * @param[in] id The motor id
29  * @param[in] value The value to control servo motor
30  *
31  * @return 0 on success, otherwise a negative error value
32  * @remarks Must adjust servo motor with some value before use to fit your system.
33  */
34 int resource_set_servo_motor_value(unsigned int motor_id, int value);
35
36 #endif /* __RESOURCE_SERVO_MOTOR_H__ */