circuit_read_contents

class CircuitReadContentsMixin

(Implicitly inherits ControlBehaviorMixin)

Enables the Entity to read it’s contents.

See also

CircuitReadHandMixin

CircuitReadResourceMixin

property read_contents: bool

Whether or not this Entity is set to read it’s contents to a circuit network.

Getter:

Gets the value of read_contents, or None if not set.

Setter:

Sets the value of read_contents.

Type:

bool

Raises:

TypeError – If set to anything other than a bool or None.

property read_mode: ReadMode

The mode in which the contents of the Entity should be read. Either ReadMode.PULSE or ReadMode.HOLD.

Getter:

Gets the value of read_mode, or None if not set.

Setter:

Sets the value of read_mode.

Type:

ReadMode

Raises:

ValueError – If set to anything other than a ReadMode value or their int equivalent.