feat: version 4.5 basic pid + EncoderMotor control test1 finished

Author: FennMai

Basic_Development/New_Car_Control/Encoder_Base/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.0)
+cmake_minimum_required(VERSION 4.5)
 project(tt)
 
 set(CMAKE_CXX_STANDARD 11)
@@ -18,7 +18,15 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 include_directories(${CMAKE_SOURCE_DIR})
 
 # Specify source files
-add_executable(tt ServoTest.cpp Emakefun_MotorDriver.cpp Emakefun_MotorShield.cpp Raspi_i2c.cpp)
+# tag-> for change
+# Emakefun_MotorShield.cpp
+add_executable(tt
+    EncoderMotTest.cpp
+    PID.cpp
+    encoder.cpp
+    EncoderShield.cpp
+    Emakefun_MotorDriver.cpp
+    Raspi_i2c.cpp)
 
 # Output target files to the bin directory
 set_target_properties(tt PROPERTIES

Basic_Development/New_Car_Control/Encoder_Base/DC_MotoTest.cpp

@@ -0,0 +1,28 @@
+#include "Emakefun_MotorShield.h"
+
+int main() {
+  Emakefun_MotorShield Pwm = Emakefun_MotorShield();
+  Pwm.begin(50);
+  Emakefun_DCMotor *DCmotor1 = Pwm.getMotor(1);
+  Emakefun_DCMotor *DCmotor2 = Pwm.getMotor(2);
+  Emakefun_DCMotor *DCmotor3 = Pwm.getMotor(3);
+  Emakefun_DCMotor *DCmotor4 = Pwm.getMotor(4);
+
+  DCmotor1->setSpeed(255);
+  DCmotor2->setSpeed(255);
+  DCmotor3->setSpeed(255);
+  DCmotor4->setSpeed(255);
+
+  while (1) {
+    DCmotor1->run(FORWARD);
+    DCmotor2->run(FORWARD);
+    DCmotor3->run(FORWARD);
+    DCmotor4->run(FORWARD);
+    delay(1000);
+    DCmotor1->run(BACKWARD);
+    DCmotor2->run(BACKWARD);
+    DCmotor3->run(BACKWARD);
+    DCmotor4->run(BACKWARD);
+    delay(1000);
+  }
+}

Basic_Development/New_Car_Control/Encoder_Base/Emakefun_MotorDriver.cpp

@@ -1,62 +1,101 @@
-/***
- * author : FENN MAI
- * last modified date: 30/05/2024
+/** 
+ * @file Emakefun_MotorDriver.cpp
+ * @brief 控制舵机和直流齿轮电机
  * 
- * Basic 3.0, date: 29/05/2024
- * changed the code from wiringPi to pigpio to control the servo and DC gear motor 
+ * @author FENN MAI
+ * @date 30/05/2024
+ * @version Basic 3.0
  * 
+ * Version: Basic 3.0
+ * 修改日期：2024年5月29日
+ * 变更内容：将代码从wiringPi改为pigpio，以控制舵机和直流齿轮电机。
  */
+
 #include "Emakefun_MotorDriver.h"
 #include <cmath>
 #include <pigpio.h>
-// addr = 0x60
-Emakefun_MotorDriver::Emakefun_MotorDriver(uint8_t addr) { _i2caddr = addr; }
 
+/**
+ * @brief 构造函数，初始化I2C地址。
+ * @param addr I2C地址，默认值为0x60。
+ */
+Emakefun_MotorDriver::Emakefun_MotorDriver(uint8_t addr) { 
+    _i2caddr = addr; 
+}
+
+/**
+ * @brief 初始化I2C通信并重置PCA9685设备。
+ */
 void Emakefun_MotorDriver::begin(void) {
-  Raspi_I2C::init(_i2caddr);
-  reset();
+    Raspi_I2C::init(_i2caddr); // 初始化I2C通信
+    reset(); // 重置PCA9685设备
 }
 
-void Emakefun_MotorDriver::reset(void) { write8(PCA9685_MODE1, 0x00); }
+/**
+ * @brief 重置PCA9685设备。
+ */
+void Emakefun_MotorDriver::reset(void) { 
+    write8(PCA9685_MODE1, 0x00); 
+}
 
+/**
+ * @brief 设置PWM频率。
+ * @param freq 频率值。
+ */
 void Emakefun_MotorDriver::setPWMFreq(float freq) {
-  // printf("Attempting to set freq :%lf \n",freq);
-
-  // freq *= 0.9;  // Correct for overshoot in the frequency setting (see issue
-  // #11).
-
-  float prescaleval = 25000000;
-  prescaleval /= 4096;
-  prescaleval /= freq;
-  prescaleval -= 1;
-  uint8_t prescale = floor(prescaleval + 0.5);
-
-  uint8_t oldmode = read8(PCA9685_MODE1);
-  uint8_t newmode = (oldmode & 0x7F) | 0x10;  // sleep
-  write8(PCA9685_MODE1, newmode);             // go to sleep
-  write8(PCA9685_PRESCALE, prescale);         // set the prescaler
-  write8(PCA9685_MODE1, oldmode);
-  gpioDelay(5000);
-  write8(PCA9685_MODE1,
-         oldmode | 0xa1);  //  This sets the MODE1 register to turn on auto increment.
-                           // This is why the beginTransmission below was not working.
-  //  Serial.print("Mode now 0x"); Serial.println(read8(PCA9685_MODE1), HEX);
+    float prescaleval = 25000000.0f; // 固定时钟频率
+    prescaleval /= 4096.0f; // 分辨率
+    prescaleval /= freq; // 频率
+    prescaleval -= 1.0f;
+    uint8_t prescale = static_cast<uint8_t>(floor(prescaleval + 0.5f));
+
+    uint8_t oldmode = read8(PCA9685_MODE1);
+    uint8_t newmode = (oldmode & 0x7F) | 0x10; // 进入睡眠模式
+    write8(PCA9685_MODE1, newmode); // 进入睡眠模式
+    write8(PCA9685_PRESCALE, prescale); // 设置预分频器
+    write8(PCA9685_MODE1, oldmode); // 退出睡眠模式
+    gpioDelay(5000); // 等待5ms
+    write8(PCA9685_MODE1, oldmode | 0xA1); // 开启自动递增
 }
 
+/**
+ * @brief 设置PWM输出。
+ * @param num PWM通道号。num(0,15)
+ * @param on PWM开启时间。PWM 开始时间（0-4095），表示 PWM 周期中信号从低到高的时间点。
+ * @param off PWM关闭时间。PWM 结束时间（0-4095），表示 PWM 周期中信号从高到低的时间点。
+ */
 void Emakefun_MotorDriver::setPWM(uint8_t num, uint16_t on, uint16_t off) {
-  // Serial.print("Setting PWM "); Serial.print(num); Serial.print(": ");
-  // Serial.print(on); Serial.print("->"); Serial.println(off);
-
-  // write8(LED0_ON_L + (num << 2), on & 0xFF);
-  // write8(LED0_ON_H + (num << 2), on >> 8);
-  // write8(LED0_OFF_L + (num << 2), off & 0xFF);
-  // write8(LED0_OFF_H + (num << 2), off >> 8);
-
-  uint8_t data[] = {static_cast<uint8_t>(LED0_ON_L + (num << 2)), static_cast<uint8_t>(on & 0xFF),
-                    static_cast<uint8_t>(on >> 8), static_cast<uint8_t>(off & 0xFF), static_cast<uint8_t>(off >> 8)};
-  Write(data, sizeof(data));
+    uint8_t data[] = {
+        // LED0_ON_L 是 PCA9685 寄存器的基地址，用于设置通道 0 的 LED 开始时间低字节。
+        // num << 2 将通道号左移两位，这是因为每个通道有四个寄存器（ON_L、ON_H、OFF_L、OFF_H）。
+        // LED0_ON_L + (num << 2) 计算得出通道 num 的 ON_L 寄存器地址。
+        static_cast<uint8_t>(LED0_ON_L + (num << 2)), 
+        // on & 0xFF 获取 on 的低 8 位。
+        // on >> 8 获取 on 的高 8 位。
+        static_cast<uint8_t>(on & 0xFF),
+        static_cast<uint8_t>(on >> 8), 
+        // off & 0xFF 获取 off 的低 8 位。
+        // off >> 8 获取 off 的高 8 位。
+        static_cast<uint8_t>(off & 0xFF), 
+        static_cast<uint8_t>(off >> 8)
+    };
+    Write(data, sizeof(data)); // 写入数据
 }
 
-uint8_t Emakefun_MotorDriver::read8(uint8_t addr) { return ReadReg8(addr); }
+/**
+ * @brief 读取8位寄存器的值。
+ * @param addr 寄存器地址。
+ * @return 寄存器的8位值。
+ */
+uint8_t Emakefun_MotorDriver::read8(uint8_t addr) { 
+    return ReadReg8(addr); 
+}
 
-void Emakefun_MotorDriver::write8(uint8_t addr, uint8_t d) { WriteReg8(addr, d); }
+/**
+ * @brief 向8位寄存器写入数据。
+ * @param addr 寄存器地址。
+ * @param d 写入的数据。
+ */
+void Emakefun_MotorDriver::write8(uint8_t addr, uint8_t d) { 
+    WriteReg8(addr, d); 
+}

Basic_Development/New_Car_Control/Encoder_Base/Emakefun_MotorDriver.h

@@ -1,16 +1,18 @@
-/***
- * author : Basav
- * last modified date: 02/04/2024
- * 
- * Basic 3.0, date: 27/03/2024
- * changed the code from wiringPi to pigpio to control the servo and DC gear 
+/** 
  * 
+ * @author FENN MAI
+ * @date 06/05/2024
+ * @version Basic 4.0
+ * @brief 编码电机初次测试
  */
+
+
 #ifndef _Emakefun_MotorDriver_H
 #define _Emakefun_MotorDriver_H
 
 #include "Raspi_i2c.h"
 
+// PCA9685寄存器地址定义
 #define PCA9685_SUBADR1 0x2
 #define PCA9685_SUBADR2 0x3
 #define PCA9685_SUBADR3 0x4
@@ -28,18 +30,58 @@
 #define ALLLED_OFF_L 0xFC
 #define ALLLED_OFF_H 0xFD
 
+/**
+ * @class Emakefun_MotorDriver
+ * @brief 通过I2C控制PCA9685芯片的类，继承自Raspi_I2C类。
+ */
 class Emakefun_MotorDriver : public Raspi_I2C {
  public:
+  /**
+   * @brief 构造函数，初始化I2C地址。
+   * @param addr I2C地址，默认值为0x60。
+   */
   Emakefun_MotorDriver(uint8_t addr = 0x60);
+
+  /**
+   * @brief 初始化I2C连接和PCA9685芯片。
+   */
   void begin(void);
+
+  /**
+   * @brief 重置PCA9685芯片。
+   */
   void reset(void);
+
+  /**
+   * @brief 设置PWM频率。
+   * @param freq 频率值。
+   */
   void setPWMFreq(float freq);
+
+  /**
+   * @brief 设置PWM输出。
+   * @param num PWM通道号。
+   * @param on PWM开启时间。
+   * @param off PWM关闭时间。
+   */
   void setPWM(uint8_t num, uint16_t on, uint16_t off);
 
  private:
-  uint8_t _i2caddr;
+  uint8_t _i2caddr; ///< I2C地址
+
+  /**
+   * @brief 读取8位寄存器的值。
+   * @param addr 寄存器地址。
+   * @return 寄存器的8位值。
+   */
   uint8_t read8(uint8_t addr);
+
+  /**
+   * @brief 向8位寄存器写入数据。
+   * @param addr 寄存器地址。
+   * @param d 写入的数据。
+   */
   void write8(uint8_t addr, uint8_t d);
 };
 
-#endif
+#endif // _Emakefun_MotorDriver_H