CAPLfunctionJ1939ILManipulateMessage

J1939ILManipulateMessage

Valid for: CANoe DE • CANoe4SW DE

Function Syntax

long J1939ILManipulateMessage( dword pgn, dword destinationAddress, qword filterMask, qword filterValue, qword dataMask, qword dataValue ); // form 1
long J1939ILManipulateMessage( dbNode node, dword pgn, dword destinationAddress, qword filterMask, qword filterValue, qword dataMask, qword dataValue ); // form 2

Description

Modifies the content of a message generated and sent by the interaction layer. The message to manipulate is specified by PGN, destination address and a part of the first eight data bytes.

Note: This function should only be used for messages whose contents cannot be changed via the contained signals.

To revert this command you can use J1939ILResetManipulatedMessage or J1939ILResetAllManipulatedMessages.

Parameters

• pgn: The message with this PGN shall be modified.
• destinationAddress:
  • 0 - 255: The message which is sent to this address shall be modified.
  • 0xFFFFFFFF (-1): The destination address of the message doesn’t matter
• filterMask: Defines the bits of the message which shall be used to identify the message.
• filterValue: Defines the value of the bits of the message which shall be used to identify the message. If the value of the masked bits of a sent message is equal to this value then the data of the message is modified.
• dataMask: Defines the bits of the message data which are modified.
• dataValue: Defines the value of the bits of the message which are modified.
• node: Simulation node to apply the function.

Return Values

• 0: Manipulation is set successfully
• -102: An invalid parameter is used

Example

on key 'a'
{
  QWORD filterMask, filterValue, dataMask, dataValue;

  // Manipulate some messages

  // 1. Manipulate ECUtoVT GetMemory message (VT Function = 0xC0):
  //    'Required memory' (bytes 3 to 5) should be set to 7654 bytes (0x001DE6) instead of 1676 bytes (0x00068C)

  // The filterMask should therefore use Byte 1 (contains 'VT function')
  // and Bytes 3 to 5 (contains 'Required Memory').
  filterMask  = 0x000000FFFFFF00FFll;
  // The filterValue contains the value 'GetMemory'(0xC0)
  // and the memory to be changed (0x00068C) at the corresponding positions.
  filterValue = 0x00000000068C00C0ll;
  // We only change the RequiredMemory value. VT function should not be changed.
  // Therefore, the dataMask contains only the bits that contain the value of'RequiredMemory'.
  dataMask    = 0x000000FFFFFF0000ll;
  // And dataValue contains only the new value (0x001DE6) of the 'RequiredMemory'.
  dataValue   = 0x000000001DE60000ll;
  ISO11783IL_ManipulateMessage(0xE700 /*ECUtoVT*/, 0x26 /*destinationAddress*/,
  filterMask, filterValue, dataMask, dataValue);

  // 2. Manipulate ECUtoVT Working Set Maintenance message (VT Function = 0xFF):

  // The filterMask should therefore use Byte 1 (contains 'VT function')
  // and Bytes 3(contains 'Version Number').
  filterMask  = 0x0000000000FF00FFll;
  // The filterValue contains the value 'Working Set Maintenance'(0xFF)
  // and the version to be changed (0x4) at the corresponding positions.
  filterValue = 0x00000000000400FFll;
  // We only change the 'Version Number' value. VT function should not be changed.
  // Therefore, the dataMask contains only the bits that contain the value of'Version Number'.
  dataMask    = 0x0000000000FF0000ll;
  // And dataValue contains only the new value (0x001DE6) of the 'RequiredMemory'.
  dataValue   = 0x0000000000050000ll;
  ISO11783IL_ManipulateMessage(0xE700 /*ECUtoVT*/, 0x26 /*destinationAddress*/,
                               filterMask, filterValue, dataMask, dataValue);
}

on key 'b'
{
  QWORD filterMask, filterValue, dataMask, dataValue;

  // Stop the manipulation configured in the previous function

  // 1. Reset the manipulation of ECUtoVT GetMemory message (VT Function = 0xC0)
  //    where the Required memory (bytes 3 to 5) is equal to 1676 bytes (0x00068C)

  // The filterMask should therefore use Byte 1 (contains 'VT function')
  // and Bytes 3 to 5 (contains 'Required Memory').
  filterMask  = 0x000000FFFFFF00FFll;
  // The filterValue contains the value 'GetMemory'(0xC0)
  // and the memory to be changed (0x00068C) at the corresponding positions.
  filterValue = 0x00000000068C00C0ll;
  ISO11783IL_ResetManipulatedMessage(0xE700 /*ECUtoVT*/, 0x26 /*destinationAddress*/, filterMask, filterValue);

  // 2. Reset the manipulating of ECUtoVT Working Set Maintenance message (VT Function = 0xFF)

  // The filterMask should therefore use Byte 1 (contains 'VT function')
  // and Bytes 3(contains 'Version Number').
  filterMask  = 0x0000000000FF00FFll;
  // The filterValue contains the value 'Working Set Maintenance'(0xFF)
  // and the version to be changed (0x4) at the corresponding positions.
  filterValue = 0x00000000000400FFll;
  ISO11783IL_ResetManipulatedMessage(0xE700 /*ECUtoVT*/, 0x26 /*destinationAddress*/, filterMask, filterValue);
}