EtherCAT.SlaveDescription (ethercat v0.5.0)

Copy Markdown View Source

Public description for one configured slave.

Descriptions contain configuration and static signal metadata. Use EtherCAT.status/2 for runtime status and EtherCAT.samples/2 for observations.

Summary

Types

native_description()
t()

Functions

native_description(driver, config)

Types

native_description()

@type native_description() :: %{
  device_type: atom() | nil,
  endpoints: [EtherCAT.Endpoint.t()]
}

t()

@type t() :: %EtherCAT.SlaveDescription{
  device_type: atom() | nil,
  driver: module(),
  endpoints: [EtherCAT.Endpoint.t()],
  name: atom(),
  target_state: :preop | :op
}

Functions

native_description(driver, config)

@spec native_description(module(), EtherCAT.Driver.config()) :: native_description()