Can

SCPI Commands :

TRIGger:SBHW:CAN:TYPE
TRIGger:SBHW:CAN:FTYPe
TRIGger:SBHW:CAN:ITYPe
TRIGger:SBHW:CAN:ICONdition
TRIGger:SBHW:CAN:IMIN
TRIGger:SBHW:CAN:IMAX
TRIGger:SBHW:CAN:DCONdition
TRIGger:SBHW:CAN:DMIN
TRIGger:SBHW:CAN:BORDer
TRIGger:SBHW:CAN:CRCerror
TRIGger:SBHW:CAN:BITSterror
TRIGger:SBHW:CAN:FORMerror
TRIGger:SBHW:CAN:ACKerror
TRIGger:SBHW:CAN:DLC
TRIGger:SBHW:CAN:DLCCondition
Commands in total: 29
Subgroups: 2
Direct child commands: 15
get_ack_error() → bool[source]
# TRIGger:SBHW:CAN:ACKerror
value: bool = driver.trigger.sbhw.can.get_ack_error()

Triggers when the transmitter does not receive an acknowledgment - a dominant bit during the ACK Slot. Available, if method RsMxo.trigger.sbhw.can.type_py() is set to ERRC.

Returns:

ack_error: OFF | ON

get_bitst_error() → bool[source]
# TRIGger:SBHW:CAN:BITSterror
value: bool = driver.trigger.sbhw.can.get_bitst_error()

Triggers if a stuff error occurs - when the 6th consecutive equal bit level in the mentioned fields is detected. Available, if method RsMxo.trigger.sbhw.can.type_py() is set to ERRC.

Returns:

bit_stuff_error: OFF | ON

get_border() → Endianness[source]
# TRIGger:SBHW:CAN:BORDer
value: enums.Endianness = driver.trigger.sbhw.can.get_border()

Sets the byte order (endianness) of the data transfer. Only for CAN protocol.

Returns:

endianness: BENDian | LENDian

  • BENDian: Big endian, data is analyzed and evaluated in the order of reception.

  • LENDian: Little endian, the instrument reads the complete data, reverses the byte order of the data, and compares it with the specified data word.

get_crc_error() → bool[source]
# TRIGger:SBHW:CAN:CRCerror
value: bool = driver.trigger.sbhw.can.get_crc_error()

Triggers on CRC errors. A CRC error occurs when the CRC calculated by the receiver differs from the received value in the CRC sequence. Available, if method RsMxo.trigger.sbhw.can.type_py() is set to ERRC.

Returns:

checksum_error: OFF | ON

get_dcondition() → OperatorB[source]
# TRIGger:SBHW:CAN:DCONdition
value: enums.OperatorB = driver.trigger.sbhw.can.get_dcondition()

Sets the operator to set a specific data pattern or a data pattern range.

Returns:

data_operator: EQUal | NEQual | LTHan | LETHan | GTHan | GETHan

  • EQUal | NEQual | LTHan | LETHan | GTHan | GETHan: Equal, not equal, less than, less or equal than, greater than, greater or equal than. These conditions require one data pattern to be set with TRIGger:SBHW:CAN:DMIN.

get_dlc() → int[source]
# TRIGger:SBHW:CAN:DLC
value: int = driver.trigger.sbhw.can.get_dlc()

Sets the data length code, the number of data bytes to be found. For complete definition, set also the operator with method RsMxo.trigger.sbhw.can.dlc_condition() .

Returns:

dlc: CAN: 1 to 8, CAN FD: 1 to 15 (64 bytes)

get_dlc_condition() → OperatorB[source]
# TRIGger:SBHW:CAN:DLCCondition
value: enums.OperatorB = driver.trigger.sbhw.can.get_dlc_condition()

Operator to set the data length code. The number of data bytes to be found is set with method RsMxo.trigger.sbhw.can.dlc() .

Returns:

dlc_operator: For little endian transfer direction, EQUal must be set.

get_dmin() → List[int][source]
# TRIGger:SBHW:CAN:DMIN
value: List[int] = driver.trigger.sbhw.can.get_dmin()

Sets a data pattern, or sets the start value of a data pattern range.

