Veethree D7 SDK
Loading...
Searching...
No Matches
The comms library

Detailed Description

This library provides support for various communication protocols:

Classes

class  vsdk::comms::can_adapter
 The CAN interface setup class. More...
struct  vsdk::comms::can_parameters
 CAN interface configuration parameters. More...
class  vsdk::comms::can_adapter_interface
 Class for abstracting lower level interactions with the CAN interfaces. A concrete implementation may "talk" to the underlying OS to query the current state of a CAN interface, request a configuration change for a CAN interface or list all available CAN interfaces. More...
struct  vsdk::comms::can_msg_frame
 CAN frame structure. More...
struct  vsdk::comms::can_bit_timing
 CAN Bit Timing structure. More...
struct  vsdk::comms::can_bit_timing_const
 CAN hardware-dependent bit timing constant. More...
struct  vsdk::comms::can_bus_err_counter
 CAN Bus error counters. More...
struct  vsdk::comms::ctrl_mode
 CAN Controller Mode. More...
struct  vsdk::comms::transmitter_delay_compensation
 CAN FD Transmitter Delay Compensation. More...
class  vsdk::comms::can_socket
 Convenience wrapper class around a CAN socket. More...
struct  vsdk::comms::receive_result
 Result to receiving a message on a socket. More...
struct  vsdk::comms::select_result_can
 Result to receive a message on multiple sockets at once. More...
class  vsdk::comms::can_socket_interface
 The can_socket_interface lists the expected interface for a CAN socket implementation that can be used by vsdk::comms::can_socket. More...
struct  vsdk::comms::interface
 The interface struct. More...
class  vsdk::comms::network_manager
 The network_manager class. More...
class  vsdk::comms::serial_port
 The serial_port class. More...
struct  vsdk::comms::port_attributes
 Structure representing serial port configuration attributes. More...

Typedefs

using vsdk::comms::can_socket_recv_callback = std::function<std::errc(can_msg_frame)>
 A callback function to be called when a message is successfully ready from a socket.
using vsdk::comms::serial_port_receive_fn = std::function<void(std::span<uint8_t>)>
 Callback function type for receiving data from a serial port.

Enumerations

enum class  vsdk::comms::can_status : uint8_t {
  vsdk::comms::can_status::error_active = 0 , vsdk::comms::can_status::error_warning , vsdk::comms::can_status::error_passive , vsdk::comms::can_status::bus_off ,
  vsdk::comms::can_status::stopped , vsdk::comms::can_status::sleeping
}
 CAN Bus status values. More...
enum class  vsdk::comms::interface_status : uint8_t { vsdk::comms::interface_status::down , vsdk::comms::interface_status::up }
 The interface_status enum. More...
enum class  vsdk::comms::interface_type : uint8_t { vsdk::comms::interface_type::loopback , vsdk::comms::interface_type::can , vsdk::comms::interface_type::normal }
 The interface_type enum. More...
enum class  vsdk::comms::port_baud_rate : uint32_t {
  vsdk::comms::port_baud_rate::none = 0 , vsdk::comms::port_baud_rate::uart110 = 110 , vsdk::comms::port_baud_rate::uart300 = 300 , vsdk::comms::port_baud_rate::uart1200 = 1200 ,
  vsdk::comms::port_baud_rate::uart2400 = 2400 , vsdk::comms::port_baud_rate::uart4800 = 4800 , vsdk::comms::port_baud_rate::uart9600 = 9600 , vsdk::comms::port_baud_rate::uart19200 = 19200 ,
  vsdk::comms::port_baud_rate::uart38400 = 38400 , vsdk::comms::port_baud_rate::uart57600 = 57600 , vsdk::comms::port_baud_rate::uart115200 = 115200 , vsdk::comms::port_baud_rate::uart230400 = 230400 ,
  vsdk::comms::port_baud_rate::uart460800 = 460800 , vsdk::comms::port_baud_rate::uart921600 = 921600
}
 Enumeration of standard baud rates for serial communication. More...
