openOBD function

An openOBD function is an autonomous procedure that can be executed in the context of an openOBD session. An openOBD function can be described as a self-contained functional procedure block that can be used to build complex diagnostic procedures on openOBD. Reuse of functionalities and isolated testing of these openOBD functions contribute to the quality and reliability of openOBD procedures.

Function information

Every function can be assigned some details that describes and uniquely identifies this function.

FunctionDetails

id       47305693-9e0a-444e-b675-60d933c8ca9a
version    2.3
name      ExampleFunction
description Demonstrate the concept of an openOBD function defintion

Stand-alone functions

An openOBD session in its most simple form is just an automated process that controls the bus communication and user interaction. This openOBD session is created within the context of a ticket. When an openOBD session is created the result will be an authentication token. This token can be used by an openOBD function to authenticate and start controlling the openOBD session. This basic use of an openOBD session can be described as a stand-alone function. Just one function that takes control of the session and once it is finished it will automatically end the openOBD session.

sequenceDiagram
    autonumber
    participant DEFAULT as Default function
box lightgray
    participant OS as openOBD session
end

    note over OS: default context<br/>available

    DEFAULT->>OS: authenticate()
    activate OS
    note over OS: default context<br/>active
    OS-->>DEFAULT: session_token
    activate DEFAULT
    rect rgb(200, 150, 255)
    DEFAULT-->OS: OBD communication
    end

    DEFAULT->>OS: finish()
    deactivate OS
    deactivate DEFAULT