Skip to main content

Structure Definitions (CAN)

This section describes CAN-related structure definitions for this product.

Main APIs​

Definition List​

Type NameDescription
StMPXCANParamCAN parameter setting information
StMPXCANLogLog information for CAN log acquisition API
StMPXCANFrameOptionCAN frame option information
StMPXCANFrameTypeCAN frame attribute information
StMPXCANIDCAN ID information
StMPXCANFrameCAN frame information
StMPXCANSlotCAN slot information
StMPXCANDirectCAN direct transmission information

Definition Details​

StMPXCANParam​

Members of StMPXCANParam (CAN parameter setting information) are as follows.

VariableTypeDescriptionNotes
EnableTerminateuint8_tTermination resistor enable/disableSee CAN Termination Resistor.
Modeuint8_tOperation modeSee CAN Operation Mode.
ArbitrationBaudrateuint8_tArbitration baudrateSee CAN Arbitration Baudrate.
ArbitrationSamplepointuint8_tArbitration sample pointSee CAN Sample Point.
DataBaudrateuint8_tData baudrateSee CAN Data Baudrate.
DataSamplepointuint8_tData sample pointSee CAN Sample Point.
Reserveduint8_t [2]Reserved 
tip

Available sample points depend on the combination of arbitration baudrate and data baudrate.
For details, see Baudrate and Sample Point Settings.

StMPXCANLog​

Members of StMPXCANLog (log information for CAN log acquisition API) are as follows.

VariableTypeDescriptionNotes
mSecuint32_tTimestamp (milliseconds)Timestamp is represented by combining mSec and uSec.
For example, for 12.345 ms (12 ms + 345 us), mSec is 12 and uSec is 345.
uSecuint16_tTimestamp (microseconds)
Protocoluint8_tProtocolSee Log Type.
Diruint8_tDirectionSee Log Direction.
IDuint32_tCAN ID (standard or extended)For standard ID, set in lower 11 bits (bit10 to bit0).
RTRuint8_tRemote Transmission Request (RTR)See CAN RTR.
IDEuint8_tID format (IDE)See CAN ID Format.
DLuint8_tData length (DL)
Erroruint8_tError flagSee CAN Error Flag.
ErrorInfouint32_tError informationSee CAN Error Information.
Datauint8_t [64]DataElement indices 0 to 63 correspond to D1 to D64.

StMPXCANFrameOption​

Members of StMPXCANFrameOption (CAN frame option information) are as follows.

VariableTypeDescriptionNotes
Protocoluint8_tProtocolSee CAN Protocol.
BRSuint8_tBit Rate Switch (BRS)See CAN Bit Rate Switch.
ErrorActionuint8_tError behaviorSee CAN Error Behavior.
Reserveduint8_tReserved

StMPXCANFrameType​

Members of StMPXCANFrameType (CAN frame attribute information) are as follows.

VariableTypeDescriptionNotes
isOneShotuint8_tOne-shot transmission enable/disableSee CAN One-shot Transmission.
FrameTypeuint8_tFrame typeSee CAN Frame Type.
Enableduint8_tSlot enable/disableSee CAN Slot Enable/Disable.
Reserveduint8_tReserved 
OptionStMPXCANFrameOptionCAN frame option information 

StMPXCANID​

Members of StMPXCANID (CAN ID information) are as follows.

VariableTypeDescriptionNotes
IDuint32_tCAN ID (standard or extended)For standard ID, set lower 11 bits (bit10 to bit0).
RTRuint8_tRemote Transmission Request (RTR)See CAN RTR.
IDEuint8_tID format (IDE)See CAN ID Format.
Reserveduint8_t [2]Reserved 

StMPXCANFrame​

Members of StMPXCANFrame (CAN frame information) are as follows.

VariableTypeDescriptionNotes
IDStMPXCANIDCAN ID information 
DLuint8_tData length (DL)Available values are 0 to 8, 12, 16, 20, 24, 32, 48, and 64.
Reserveduint8_t [3]Reserved 
Datauint8_t [64]Data (D1 to D64)Element indices 0 to 63 correspond to D1 to D64.

StMPXCANSlot​

Members of StMPXCANSlot (slot information) are as follows.

VariableTypeDescriptionNotes
SlotNouint8_tSlot number (1 to 28)
TriggerTypeuint8_tTransmission trigger typeSee CAN Transmission Trigger Type.
Reserved1uint8_t [2]Reserved
FrameTypeStMPXCANFrameTypeCAN frame attribute information
TriggerIDStMPXCANIDReception trigger ID
msSendDelayuint32_tDelay for event transmission (ms)Delay for event transmission, transmit offset, transmit cycle, and minimum guaranteed transmit interval are represented as follows.
[Delay for event transmission] msSendDelay, usSendDelay
[Transmit offset] msSendOffset, usSendOffset
[Transmit cycle] msSendCycle, usSendCycle
[Minimum guaranteed transmit interval] msMinTransInterval, usMinTransInterval
For example, to set transmit offset to 12.345 ms (12 ms + 345 us), set msSendOffset=12 and usSendOffset=345.
msSendOffsetuint32_tTransmit offset (ms)
msSendCycleuint32_tTransmit cycle (ms)
msMinTransIntervaluint32_tMinimum guaranteed transmit interval (ms)
usSendDelayuint16_tDelay for event transmission (us)
usSendOffsetuint16_tTransmit offset (us)
usSendCycleuint16_tTransmit cycle (us)
usMinTransIntervaluint16_tMinimum guaranteed transmit interval (us)
SendCounteruint16_tTransmission countIf set to 0, transmission count is unlimited.
Reserved2uint8_t [2]Reserved
FrameStMPXCANFrameCAN frame information
Incrementuint8_t [64]Increment enabled/disabledElement indices 0 to 63 correspond to D1 to D64.
See CAN Increment Enable/Disable.

StMPXCANDirect​

Members of StMPXCANDirect (CAN direct transmission information) are as follows.

VariableTypeDescription
FrameTypeStMPXCANFrameTypeCAN frame attribute information
FrameStMPXCANFrameCAN frame information