# cot软件包(注释增强版) **Repository Path**: MagicBude/cot_package ## Basic Information - **Project Name**: cot软件包(注释增强版) - **Description**: 包括各类组件模块代码,如菜单框架、参数管理、定时器任务调度和按键动作识别等功能模块 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 3 - **Forks**: 1 - **Created**: 2025-06-19 - **Last Updated**: 2026-11-13 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # cot_package 面向嵌入式 C 项目的轻量级组件集合,包含按键识别、LED 控制、多级菜单、参数管理和任务调度。可按工程需要选用组件,通过板级回调、时基和配置头文件完成接入。 本仓库使用 Git 子模块管理各组件,记录一组确定的组件提交版本。组件的接口、示例和配置说明维护在各自仓库中;本仓库提供统一的获取与导航入口。 ## 组件导航 - [cot_key:按键识别](cot_key/README.md)——普通、长按、连击及连击复合模式,多按键管理和事件回调。 - [cot_led:LED 控制](cot_led/README.md)——亮灭、闪烁、软件 PWM 呼吸、自定义序列及多灯组合效果。 - [cot_menu:菜单框架](cot_menu/README.md)——多级菜单、菜单项选择、快捷导航和显示回调调度。 - [cot_param:参数管理](cot_param/README.md)——参数表、默认值、范围校验、更新、序列化和加载;具体存储介质由工程适配。 - [cot_task:任务调度](cot_task/README.md)——基于 1 ms 时基的协作式任务调度,包含普通任务、中断任务和可选负载率统计。 - [cot_os:协程调度](cot_os/README.md)——基于 `setjmp/longjmp` 的协作式多任务,支持独立栈与共享栈,需要适配并验证目标平台栈操作。 `cot_task` 的普通任务回调应快速返回,不应阻塞;`cot_os` 通过协程等待接口切换任务,并涉及栈与上下文恢复。请根据执行模型选择调度组件,具体使用约束见对应文档。 ## 获取代码 需要安装 Git。首次克隆时同时获取子模块: ```sh git clone --recurse-submodules https://gitee.com/MagicBude/cot_package.git cd cot_package ``` 如果已经克隆主仓库,但组件目录为空: ```sh git submodule update --init --recursive ``` 只下载主仓库 ZIP 不会包含子模块源码,建议使用上述 Git 克隆方式。 ## 更新到主仓库记录的版本 在工作区改动已经提交或妥善保存后执行: ```sh git pull --ff-only git submodule update --init --recursive git submodule status --recursive ``` 子模块通常处于 detached HEAD 状态,这是检出主仓库指定提交的正常结果。不要将 `git submodule update --remote` 当作常规同步命令:它会跟随远端分支更新,可能偏离主仓库记录的组件版本。 ## 接入工程 1. 打开所需组件的 README,核对配置项、平台依赖及使用约束。 2. 将所需核心 `.c` 文件加入工程,并设置对应头文件搜索路径;无需把全部组件和示例一并编译。 3. 按需适配 GPIO、显示、存储、累计毫秒时基或栈操作。组件中的 STM32 管理层属于接入示例,需结合目标硬件调整。 4. 初始化组件,按照对应文档安排周期调用或调度入口,再验证目标硬件行为。 按键扫描 `cotKey_Scan` 和 LED 控制 `cotLed_Ctrl` 接收累计毫秒时间,而非两次调用的间隔。LED 呼吸效果使用软件 PWM,需要满足文档中的调用周期要求。`cot_os` 移植还需核对 ABI、栈增长方向、编译优化与 C 库实现。 本仓库没有统一的固件入口或全组件构建脚本,具体编译配置由使用方工程提供。参数绑定宏使用 GNU 扩展,工具链兼容性以组件文档和实际编译结果为准。 ## 主机回归与硬件验证 各组件的主机测试及运行方式见: - [按键回归说明](cot_key/tests/README.md) - [LED 回归说明](cot_led/tests/README.md) - [菜单回归说明](cot_menu/tests/README.md) - [任务回归说明](cot_task/tests/README.md) - [协程回归说明](cot_os/tests/README.md) 主机测试用于验证可模拟的状态、计时及配置边界,不代替目标板上的 GPIO、显示、中断、实时性和栈切换验证。参数组件的使用方式见其 README。 ## 维护子模块版本 修改组件时,先在对应子模块中切换到工作分支,完成检查、提交并推送;再回到主仓库提交更新后的子模块引用。应先推送组件提交,再推送主仓库,确保其他人能够获取引用的版本。 ## 来源与许可 各组件保留自己的来源说明及 `LICENSE`。使用、修改和分发前,请分别查阅所选组件的许可证: [cot_key](cot_key/LICENSE)、[cot_led](cot_led/LICENSE)、[cot_menu](cot_menu/LICENSE)、[cot_param](cot_param/LICENSE)、[cot_task](cot_task/LICENSE)、[cot_os](cot_os/LICENSE)。