Repository files navigation

Generates Rust messages from adbc file.

⚠️ This is experimental - use with caution.⚠️

Install published version usingcargo:

cargo install dbc-codegen-cli

Install latest version from the git repository:

cargo install dbc-codegen-cli --git https://github.com/technocreatives/dbc-codegen --branch main

Generatemessages.rs fromexample.dbc using the CLI:

dbc-codegen testing/dbc-examples/example.dbc dir/where/messages_rs/file/is/written

Or put something like this into yourbuild.rs file:

fnmain(){let dbc_path ="../dbc-examples/example.dbc";let dbc_file = std::fs::read(dbc_path).unwrap();println!("cargo:rerun-if-changed={}", dbc_path);let config =Config::builder().dbc_name("example.dbc").dbc_content(&dbc_file)//.allow_dead_code(true) // Don't emit warnings if not all generated code is used//.impl_arbitrary(FeatureConfig::Gated("arbitrary")) // Optional impls.//.impl_debug(FeatureConfig::Always)                 // See rustdoc for more,//.check_ranges(FeatureConfig::Never)                // or look below for an example..build();letmut out = std::io::BufWriter::new(std::fs::File::create("src/messages.rs").unwrap());    dbc_codegen::codegen(config,&mut out).expect("dbc-codegen failed");}

dbc-codegen generates a Rust file that is expected to be in a cargo project.Here is an exampletesting/can-messages/Cargo.toml which defines dependencies and features that are used in generated message file.

To use the code, addmod messages to yourlib.rs (ormain.rs).You will most likely want to interact with the generatedMessages enum, and callMessages::from_can_message(id, &payload).

Note: The generated code contains a lot of documentation.Give it a try:

cargo doc --open

The generator config has the following flags that control what code gets generated:

• impl_debug: enables#[derive(Debug)] for messages.
• impl_arbitrary: enables implementation of [Arbitrary] trait.Also requires you to addarbitrary crate (version 1.x) as a dependency of the crate.[Arbitrary]:https://docs.rs/arbitrary/1.0.0/arbitrary/trait.Arbitrary.html
• impl_error: Implementsstd::error::Error forCanError. This makes it easy to use crates likeanyhow for error handling.
• check_ranges: adds range checks in signal setters. (Enabled by default)

These implementations can be enabled, disabled, or placed behind feature guards, like so:

Config::builder()// this will generate Debug implementations.impl_debug(FeatureConfig::Always)// this will generate Error implementations behind `#[cfg(feature = "std")]` guards.impl_error(FeatureConfig::Gated("std"))// this will disable range checks.check_ranges(FeatureConfig::Never)

The generated code is no_std compatible, unless you enableimpl_error.

If some field name starts with a non-alphabetic character or is a Rust keyword then it is prefixed withx.

For example:

VAL_ 512 Five 0 "0Off" 1 "1On" 2 "2Oner" 3 "3Onest";

…is generated as:

pubenumBarFive{X0off,X1on,X2oner,X3onest,    _Other(bool),}

Type here:

SG_ Type : 30|1@0+ (1,0) [0|1] "boolean" Dolor

…conflicts with the Rust keywordtype. Therefore we prefix it withx:

pubfnxtype(&self) ->BarType{matchself.xtype_raw(){false =>BarType::X0off,true =>BarType::X1on,        x =>BarType::_Other(x),}}

If using Nix, dbc-codegen is integrated withlorri for easy project dependency management. To enable, create a symlink in the top-level working directory:

ln -s envrc.lorri .envrc

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE orhttp://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT orhttp://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionallysubmitted for inclusion in the work by you, as defined in the Apache-2.0license, shall be dual licensed as above, without any additional terms orconditions.