circuit_read_contents
- class CircuitReadContentsMixin
(Implicitly inherits
ControlBehaviorMixin
)Enables the Entity to read it’s contents.
- 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
, orNone
if not set.- Setter:
Sets the value of
read_contents
.- Type:
bool
- Raises:
TypeError – If set to anything other than a
bool
orNone
.
- property read_mode: ReadMode
The mode in which the contents of the Entity should be read. Either
ReadMode.PULSE
orReadMode.HOLD
.- Getter:
Gets the value of
read_mode
, orNone
if not set.- Setter:
Sets the value of
read_mode
.- Type:
- Raises:
ValueError – If set to anything other than a
ReadMode
value or theirint
equivalent.