Skip to main content

Obd

obd.battery#

Gets current battery voltage


obd.commands#

Lists all supported OBD commands found for vehicle.


obd.connection#

Manages current connection.

OPTIONAL ARGUMENTS

  • baudrate (int): Changes baudrate used to communicate with interface.
  • reset (str): Reboots interface. Available options: warm, cold

EXAMPLES

  • obd.connection
  • obd.connection baudrate=1152000
  • obd.connection reset=cold

obd.context#

warning

DEPRECATED Use 'manage context' instead.

Gets current context.


obd.dtc#

Reads and clears Diagnostics Trouble Codes (DTCs).

OPTIONAL ARGUMENTS

  • clear (bool): clear DTC codes

obd.dump#

Dumps all messages from bus to screen or file.

OPTIONAL ARGUMENTS

  • duration (int): How many seconds to record data? Default value is 2 seconds.
  • file (str): Write data to a file with the given name.
  • description (str): Additional description to the file.
  • filtering (bool): Use filters while monitoring or monitor all messages? Default value is False. It is possible to specify can or j1939 (PGN) in order to add filters based on the messages found in a CAN database file (.dbc).
  • protocol (str): ID of specific protocol to be used to receive the data. If none is specifed the current protocol will be used.
  • baudrate (int): Specific protocol baudrate to be used. If none is specifed the current baudrate will be used.
  • verify (bool): Verify that OBD-II communication is possible with the desired protocol? Default value is False.
  • raw_response (bool): Get raw response without any validation nor parsing? Default value is False.
  • format_response (bool): Format response frames by separating header and data with a hash sign. Default value is True.

obd.execute#

Executes an AT/ST command.

ARGUMENTS

  • cmd (str): Command to execute.

OPTIONAL ARGUMENTS

  • assert_result (str or list): Validate the response by checking that is matches this specific value.
  • reset (str): Reset interface after execution. Valid options are: warm, cold
  • keep_conn (bool): Keep connection to interface after execution or close it permanently? Default value is True.
  • type (str): Specify a name of the type of the result. Default is the given command.

obd.file_export#

Fast export of all messages on a bus to a log file.

OPTIONAL ARGUMENTS

  • run (bool): Specify if subprocess should be running or not. If not defined the current state will be queried.
  • folder (str): Custom folder to place export log files.
  • wait_timeout (int): Maximum time in seconds to wait for subprocess to complete. Default value is 0.
  • monitor_filtering (bool): Use filters while monitoring or monitor all messages? Default value is False. It is possible to specify can or j1939 (PGN) in order to add filters based on the messages found in a CAN database file (.dbc).
  • monitor_mode (int): The STN monitor mode. Default is 0.
  • can_auto_format (bool): Apply automatic formatting of messages? Default value is False.
  • read_timeout (int): How long time in seconds should the subprocess wait for data on the serial port? Default value is 1.
  • serial_baudrate (int): Specify a custom baud rate to use for the serial connection to the STN.
  • process_nice (int): Process nice value that controls the priority of the subprocess. Default value is -2.
  • protocol (str): ID of specific protocol to be used to receive the data. If none is specifed the current protocol will be used.
  • baudrate (int): Specific protocol baudrate to be used. If none is specifed the current baudrate will be used.
  • verify (bool): Verify that OBD-II communication is possible with the desired protocol? Default value is False.

obd.file_import#

Fast import of exported log files containing messages from a bus.

OPTIONAL ARGUMENTS

  • folder (str): Custom folder to import log files from.
  • limit (int): The maximum number of lines/messages to read each time. Default value is 5000.
  • idle_sleep (int): Pause in seconds if there is no lines/messages to import. Default value is 0.
  • cleanup_grace (int): Grace period in seconds before a fully imported log file is deleted. Default value is 60.
  • process_nice (int): Process nice value that controls the priority of the service. Default value is 0.
  • type (str): Specify a name of the type of the result. Default is raw.

obd.filter#

Manages filters.

ARGUMENTS

  • action (str): Action to perform. Available actions are auto, list, add, clear and sync.

EXAMPLES

  • obd.filter auto [enable=true]
  • obd.filter list [type=<all|pass|block|flow|pgn>]
  • obd.filter add <pass|block|flow|pgn> 7c8,7ff
  • obd.filter clear [type=<all|pass|block|flow|pgn>]
  • obd.filter sync <DBC file path> <pass|block|flow|pgn> [frame_id_mask=0x1FFFFF00]

obd.help#

Shows this help information.


obd.manage#

Runtime management of the underlying service instance.

SUPPORTED COMMANDS

  • hook list|call <name> [argument]... [<key>=<value>]...
  • worker list|show|start|pause|resume|kill <name>
  • reactor list|show <name>
  • run <key>=<value>...

