5#ifndef CAN_ADAPTER_INTERFACE_H
6#define CAN_ADAPTER_INTERFACE_H
39 std::optional<std::string>
name;
41 std::optional<interface_status>
state;
61 std::optional<transmitter_delay_compensation>
tdc;
92 std::
string if_name()
const {
return _if_name; }
126 std::string _if_name;
133#ifndef DOXYGEN_SKIP_THIS
135#include <fmt/ranges.h>
141 -> format_context::iterator
168 return formatter<std::string>::format(s, ctx);
173struct fmt::formatter<
vsdk::comms::ctrl_mode> : fmt::formatter<std::string> {
175 auto format(vsdk::comms::ctrl_mode mode, format_context& ctx)
const -> format_context::iterator
177 std::vector<std::string> modes;
179 modes.emplace_back(fmt::format(
"LOOPBACK {}",
mode.loopback.value() ?
"ON" :
"OFF"));
181 if (
mode.listenonly) {
182 modes.emplace_back(fmt::format(
"LISTENONLY {}",
mode.listenonly.value() ?
"ON" :
"OFF"));
184 if (
mode.triple_sampling) {
186 fmt::format(
"TRIPLE_SAMPLING {}",
mode.triple_sampling.value() ?
"ON" :
"OFF"));
189 modes.emplace_back(fmt::format(
"ONE_SHOT {}",
mode.one_shot.value() ?
"ON" :
"OFF"));
191 if (
mode.berr_reporting) {
193 fmt::format(
"BERR_REPORTING {}",
mode.berr_reporting.value() ?
"ON" :
"OFF"));
196 modes.emplace_back(fmt::format(
"FD {}",
mode.fd.value() ?
"ON" :
"OFF"));
198 if (
mode.presume_ack) {
200 fmt::format(
"PRESUME_ACK {}",
mode.presume_ack.value() ?
"ON" :
"OFF"));
202 if (
mode.fd_non_iso) {
203 modes.emplace_back(fmt::format(
"FD_NON_ISO {}",
mode.fd_non_iso.value() ?
"ON" :
"OFF"));
205 if (
mode.cc_len8_dlc) {
207 fmt::format(
"CC_LEN8_DLC {}",
mode.cc_len8_dlc.value() ?
"ON" :
"OFF"));
210 modes.emplace_back(fmt::format(
"TDC_AUTO {}",
mode.tdc_auto.value() ?
"ON" :
"OFF"));
212 if (
mode.tdc_manual) {
213 modes.emplace_back(fmt::format(
"TDC_MANUAL {}",
mode.tdc_manual.value() ?
"ON" :
"OFF"));
215 return formatter<std::string>::format(fmt::format(
"controller modes:{{}}",
216 fmt::join(modes,
" ")),
virtual std::vector< std::string > list_adapters()=0
List all available CAN adapters' names.
std::string if_name() const
The name of the interface that this instance refers to.
Definition can_adapter_interface.h:92
virtual void get_config(can_parameters ¶m)=0
Get the config for the interface.
can_adapter_interface()=default
Default constructor. Allows calling can_adapter_interface::list_adapters without requiring an interfa...
virtual bool set_config(const can_parameters ¶m)=0
Modify the config for the interface.
can_adapter_interface(std::string_view if_name)
Constructor that uses the device interface name.
Definition can_adapter_interface.h:78
virtual bool restart_adapter()=0
Restart the CAN interface.
Add include this file to your file so you have access to fmtlib header-only implementation.
constexpr uint32_t bitrate_500k
Common CAN bitrates.
Definition can_adapter_interface.h:29
constexpr uint32_t bitrate_20k
Common CAN bitrates.
Definition can_adapter_interface.h:25
constexpr uint32_t bitrate_50k
Common CAN bitrates.
Definition can_adapter_interface.h:26
constexpr uint32_t bitrate_250k
Common CAN bitrates.
Definition can_adapter_interface.h:28
constexpr uint32_t bitrate_1meg
Common CAN bitrates.
Definition can_adapter_interface.h:31
constexpr uint32_t bitrate_800k
Common CAN bitrates.
Definition can_adapter_interface.h:30
constexpr uint32_t bitrate_10k
Common CAN bitrates.
Definition can_adapter_interface.h:24
constexpr uint32_t bitrate_125k
Common CAN bitrates.
Definition can_adapter_interface.h:27
can_status
CAN Bus status values.
Definition can_common.h:46
mode
Digital output channel mode.
Definition digital_common.h:47
Any entities that belong to the comms library.
Definition can_adapter.h:12
Any entities that belong to the Veethree SDK libraries.
Definition can_adapter.h:12
The network_manager interface.
CAN interface configuration parameters.
Definition can_adapter_interface.h:37
std::optional< uint32_t > tx_queue_len
Transmission Queue length (tx queue len)
Definition can_adapter_interface.h:45
std::optional< uint32_t > restart_delay_ms
Automatic interface restart delay in milliseconds.
Definition can_adapter_interface.h:47
std::optional< can_status > bus_state
The bus state.
Definition can_adapter_interface.h:43
std::optional< interface_status > state
The interface state (up/down)
Definition can_adapter_interface.h:41
std::optional< ctrl_mode > ctrlmode
CAN controller mode.
Definition can_adapter_interface.h:63
std::optional< can_bit_timing_const > data_bit_timing_const
Data bit timing constant.
Definition can_adapter_interface.h:55
std::optional< can_bit_timing > data_bit_timing
Data bit timing.
Definition can_adapter_interface.h:53
std::optional< transmitter_delay_compensation > tdc
Transmit delay compensation.
Definition can_adapter_interface.h:61
std::optional< can_bit_timing > bit_timing
The bit timing.
Definition can_adapter_interface.h:49
std::optional< can_bit_timing_const > bit_timing_const
The bit timing constant.
Definition can_adapter_interface.h:51
std::optional< std::string > name
The interface name.
Definition can_adapter_interface.h:39
std::optional< can_bus_err_counter > berr_counter
The CAN bus error counter.
Definition can_adapter_interface.h:59
std::optional< uint32_t > clock
The interface clock frequency in Hz.
Definition can_adapter_interface.h:57