Skip to content

Commands.md

Latest commit

 

History

History
423 lines (345 loc) · 10.6 KB

Commands.md

File metadata and controls

423 lines (345 loc) · 10.6 KB

DutyCycle 命令使用说明

概述

DutyCycle提供了一个命令行界面，用于与系统中的数据节点进行交互。以下是所有可用命令的详细使用说明。 核心代码位于：Firmware/App/Service/DataProc/DP_Shell.cpp

命令列表

命令 注释
help 显示帮助信息
loglevel 设置日志级别
ps 显示栈使用最大深度
publish 发布消息（仅供调试使用）
clock 显示或设置系统时钟
power 控制电源状态
ctrl 控制设备功能
alarm 闹钟设置
kvdb 数据库操作（仅供调试使用）

help

概述：显示所有可用命令。

命令格式：

help

示例：

help

输出：

Available Commands:
help
loglevel
ps
publish
clock
power
ctrl
alarm
kvdb

loglevel

概述：设置系统的日志级别。

命令格式：

loglevel <level>
  • <level>：日志级别，取值范围为0~4。
    • 0: Trace
    • 1: Info （默认值）
    • 2: Warning
    • 3: Error
    • 4: Off

示例：

设置日志级别为3（仅打印错误等级日志）。

loglevel 3

输出： 无，后面将仅打印错误等级日志。

ps

概述：显示系统栈最深使用量，需要确保日志等级为1(Info)及以下。

命令格式：

ps

示例：

ps

输出：

[INFO] Memory_DumpStackInfo: Stack: 99% used (total: 1536, free: 4)

栈使用量为99%，总大小为1536字节，剩余大小为4字节。

publish

概述：向订阅DP_Shell的节点发布消息，仅供内部调试使用。

命令格式：

publish <msg1> <msg2> ...
  • <msg1>：消息内容1。
  • <msg2>：消息内容2。
  • 等等。

示例：

publish aaa bbb

输出：

publish finished: -3

消息发布结束，返回值为-3。

clock

概述：显示当前时钟，并可以设置新的时钟时间。

命令格式：

clock [-c <cmd>] [-y <year>] [-m <month>] [-d <day>] [-H <hour>] [-M <minute>] [-S <second>]
  • -c <cmd>：时钟命令，可选值包括：
    • SET：设置新的时钟时间。
  • -y <year>：年份。
  • -m <month>：月份。
  • -d <day>：日期。
  • -H <hour>：小时。
  • -M <minute>：分钟。
  • -S <second>：秒。

示例1：

显示当前时间，不设置新的时间。

clock

输出：

Current clock: 2025-04-25 FRI 14:17:32.18
#ERROR-PARAM:command is null
#ERROR-TYPE:PARSING

当前时间为2025年4月25日星期五14时17分32秒18毫秒。

示例2：

设置新的时钟时间为2025年4月25日14时15分10秒。

clock -c SET -y 2025 -m 4 -d 25 -H 14 -M 15 -S 10

输出：

Current clock: 2025-04-25 FRI 14:01:07.260
New clock: 2025-04-25 14:15:10.0

当前时间为2025年4月25日14时01分07秒260毫秒，设置后的时间为2025年4月25日14时15分10秒0毫秒。

示例3：

使用config_clock.py脚本自动配置时间，打开PC终端（非串口终端），使用脚本请确保安装python3.x及pyserial模块:

pip install -r Tools/requirements.txt

运行以下命令自动设置时间。脚本会自动扫描串口设备，找到第一个可用串口设备，并配置时间：

python Tools/config_clock.py

或者如果PC中有多个串口设备，可以添加-p参数手动指定串口号：

Windows 系统:

python Tools/config_clock.py -p COM3

Linux 系统:

python Tools/config_clock.py -p /dev/ttyUSB0

如果遇到权限不足无法打开串口设备，可以执行以下命令：

sudo chmod 666 /dev/ttyUSB0 # 替换为实际串口设备