EXAMPLES

  • obd.manage hook list
  • obd.manage hook call execute_handler ATRV
  • obd.manage worker list *
  • obd.manage worker show *
  • obd.manage worker start *
  • obd.manage worker pause *
  • obd.manage worker resume *
  • obd.manage worker kill *
  • obd.manage reactor list
  • obd.manage reactor show *
  • obd.manage run handler="query" args="[\"ELM_VOLTAGE\"]" converter="battery" returner="cloud"

obd.monitor#

Monitors messages on bus until limit or duration is reached.

OPTIONAL ARGUMENTS

  • wait (bool): Wait for each message/line to read according to the default timeout of the serial connection (default 1 second). Otherwise there will only be waiting on the first line. line/message. Default value is False.
  • limit (int): The maximum number of messages to read. Default value is 500.
  • duration (float): How many seconds to monitor? If not set there is no limitation.
  • mode (int): The STN monitor mode. Default is 0.
  • auto_format (bool): Apply automatic formatting of messages? Default value is False.
  • filtering (bool): Use filters while monitoring or monitor all messages? Default value is False. It is possible to specify can or j1939 (PGN) in order to add filters based on the messages found in a CAN database file (.dbc).
  • protocol (str): ID of specific protocol to be used to receive the data. If none is specifed the current protocol will be used.
  • baudrate (int): Specific protocol baudrate to be used. If none is specifed the current baudrate will be used.
  • verify (bool): Verify that OBD-II communication is possible with the desired protocol? Default value is False.
  • type (str): Specify a name of the type of the result. Default is raw.

obd.play#

Plays all messages from a file on the bus.

ARGUMENTS

  • file (str): Path to file recorded with the obd.dump command.