Returns:

data_pattern: List of comma-separated values

get_form_error() → bool[source]
# TRIGger:SBHW:CAN:FORMerror
value: bool = driver.trigger.sbhw.can.get_form_error()

Triggers when a fixed-form bit field contains one or more illegal bits. Available, if method RsMxo.trigger.sbhw.can.type_py() is set to ERRC.

Returns:

form_error: OFF | ON

get_ftype() → SbusCanFrameType[source]
# TRIGger:SBHW:CAN:FTYPe
value: enums.SbusCanFrameType = driver.trigger.sbhw.can.get_ftype()

Sets the CAN frame type.

Returns:

frame_type: CBFF: classical base frame format data CBFR: classical base frame format remote CEFF: classical extended frame format data CEFR: classical extended frame format remote FBFF: FD base frame format FEFF: FD extended frame format XLFF: XL frame format ERR: error OVLD: overload

get_icondition() → OperatorB[source]
# TRIGger:SBHW:CAN:ICONdition
value: enums.OperatorB = driver.trigger.sbhw.can.get_icondition()

Sets the operator to set a specific identifier or an identifier range.

Returns:

id_operator: EQUal | NEQual | LTHan | LETHan | GTHan | GETHan | INRange | OORange

  • EQUal | NEQual | LTHan | LETHan | GTHan | GETHan: Equal, not equal, less than, less or equal than, greater than, greater or equal than. These conditions require one identifier pattern to be set with TRIGger:SBHW:CAN:IMIN.

  • INRange | OORange: In range / out of range: Set the minimum and maximum value of the range with TRIGger:SBHW:CAN:IMIN and TRIGger:SBHW:CAN:IMAX.

get_imax() → List[int][source]
# TRIGger:SBHW:CAN:IMAX
value: List[int] = driver.trigger.sbhw.can.get_imax()

Sets the end value of an identifier range if method RsMxo.trigger.sbhw.can.icondition() is set to INRange or OORange.

Returns:

id_pattern: List of comma-separated values

get_imin() → List[int][source]
# TRIGger:SBHW:CAN:IMIN
value: List[int] = driver.trigger.sbhw.can.get_imin()

Specifies a message identifier pattern, or sets the start value of an identifier range.

get_itype() → SbusCanIdentifierType[source]
# TRIGger:SBHW:CAN:ITYPe
value: enums.SbusCanIdentifierType = driver.trigger.sbhw.can.get_itype()

Selects the format of data and remote frames. Remote frames are not available in the CAN FD protocol.

Returns:

identifier_type: B11 | B29

  • B11: 11-bit identifier (standard format) . The instrument triggers on the sample point of the IDE bit.

  • B29: 29-bit identifier (extended format) . The instrument triggers on the sample point of the RTR bit.

get_type_py() → SbusCanTriggerType[source]
# TRIGger:SBHW:CAN:TYPE
value: enums.SbusCanTriggerType = driver.trigger.sbhw.can.get_type_py()

Selects the trigger type for CAN analysis.

Returns:

type_py: STOF | EDOF | FTYP | ID | IDDT | ERRC

  • STOF: STart of Frame: triggers on the first edge of the dominant SOF bit (synchronization bit) .

  • FTYP: Frame type: triggers on a specified frame type and on the identifier format.

  • ID: Identifier: Sets the trigger to one specific identifier or an identifier range.To set the identifier, use TRIGger:SBHW:CAN:ICONdition, TRIGger:SBHW:CAN:IMAX, and TRIGger:SBHW:CAN:IMIN.

  • IDDT: Identifier and data: Combination of identifier and data conditions. To set the identifier condition, use TRIGger:SBHW:CAN:ICONdition, TRIGger:SBHW:CAN:IMIN, and TRIGger:SBHW:CAN:IMAX.To set the data condition, use TRIGger:SBHW:CAN:DCONdition and TRIGger:SBHW:CAN:DMIN.

  • ERRC: Error condition: Define the error types with:TRIGger:SBHW:CAN:ACKerrorTRIGger:SBHW:CAN:BITSterrorTRIGger:SBHW:CAN:CRCerrorTRIGger:SBHW:CAN:FORMerrorTRIGger:SBHW:CAN:FDATa:SCERror