或者执行以下命令将当前用户加入到此用户组，然后注销重新登录即可。

sudo usermod -a -G dialout $USER

输出：

No specific port was provided. Using the first available port: COM3
Serial port COM3 opened with baud rate 115200 and timeout 1 seconds
Sending command: clock -c SET -y 2025 -m 4 -d 26 -H 0 -M 3 -S 14
Received data:
clock -c SET -y 2025 -m 4 -d 26 -H 0 -M 3 -S 14
Serial port closed

脚本使用自动扫描串口模式，显示了回显信息，表示自动配置时间为2025年4月26日0点3分14秒。

power

概述：电源控制。注意：关闭或重启系统后，RTC（实时时钟）也会关闭，再次启动后需要重新设置时间，系统启动的默认时间为固件编译时间。

命令格式：

power -c <cmd>
  • -c <cmd>：电源控制命令，可选值包括：
    • SHUTDOWN：关闭系统。
    • REBOOT：重启系统。

示例：

power -c SHUTDOWN

输出：

[WARN] HAL::Power::onIoctl: Power off!

系统下电。

ctrl

概述：发送控制命令。

命令格式：

ctrl -c <cmd> [-H <hour>] [-M <motor>] [--mode <mode>]
  • -c <cmd>：控制命令，可选值包括：
    • SWEEP_TEST：执行指针扫动测试。
    • ENABLE_CLOCK_MAP：启用时钟映射。
    • LIST_CLOCK_MAP：列出时钟映射。
    • SET_MOTOR_VALUE：设置电机值。
    • SET_CLOCK_MAP：设置时钟映射。
    • SET_MODE：设置显示模式。
    • SHOW_BATTERY_USAGE：显示电池使用情况。
  • -H <hour>：要设置的小时数。
  • -M <motor>：要设置的电机值。
  • --mode <mode>：显示模式，可选值包括：
    • 0：功率因数表模式（cos-phi）。
    • 1：电压、电流（线性）表模式（linear）。

示例： 设置电机值为100。

ctrl -c SET_MOTOR_VALUE -M 100

输出：

[INFO] DP_Ctrl::onTimer: Motor value reached: 100

电机已设置值为100。

alarm

概述：设置闹钟和正点报时功能。

命令格式：

alarm -c <cmd> [-i <ID>] [-H <hour>] [-M <minute>] [-m <music>] [-f <filter>]
  • -c <cmd>：闹钟命令，可选值包括：
    • SET：设置闹钟时间。
    • LIST：列出所有闹钟。
    • SET_FILTER：设置小时过滤器。
    • SET_ALARM_MUSIC：编辑自定义闹钟音乐。
    • LIST_ALARM_MUSIC：列出自定义闹钟音乐内容。
    • CLEAR_ALARM_MUSIC：清除自定义闹钟音乐。
    • SAVE_ALARM_MUSIC：保存自定义闹钟音乐。
    • PLAY_ALARM_MUSIC：播放闹钟音乐。
    • PLAY_ALARM_HOURLY：播放正点报时音乐。
    • PLAY_TONE：播放指定频率的音效。
  • -i <ID>：闹钟ID。范围为0~3。
  • -H <hour>：小时。
  • -M <minute>：分钟。
  • -m <music>：音乐ID。范围为0~2。
  • -f <filter>：正点报时小时过滤器，格式为 1,2,3,4。
  • --index <index>：音效索引。
  • --freq <freq>：音效频率（单位：赫兹）。
  • --duration <duration>：音效持续时间（单位：毫秒）。
  • --time <time>：音效播放时间（单位：毫秒），如果不设置则以duration为准。
  • --bpm <bpm>：音乐节拍（单位：拍）。

示例1： 设置闹钟0的时间为7:30，音乐ID为1。

alarm -c SET -i 0 -H 7 -M 30 -m 1

输出： 无，使用LIST指令查看是否生效。

