Merge branch 'servo-motor-as-component-registry' into 'master'

feat: Added servo component to the registry

See merge request ae_group/esp-iot-solution!1160

Author: leeebo

.github/workflows/upload_component.yml

@@ -61,6 +61,7 @@ jobs:
             components/motor/drv10987;
             components/motor/esp_sensorless_bldc_control;
             components/motor/esp_simplefoc;
+            components/motor/servo;
             components/openai;
             components/sensors/gesture/apds9960;
             components/sensors/humiture/aht20;

.gitlab/ci/build.yml

@@ -563,6 +563,17 @@ build_example_motor_foc_knob:
   variables:
     EXAMPLE_DIR: examples/motor/foc_knob_example
 
+build_example_motor_servo:
+  extends:
+    - .build_examples_template
+    - .rules:build:example_motor_servo
+  parallel:
+    matrix:
+      - IMAGE: espressif/idf:release-v4.4
+      - IMAGE: espressif/idf:release-v5.2
+  variables:
+    EXAMPLE_DIR: components/motor/servo/examples/servo_control
+
 build_example_ota_simple_ota_example:
   extends:
     - .build_examples_template
@@ -1170,6 +1181,14 @@ build_components_motor_esp_simplefoc_test_apps:
   variables:
     EXAMPLE_DIR: components/motor/esp_simplefoc/test_apps
 
+build_components_motor_servo_test_apps:
+  extends:
+    - .build_examples_template
+    - .rules:build:components_motor_servo_test_apps
+    - .build_idf_active_release_version
+  variables:
+    EXAMPLE_DIR: components/motor/servo/test_apps
+
 build_components_ntc_driver_test_apps:
   extends:
     - .build_examples_template

.gitlab/ci/rules.yml

@@ -191,6 +191,7 @@
 
 .patterns-components_motor_servo: &patterns-components_motor_servo
   - "components/motor/servo/**/*"
+  - "components/tools/cmake_utilities/package_manager.cmake"
 
 .patterns-components_openai: &patterns-components_openai
   - "components/openai/**/*"
@@ -485,6 +486,9 @@
 .patterns-example_motor_foc_knob: &patterns-example_motor_foc_knob
   - "examples/motor/foc_knob_example/**/*"
 
+.patterns-example_motor_servo: &patterns-example_motor_servo
+  - "components/motor/servo/examples/servo_control/**/*"
+
 .patterns-example_ota_simple_ota_example: &patterns-example_ota_simple_ota_example
   - "examples/ota/simple_ota_example/**/*"
 
@@ -1072,6 +1076,18 @@
     - <<: *if-dev-push
       changes: *patterns-example_motor_foc_knob
 
+.rules:build:example_motor_servo:
+  rules:
+    - <<: *if-protected
+    - <<: *if-label-build
+    - <<: *if-trigger-job
+    - <<: *if-dev-push
+      changes: *patterns-build_system
+    - <<: *if-dev-push
+      changes: *patterns-components_motor_servo
+    - <<: *if-dev-push
+      changes: *patterns-example_motor_servo
+
 .rules:build:example_ota_simple_ota_example:
   rules:
     - <<: *if-protected
@@ -1936,7 +1952,7 @@
     - <<: *if-dev-push
       changes: *patterns-components_motor_esp_sensorless_bldc_control
 
-.rules:build:components_motor_servo_test:
+.rules:build:components_motor_servo_test_apps:
   rules:
     - <<: *if-protected
     - <<: *if-label-build

components/motor/servo/CHANGELOG.md

@@ -0,0 +1,7 @@
+# ChangeLog
+
+## v0.1.0 - 2024-11-27
+
+### Enhancements:
+
+* Initial version

components/motor/servo/README.md

