Veethree D7 SDK
Loading...
Searching...
No Matches
can_adapter_interface.h
Go to the documentation of this file.
1
5#ifndef CAN_ADAPTER_INTERFACE_H
6#define CAN_ADAPTER_INTERFACE_H
7
8#include "can_common.h"
9#include "network_manager.h"
10#include <optional>
11#include <string>
12#include <vector>
13
14namespace vsdk::comms {
19
24constexpr uint32_t bitrate_10k = 10'000;
25constexpr uint32_t bitrate_20k = 20'000;
26constexpr uint32_t bitrate_50k = 50'000;
27constexpr uint32_t bitrate_125k = 125'000;
28constexpr uint32_t bitrate_250k = 250'000;
29constexpr uint32_t bitrate_500k = 500'000;
30constexpr uint32_t bitrate_800k = 800'000;
31constexpr uint32_t bitrate_1meg = 1'000'000;
33
39 std::optional<std::string> name;
41 std::optional<interface_status> state;
43 std::optional<can_status> bus_state;
45 std::optional<uint32_t> tx_queue_len;
47 std::optional<uint32_t> restart_delay_ms;
49 std::optional<can_bit_timing> bit_timing;
51 std::optional<can_bit_timing_const> bit_timing_const;
53 std::optional<can_bit_timing> data_bit_timing;
55 std::optional<can_bit_timing_const> data_bit_timing_const;
57 std::optional<uint32_t> clock;
59 std::optional<can_bus_err_counter> berr_counter;
61 std::optional<transmitter_delay_compensation> tdc;
63 std::optional<ctrl_mode> ctrlmode;
64};
65
72class can_adapter_interface { // NOLINT (cppcoreguidelines-special-member-functions)
73public:
78 explicit can_adapter_interface(std::string_view if_name)
79 : _if_name(if_name)
80 {}
81
87 virtual ~can_adapter_interface() noexcept = default;
88
92 std::string if_name() const { return _if_name; }
93
100 virtual void get_config(can_parameters& param) = 0;
101
109 virtual bool set_config(const can_parameters& param) = 0;
110
115 virtual bool restart_adapter() = 0;
116
123 virtual std::vector<std::string> list_adapters() = 0;
124
125private:
126 std::string _if_name;
127};
128
130
131} // namespace vsdk::comms
132
133#ifndef DOXYGEN_SKIP_THIS
134
135#include <fmt/ranges.h>
136#include <utils/fmt_wrapper.h>
137
138template<>
139struct fmt::formatter<vsdk::comms::can_status> : fmt::formatter<std::string> {
140 auto format(vsdk::comms::can_status state, format_context& ctx) const
141 -> format_context::iterator
142 {
143 using enum vsdk::comms::can_status;
144 std::string s;
145 switch (state) {
146 case error_active:
147 s = "error_active";
148 break;
149 case error_warning:
150 s = "error_warning";
151 break;
152 case error_passive:
153 s = "error_passive";
154 break;
155 case bus_off:
156 s = "bus_off";
157 break;
158 case stopped:
159 s = "stopped";
160 break;
161 case sleeping:
162 s = "sleeping";
163 break;
164 default:
165 s = "unknown";
166 break;
167 }
168 return formatter<std::string>::format(s, ctx);
169 }
170};
171
172template<>
173struct fmt::formatter<vsdk::comms::ctrl_mode> : fmt::formatter<std::string> {
174 // NOLINTNEXTLINE (*-function-cognitive-complexity)
175 auto format(vsdk::comms::ctrl_mode mode, format_context& ctx) const -> format_context::iterator
176 {
177 std::vector<std::string> modes;
178 if (mode.loopback) {
179 modes.emplace_back(fmt::format("LOOPBACK {}", mode.loopback.value() ? "ON" : "OFF"));
180 }
181 if (mode.listenonly) {
182 modes.emplace_back(fmt::format("LISTENONLY {}", mode.listenonly.value() ? "ON" : "OFF"));
183 }
184 if (mode.triple_sampling) {
185 modes.emplace_back(
186 fmt::format("TRIPLE_SAMPLING {}", mode.triple_sampling.value() ? "ON" : "OFF"));
187 }
188 if (mode.one_shot) {
189 modes.emplace_back(fmt::format("ONE_SHOT {}", mode.one_shot.value() ? "ON" : "OFF"));
190 }
191 if (mode.berr_reporting) {
192 modes.emplace_back(
193 fmt::format("BERR_REPORTING {}", mode.berr_reporting.value() ? "ON" : "OFF"));
194 }
195 if (mode.fd) {
196 modes.emplace_back(fmt::format("FD {}", mode.fd.value() ? "ON" : "OFF"));
197 }
198 if (mode.presume_ack) {
199 modes.emplace_back(
200 fmt::format("PRESUME_ACK {}", mode.presume_ack.value() ? "ON" : "OFF"));
201 }
202 if (mode.fd_non_iso) {
203 modes.emplace_back(fmt::format("FD_NON_ISO {}", mode.fd_non_iso.value() ? "ON" : "OFF"));
204 }
205 if (mode.cc_len8_dlc) {
206 modes.emplace_back(
207 fmt::format("CC_LEN8_DLC {}", mode.cc_len8_dlc.value() ? "ON" : "OFF"));
208 }
209 if (mode.tdc_auto) {
210 modes.emplace_back(fmt::format("TDC_AUTO {}", mode.tdc_auto.value() ? "ON" : "OFF"));
211 }
212 if (mode.tdc_manual) {
213 modes.emplace_back(fmt::format("TDC_MANUAL {}", mode.tdc_manual.value() ? "ON" : "OFF"));
214 }
215 return formatter<std::string>::format(fmt::format("controller modes:{{}}",
216 fmt::join(modes, " ")),
217 ctx);
218 }
219};
220
221#endif // DOXYGEN_SKIP_THIS
222
223#endif // CAN_ADAPTER_INTERFACE_H
Common CAN structures.
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 &param)=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 &param)=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