set_ack_error(ack_error: bool) → None[source]
# TRIGger:SBHW:CAN:ACKerror
driver.trigger.sbhw.can.set_ack_error(ack_error = False)

Triggers when the transmitter does not receive an acknowledgment - a dominant bit during the ACK Slot. Available, if method RsMxo.trigger.sbhw.can.type_py() is set to ERRC.

Parameters:

ack_error – OFF | ON

set_bitst_error(bit_stuff_error: bool) → None[source]
# TRIGger:SBHW:CAN:BITSterror
driver.trigger.sbhw.can.set_bitst_error(bit_stuff_error = False)

Triggers if a stuff error occurs - when the 6th consecutive equal bit level in the mentioned fields is detected. Available, if method RsMxo.trigger.sbhw.can.type_py() is set to ERRC.

Parameters:

bit_stuff_error – OFF | ON

set_border(endianness: Endianness) → None[source]
# TRIGger:SBHW:CAN:BORDer
driver.trigger.sbhw.can.set_border(endianness = enums.Endianness.BENDian)

Sets the byte order (endianness) of the data transfer. Only for CAN protocol.

Parameters:

endianness –

BENDian | LENDian

  • BENDian: Big endian, data is analyzed and evaluated in the order of reception.

  • LENDian: Little endian, the instrument reads the complete data, reverses the byte order of the data, and compares it with the specified data word.

set_crc_error(checksum_error: bool) → None[source]
# TRIGger:SBHW:CAN:CRCerror
driver.trigger.sbhw.can.set_crc_error(checksum_error = False)

Triggers on CRC errors. A CRC error occurs when the CRC calculated by the receiver differs from the received value in the CRC sequence. Available, if method RsMxo.trigger.sbhw.can.type_py() is set to ERRC.

Parameters:

checksum_error – OFF | ON

set_dcondition(data_operator: OperatorB) → None[source]
# TRIGger:SBHW:CAN:DCONdition
driver.trigger.sbhw.can.set_dcondition(data_operator = enums.OperatorB.EQUal)

Sets the operator to set a specific data pattern or a data pattern range.

Parameters:

data_operator –

EQUal | NEQual | LTHan | LETHan | GTHan | GETHan

  • EQUal | NEQual | LTHan | LETHan | GTHan | GETHan: Equal, not equal, less than, less or equal than, greater than, greater or equal than. These conditions require one data pattern to be set with TRIGger:SBHW:CAN:DMIN.

set_dlc(dlc: int) → None[source]
# TRIGger:SBHW:CAN:DLC
driver.trigger.sbhw.can.set_dlc(dlc = 1)

Sets the data length code, the number of data bytes to be found. For complete definition, set also the operator with method RsMxo.trigger.sbhw.can.dlc_condition() .

Parameters:

dlc – CAN: 1 to 8, CAN FD: 1 to 15 (64 bytes)

set_dlc_condition(dlc_operator: OperatorB) → None[source]
# TRIGger:SBHW:CAN:DLCCondition
driver.trigger.sbhw.can.set_dlc_condition(dlc_operator = enums.OperatorB.EQUal)

Operator to set the data length code. The number of data bytes to be found is set with method RsMxo.trigger.sbhw.can.dlc() .

Parameters:

dlc_operator – For little endian transfer direction, EQUal must be set.

set_dmin(data_pattern: List[int]) → None[source]
# TRIGger:SBHW:CAN:DMIN
driver.trigger.sbhw.can.set_dmin(data_pattern = [1, 2, 3])

Sets a data pattern, or sets the start value of a data pattern range.

Parameters:

data_pattern – List of comma-separated values

set_form_error(form_error: bool) → None[source]
# TRIGger:SBHW:CAN:FORMerror
driver.trigger.sbhw.can.set_form_error(form_error = False)

Triggers when a fixed-form bit field contains one or more illegal bits. Available, if method RsMxo.trigger.sbhw.can.type_py() is set to ERRC.

Parameters:

form_error – OFF | ON

