mm::etg::EniCyclicCmd Struct Reference

One datagram of a cyclic frame (ENI Cyclic/Frame/Cmd). More...

#include <eni.h>

Collaboration diagram for mm::etg::EniCyclicCmd:

Public Attributes
std::vector< EniState >	states
	AL states to send this frame in; at least one, at most four.
std::string	comment
	Free text a master may log.
EniCmd	cmd = EniCmd::Lrw
	Usually Lrw: one datagram exchanges the whole image.
std::optional< std::uint16_t >	adp
	Device address, with ado. Excludes addr.
std::optional< std::uint16_t >	ado
	Offset in the device's ESC memory. Excludes addr.
std::optional< std::uint32_t >	addr
	Logical start address. Excludes adp and ado.
std::vector< std::uint8_t >	data
	Bytes to write. Excludes dataLength.
std::optional< std::uint32_t >	dataLength
	Bytes to exchange. Excludes data.
std::optional< std::uint32_t >	cnt
	Working counter a healthy bus returns.
std::uint32_t	inputOffs = 0
	Where the read data lands in the input image.
std::uint32_t	outputOffs = 0

Detailed Description

One datagram of a cyclic frame (ENI Cyclic/Frame/Cmd).

inputOffs and outputOffs are both required by the schema, so a frame that only reads still writes an output offset of zero.

Member Data Documentation

addr

std::optional<std::uint32_t> mm::etg::EniCyclicCmd::addr

Logical start address. Excludes adp and ado.

ado

std::optional<std::uint16_t> mm::etg::EniCyclicCmd::ado

Offset in the device's ESC memory. Excludes addr.

adp

std::optional<std::uint16_t> mm::etg::EniCyclicCmd::adp

Device address, with ado. Excludes addr.

cmd

EniCmd mm::etg::EniCyclicCmd::cmd = EniCmd::Lrw

Usually Lrw: one datagram exchanges the whole image.

cnt

std::optional<std::uint32_t> mm::etg::EniCyclicCmd::cnt

Working counter a healthy bus returns.

comment

std::string mm::etg::EniCyclicCmd::comment

Free text a master may log.

data

std::vector<std::uint8_t> mm::etg::EniCyclicCmd::data

Bytes to write. Excludes dataLength.

dataLength

std::optional<std::uint32_t> mm::etg::EniCyclicCmd::dataLength

Bytes to exchange. Excludes data.

inputOffs

std::uint32_t mm::etg::EniCyclicCmd::inputOffs = 0

Where the read data lands in the input image.

outputOffs

std::uint32_t mm::etg::EniCyclicCmd::outputOffs = 0

Where the written data comes from in the output image.

states

std::vector<EniState> mm::etg::EniCyclicCmd::states

AL states to send this frame in; at least one, at most four.

---

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

• libs/etg/eni.h