enum class  vsdk::comms::port_parity : uint8_t { vsdk::comms::port_parity::none , vsdk::comms::port_parity::odd , vsdk::comms::port_parity::even }
 Enumeration of serial port parity settings. More...
enum class  vsdk::comms::port_stop_bits : uint8_t { vsdk::comms::port_stop_bits::bits1 , vsdk::comms::port_stop_bits::bits2 }
 Enumeration of serial port stop bit configurations. More...
enum class  vsdk::comms::port_data_bits : uint8_t { vsdk::comms::port_data_bits::bits7 , vsdk::comms::port_data_bits::bits8 }
 Enumeration of serial port data bit configurations. More...
enum class  vsdk::comms::port_flush_mode : uint8_t { vsdk::comms::port_flush_mode::both , vsdk::comms::port_flush_mode::input , vsdk::comms::port_flush_mode::output }
 Enumeration of serial port flush modes. More...
enum class  vsdk::comms::port_alias : uint8_t { vsdk::comms::port_alias::port0 , vsdk::comms::port_alias::port1 , vsdk::comms::port_alias::device }
 Enumeration of supported serial port aliases. More...
enum  vsdk::comms::port_mode : uint8_t {
  vsdk::comms::none = 0x0 , vsdk::comms::rs232 = 0x1 , vsdk::comms::rs422 = 0x2 , vsdk::comms::rs485 = 0x4 ,
  vsdk::comms::j1708 = 0x8
}
 Bitmask enumeration of supported serial port modes. More...

Functions

std::unique_ptr< serial_port_context_interface > vsdk::comms::serial_port_default_context ()
 Create a default serial port context instance for the platform.

Variables

constexpr auto vsdk::comms::can_max_msg_len = 8
 The maximum length of a CAN frame payload.
constexpr uint32_t vsdk::comms::bitrate_10k = 10'000
 Common CAN bitrates.
constexpr uint32_t vsdk::comms::bitrate_20k = 20'000
 Common CAN bitrates.
constexpr uint32_t vsdk::comms::bitrate_50k = 50'000
 Common CAN bitrates.
constexpr uint32_t vsdk::comms::bitrate_125k = 125'000
 Common CAN bitrates.
constexpr uint32_t vsdk::comms::bitrate_250k = 250'000
 Common CAN bitrates.
constexpr uint32_t vsdk::comms::bitrate_500k = 500'000
 Common CAN bitrates.
constexpr uint32_t vsdk::comms::bitrate_800k = 800'000
 Common CAN bitrates.
constexpr uint32_t vsdk::comms::bitrate_1meg = 1'000'000
 Common CAN bitrates.

Detailed Description

This library provides support for various communication protocols:

Typedef Documentation

◆ serial_port_receive_fn

using vsdk::comms::serial_port_receive_fn = std::function<void(std::span<uint8_t>)>

Callback function type for receiving data from a serial port.

This callback is invoked when data is received on the serial port.

Parameters
dataA span of received bytes.

Example:

serial_port_receive_fn receive_callback = [](std::span<uint8_t> data) {
// Process received data
};
std::function< void(std::span< uint8_t >)> serial_port_receive_fn
Callback function type for receiving data from a serial port.
Definition serial_port_common.h:35

Enumeration Type Documentation

◆ can_status

enum class vsdk::comms::can_status : uint8_t
strong

CAN Bus status values.

Enumerator
error_active 

RX/TX error count < 96.

error_warning 

RX/TX error count < 128.

error_passive 

RX/TX error count < 256.

bus_off 

RX/TX error count >= 256.

stopped 

Device is stopped.

sleeping 

Device is sleeping.

◆ interface_status

enum class vsdk::comms::interface_status : uint8_t
strong

The interface_status enum.

An interface status, which can be 'up' or 'down'.

Enumerator
down 

interface is down

up 

interface is up

◆ interface_type

enum class vsdk::comms::interface_type : uint8_t
strong

The interface_type enum.

An interface type.

Enumerator
loopback 

interface is a loopback device, e.g. lo

can 

interface is a socketcan interface, e.g. can0

