openOBD CLI
An openOBD CLI is available for the purpose of managing active openOBD sessions. The CLI can retrieve the status of your openOBD sessions, as well as interrupt them. It is available from the Snap Store. This page assumes the openOBD CLI will be installed on a Linux distribution.
Setup
In this setup, the openOBD CLI will be installed using the terminal.
If snap is not yet installed, it can be installed by running:
With snap installed, the openOBD CLI can be installed by running:
Partner API credentials are required to be able to access openOBD sessions. To securely store these credentials, the openOBD CLI needs access to the system's keyring. To give it access, run the following command:
Configuring credentials
After installing the openOBD CLI, Partner API credentials will need to be entered to make use of the CLI's functionality.
To add a new set of credentials, use the openobd profile add <profile_name> command, where <profile_name> can be any name that represents the credential set.
After running this command, the credentials can be entered.
Below is an overview of all the profile subcommands and their functionality.
profile subcommand |
Description |
|---|---|
add |
Creates a new profile with the given name to hold a new credential set |
delete |
Deletes the given profile |
list |
Lists all profiles |
set |
Switches to the given profile to use its credentials |
show |
Shows details on the currently active profile or the given profile |
Functionality
The openOBD CLI can be used to either retrieve openOBD sessions, or to interrupt them. These commands are described in the table below.
openobd command |
Description |
|---|---|
get-session |
Retrieves session info for the given session UUID |
get-session-list |
Retrieves info on all (recently) active sessions |
interrupt-session |
Forcefully closes the openOBD session with the given UUID. If no UUID is given, a selection can be made from ongoing sessions |
Do note that you can only interact with sessions to which your credentials have access.