Route header fields for serial MC requests. More...

#include <types.hpp>

Public Attributes
RouteKind	kind = RouteKind::HostStation
	Route interpretation used by the selected frame family.

std::uint8_t	station_no = 0x00
	Target station number on multidrop serial links.

std::uint8_t	network_no = 0x00
	Network number used by routed `3C/4C` requests.

std::uint8_t	pc_no = 0xFF
	PLC number field used by `3C/4C` and legacy frame families.

std::uint16_t	request_destination_module_io_no = 0x03FF
	Destination I/O number for the target CPU/module in `3C/4C` routing.

std::uint8_t	request_destination_module_station_no = 0x00
	Destination station number for the target CPU/module in `3C/4C` routing.

bool	self_station_enabled = false
	Enables self-station routing on frame families that support it.

std::uint8_t	self_station_no = 0x00
	Self-station number used when `self_station_enabled` is true.

Detailed Description

Route header fields for serial MC requests.

The same struct is shared across 2C/3C/4C, 1C, and 1E, but not every field is active on every frame family. FrameCodec::validate_config() checks the combinations that are legal for the selected frame.

Definition at line 296 of file types.hpp.

Member Data Documentation

◆ kind

RouteKind mcprotocol::serial::RouteConfig::kind = RouteKind::HostStation

Route interpretation used by the selected frame family.

Definition at line 298 of file types.hpp.

◆ network_no

std::uint8_t mcprotocol::serial::RouteConfig::network_no = 0x00

Network number used by routed 3C/4C requests.

Definition at line 302 of file types.hpp.

◆ pc_no

std::uint8_t mcprotocol::serial::RouteConfig::pc_no = 0xFF

PLC number field used by 3C/4C and legacy frame families.

Definition at line 304 of file types.hpp.

◆ request_destination_module_io_no

std::uint16_t mcprotocol::serial::RouteConfig::request_destination_module_io_no = 0x03FF

Destination I/O number for the target CPU/module in 3C/4C routing.

Definition at line 306 of file types.hpp.

◆ request_destination_module_station_no

std::uint8_t mcprotocol::serial::RouteConfig::request_destination_module_station_no = 0x00

Destination station number for the target CPU/module in 3C/4C routing.

Definition at line 308 of file types.hpp.

◆ self_station_enabled

bool mcprotocol::serial::RouteConfig::self_station_enabled = false

Enables self-station routing on frame families that support it.

Definition at line 310 of file types.hpp.

◆ self_station_no

std::uint8_t mcprotocol::serial::RouteConfig::self_station_no = 0x00

Self-station number used when self_station_enabled is true.

Definition at line 312 of file types.hpp.

◆ station_no

std::uint8_t mcprotocol::serial::RouteConfig::station_no = 0x00

Target station number on multidrop serial links.

Definition at line 300 of file types.hpp.

The documentation for this struct was generated from the following file:

include/mcprotocol/serial/types.hpp

Public Attributes