MC Protocol Serial C++ 0.2.3
MC protocol serial library for MCU-oriented environments
Loading...
Searching...
No Matches
mcprotocol::serial::CommandCodec Namespace Reference

Command-payload codec helpers below the frame layer. More...

Functions

Contiguous Device-Memory Read Helpers
Status encode_batch_read_words (const ProtocolConfig &config, const BatchReadWordsRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_read_extended_file_register_words (const ProtocolConfig &config, const ExtendedFileRegisterBatchReadWordsRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_direct_read_extended_file_register_words (const ProtocolConfig &config, const ExtendedFileRegisterDirectBatchReadWordsRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_extended_batch_read_words (const ProtocolConfig &config, const QualifiedBufferWordDevice &device, std::uint16_t points, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_link_direct_batch_read_words (const ProtocolConfig &config, const LinkDirectDevice &device, std::uint16_t points, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_batch_read_words_response (const ProtocolConfig &config, const BatchReadWordsRequest &request, std::span< const std::uint8_t > response_data, std::span< std::uint16_t > out_words) noexcept
 
Status parse_read_extended_file_register_words_response (const ProtocolConfig &config, std::uint16_t points, std::span< const std::uint8_t > response_data, std::span< std::uint16_t > out_words) noexcept
 
Status parse_extended_batch_read_words_response (const ProtocolConfig &config, std::uint16_t points, std::span< const std::uint8_t > response_data, std::span< std::uint16_t > out_words) noexcept
 
Status encode_batch_read_bits (const ProtocolConfig &config, const BatchReadBitsRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_link_direct_batch_read_bits (const ProtocolConfig &config, const LinkDirectDevice &device, std::uint16_t points, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_batch_read_bits_response (const ProtocolConfig &config, const BatchReadBitsRequest &request, std::span< const std::uint8_t > response_data, std::span< BitValue > out_bits) noexcept
 
Contiguous Device-Memory Write Helpers
Status encode_batch_write_words (const ProtocolConfig &config, const BatchWriteWordsRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_write_extended_file_register_words (const ProtocolConfig &config, const ExtendedFileRegisterBatchWriteWordsRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_direct_write_extended_file_register_words (const ProtocolConfig &config, const ExtendedFileRegisterDirectBatchWriteWordsRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_link_direct_batch_write_words (const ProtocolConfig &config, const LinkDirectDevice &device, std::span< const std::uint16_t > words, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_extended_batch_write_words (const ProtocolConfig &config, const QualifiedBufferWordDevice &device, std::span< const std::uint16_t > words, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_batch_write_bits (const ProtocolConfig &config, const BatchWriteBitsRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_link_direct_batch_write_bits (const ProtocolConfig &config, const LinkDirectDevice &device, std::span< const BitValue > bits, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Random-Access Helpers
Status encode_link_direct_random_read (const ProtocolConfig &config, std::span< const LinkDirectRandomReadItem > items, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_random_read (const ProtocolConfig &config, const RandomReadRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_random_read_response (const ProtocolConfig &config, std::span< const RandomReadItem > items, std::span< const std::uint8_t > response_data, std::span< std::uint32_t > out_values) noexcept
 
Status encode_random_write_words (const ProtocolConfig &config, std::span< const RandomWriteWordItem > items, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_random_write_extended_file_register_words (const ProtocolConfig &config, std::span< const ExtendedFileRegisterRandomWriteWordItem > items, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_link_direct_random_write_words (const ProtocolConfig &config, std::span< const LinkDirectRandomWriteWordItem > items, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_random_write_bits (const ProtocolConfig &config, std::span< const RandomWriteBitItem > items, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_link_direct_random_write_bits (const ProtocolConfig &config, std::span< const LinkDirectRandomWriteBitItem > items, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Multi-Block Helpers
Status encode_link_direct_multi_block_read (const ProtocolConfig &config, const LinkDirectMultiBlockReadRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_multi_block_read (const ProtocolConfig &config, const MultiBlockReadRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_multi_block_read_response (const ProtocolConfig &config, std::span< const MultiBlockReadBlock > blocks, std::span< const std::uint8_t > response_data, std::span< std::uint16_t > out_words, std::span< BitValue > out_bits, std::span< MultiBlockReadBlockResult > out_results) noexcept
 
Status encode_multi_block_write (const ProtocolConfig &config, const MultiBlockWriteRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_link_direct_multi_block_write (const ProtocolConfig &config, const LinkDirectMultiBlockWriteRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Monitor Helpers
Status encode_register_monitor (const ProtocolConfig &config, const MonitorRegistration &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_register_extended_file_register_monitor (const ProtocolConfig &config, const ExtendedFileRegisterMonitorRegistration &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_link_direct_register_monitor (const ProtocolConfig &config, const LinkDirectMonitorRegistration &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_read_monitor (const ProtocolConfig &config, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_read_monitor (const ProtocolConfig &config, std::span< const RandomReadItem > items, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_read_extended_file_register_monitor (const ProtocolConfig &config, std::span< const ExtendedFileRegisterAddress > items, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_read_monitor_response (const ProtocolConfig &config, std::span< const RandomReadItem > items, std::span< const std::uint8_t > response_data, std::span< std::uint32_t > out_values) noexcept
 
Status parse_read_extended_file_register_monitor_response (const ProtocolConfig &config, std::span< const ExtendedFileRegisterAddress > items, std::span< const std::uint8_t > response_data, std::span< std::uint16_t > out_words) noexcept
 
Serial-Module Dedicated Helpers
Status encode_read_user_frame (const ProtocolConfig &config, const UserFrameReadRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_read_user_frame_response (const ProtocolConfig &config, std::span< const std::uint8_t > response_data, UserFrameRegistrationData &out_data) noexcept
 
Status encode_write_user_frame (const ProtocolConfig &config, const UserFrameWriteRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_delete_user_frame (const ProtocolConfig &config, const UserFrameDeleteRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_control_global_signal (const ProtocolConfig &config, const GlobalSignalControlRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_initialize_transmission_sequence (const ProtocolConfig &config, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_deregister_cpu_monitoring (const ProtocolConfig &config, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Buffer-Memory Helpers
Status encode_read_host_buffer (const ProtocolConfig &config, const HostBufferReadRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_read_host_buffer_response (const ProtocolConfig &config, const HostBufferReadRequest &request, std::span< const std::uint8_t > response_data, std::span< std::uint16_t > out_words) noexcept
 
Status encode_write_host_buffer (const ProtocolConfig &config, const HostBufferWriteRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_read_module_buffer (const ProtocolConfig &config, const ModuleBufferReadRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_read_module_buffer_response (const ProtocolConfig &config, const ModuleBufferReadRequest &request, std::span< const std::uint8_t > response_data, std::span< std::byte > out_bytes) noexcept
 
Status encode_write_module_buffer (const ProtocolConfig &config, const ModuleBufferWriteRequest &request, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Diagnostic And Remote-Control Helpers
Status encode_read_cpu_model (const ProtocolConfig &config, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_read_cpu_model_response (const ProtocolConfig &config, std::span< const std::uint8_t > response_data, CpuModelInfo &out_info) noexcept
 
Status encode_remote_run (const ProtocolConfig &config, RemoteOperationMode mode, RemoteRunClearMode clear_mode, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_remote_stop (const ProtocolConfig &config, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_remote_pause (const ProtocolConfig &config, RemoteOperationMode mode, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_remote_latch_clear (const ProtocolConfig &config, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_remote_reset (const ProtocolConfig &config, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_unlock_remote_password (const ProtocolConfig &config, std::string_view remote_password, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_lock_remote_password (const ProtocolConfig &config, std::string_view remote_password, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_clear_error_information (const ProtocolConfig &config, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status encode_loopback (const ProtocolConfig &config, std::span< const char > hex_ascii, std::span< std::uint8_t > out_request_data, std::size_t &out_size) noexcept
 
Status parse_loopback_response (const ProtocolConfig &config, std::span< const std::uint8_t > response_data, std::span< char > out_echoed) noexcept
 
constexpr std::uint32_t module_buffer_start_address (std::uint32_t buffer_memory_address, std::uint32_t module_additional_value) noexcept
 Converts a logical buffer-memory word address plus module offset into a byte start address.
 

Detailed Description

Command-payload codec helpers below the frame layer.

These helpers operate on request/response data only. They do not add or remove the surrounding C1/C2/C3/C4 frame bytes.

Function Documentation

◆ encode_batch_read_bits()

Status mcprotocol::serial::CommandCodec::encode_batch_read_bits ( const ProtocolConfig &  config,
const BatchReadBitsRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_batch_read_words()

Status mcprotocol::serial::CommandCodec::encode_batch_read_words ( const ProtocolConfig &  config,
const BatchReadWordsRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_batch_write_bits()

Status mcprotocol::serial::CommandCodec::encode_batch_write_bits ( const ProtocolConfig &  config,
const BatchWriteBitsRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_batch_write_words()

Status mcprotocol::serial::CommandCodec::encode_batch_write_words ( const ProtocolConfig &  config,
const BatchWriteWordsRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_clear_error_information()

Status mcprotocol::serial::CommandCodec::encode_clear_error_information ( const ProtocolConfig &  config,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_control_global_signal()

Status mcprotocol::serial::CommandCodec::encode_control_global_signal ( const ProtocolConfig &  config,
const GlobalSignalControlRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_delete_user_frame()

Status mcprotocol::serial::CommandCodec::encode_delete_user_frame ( const ProtocolConfig &  config,
const UserFrameDeleteRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_deregister_cpu_monitoring()

Status mcprotocol::serial::CommandCodec::encode_deregister_cpu_monitoring ( const ProtocolConfig &  config,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_direct_read_extended_file_register_words()

Status mcprotocol::serial::CommandCodec::encode_direct_read_extended_file_register_words ( const ProtocolConfig &  config,
const ExtendedFileRegisterDirectBatchReadWordsRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_direct_write_extended_file_register_words()

Status mcprotocol::serial::CommandCodec::encode_direct_write_extended_file_register_words ( const ProtocolConfig &  config,
const ExtendedFileRegisterDirectBatchWriteWordsRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_extended_batch_read_words()

Status mcprotocol::serial::CommandCodec::encode_extended_batch_read_words ( const ProtocolConfig &  config,
const QualifiedBufferWordDevice &  device,
std::uint16_t  points,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_extended_batch_write_words()

Status mcprotocol::serial::CommandCodec::encode_extended_batch_write_words ( const ProtocolConfig &  config,
const QualifiedBufferWordDevice &  device,
std::span< const std::uint16_t >  words,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_initialize_transmission_sequence()

Status mcprotocol::serial::CommandCodec::encode_initialize_transmission_sequence ( const ProtocolConfig &  config,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_batch_read_bits()

Status mcprotocol::serial::CommandCodec::encode_link_direct_batch_read_bits ( const ProtocolConfig &  config,
const LinkDirectDevice &  device,
std::uint16_t  points,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_batch_read_words()

Status mcprotocol::serial::CommandCodec::encode_link_direct_batch_read_words ( const ProtocolConfig &  config,
const LinkDirectDevice &  device,
std::uint16_t  points,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_batch_write_bits()

Status mcprotocol::serial::CommandCodec::encode_link_direct_batch_write_bits ( const ProtocolConfig &  config,
const LinkDirectDevice &  device,
std::span< const BitValue >  bits,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_batch_write_words()

Status mcprotocol::serial::CommandCodec::encode_link_direct_batch_write_words ( const ProtocolConfig &  config,
const LinkDirectDevice &  device,
std::span< const std::uint16_t >  words,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_multi_block_read()

Status mcprotocol::serial::CommandCodec::encode_link_direct_multi_block_read ( const ProtocolConfig &  config,
const LinkDirectMultiBlockReadRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_multi_block_write()

Status mcprotocol::serial::CommandCodec::encode_link_direct_multi_block_write ( const ProtocolConfig &  config,
const LinkDirectMultiBlockWriteRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_random_read()

Status mcprotocol::serial::CommandCodec::encode_link_direct_random_read ( const ProtocolConfig &  config,
std::span< const LinkDirectRandomReadItem >  items,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_random_write_bits()

Status mcprotocol::serial::CommandCodec::encode_link_direct_random_write_bits ( const ProtocolConfig &  config,
std::span< const LinkDirectRandomWriteBitItem >  items,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_random_write_words()

Status mcprotocol::serial::CommandCodec::encode_link_direct_random_write_words ( const ProtocolConfig &  config,
std::span< const LinkDirectRandomWriteWordItem >  items,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_link_direct_register_monitor()

Status mcprotocol::serial::CommandCodec::encode_link_direct_register_monitor ( const ProtocolConfig &  config,
const LinkDirectMonitorRegistration &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_lock_remote_password()

Status mcprotocol::serial::CommandCodec::encode_lock_remote_password ( const ProtocolConfig &  config,
std::string_view  remote_password,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_loopback()

Status mcprotocol::serial::CommandCodec::encode_loopback ( const ProtocolConfig &  config,
std::span< const char >  hex_ascii,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_multi_block_read()

Status mcprotocol::serial::CommandCodec::encode_multi_block_read ( const ProtocolConfig &  config,
const MultiBlockReadRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_multi_block_write()

Status mcprotocol::serial::CommandCodec::encode_multi_block_write ( const ProtocolConfig &  config,
const MultiBlockWriteRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_random_read()

Status mcprotocol::serial::CommandCodec::encode_random_read ( const ProtocolConfig &  config,
const RandomReadRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_random_write_bits()

Status mcprotocol::serial::CommandCodec::encode_random_write_bits ( const ProtocolConfig &  config,
std::span< const RandomWriteBitItem >  items,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_random_write_extended_file_register_words()

Status mcprotocol::serial::CommandCodec::encode_random_write_extended_file_register_words ( const ProtocolConfig &  config,
std::span< const ExtendedFileRegisterRandomWriteWordItem >  items,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_random_write_words()

Status mcprotocol::serial::CommandCodec::encode_random_write_words ( const ProtocolConfig &  config,
std::span< const RandomWriteWordItem >  items,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_read_cpu_model()

Status mcprotocol::serial::CommandCodec::encode_read_cpu_model ( const ProtocolConfig &  config,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_read_extended_file_register_monitor()

Status mcprotocol::serial::CommandCodec::encode_read_extended_file_register_monitor ( const ProtocolConfig &  config,
std::span< const ExtendedFileRegisterAddress >  items,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_read_extended_file_register_words()

Status mcprotocol::serial::CommandCodec::encode_read_extended_file_register_words ( const ProtocolConfig &  config,
const ExtendedFileRegisterBatchReadWordsRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_read_host_buffer()

Status mcprotocol::serial::CommandCodec::encode_read_host_buffer ( const ProtocolConfig &  config,
const HostBufferReadRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_read_module_buffer()

Status mcprotocol::serial::CommandCodec::encode_read_module_buffer ( const ProtocolConfig &  config,
const ModuleBufferReadRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_read_monitor() [1/2]

Status mcprotocol::serial::CommandCodec::encode_read_monitor ( const ProtocolConfig &  config,
std::span< const RandomReadItem >  items,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_read_monitor() [2/2]

Status mcprotocol::serial::CommandCodec::encode_read_monitor ( const ProtocolConfig &  config,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_read_user_frame()

Status mcprotocol::serial::CommandCodec::encode_read_user_frame ( const ProtocolConfig &  config,
const UserFrameReadRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_register_extended_file_register_monitor()

Status mcprotocol::serial::CommandCodec::encode_register_extended_file_register_monitor ( const ProtocolConfig &  config,
const ExtendedFileRegisterMonitorRegistration &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_register_monitor()

Status mcprotocol::serial::CommandCodec::encode_register_monitor ( const ProtocolConfig &  config,
const MonitorRegistration &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_remote_latch_clear()

Status mcprotocol::serial::CommandCodec::encode_remote_latch_clear ( const ProtocolConfig &  config,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_remote_pause()

Status mcprotocol::serial::CommandCodec::encode_remote_pause ( const ProtocolConfig &  config,
RemoteOperationMode  mode,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_remote_reset()

Status mcprotocol::serial::CommandCodec::encode_remote_reset ( const ProtocolConfig &  config,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_remote_run()

Status mcprotocol::serial::CommandCodec::encode_remote_run ( const ProtocolConfig &  config,
RemoteOperationMode  mode,
RemoteRunClearMode  clear_mode,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_remote_stop()

Status mcprotocol::serial::CommandCodec::encode_remote_stop ( const ProtocolConfig &  config,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_unlock_remote_password()

Status mcprotocol::serial::CommandCodec::encode_unlock_remote_password ( const ProtocolConfig &  config,
std::string_view  remote_password,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_write_extended_file_register_words()

Status mcprotocol::serial::CommandCodec::encode_write_extended_file_register_words ( const ProtocolConfig &  config,
const ExtendedFileRegisterBatchWriteWordsRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_write_host_buffer()

Status mcprotocol::serial::CommandCodec::encode_write_host_buffer ( const ProtocolConfig &  config,
const HostBufferWriteRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_write_module_buffer()

Status mcprotocol::serial::CommandCodec::encode_write_module_buffer ( const ProtocolConfig &  config,
const ModuleBufferWriteRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ encode_write_user_frame()

Status mcprotocol::serial::CommandCodec::encode_write_user_frame ( const ProtocolConfig &  config,
const UserFrameWriteRequest &  request,
std::span< std::uint8_t >  out_request_data,
std::size_t &  out_size 
)
noexcept

◆ module_buffer_start_address()

constexpr std::uint32_t mcprotocol::serial::CommandCodec::module_buffer_start_address ( std::uint32_t  buffer_memory_address,
std::uint32_t  module_additional_value 
)
constexprnoexcept

Converts a logical buffer-memory word address plus module offset into a byte start address.

Definition at line 534 of file codec.hpp.

◆ parse_batch_read_bits_response()

Status mcprotocol::serial::CommandCodec::parse_batch_read_bits_response ( const ProtocolConfig &  config,
const BatchReadBitsRequest &  request,
std::span< const std::uint8_t >  response_data,
std::span< BitValue >  out_bits 
)
noexcept

◆ parse_batch_read_words_response()

Status mcprotocol::serial::CommandCodec::parse_batch_read_words_response ( const ProtocolConfig &  config,
const BatchReadWordsRequest &  request,
std::span< const std::uint8_t >  response_data,
std::span< std::uint16_t >  out_words 
)
noexcept

◆ parse_extended_batch_read_words_response()

Status mcprotocol::serial::CommandCodec::parse_extended_batch_read_words_response ( const ProtocolConfig &  config,
std::uint16_t  points,
std::span< const std::uint8_t >  response_data,
std::span< std::uint16_t >  out_words 
)
noexcept

◆ parse_loopback_response()

Status mcprotocol::serial::CommandCodec::parse_loopback_response ( const ProtocolConfig &  config,
std::span< const std::uint8_t >  response_data,
std::span< char >  out_echoed 
)
noexcept

◆ parse_multi_block_read_response()

Status mcprotocol::serial::CommandCodec::parse_multi_block_read_response ( const ProtocolConfig &  config,
std::span< const MultiBlockReadBlock >  blocks,
std::span< const std::uint8_t >  response_data,
std::span< std::uint16_t >  out_words,
std::span< BitValue >  out_bits,
std::span< MultiBlockReadBlockResult >  out_results 
)
noexcept

◆ parse_random_read_response()

Status mcprotocol::serial::CommandCodec::parse_random_read_response ( const ProtocolConfig &  config,
std::span< const RandomReadItem >  items,
std::span< const std::uint8_t >  response_data,
std::span< std::uint32_t >  out_values 
)
noexcept

◆ parse_read_cpu_model_response()

Status mcprotocol::serial::CommandCodec::parse_read_cpu_model_response ( const ProtocolConfig &  config,
std::span< const std::uint8_t >  response_data,
CpuModelInfo &  out_info 
)
noexcept

◆ parse_read_extended_file_register_monitor_response()

Status mcprotocol::serial::CommandCodec::parse_read_extended_file_register_monitor_response ( const ProtocolConfig &  config,
std::span< const ExtendedFileRegisterAddress >  items,
std::span< const std::uint8_t >  response_data,
std::span< std::uint16_t >  out_words 
)
noexcept

◆ parse_read_extended_file_register_words_response()

Status mcprotocol::serial::CommandCodec::parse_read_extended_file_register_words_response ( const ProtocolConfig &  config,
std::uint16_t  points,
std::span< const std::uint8_t >  response_data,
std::span< std::uint16_t >  out_words 
)
noexcept

◆ parse_read_host_buffer_response()

Status mcprotocol::serial::CommandCodec::parse_read_host_buffer_response ( const ProtocolConfig &  config,
const HostBufferReadRequest &  request,
std::span< const std::uint8_t >  response_data,
std::span< std::uint16_t >  out_words 
)
noexcept

◆ parse_read_module_buffer_response()

Status mcprotocol::serial::CommandCodec::parse_read_module_buffer_response ( const ProtocolConfig &  config,
const ModuleBufferReadRequest &  request,
std::span< const std::uint8_t >  response_data,
std::span< std::byte >  out_bytes 
)
noexcept

◆ parse_read_monitor_response()

Status mcprotocol::serial::CommandCodec::parse_read_monitor_response ( const ProtocolConfig &  config,
std::span< const RandomReadItem >  items,
std::span< const std::uint8_t >  response_data,
std::span< std::uint32_t >  out_values 
)
noexcept

◆ parse_read_user_frame_response()

Status mcprotocol::serial::CommandCodec::parse_read_user_frame_response ( const ProtocolConfig &  config,
std::span< const std::uint8_t >  response_data,
UserFrameRegistrationData &  out_data 
)
noexcept