示例2： 设置正点报时的小时过滤器，过滤掉10~12点和14~23点以外的时间，防止打扰休息。

alarm -c SET_FILTER -f 10,11,12,14,15,16,17,18,19,20,21,22,23

输出：

add hour: 10 to filter
add hour: 11 to filter
add hour: 12 to filter
add hour: 14 to filter
add hour: 15 to filter
add hour: 16 to filter
add hour: 17 to filter
add hour: 18 to filter
add hour: 19 to filter
add hour: 20 to filter
add hour: 21 to filter
add hour: 22 to filter
add hour: 23 to filter
[INFO] DP_Alarm::onNotify: Set hourly alarm filter: 0x00FFDC00

设置成功后自动打印出过滤器信息以及掩码。

示例3： 列出所有闹钟信息。

alarm -c LIST

输出：

[INFO] DP_Alarm::listAlarms: Hourly alarm filter: 0x00FFDC00
[INFO] DP_Alarm::listAlarms: Alarm 0: 07:30, Music ID: 1
[INFO] DP_Alarm::listAlarms: Alarm 1: 18:20, Music ID: 1
[INFO] DP_Alarm::listAlarms: Alarm 2: 21:00, Music ID: 2

报时过滤器掩码为0x00FFDC00；闹钟0为7:30，音乐ID为1；闹钟1为18:20，音乐ID为1；闹钟2为21:00，音乐ID为2。

附录：音符频率速查表

低音 (L) 频率 (Hz) 中音 (M) 频率 (Hz) 高音 (H) 频率 (Hz)
低音1 262 中音1 523 高音1 1046
低音1# 277 中音1# 554 高音1# 1109
低音2 294 中音2 587 高音2 1175
低音2# 311 中音2# 622 高音2# 1245
低音3 330 中音3 659 高音3 1318
低音4 349 中音4 698 高音4 1397
低音4# 370 中音4# 740 高音4# 1480
低音5 392 中音5 784 高音5 1568
低音5# 415 中音5# 831 高音5# 1661
低音6 440 中音6 880 高音6 1760
低音6# 466 中音6# 932 高音6# 1865
低音7 494 中音7 988 高音7 1976

kvdb

概述：数据库操作（仅供调试使用）。

命令格式：

kvdb -c <cmd> -k <key>
  • -c <cmd>：KVDB命令，可选值包括：
    • DEL：删除指定的键。
    • LIST：列出所有键。
    • SAVE：保存（此）。
  • -k <key>：键名。

示例： 列出所有键。

kvdb -c LIST

输出：

[INFO] DP_KVDB::onSet: Key list:
[INFO] DP_KVDB::onSet: [0]:
[INFO] DP_KVDB::onSet: 	name = '_hourMotorMap'
[INFO] DP_KVDB::onSet: 	status = 2
[INFO] DP_KVDB::onSet: 	crc_is_ok = 1
[INFO] DP_KVDB::onSet: 	name_len = 13
[INFO] DP_KVDB::onSet: 	magic = 0x1
[INFO] DP_KVDB::onSet: 	len = 108
[INFO] DP_KVDB::onSet: 	value_len = 50
[INFO] DP_KVDB::onSet: 	addr.start = 0x1452
[INFO] DP_KVDB::onSet: 	addr.value = 0x1508
[INFO] DP_KVDB::onSet: [1]:
[INFO] DP_KVDB::onSet: 	name = '_alarmParam'
[INFO] DP_KVDB::onSet: 	status = 2
[INFO] DP_KVDB::onSet: 	crc_is_ok = 1
[INFO] DP_KVDB::onSet: 	name_len = 11
[INFO] DP_KVDB::onSet: 	magic = 0x1
[INFO] DP_KVDB::onSet: 	len = 68
[INFO] DP_KVDB::onSet: 	value_len = 16
[INFO] DP_KVDB::onSet: 	addr.start = 0x1696
[INFO] DP_KVDB::onSet: 	addr.value = 0x1748
⚡