OPTIONAL ARGUMENTS

  • delay (float): Delay in milliseconds between sending each message. Default value is 0.
  • slice (str): Slice the list of messages before sending on the CAN bus. Based one the divide and conquer algorithm. Multiple slice characters can be specified in continuation of each other.
    • t: Top half of remaining result.
    • b: Bottom half of remaining result.
  • filter (str): Filter out messages before sending on the CAN bus. Multiple filters can be specified if separated using comma characters.
    • +[id][#][data]: Include only messages matching string.
    • -[id][#][data]: Exclude messages matching string.
    • +duplicate: Include only messages where duplicates exist.
    • -duplicate: Exclude messages where duplicates exist.
    • +mutate: Include only messages where data mutates.
    • -mutate: Exclude messages where data mutates.
  • group (str): How to group the result of sent messages. This only affects the display values returned from this command. Default value is id.
    • id: Group by message ID only.
    • msg: Group by entire message string.
  • protocol (str): ID of specific protocol to be used to send the data. If none is specifed the current protocol will be used.
  • baudrate (int): Specific protocol baudrate to be used. If none is specifed the current baudrate will be used.
  • verify (bool): Verify that OBD-II communication is possible with the desired protocol? Default value is False.
  • auto_format (bool): Apply automatic formatting of messages? Default value is False.
  • test (bool): Run command in test-only? (dry-run) mode. No data will be sent on CAN bus. Default value is False.

obd.protocol#

Configures protocol or lists all supported.

OPTIONAL ARGUMENTS

  • set (str): Change to protocol with given identifier.
  • baudrate (int): Use custom protocol baudrate.
  • verify (bool): Verify that OBD-II communication is possible with the desired protocol? Default value is False.

EXAMPLES

  • obd.protocol
  • obd.protocol set=auto
  • obd.protocol set=6
  • obd.protocol set=53 baudrate=250000

obd.query#

Queries a given OBD command. To see supported OBD commands for your vehicle run: obd.commands

ARGUMENTS

  • name (str): Name of the command.

OPTIONAL ARGUMENTS, GENERAL

  • mode (str): Service section of the PID.
  • pid (str): Code section of the PID.
  • header (str): Identifer of message to send. If none is specifed the default header will be used.
  • bytes (int): Byte size of individual returned frame(s). Default value is 0.
  • frames (int): Expected frame count to be returned?
  • strict (int): Enforce strict validation of specified bytes and/or frames. Default value is False.
  • decoder (str): Specific decoder to be used to process the response.
  • formula (str): Formula written in Python to convert the response.
  • unit (str): Unit of the result.
  • protocol (str): ID of specific protocol to be used to receive the data. If none is specifed the current protocol will be used.
  • baudrate (int): Specific protocol baudrate to be used. If none is specifed the current baudrate will be used.
  • verify (bool): Verify that OBD-II communication is possible with the desired protocol? Default value is False.
  • force (bool): Force query of unknown command. Default is False.

OPTIONAL ARGUMENTS, CAN SPECIFIC

  • can_extended_address (str): Use CAN extended address.
  • can_priority (str): Set CAN priority bits of a 29-bit CAN ID.
  • can_flow_control_clear (bool): Clear all CAN flow control filters and ID pairs before adding any new ones.
  • can_flow_control_filter (str): Ensure CAN flow control filter is added. Value must consist of <Pattern>,<Mask>.
  • can_flow_control_id_pair (str): Ensure CAN flow control ID pair is added. Value must consist of <Transmitter ID>,<Receiver ID>.

OPTIONAL ARGUMENTS, J1939 SPECIFIC

  • j1939_pgn_filter (str): Ensure J1939 PGN filter is added. Value must consist of <PGN>[,<Target Address>].

EXAMPLES

  • obd.query RPM
  • obd.query SPEED
  • obd.query FUEL_LEVEL force=True
  • obd.query custom_intake_temp_raw mode=01 pid=0F
  • obd.query custom_intake_temp mode=01 pid=0F decoder=temp

obd.recordings#

Lists all dumped recordings available on disk.


obd.send#

Sends a message on bus.

ARGUMENTS

  • msg (str): Message to send.

OPTIONAL ARGUMENTS, GENERAL

  • header (str): Identifer of message to send. If none is specifed the default header will be used.
  • auto_format (bool): Apply automatic formatting of messages? Default value is False.
  • auto_filter (bool): Ensure automatic response filtering is enabled. Default value is True if no custom filters have be added.
  • expect_response (bool): Wait for response after sending? Avoid waiting for timeout by specifying the exact the number of frames expected. Default value is False.
  • format_response (bool): Format response frames by separating header and data with a hash sign. Default value is False.
  • raw_response (bool): Get raw response without any validation nor parsing? Default value is False.
  • echo (bool): Include the request message in the response? Default value is False.
  • protocol (str): ID of specific protocol to be used to receive the data. If none is specifed the current protocol will be used.
  • baudrate (int): Specific protocol baudrate to be used. If none is specifed the current baudrate will be used.
  • verify (bool): Verify that OBD-II communication is possible with the desired protocol? Default value is False.
  • output (str): What data type should the output be returned in? Default is a list.
  • type (str): Specify a name of the type of the result. Default is raw.

OPTIONAL ARGUMENTS, CAN SPECIFIC

  • can_extended_address (str): Use CAN extended address.
  • can_priority (str): Set CAN priority bits of a 29-bit CAN ID.
  • can_flow_control_clear (bool): Clear all CAN flow control filters and ID pairs before adding any new ones.
  • can_flow_control_filter (str): Ensure CAN flow control filter is added. Value must consist of <Pattern>,<Mask>.
  • can_flow_control_id_pair (str): Ensure CAN flow control ID pair is added. Value must consist of <Transmitter ID>,<Receiver ID>.

OPTIONAL ARGUMENTS, J1939 SPECIFIC

  • j1939_pgn_filter (str): Ensure J1939 PGN filter is added. Value must consist of <PGN>[,<Target Address>].

obd.setup#

Setup advanced runtime settings.

OPTIONAL ARGUMENTS, GENERAL

  • print_spaces (bool): Turn printing of spaces in OBD responses on or off. To get better performance, turn spaces off.
  • adaptive_timing (int): Set adaptive timing mode. Sometimes, a single OBD requests results in multiple response frames. The time between frames varies significantly depending on the vehicle year, make, and model - from as low as 5ms up to 100ms. Default value is 1 (on, normal mode).
  • response_timeout (int): When adaptive timing is on, this sets the maximum time that is to be allowed, even if the adaptive algorithm determines that the setting should be longer. In most circumstances, it is best to let the adaptive timing algorithm determine what to use for the timeout. Default value is 50 x 4ms giving a time of approximately 200ms.
  • auto_filter (bool): Ensure automatic response filtering is enabled.

OPTIONAL ARGUMENTS, CAN SPECIFIC

  • can_extended_address (str): Use CAN extended address.
  • can_priority (str): Set CAN priority bits of a 29-bit CAN ID.
  • can_flow_control_clear (bool): Clear all CAN flow control filters and ID pairs before adding any new ones.
  • can_flow_control_filter (str): Ensure CAN flow control filter is added. Value must consist of <Pattern>,<Mask>.
  • can_flow_control_id_pair (str): Ensure CAN flow control ID pair is added. Value must consist of <Transmitter ID>,<Receiver ID>.

OPTIONAL ARGUMENTS, J1939 SPECIFIC

  • j1939_pgn_filter (str): Ensure J1939 PGN filter is added. Value must consist of <PGN>[,<Target Address>].

obd.status#

Gets current status information.