@@ -0,0 +1,57 @@
+# Servo Motor Component
+
+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.
+
+The library uses PWM (Pulse Width Modulation) to control servo motor rotation and supports customizable configurations for angle limits, pulse width, frequency, and more.
+
+## Features
+
+- Easy control of servo motors using PWM signals
+- Support for custom angle range and pulse width
+- Flexible configuration of PWM channels and timers
+- Compatible with the ESP-IDF framework
+
+## Getting Started
+
+### Prerequisites
+
+- ESP-IDF installed and configured on your development environment
+- A servo motor compatible with PWM signals
+- Proper connections between the ESP32 and the servo motor (signal, VCC, GND)
+
+## How to use
+
+Initialize the sensor with the configuration:
+
+```c
+    servo_config_t servo_cfg = {
+        .max_angle = 180,
+        .min_width_us = 500,
+        .max_width_us = 2500,
+        .freq = 50,
+        .timer_number = LEDC_TIMER_0,
+        .channels = {
+            .servo_pin = {
+                SERVO_GPIO,
+            },
+            .ch = {
+                LEDC_CHANNEL_0,
+            },
+        },
+        .channel_number = 1,
+    };
+
+    // Initialize the servo
+    iot_servo_init(LEDC_LOW_SPEED_MODE, &servo_cfg);
+```
+
+Set the angle:
+
+```c
+uint16_t angle = 0;
+iot_servo_write_angle(LEDC_LOW_SPEED_MODE, 0, angle);
+```
+
+## Reference
+
+[Documentation](https://docs.espressif.com/projects/esp-iot-solution/en/latest/motor/servo.html)

components/motor/servo/examples/servo_control/CMakeLists.txt

@@ -0,0 +1,6 @@
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(servo_control)

components/motor/servo/examples/servo_control/README.md

@@ -0,0 +1,36 @@
+# Example for the servo component
+
+This example shows how to use the servo component.
+
+## How to use
+
+Initialize the sensor with the configuration:
+
+```c
+    servo_config_t servo_cfg = {
+        .max_angle = 180,
+        .min_width_us = 500,
+        .max_width_us = 2500,
+        .freq = 50,
+        .timer_number = LEDC_TIMER_0,
+        .channels = {
+            .servo_pin = {
+                SERVO_GPIO,
+            },
+            .ch = {
+                LEDC_CHANNEL_0,
+            },
+        },
+        .channel_number = 1,
+    };
+
+    // Initialize the servo
+    iot_servo_init(LEDC_LOW_SPEED_MODE, &servo_cfg);
+```
+
+Set the angle:
+
+```c
+uint16_t angle = 0;
+iot_servo_write_angle(LEDC_LOW_SPEED_MODE, 0, angle);
+```

components/motor/servo/examples/servo_control/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "servo_control.c"
+                    INCLUDE_DIRS ".")

components/motor/servo/examples/servo_control/main/idf_component.yml

@@ -0,0 +1,4 @@
+dependencies:
+  espressif/servo:
+    version: "*"
+    override_path: '../../../'

components/motor/servo/examples/servo_control/main/servo_control.c

@@ -0,0 +1,73 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <stdio.h>
+#include <math.h>
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "esp_log.h"
+#include "esp_system.h"
+#include "sdkconfig.h"
+#include "iot_servo.h"
+
+#define SERVO_GPIO          (2)  // Servo GPIO
+
+static const char *TAG = "Servo Control";
+
+static uint16_t calibration_value_0 = 30; // Real 0 degree angle
+uint16_t calibration_value_180 = 195; // Real 0 degree angle
+
+// Task to test the servo
+static void servo_test_task(void *arg)
+{
+    ESP_LOGI(TAG, "Servo Test Task");
+    while (1) {
+        // Set the angle of the servo
+        for (int i = calibration_value_0; i <= calibration_value_180; i += 1) {
+            iot_servo_write_angle(LEDC_LOW_SPEED_MODE, 0, i);
+            vTaskDelay(20 / portTICK_PERIOD_MS);
+        }
+        // Return to the initial position
+        iot_servo_write_angle(LEDC_LOW_SPEED_MODE, 0, calibration_value_0);
+        vTaskDelay(1000 / portTICK_PERIOD_MS);
+    }
+    vTaskDelete(NULL);
+}
+
+static void servo_init(void)
+{
+    ESP_LOGI(TAG, "Servo Control");
+
+    // Configure the servo
+    servo_config_t servo_cfg = {
+        .max_angle = 180,
+        .min_width_us = 500,
+        .max_width_us = 2500,
+        .freq = 50,
+        .timer_number = LEDC_TIMER_0,
+        .channels = {
+            .servo_pin = {
+                SERVO_GPIO,
+            },
+            .ch = {
+                LEDC_CHANNEL_0,
+            },
+        },
+        .channel_number = 1,
+    };
+
+    // Initialize the servo
+    iot_servo_init(LEDC_LOW_SPEED_MODE, &servo_cfg);
+}
+
+void app_main(void)
+{
+    ESP_LOGI(TAG, "Servo Control");
+    // Initialize the servo
+    servo_init();
+    // Create the servo test task
+    xTaskCreate(servo_test_task, "servo_test_task", 2048, NULL, 5, NULL);
+}