|
Veethree D7 SDK
|
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. | |
Functions | |
| std::unique_ptr< serial_port_context_interface > | vsdk::comms::serial_port_default_context () |
| Create a default serial port context instance for the platform. | |
This library provides support for various communication protocols:
| 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.
| data | A span of received bytes. |
Example:
|
strong |
|
strong |
The interface_status enum.
An interface status, which can be 'up' or 'down'.
| Enumerator | |
|---|---|
| down | interface is down |
| up | interface is up |
|
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 |
|
strong |
Enumeration of supported serial port aliases.
This enum class defines the aliases for different serial ports.
Example:
| Enumerator | |
|---|---|
| port0 | RS422 or RS485 port. |
| port1 | RS232 port. |
| device | User-defined device (e.g., /dev/ttyLP3) |
|
strong |
Enumeration of standard baud rates for serial communication.
This enum class defines common baud rates used in serial communication.
Example:
|
strong |
Enumeration of serial port data bit configurations.
This enum class defines the number of data bits used in serial communication.
Example:
| Enumerator | |
|---|---|
| bits7 | 7 data bits |
| bits8 | 8 data bits |
|
strong |
Enumeration of serial port flush modes.
This enum class defines the modes for flushing serial port buffers.
Example:
| Enumerator | |
|---|---|
| both | Flush both input and output buffers. |
| input | Flush input buffer only. |
| output | Flush output buffer only. |
| 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:
| Enumerator | |
|---|---|
| none | No mode. |
| rs232 | RS232 mode. |
| rs422 | RS422 mode. |
| rs485 | RS485 mode. |
| j1708 | J1708 mode. |
|
strong |
Enumeration of serial port parity settings.
This enum class defines the parity options for serial communication.
Example:
| Enumerator | |
|---|---|
| none | No parity. |
| odd | Odd parity. |
| even | Even parity. |
|
strong |
Enumeration of serial port stop bit configurations.
This enum class defines the number of stop bits used in serial communication.
Example:
| Enumerator | |
|---|---|
| bits1 | One stop bit. |
| bits2 | Two stop bits. |
| std::unique_ptr< serial_port_context_interface > vsdk::comms::serial_port_default_context | ( | ) |
Create a default serial port context instance for the platform.