Add some notes

Author: KingRichord

infinite_sense_core/include/data.h

@@ -3,43 +3,43 @@
 #include <string>
 #include "image.h"
 namespace infinite_sense {
-    struct ImuData {
-        uint64_t time_stamp_us;
-        float temperature;
-        std::string name;
-        float a[3];
-        float g[3];
-        float q[4];
-    };
+struct ImuData {
+  uint64_t time_stamp_us;
+  float temperature;
+  std::string name;
+  float a[3];
+  float g[3];
+  float q[4];
+};
 
-    struct CamData {
-        uint64_t time_stamp_us;
-        std::string name;
-        GMat image;
-    };
+struct CamData {
+  uint64_t time_stamp_us;
+  std::string name;
+  GMat image;
+};
 
-    struct LaserData {
-        uint64_t time_stamp_us;
-        std::string name;
-    };
+struct LaserData {
+  uint64_t time_stamp_us;
+  std::string name;
+};
 
-    struct GPSData {
-        uint64_t time_stamp_us;
-        uint64_t gps_stamp_us;
-        uint64_t gps_stamp_us_trigger;
-        std::string name;
-        float latitude;
-        float longitude;
-    };
+struct GPSData {
+  uint64_t time_stamp_us;
+  uint64_t gps_stamp_us;
+  uint64_t gps_stamp_us_trigger;
+  std::string name;
+  float latitude;
+  float longitude;
+};
 
-    enum TriggerDevice {
-        IMU_1 = 0,    // internal imu
-        IMU_2 = 1,    // external imu
-        CAM_1 = 2,    // camera 1
-        CAM_2 = 3,    // camera 2
-        CAM_3 = 4,    // camera 3
-        CAM_4 = 5,    // camera 4
-        LASER = 6,    // laser pps
-        GPS = 7,    // gps pps
-    };
-}
+enum TriggerDevice {
+  IMU_1 = 0,  // internal imu
+  IMU_2 = 1,  // external imu
+  CAM_1 = 2,  // camera 1
+  CAM_2 = 3,  // camera 2
+  CAM_3 = 4,  // camera 3
+  CAM_4 = 5,  // camera 4
+  LASER = 6,  // laser pps
+  GPS = 7,    // gps pps
+};
+}  // namespace infinite_sense

infinite_sense_core/include/image.h

@@ -104,7 +104,8 @@ class GMat {
  public:
   GMat();
 
-  GMat(int rows_, int cols_, int type = GMatType<>::Type, uchar* src = nullptr, bool copy = false, int image_align = 16);
+  GMat(int rows_, int cols_, int type = GMatType<>::Type, uchar* src = nullptr, bool copy = false,
+       int image_align = 16);
 
   GMat(const GMat& ref);
 

infinite_sense_core/include/infinite_sense.h

@@ -10,25 +10,96 @@ class SerialManager;
 class CamManger;
 class TriggerManger;
 class Messenger;
+
+/**
+ * @class Synchronizer
+ * @brief 同步器类，负责统一协调网络、串口、相机等模块的启动与配置，管理多传感器系统的时间同步。
+ */
 class Synchronizer {
  public:
+  /**
+   * @brief 构造函数，初始化成员变量。
+   */
   Synchronizer();
+
+  /// 默认析构函数。
   ~Synchronizer() = default;
+
+  /**
+   * @brief 启动同步器，初始化并启动各组件（网络、串口、相机等）。
+   */
   void Start() const;
+
+  /**
+   * @brief 停止同步器，释放资源。
+   */
   void Stop() const;
-  static void SetLogPath(const std::string &path);
+
+  /**
+   * @brief 设置日志输出路径（静态方法）。
+   *
+   * @param path 日志保存路径。
+   */
+  static void SetLogPath(const std::string& path);
+
+  /**
+   * @brief 配置串口连接参数。
+   *
+   * @param serial_dev 串口设备名称（如 "/dev/ttyUSB0"）。
+   * @param serial_baud_rate 波特率（如 115200）。
+   */
   void SetSerialLink(std::string serial_dev, int serial_baud_rate);
+
+  /**
+   * @brief 配置网络连接参数。
+   *
+   * @param net_dev 目标网络 IP 地址。
+   * @param port 网络端口号。
+   */
   void SetNetLink(std::string net_dev, unsigned int port);
+
+  /**
+   * @brief 使用 MV（迈德威视）相机，并配置其对应的触发设备。
+   *
+   * @param params 可选参数：映射相机名称到 TriggerDevice 枚举。
+   */
   void UseMvCam(const std::map<std::string, TriggerDevice>& params = std::map<std::string, TriggerDevice>());
+
+  /**
+   * @brief 获取指定设备最近一次的触发时间（静态方法）。
+   *
+   * @param dev 查询的设备类型。
+   * @param time 返回对应的触发时间戳。
+   * @return true 如果查询成功（设备有触发记录）。
+   * @return false 如果设备无记录。
+   */
   static bool GetLastTriggerTime(TriggerDevice dev, uint64_t time);
-  static void PrintSummary() ;
+
+  /**
+   * @brief 打印当前系统的配置与状态摘要信息。
+   */
+  static void PrintSummary();
+
  private:
+  /// 网络地址
   std::string net_ip_;
+
+  /// 网络端口号
   unsigned short net_port_{};
+
+  /// 串口设备
   std::string serial_dev_;
+
+  /// 串口波特率
   int serial_baud_rate_{};
+
+  /// 网络管理器
   std::shared_ptr<NetManager> net_manager_{nullptr};
+
+  /// 串口管理器
   std::shared_ptr<SerialManager> serial_manager_{nullptr};
+
+  /// 相机管理器
   std::shared_ptr<CamManger> cam_manager_{nullptr};
 };
 

infinite_sense_core/src/ser.cpp

@@ -68,7 +68,6 @@ void SerialManager::Receive() const {
         if (json_data.empty()) {
           continue;
         }
-        // std::cout << json_data.dump() << std::endl;
         ptp_->ReceivePtpData(json_data);
         ProcessTriggerData(json_data);
         ProcessIMUData(json_data);