Information about a slave's mailbox configuration. More...

#include <soem.h>

Public Attributes
uint16_t	readLength
	Length of the mailbox read area (in bytes).
uint16_t	readOffset
	Offset of the mailbox read area within the slave's memory.
uint16_t	supportedProtocols
	Supported mailbox protocols as a bitmask.
uint16_t	writeLength
	Length of the mailbox write area (in bytes).
uint16_t	writeOffset
	Offset of the mailbox write area within the slave's memory.

Detailed Description

Information about a slave's mailbox configuration.

In EtherCAT, the mailbox is used for protocol communication between the master and the slave (e.g., CoE, FoE, SoE, EoE). This struct describes the layout and capabilities of the slave's mailbox.

Member Data Documentation

◆ readLength

uint16_t mm::comm::soem::SlaveInfoMailbox::readLength

Length of the mailbox read area (in bytes).

This is the number of bytes the master can read from the slave's mailbox.

◆ readOffset

uint16_t mm::comm::soem::SlaveInfoMailbox::readOffset

Offset of the mailbox read area within the slave's memory.

This is the starting address of the read mailbox area relative to the slave's memory.

◆ supportedProtocols

uint16_t mm::comm::soem::SlaveInfoMailbox::supportedProtocols

Supported mailbox protocols as a bitmask.

Indicates which protocols the slave supports over the mailbox:

Bit 0: CoE (CANopen over EtherCAT)
Bit 1: FoE (File access over EtherCAT)
Bit 2: SoE (Servodrive over EtherCAT)
Bit 3: EoE (Ethernet over EtherCAT)
Bits 4..15: reserved

◆ writeLength

uint16_t mm::comm::soem::SlaveInfoMailbox::writeLength

Length of the mailbox write area (in bytes).

This is the number of bytes the master can write to the slave's mailbox.

◆ writeOffset

uint16_t mm::comm::soem::SlaveInfoMailbox::writeOffset

Offset of the mailbox write area within the slave's memory.

This is the starting address of the write mailbox area relative to the slave's memory.

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

libs/comm/soem.h