ISO11783 Virtual Terminal Interaction Layer
(Only available with ISO11783!) Valid for: CANoe DE • CANoe4SW DE To use the CAPL functions the ISO11783_VT_IL.dll i.e. Virtual Terminal Interaction Layer (VT IL) must be included. ON THIS PAGE:- Callback Functions
- DTC Support
- Node Control
- Other Functions
- Signal/Message Access
- VT - Fault Injection for Messages
- VT - Fault Injection for Transport Protocols
- VT - Handling
- VT - Handling (User-Layout Mask)
- VT - Other Functions
- VT - Value Request
Callback Functions
| Functions | Short Description |
|---|---|
| VTIL_OnAddressClaimConflict | Is called if an address conflict is detected. |
| VTIL_OnAddressViolation | Is called if an address violation is detected. |
| VTIL_OnCA | Is called from the IL when a Command Address message is received. |
| VTIL_OnChangedState | Is called if the IL has changed its state. |
| VTIL_OnError | Is called if an error has occurred. |
| VTIL_OnRequest | Is called if a request (0xEA00) is received. |
| VTIL_OnRxMessage | Is called from the IL if the IL receives the parameter group, namely before the parameter group is processed by the IL. |
| VTIL_OnTxMessage | Is called if a message was sent successfully. |
| VTIL_OnTxPrepare | Is called before a parameter group is sent. |
DTC Support
| Functions | Short Description |
|---|---|
| VTIL_ActivateDiagnosticsSupport | Activates or deactivates the support of ISO11783 diagnostics by the IL. |
| VTIL_ActivateDTC | Activates a diagnostics trouble code (DTC) and add it to the list of active DTCs. |
| VTIL_ClearAllDTCs | Clears the list of active DTCs as well as the list of previously active DTCs. |
| VTIL_DeactivateDTC | Deactivates a diagnostics trouble code (DTC) and removes it from the list of active DTCs. |
| VTIL_GetDTCStatus | Returns the current occurrence count of a diagnostics trouble code (DTC). |
Node Control
| Functions | Short Description |
|---|---|
| VTIL_AcceptRxPG | Checks if the received parameter group is addressed to the ISO11783 IL. |
| VTIL_ControlInit | Suppress the auto-start function of the IL. |
| VTIL_ControlStart | Activate node to start Address Claiming. |
| VTIL_ControlStop | Deactivates the IL and stops sending cyclic messages. |
| VTIL_EnableAddressViolationDetection | Activates detection of address violations by other nodes. |
| VTIL_EnableNameManagement | This function activates the name management of a node. |
| VTIL_GetAddress | Returns the address that is used by the VT IL. |
| VTIL_GetState | Returns the current state of the VT IL. |
| VTIL_SetNodeProperty | Changes an internal property of the node. |
| VTIL_GetDeviceName | Gets the NAME as reported on the bus. |
Other Functions
| Functions | Short Description |
|---|---|
| VTIL_GetLastError | Returns the value of the last called VT IL function. |
| VTIL_GetLastErrorText | Returns the textual description of the value of the last called VT IL function. |
| VTIL_SetVerbosity | Set verbosity for writing in Write Window. |
Signal/Message Access
| Functions | Short Description |
|---|---|
| VTIL_SetMsgEvent | Sends a message immediately. |
| VTIL_SetMsgRawData | Sets the data bytes of the message. |
| VTIL_SetSignal | Sets the physical value of a signal. |
| VTIL_SetSignalRaw | Sets the raw value of a signal. |
VT – Fault Injection for Messages
| Functions | Short Description |
|---|---|
| VTIL_BlockRxMessage | Prevents processing of a received message by the Interaction Layer. |
| VTIL_BlockTxMessage | Prevents transmitting of a message generated by the interaction layer. |
| VTIL_DelayRxMessage | Delays processing of a received message by the interaction layer. |
| VTIL_ManipulateMessage | Modifies the content of a message generated and sent by the interaction layer. |
| VTIL_SetResponseContent | Changes the content of the next VT response. |
| VTIL_SetVTStatus | Changes the content and cycle time of the VT Status message. |
VT – Fault Injection for Transport Protocols
| Functions | Short Description |
|---|---|
| VTIL_BlockTxTpAbort | Prevents transmission of (E)TP.Abort message by the Interaction Layer. |
| VTIL_BlockTxTpCts | Prevents transmission of (E)TP.CTS message by the Interaction Layer. |
| VTIL_BlockTxTpDpo | Prevents transmitting of a ETP.DPO message generated and sent by the interaction layer. |
| VTIL_BlockTxTpDt | Prevents transmission of (E)TP.DT message by the Interaction Layer. |
| VTIL_BlockTxTpEoma | Prevents transmission of (E)TP.EoMA message by the Interaction Layer. |
| VTIL_DelayTxTpAbort | Delays transmission of (E)TP.Abort message by the Interaction Layer. |
| VTIL_DelayTxTpCts | Delays transmission of (E)TP.CTS message by the Interaction Layer. |
| VTIL_DelayTxTpDpo | Delays transmitting of a ETP.DPO message generated and sent by the interaction layer. |
| VTIL_DelayTxTpDt | Delays transmission of (E)TP.DT message by the Interaction Layer. |
| VTIL_DelayTxTpEoma | Delays transmission of (E)TP.EoMA message by the Interaction Layer. |
| VTIL_FreezeTp | Freezes the current (E)TP connection immediately. |
VT – Handling
| Functions | Short Description |
|---|---|
| VTIL_ACK, VTIL_ACKMsg | Simulates pressing of the ACK means of the Virtual Terminal. |
| VTIL_ActivateWorkingSet | Simulates the activating of a Working Set in the Virtual Terminal. |
| VTIL_AddKeyGroup | Adds a Key Group to a User-Layout Data Mask of the Virtual Terminal. |
| VTIL_AddWindowMask | Adds a Window Mask to a User-Layout Data Mask of the Virtual Terminal. |
| VTIL_ClearUserLayoutMask | Removes all Window Masks and all Key Groups from a User-Layout Mask of the Virtual Terminal. |
| VTIL_CreateAuxAssignment | Assigns an Auxiliary Input to an Auxiliary Function |
| VTIL_EditNumericValue | Simulates editing of an Input Number or Input List object. |
| VTIL_EditStringValue | Simulates editing of an Input String object. |
| VTIL_ESC, VTIL_ESCMsg | Simulates pressing of the ESC means of the Virtual Terminal. |
| VTIL_PressButton | Simulates pressing of a Button of the active Data/Alarm Mask. |
| VTIL_PressSoftKey | Simulates pressing of a Soft Key of the active Soft Key Mask. |
| VTIL_RemoveAuxAssignment | Removes an auxiliary assignment |
| VTIL_RemoveKeyGroup | Removes a Key Group from a User-Layout Soft Key Mask of the Virtual Terminal. |
| VTIL_RemoveWindowMask | Removes a Window Mask from a User-Layout Data Mask of the Virtual Terminal. |
| VTIL_SelectInputObject | Sends the VT Select Input Object message. |
| VTIL_Touch | Simulates touching into the Data Mask. |
VT – Handling (User-Layout Mask)
| Functions | Short Description |
|---|---|
| VTIL_AddKeyGroup | Adds a Key Group to a User-Layout Data Mask of the Virtual Terminal. |
| VTIL_AddWindowMask | Adds a Window Mask to a User-Layout Data Mask of the Virtual Terminal. |
| VTIL_ClearUserLayoutMask | Removes all Window Masks and all Key Groups from a User-Layout Mask of the Virtual Terminal. |
| VTIL_RemoveKeyGroup | Removes a Key Group from a User-Layout Soft Key Mask of the Virtual Terminal. |
| VTIL_RemoveWindowMask | Removes a Window Mask from a User-Layout Data Mask of the Virtual Terminal. |
VT – Other Functions
| Functions | Short Description |
|---|---|
| VTIL_ConnectSysVar | Connects an object from the object pool to a system variable. |
| VTIL_DeleteAllStoredVersions | Deletes all stored object pool versions. |
| VTIL_ExportObjectPool | Exports the current object pool of the Working Set Master into a file (iop). |
| VTIL_GetChildObjectId | Returns the ID of a child object. |
| VTIL_GetIdOfVisibleObject | Returns the object ID of a visible object at a specified position. |
| VTIL_GetNextTAN | Gets the TAN that will be used in the next activation message. |
| VTIL_GetNumberOfChildObjects | Returns the number of child objects contained in an object. |
| VTIL_IsObjectVisible | Checks if an object is visible in the current Data Mask or Soft Key Mask. |
| VTIL_PressISB | Simulates pressing the ISOBUS Shortcut Button [ISB] of the Virtual Terminal. |
| VTIL_RegisterObjectPool | Registers an object pool file (iop). |
| VTIL_SaveAsImage | Saves the current Data/Alarm Mask or one of the current Soft Keys as an image. |
| VTIL_SetNextTAN | Sets the TAN to be used in the next activation message. |
VT – Value Request
| Functions | Short Description |
|---|---|
| VTIL_GetActiveMask | Returns object ID of the active Data or Alarm Mask. |
| VTIL_GetDisplayedValue | Returns the displayed value of an object. |
| VTIL_GetDwordValue | Returns the value of an object attribute. |
| VTIL_GetDoubleValue | Returns the value of an object or of an object attribute. |
| VTIL_GetStringValue | Returns the value of an object. |