normal 

interface is a regular interface, e.g. eth0

◆ port_alias

enum class vsdk::comms::port_alias : uint8_t
strong

Enumeration of supported serial port aliases.

This enum class defines the aliases for different serial ports.

Example:

port_alias
Enumeration of supported serial port aliases.
Definition serial_port_common.h:136
@ port1
RS232 port.
Definition serial_port_common.h:138
Enumerator
port0 

RS422 or RS485 port.

port1 

RS232 port.

device 

User-defined device (e.g., /dev/ttyLP3)

◆ port_baud_rate

enum class vsdk::comms::port_baud_rate : uint32_t
strong

Enumeration of standard baud rates for serial communication.

This enum class defines common baud rates used in serial communication.

Example:

port_baud_rate
Enumeration of standard baud rates for serial communication.
Definition serial_port_common.h:47
@ uart9600
9600 baud
Definition serial_port_common.h:54
Enumerator
none 

No baud rate specified.

uart110 

110 baud

uart300 

300 baud

uart1200 

1200 baud

uart2400 

2400 baud

uart4800 

4800 baud

uart9600 

9600 baud

uart19200 

19200 baud

uart38400 

38400 baud

uart57600 

57600 baud

uart115200 

115200 baud

uart230400 

230400 baud

uart460800 

460800 baud

uart921600 

921600 baud

◆ port_data_bits

enum class vsdk::comms::port_data_bits : uint8_t
strong

Enumeration of serial port data bit configurations.

This enum class defines the number of data bits used in serial communication.

Example:

port_data_bits
Enumeration of serial port data bit configurations.
Definition serial_port_common.h:105
@ bits8
8 data bits
Definition serial_port_common.h:107
Enumerator
bits7 

7 data bits

bits8 

8 data bits

◆ port_flush_mode

enum class vsdk::comms::port_flush_mode : uint8_t
strong

Enumeration of serial port flush modes.

This enum class defines the modes for flushing serial port buffers.

Example:

port_flush_mode
Enumeration of serial port flush modes.
Definition serial_port_common.h:120
@ both
Flush both input and output buffers.
Definition serial_port_common.h:121
Enumerator
both 

Flush both input and output buffers.

input 

Flush input buffer only.

output 

Flush output buffer only.

◆ port_mode

enum vsdk::comms::port_mode : uint8_t

Bitmask enumeration of supported serial port modes.

This enum defines the modes that a serial port can operate in. Multiple modes can be combined using bitwise OR.

Example:

port_mode
Bitmask enumeration of supported serial port modes.
Definition serial_port_common.h:153
@ rs232
RS232 mode.
Definition serial_port_common.h:155
@ rs485
RS485 mode.
Definition serial_port_common.h:157
Enumerator
none 

No mode.

rs232 

RS232 mode.

rs422 

RS422 mode.

rs485 

RS485 mode.

j1708 

J1708 mode.

◆ port_parity

enum class vsdk::comms::port_parity : uint8_t
strong

Enumeration of serial port parity settings.

This enum class defines the parity options for serial communication.

Example:

port_parity
Enumeration of serial port parity settings.
Definition serial_port_common.h:74
@ even
Even parity.
Definition serial_port_common.h:77
Enumerator
none 

No parity.

odd 

Odd parity.

even 

Even parity.

◆ port_stop_bits

enum class vsdk::comms::port_stop_bits : uint8_t
strong

Enumeration of serial port stop bit configurations.

This enum class defines the number of stop bits used in serial communication.

Example:

port_stop_bits
Enumeration of serial port stop bit configurations.
Definition serial_port_common.h:90
@ bits1
One stop bit.
Definition serial_port_common.h:91
Enumerator
bits1 

One stop bit.

bits2 

Two stop bits.

Function Documentation

◆ serial_port_default_context()

std::unique_ptr< serial_port_context_interface > vsdk::comms::serial_port_default_context ( )

Create a default serial port context instance for the platform.

Returns
A std::unique_ptr object containing a context object that implements serial_port_context_interface.