RemoteDebug 项目使用教程

RemoteDebug 项目使用教程

RemoteDebugLibrary for Arduino to debug projects over WiFi, with web app or telnet, with print commands like Serial Monitor项目地址:https://gitcode.com/gh_mirrors/re/RemoteDebug

1. 项目的目录结构及介绍

RemoteDebug 项目的目录结构如下：

RemoteDebug/
├── examples/
│   ├── Basic/
│   ├── Advanced/
│   └── ...
├── src/
│   ├── RemoteDebug.h
│   └── RemoteDebug.cpp
├── LICENSE
├── README.md
└── ...

目录结构介绍

• examples/: 包含多个示例项目，展示了如何使用 RemoteDebug 库。
  • Basic/: 基础示例，演示了 RemoteDebug 的基本用法。
  • Advanced/: 高级示例，展示了更多高级功能，如调试级别和配置。
• src/: 包含 RemoteDebug 库的核心文件。
  • RemoteDebug.h: 库的头文件。
  • RemoteDebug.cpp: 库的实现文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档，包含基本介绍和使用方法。

2. 项目的启动文件介绍

项目的启动文件主要是 RemoteDebug.h 和 RemoteDebug.cpp。

RemoteDebug.h

RemoteDebug.h 是库的头文件，定义了 RemoteDebug 类及其成员函数和变量。以下是部分代码示例：

#ifndef RemoteDebug_h
#define RemoteDebug_h

#include <Arduino.h>

class RemoteDebug {
public:
    RemoteDebug();
    void begin(const char* hostName);
    void setResetCmdEnabled(bool enable);
    void showProfiler(bool enable);
    // 其他成员函数
};

#endif

RemoteDebug.cpp

RemoteDebug.cpp 是库的实现文件，包含了 RemoteDebug 类的具体实现。以下是部分代码示例：

#include "RemoteDebug.h"

RemoteDebug::RemoteDebug() {
    // 构造函数实现
}

void RemoteDebug::begin(const char* hostName) {
    // begin 函数实现
}

void RemoteDebug::setResetCmdEnabled(bool enable) {
    // setResetCmdEnabled 函数实现
}

void RemoteDebug::showProfiler(bool enable) {
    // showProfiler 函数实现
}

3. 项目的配置文件介绍

RemoteDebug 项目的配置主要通过代码中的设置函数进行。以下是一些常用的配置函数：

初始化配置

在项目的 setup() 函数中进行初始化配置：

#include "RemoteDebug.h"

RemoteDebug Debug;

void setup() {
    // 初始化 WiFi
    WiFi.begin("your-ssid", "your-password");
    while (WiFi.status() != WL_CONNECTED) {
        delay(1000);
    }

    // 初始化 RemoteDebug
    Debug.begin("RemoteDebug");
    Debug.setResetCmdEnabled(true);
    Debug.showProfiler(true);
}

调试级别配置

可以通过设置调试级别来过滤日志输出：

Debug.setLevel(DEBUG_LEVEL_VERBOSE); // 设置为详细级别

其他配置

还可以通过其他函数进行更多配置，如启用重置命令和显示性能分析器：

Debug.setResetCmdEnabled(true); // 启用重置命令
Debug.showProfiler(true); // 启用性能分析器

通过这些配置，可以灵活地控制 RemoteDebug 的行为，以满足不同项目的需求。

RemoteDebugLibrary for Arduino to debug projects over WiFi, with web app or telnet, with print commands like Serial Monitor项目地址:https://gitcode.com/gh_mirrors/re/RemoteDebug