State

SCPI Command :

BUS<*>:I3C:FRAMe<*>:FLD<*>:STATe
Commands in total: 1
Subgroups: 0
Direct child commands: 1
get(bus=Bus.Default, busFrameNull=BusFrameNull.Default, busFieldNull=BusFieldNull.Default) → I3cFrameState[source]
# BUS<*>:I3C:FRAMe<*>:FLD<*>:STATe
value: enums.I3cFrameState = driver.bus.i3C.frame.fld.state.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)

Returns the overall state of the specified field for the selected frame.

Parameters:

  • bus – optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Bus’)

  • busFrameNull – optional repeated capability selector. Default value: Nr0 (settable in the interface ‘Frame’)

  • busFieldNull – optional repeated capability selector. Default value: Nr0 (settable in the interface ‘Fld’)

Returns:

state: OK | ACK | PAR | CRC | LENGth | UNKNown | INComplete

  • OK: The field has no error, it is valid.

  • ACK: Wrong acknowledgment (ACK) delimiter occurred.

  • PAR: Wrong parity detected.

  • CRC: Cyclic redundancy check failed.

  • LENGth: Wrong length of the field.

  • UNKNown: Unknown field type detected.

  • INComplete: The field is not completely contained in the acquisition. The acquired part of the field is usually valid, but cannot always be trusted.