API Reference ethercat v#0.5.0

Copy Markdown View Source

Modules

Public runtime API for the EtherCAT protocol boundary.

Canonical backend description for master startup, simulator transport, and scan.

Canonical raw-socket backend description.

Canonical redundant raw backend description.

Canonical UDP backend description.

Public API for the EtherCAT bus scheduler.

An EtherCAT datagram struct and wire-format codec (spec §2.2).

Shared scheduling helpers for bus link gen_statem implementations.

Dual-port bus link implemented as a gen_statem.

Pure helpers for redundant exchange interpretation.

Single-port bus link implemented as a gen_statem.

Internal queue item used by EtherCAT.Bus.Link scheduling helpers.

Result of a single EtherCAT datagram round-trip.

Builder for ordered EtherCAT datagram transactions.

Behaviour for EtherCAT frame transports.

Raw AF_PACKET socket transport for EtherCAT.

UDP/IP transport for simulator and integration endpoints.

Helpers for interactive slave-capture sessions.

Distributed Clocks initialization and runtime maintenance.

Declarative configuration for master-wide Distributed Clocks infrastructure.

Runtime status snapshot for Distributed Clocks.

Session-bound inspection and diagnostic API.

Cyclic process image for one logical EtherCAT domain.

Declarative configuration struct for a Domain.

Current protocol lifecycle and cycle health for one process-data domain.

Public protocol/device driver boundary for EtherCAT slaves.

One discovered PDO supplied to EtherCAT.Driver.signal_model/2.

Optional provisioning extension API for driver-authored mailbox setup.

Declarative mapping of one logical process-data signal to a PDO or slice of a PDO.

Public protocol description of one decoded signal on a configured slave.

Master orchestrates startup, activation, deactivation, and runtime recovery for the local EtherCAT session.

Stable machine-readable master runtime status.

Protocol-level runtime notification for one configured slave.

Session-bound provisioning and low-level configuration API.

Host-supervised singleton runtime for EtherCAT.

Coherent decoded process-data observation for one slave within one domain cycle.

One-shot backend scan that reports observed topology without opening a master session.

Stable observational scan result for one backend probe.

Opaque identity for one started EtherCAT session.

Session-bound signal and latch subscriptions.

Simulated EtherCAT slave segment for deep integration tests, virtual hardware, and simulator-backed tooling.

Optional simulator-side companion for a real EtherCAT.Driver.

Device and signal-level API for simulated EtherCAT slaves.

Public authored definition for a simulated EtherCAT slave.

Stable machine-readable simulator runtime status.

Public raw transport surface for EtherCAT.Simulator.

Runtime boundary for one physical slave.

Declarative configuration for one slave in physical bus order.

EtherCAT Slave Controller (ESC) register map.

SII EEPROM interface for EtherCAT slaves.

CANopen over EtherCAT (CoE) mailbox protocol.

Current protocol/runtime status for one configured EtherCAT slave.

Helpers for common CoE application sync-mode objects.

Declarative per-slave sync and latch configuration.

Public description for one configured slave.

Telemetry integration for the EtherCAT stack.

Mix Tasks

Boot an interactive PREOP capture session against a live EtherCAT ring.