Skip to main content

Crate odrive_can_protocol

Crate odrive_can_protocol 

Source
Expand description

ODrive CANSimple 协议库入口,提供版本明确的编解码 API 与硬件无关帧类型。

默认仅使用 core;可选 feature 提供驱动帧转换,不执行设备收发或控制。

§odrive-can-protocol

maintenance crates.io docs.rs MIT MSRV

已弃用 / Deprecated:本 crate 已合并到 odrive_can_driver 的 protocol 模块,停止独立维护。新项目和后续更新请使用 odrive_can_driver。

0.1.3 仅更新包元数据和文档;协议实现、现有 API、依赖与 MSRV 保持不变。crates.io 历史版本继续保留,供已有依赖使用。

§迁移到 odrive_can_driver

使用 odrive_can_driver 0.2(要求 Rust 1.98.1 或更新版本):

[dependencies]
odrive_can_driver = "0.2"

将旧导入路径增加 protocol 层,例如:

-use odrive_can_protocol::fw_v0_5_1::{encode, Command, Message, NodeId};
+use odrive_can_driver::protocol::fw_v0_5_1::{encode, Command, Message, NodeId};

原 crate 根的类型和函数迁至 odrive_can_driver::protocol,帧适配入口迁至 odrive_can_driver::protocol::compat。embedded-can、embassy-stm32、socketcan 三个可选 feature 名称不变;仅编解码仍可使用默认 no_std、无分配、零依赖构建。旧包和新包定义的类型不能混用,应同时更新相关导入。

新包同时提供设备驱动、查询与收发后端。迁移和接入方式见新项目 README及协议 API。

§旧包参考

以下内容仅供仍使用 odrive-can-protocol 0.1 的项目参考。

odrive-can-protocol 是 ODrive CANSimple 的硬件无关编解码库。默认构建使用 Rust 2024、#![no_std]、无 alloc、零依赖,MSRV 为 Rust 1.85;它不访问 CAN 外设,也不管理任务、时序或控制策略。

§安装

[dependencies]
odrive-can-protocol = "0.1.3"

Rust 中的 crate 名为 odrive_can_protocol。完整 API 见 rustdoc。

§快速开始

use odrive_can_protocol::fw_v0_5_1::{encode, Command, Message, NodeId};

let frame = encode(
    NodeId::new(1).unwrap(),
    Message::Command(Command::SetInputVel {
        velocity: -2.5,
        torque_ff: 0.25,
    }),
)
.unwrap();

assert_eq!(frame.id(), 0x02d);

更多编码、RTR 查询和 Heartbeat 解码见 examples/encode_decode.rs:

cargo run --example encode_decode

§协议支持

当前 API 位于 odrive_can_protocol::fw_v0_5_1,crate 根同时重导出主要类型与 encode、decode。它支持标准 11-bit Classic CAN;多字节字段为 little-endian,浮点字段为 IEEE 754 binary32。

固件模块状态
ODrive fw-v0.5.1fw_v0_5_1已支持
MKS ODrive Mini ODriveMINI-fw-v0.5.1-20250326fw_v0_5_1已支持,同一 CANSimple 布局

MKS 结论仅覆盖该固定源码包:ODriveMINI-fw-v0.5.1-20250326.rar。该包的 CANSimple 源码与官方 ODrive fw-v0.5.1 基线一致,因此无需 MKS 专用 feature 或转换层。其他 MKS 固件版本应先核对源码。

§可选兼容层

兼容层是 crate 的 optional feature;启用后可直接使用原生帧类型,无需自行复制转换代码。embedded-can 是 Embassy STM32 与 SocketCAN 的共同基础,后两者会自动启用它。

feature提供的接入前提
embedded-can通用 Classic embedded_can::Frame 转换MSRV 1.85
embassy-stm32embassy_stm32::can::Frame、FdFrame 转换消费方选择芯片与 embassy-stm32 0.6 feature
socketcanLinux socketcan::CanFrame、CanAnyFrame 转换Linux、SocketCAN 4、Rust 1.89

embedded-can 使用 EncodedFrame::to_embedded_can::<F>() -> Option<F> 创建原生 Classic 帧;FrameRef::from_classic_embedded_can(&frame) 借用解码,并在 compat::embedded_can::InvalidFrameLength 中报告无法表示的长度。该 trait 不携带 CAN FD 或 Linux 错误帧语义,因此该入口只接收已确认的 Classic 帧。

启用 embassy-stm32 后,embassy_stm32::can::Frame 与 FdFrame 均实现 From<&EncodedFrame>,FrameRef 实现对二者借用的 TryFrom;错误类型位于 compat::embassy。启用 socketcan 后,socketcan::CanFrame 实现 From<&EncodedFrame>,FrameRef 实现对 CanFrame 和 CanAnyFrame 借用的 TryFrom;错误类型位于 compat::socketcan。

驱动依赖、芯片选择和最小接入示例见 examples。

§API 边界

encode(node, message) 只完成协议编码;decode(node, frame) 只还原该节点的已知消息。设备错误位、未知状态和线上浮点位模式作为协议数据保留。应用负责收发、设备许可、超时、重试、单位换算和动作结果判断。

§后续维护

此旧包停止独立维护。问题反馈、修复和功能贡献请前往 odrive-can-driver。

§License

本项目采用 MIT License,保留原版权信息。

Re-exports§

pub use frame::EncodedFrame;
pub use frame::FrameId;
pub use frame::FramePayload;
pub use frame::FrameRef;
pub use fw_v0_5_1::AxisState;
pub use fw_v0_5_1::Command;
pub use fw_v0_5_1::DecodeError;
pub use fw_v0_5_1::EncodeError;
pub use fw_v0_5_1::Message;
pub use fw_v0_5_1::NodeId;
pub use fw_v0_5_1::Query;
pub use fw_v0_5_1::Response;
pub use fw_v0_5_1::decode;
pub use fw_v0_5_1::encode;

Modules§

compat
按 feature 启用的驱动帧转换。 原生 CAN 帧适配,保持标识符、有效长度与帧类型,不执行任何 I/O。
frame
与硬件无关的 CAN 帧表示。 与 CAN 驱动解耦的帧类型,显式保存 ID 形态、有效载荷与 RTR 信息。
fw_v0_5_1
ODrive 固件 fw-v0.5.1 的 CANSimple 协议。 ODrive fw-v0.5.1 CANSimple 协议。