Skip to content

Commit df2a1d6

Browse files
committed
Added docs link and improved readme file
1 parent b2449ff commit df2a1d6

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

components/motor/servo/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
# Servo Motor Component
22

3-
This component helps you controlling servo motors based on PWM signal.
3+
This component provides an easy-to-use interface for controlling servo motors with the ESP-IDF framework. Servo motors are commonly used in robotics, automation, and various mechanical applications due to their precise control of angular position.
4+
5+
The library uses PWM (Pulse Width Modulation) to control servo motor rotation and supports customizable configurations for angle limits, pulse width, frequency, and more.
6+
7+
## Features
8+
9+
- Easy control of servo motors using PWM signals
10+
- Support for custom angle range and pulse width
11+
- Flexible configuration of PWM channels and timers
12+
- Compatible with the ESP-IDF framework
13+
14+
## Getting Started
15+
16+
### Prerequisites
17+
18+
- ESP-IDF installed and configured on your development environment
19+
- A servo motor compatible with PWM signals
20+
- Proper connections between the ESP32 and the servo motor (signal, VCC, GND)
421

522
## How to use
623

@@ -36,3 +53,5 @@ iot_servo_write_angle(LEDC_LOW_SPEED_MODE, 0, angle);
3653
```
3754

3855
## Reference
56+
57+
[Documentation](https://docs.espressif.com/projects/esp-iot-solution/en/latest/motor/servo.html)

components/motor/servo/idf_component.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ description: Espressif's Servo Motor Component
33
url: https://github.com/espressif/esp-iot-solution/tree/master/components/motor/servo
44
repository: https://github.com/espressif/esp-iot-solution.git
55
issues: https://github.com/espressif/esp-iot-solution/issues
6+
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/motor/servo.html
67
dependencies:
78
idf:
8-
version: '>=5.0'
9+
version: '>=4.4'

0 commit comments

Comments
 (0)