EtherNetIPDevice#

Bases: Instrument

EtherNet/IP device with config-driven tag access.

Initialize an Instrument.

Parameters:

name

Channel-name prefix for published data.
publishers

Publishers that receive emitted Measurement/Command data.
background_config

Background-daemon settings; default if omitted.
legacy_naming

When True, publish channels under their pre-v1.0 names (e.g. main.ch1_v instead of main.ch1.voltage for PSU) for dashboards or recorded datasets keyed on those names. The setting is all-or-nothing per instrument. PSU, ELoad, I2C, InstroScope, and DAQ digital channels honor the flag; the categories with no v1.0 rename (DMM, Modbus, DAQ analog and relay channels) ignore it. Scheduled for removal in v2.0.
**kwargs

Default tags applied to every emitted Measurement or Command. Pass dataset_rid="<rid>" to auto-create a NominalCorePublisher (uses the on-disk ‘default’ Nominal credential).

Attributes

`address`	EtherNet/IP endpoint address.
`background_interval`	Seconds between background daemon iterations (0 = no wait).
`channel_names`	Return an insertion-ordered snapshot of all published channel names.

Methods

`add_background_daemon_function`	Append `method` to the daemon's call list.
`add_publisher`	Register a publisher to receive this instrument's Measurement/Command data.
`close`	Close the EtherNet/IP session and stop background polling.
`define_background_daemon`	Replace all daemon functions with a single `method` (called with the given args).
`get_channel`	Return the most recent `length` samples for `channel_name` from the in-memory buffer.
`get_single_channel_value`	Return the most recent sample for `channel_name` from the in-memory buffer.
`open`	Open the EtherNet/IP session.
`publish`	Fan `data` out to every configured publisher; `kwargs` pass through.
`read`	Read one configured tag by alias and publish the result.
`read_tag`	Read one configured tag by alias and publish the result.
`start`	Start background polling for poll-enabled EtherNet/IP tags.
`stop`	Signal the background daemon to stop and join it.
`write`	Write one configured tag by alias and publish the command.
`write_tag`	Write one configured tag by alias and publish the command.

property background_interval#: Seconds between background daemon iterations (0 = no wait).

start() → None[source]#: Start background polling for poll-enabled EtherNet/IP tags.

property address: str#: EtherNet/IP endpoint address.

open() → None[source]#: Open the EtherNet/IP session.

close() → None[source]#: Close the EtherNet/IP session and stop background polling.

read_tag(

alias: str,

**kwargs,

) → Measurement[source]#: Read one configured tag by alias and publish the result.

read(

alias: str,

**kwargs,

) → Measurement[source]#: Read one configured tag by alias and publish the result.

write_tag(

alias: str,

value: bool | int | float,

**kwargs,

) → Command[source]#: Write one configured tag by alias and publish the command.

write(

alias: str,

value: bool | int | float,

**kwargs,

) → Command[source]#: Write one configured tag by alias and publish the command.

add_background_daemon_function(

method: Callable,

*args,

**kwargs,

)#: Append method to the daemon’s call list. Use define_background_daemon to replace instead.

add_publisher( publisher: Publisher, )#: Register a publisher to receive this instrument’s Measurement/Command data.

property channel_names: tuple[str, ...]#

Return an insertion-ordered snapshot of all published channel names.

Names are complete after one full daemon iteration: {name}.loop_time publishes every iteration, so call get_channel(“loop_time”, wait_for_new_samples=True) then read channel_names to ensure the complete set has arrived.

Raises:: RuntimeError – No background buffer; start() was not called.

define_background_daemon(

method: Callable,

*args,

**kwargs,

)#: Replace all daemon functions with a single method (called with the given args).

get_channel( channel_name: str, length: int = 1, wait_for_new_samples: bool = False, timeout: float = 10.0, ) → Measurement#

Return the most recent length samples for channel_name from the in-memory buffer.

If the channel does not exist yet, or no sample is available, the code will always block until timeout expires.

Parameters:

channel_name

Name of the channel to retrieve.
length

Number of trailing samples to return.
wait_for_new_samples

Block until at least length new values arrive.
timeout

Seconds to wait when insufficient data exists or wait_for_new_samples=True.

Raises:

RuntimeError – No background buffer; start() was not called.
ChannelNotFoundError – channel had no values and no data appeared before timeout. wait_for_new_samples=True and channel did not appear within timeout.
ChannelValueTimeoutError – wait_for_new_samples=True and values did not arrive within timeout.

get_single_channel_value( channel_name: str, ) → float | str | None#

Return the most recent sample for channel_name from the in-memory buffer.

This will not wait, if data is not available then None is returned.

Parameters:

channel_name

Name of the channel to retrieve.

Raises:

RuntimeError – No background buffer; start() was not called.

publish(

data: Measurement | Command,

**kwargs,

)#: Fan data out to every configured publisher; kwargs pass through.

stop()#: Signal the background daemon to stop and join it. No-op if not running.