set_ftype(frame_type: SbusCanFrameType) → None[source]
# TRIGger:SBHW:CAN:FTYPe
driver.trigger.sbhw.can.set_ftype(frame_type = enums.SbusCanFrameType.CBFF)

Sets the CAN frame type.

Parameters:

frame_type – CBFF: classical base frame format data CBFR: classical base frame format remote CEFF: classical extended frame format data CEFR: classical extended frame format remote FBFF: FD base frame format FEFF: FD extended frame format XLFF: XL frame format ERR: error OVLD: overload

set_icondition(id_operator: OperatorB) → None[source]
# TRIGger:SBHW:CAN:ICONdition
driver.trigger.sbhw.can.set_icondition(id_operator = enums.OperatorB.EQUal)

Sets the operator to set a specific identifier or an identifier range.

Parameters:

id_operator –

EQUal | NEQual | LTHan | LETHan | GTHan | GETHan | INRange | OORange

  • EQUal | NEQual | LTHan | LETHan | GTHan | GETHan: Equal, not equal, less than, less or equal than, greater than, greater or equal than. These conditions require one identifier pattern to be set with TRIGger:SBHW:CAN:IMIN.

  • INRange | OORange: In range / out of range: Set the minimum and maximum value of the range with TRIGger:SBHW:CAN:IMIN and TRIGger:SBHW:CAN:IMAX.

set_imax(id_pattern: List[int]) → None[source]
# TRIGger:SBHW:CAN:IMAX
driver.trigger.sbhw.can.set_imax(id_pattern = [1, 2, 3])

Sets the end value of an identifier range if method RsMxo.trigger.sbhw.can.icondition() is set to INRange or OORange.

Parameters:

id_pattern – List of comma-separated values

set_imin(id_pattern: List[int]) → None[source]
# TRIGger:SBHW:CAN:IMIN
driver.trigger.sbhw.can.set_imin(id_pattern = [1, 2, 3])

Specifies a message identifier pattern, or sets the start value of an identifier range.

set_itype(identifier_type: SbusCanIdentifierType) → None[source]
# TRIGger:SBHW:CAN:ITYPe
driver.trigger.sbhw.can.set_itype(identifier_type = enums.SbusCanIdentifierType.B11)

Selects the format of data and remote frames. Remote frames are not available in the CAN FD protocol.

Parameters:

identifier_type –

B11 | B29

  • B11: 11-bit identifier (standard format) . The instrument triggers on the sample point of the IDE bit.

  • B29: 29-bit identifier (extended format) . The instrument triggers on the sample point of the RTR bit.

set_type_py(type_py: SbusCanTriggerType) → None[source]
# TRIGger:SBHW:CAN:TYPE
driver.trigger.sbhw.can.set_type_py(type_py = enums.SbusCanTriggerType.EDOF)

Selects the trigger type for CAN analysis.

Parameters:

type_py –

STOF | EDOF | FTYP | ID | IDDT | ERRC

  • STOF: STart of Frame: triggers on the first edge of the dominant SOF bit (synchronization bit) .

  • FTYP: Frame type: triggers on a specified frame type and on the identifier format.

  • ID: Identifier: Sets the trigger to one specific identifier or an identifier range.To set the identifier, use TRIGger:SBHW:CAN:ICONdition, TRIGger:SBHW:CAN:IMAX, and TRIGger:SBHW:CAN:IMIN.

  • IDDT: Identifier and data: Combination of identifier and data conditions. To set the identifier condition, use TRIGger:SBHW:CAN:ICONdition, TRIGger:SBHW:CAN:IMIN, and TRIGger:SBHW:CAN:IMAX.To set the data condition, use TRIGger:SBHW:CAN:DCONdition and TRIGger:SBHW:CAN:DMIN.

  • ERRC: Error condition: Define the error types with:TRIGger:SBHW:CAN:ACKerrorTRIGger:SBHW:CAN:BITSterrorTRIGger:SBHW:CAN:CRCerrorTRIGger:SBHW:CAN:FORMerrorTRIGger:SBHW:CAN:FDATa:SCERror

Cloning the Group

# Create a copy of the original group, that exists independently
can_copy = driver.trigger.sbhw.can.clone()

Subgroups