Shiny Client v6.3Easy Live Activities, Game Center, Geospatial Geofencing, App Store APIs, More Thermal Printer Support, & Call Directory

OBD-II

The OBD-II bridge talks to a vehicle through an ELM327 or OBDLink adapter: decoded PIDs, the VIN, trouble codes and live readings. It’s backed by Shiny.Obd.

Install and register

dotnet add package Shiny.AppDeviceBridge.Obd

builder.UseAppDeviceBridge(
    bridge => bridge.AddObdBridge(),
    webApp => { /* … */ }
);

Client	C#	TypeScript
`IObdBridge`	`AddObdBridgeClient()`	`ObdBridge`

Details

Topic	Details
Adapters	ELM327 and OBDLink, one at a time. `scan` finds Bluetooth LE adapters, or with `"transport": "wifi"` probes the addresses Wi-Fi adapters ship with. `connection` takes the `peripheralUuid` from a scan, or a Wi-Fi `host` and `port`. The host must be a loopback, private or link-local IP address.
Reading	`command` takes a name from `GET obd/commands` (`engineRpm`, `vehicleSpeed`, `coolantTemperature`…) and answers the decoded value with its unit. `POST obd/raw` sends a read-only request: modes 01, 02, 03, 05, 06, 07, 09, 0A or 22, or an informational AT command. Commands are serialized, because ELM327 is half-duplex.
Trouble codes	`GET obd/dtc` returns stored, pending and permanent codes. A list is `null` when the vehicle doesn’t support that mode. `DELETE obd/dtc` needs `?confirm=true`, because clearing codes also resets the emissions readiness monitors.
Monitoring	`monitor` polls up to 10 commands, every 250 ms at most often, and sends each result as `obd.reading`, so listen to that first; without a listener it answers `409`. It stops once nothing listens to `obd.reading`, and the adapter stays connected. After three rounds with no answers the connection is dropped with `obd.disconnected`.
Platform setup	Bluetooth as for the Bluetooth LE bridge. Wi-Fi adapters need `NSLocalNetworkUsageDescription` on iOS and Mac Catalyst. On Android, the app has to bind to the adapter’s network, which has no internet. Linux supports Wi-Fi adapters only.

From the page

import { ObdBridge } from "@shinyorg/appdevicebridge";

const obd = new ObdBridge();
const [adapter] = await obd.scan({ transport: "Ble", scanMs: 5000 });
await obd.connect({ transport: "Ble", peripheralUuid: adapter.id });

const rpm = await obd.read({ command: "engineRpm" });      // { value: 812, unit: "rpm" }
const { vin } = await obd.getVin();

// live gauges: listen, then start the monitor
await obd.onReading(r => gauges[r.command] = r.value);
await obd.startMonitor({ commands: ["engineRpm", "vehicleSpeed", "coolantTemperature"], intervalMs: 500 });

getCommands() lists the named values read and startMonitor take.

Requests

GET/_bridge/obd/status#

The connection, the adapter, Bluetooth availability, and the running monitor.

C#IObdBridge.GetStatusAsyncTSObdBridge.getStatus

Response

200 ObdStatus

ObdStatus · 11 fields

`connected`	`boolean`
`transport`	`ObdTransport \| null`
`adapterId`	`string \| null`
`adapterName`	`string \| null`
`adapterType`	`ObdAdapterType \| null`
`adapterIdentifier`	`string \| null`	What the adapter reports about itself.
`protocol`	`string \| null`	The vehicle protocol the adapter settled on.
`bluetoothSupported`	`boolean`	Whether Bluetooth LE adapters can be used here.
`bluetoothAccess`	`AccessState \| null`
`scanning`	`boolean`
`monitor`	`ObdMonitor \| null`	The running monitor.

GET/_bridge/obd/commands#

The named commands read and startMonitor accept.

C#IObdBridge.GetCommandsAsyncTSObdBridge.getCommands

Response

200 ObdCommandInfo[]

ObdCommandInfo · 3 fields

`name`	`string`	Such as `engineRpm`.
`pid`	`string`	The raw request it sends.
`unit`	`string \| null`

POST/_bridge/obd/scan#

The adapters seen during the scan window.

C#IObdBridge.ScanAsyncTSObdBridge.scan

Body

application/json · ObdScanRequest

ObdScanRequest · 3 fields

`transport`	`ObdTransport`
`scanMs`	`number \| null`	Up to 30,000 ms; 5 seconds when null.
`nameFilter`	`string \| null`	Only adapters whose name contains this; at most 64 characters.

Response

200 ObdAdapter[]

ObdAdapter · 5 fields

`id`	`string`	A Bluetooth peripheral id, or a Wi-Fi adapter's host and port.
`name`	`string`
`transport`	`ObdTransport`
`host`	`string \| null`
`port`	`number \| null`

GET/_bridge/obd/adapters#

The last scan's adapters.

C#IObdBridge.GetAdaptersAsyncTSObdBridge.getAdapters

Response

200 ObdAdapter[]

ObdAdapter · 5 fields

`id`	`string`	A Bluetooth peripheral id, or a Wi-Fi adapter's host and port.
`name`	`string`
`transport`	`ObdTransport`
`host`	`string \| null`
`port`	`number \| null`

POST/_bridge/obd/connection#

Connects to an adapter — a Bluetooth peripheral, or a Wi-Fi host, probed when none is given.

C#IObdBridge.ConnectAsyncTSObdBridge.connect

Body

application/json · ObdConnectRequest

ObdConnectRequest · 8 fields

`transport`	`ObdTransport`
`peripheralUuid`	`string \| null`
`host`	`string \| null`
`port`	`number \| null`
`timeoutMs`	`number \| null`	Up to 60,000 ms; 30 seconds when null.
`serviceUuid`	`string \| null`	For an adapter that does not use the usual GATT service.
`readCharacteristicUuid`	`string \| null`
`writeCharacteristicUuid`	`string \| null`

Response

200 ObdStatus

ObdStatus · 11 fields

`connected`	`boolean`
`transport`	`ObdTransport \| null`
`adapterId`	`string \| null`
`adapterName`	`string \| null`
`adapterType`	`ObdAdapterType \| null`
`adapterIdentifier`	`string \| null`	What the adapter reports about itself.
`protocol`	`string \| null`	The vehicle protocol the adapter settled on.
`bluetoothSupported`	`boolean`	Whether Bluetooth LE adapters can be used here.
`bluetoothAccess`	`AccessState \| null`
`scanning`	`boolean`
`monitor`	`ObdMonitor \| null`	The running monitor.

DELETE/_bridge/obd/connection#

Disconnects, stopping the monitor.

C#IObdBridge.DisconnectAsyncTSObdBridge.disconnect

Response: 204 No content

POST/_bridge/obd/command#

Reads one named value. Fails with 404 for a command not in getCommands.

C#IObdBridge.ReadAsyncTSObdBridge.read

Body

application/json · ObdReadRequest

ObdReadRequest · 1 field

command string A name from the command list, such as engineRpm.

Response

200 ObdReading

ObdReading · 4 fields

`command`	`string`
`value`	`number \| null`	A numeric reading.
`text`	`string \| null`	A text reading.
`unit`	`string \| null`

Errors

404Not found

POST/_bridge/obd/raw#

Sends a raw request and returns the adapter's reply. Only read-only requests are accepted: OBD modes 01, 02, 03, 05, 06, 07, 09, 0A or 22 in hex, or a harmless AT command.

C#IObdBridge.SendRawAsyncTSObdBridge.sendRaw

Body

application/json · ObdRawRequest

ObdRawRequest · 1 field

raw string Such as 010C or AT RV.

Response

200 ObdRawResult

ObdRawResult · 2 fields

`command`	`string`
`response`	`string`

GET/_bridge/obd/vin#

The vehicle identification number.

C#IObdBridge.GetVinAsyncTSObdBridge.getVin

Response

200 ObdVin

ObdVin · 1 field

vin string

GET/_bridge/obd/dtc#

Stored, pending and permanent trouble codes.

C#IObdBridge.GetTroubleCodesAsyncTSObdBridge.getTroubleCodes

Response

200 ObdTroubleCodes

ObdTroubleCodes · 3 fields

`stored`	`string[] \| null`
`pending`	`string[] \| null`
`permanent`	`string[] \| null`

DELETE/_bridge/obd/dtc#

Clears trouble codes. This also resets the emissions readiness monitors, which take several drive cycles to complete again, so confirm must be true.

C#IObdBridge.ClearTroubleCodesAsyncTSObdBridge.clearTroubleCodes

Parameter	In	Type
`confirm`	query	`boolean`	required

Response

200 ObdClearResult

ObdClearResult · 1 field

cleared boolean

POST/_bridge/obd/monitor#

Reads up to 10 named values on an interval; readings arrive through onReading, so listen first: without a listener it fails with 409. The monitor stops once that has no listener left; the adapter stays connected.

C#IObdBridge.StartMonitorAsyncTSObdBridge.startMonitor

Body

application/json · ObdMonitorRequest

ObdMonitorRequest · 2 fields

`commands`	`string[]`
`intervalMs`	`number \| null`	250–60,000 ms; one second when null.

Response

200 ObdMonitor

ObdMonitor · 2 fields

`commands`	`string[]`
`intervalMs`	`number`

Errors

409Conflict

DELETE/_bridge/obd/monitor#

Stops the monitor.

C#IObdBridge.StopMonitorAsyncTSObdBridge.stopMonitor

Response: 204 No content

Events

EVENTobd.reading#

A monitored reading, or the error reading it.

C#IObdBridge.OnReadingAsyncTSObdBridge.onReading

Payload: ObdMonitorReading

`command`	`string`
`value`	`number \| null`
`text`	`string \| null`
`unit`	`string \| null`
`error`	`string \| null`	Why the reading failed; the value is null then.
`timestamp`	`string`

EVENTobd.disconnected#

The adapter went away or stopped answering.

C#IObdBridge.OnDisconnectedAsyncTSObdBridge.onDisconnected

Payload: ObdDisconnected

`reason`	`string`
`transport`	`ObdTransport`
`adapterId`	`string`

Types

JSON property names are camelCase and enums travel as their names. A ? marks a property the payload may omit;| null one that may be null.

ObdStatusobject#

`connected`	`boolean`
`transport`	`ObdTransport \| null`
`adapterId`	`string \| null`
`adapterName`	`string \| null`
`adapterType`	`ObdAdapterType \| null`
`adapterIdentifier`	`string \| null`	What the adapter reports about itself.
`protocol`	`string \| null`	The vehicle protocol the adapter settled on.
`bluetoothSupported`	`boolean`	Whether Bluetooth LE adapters can be used here.
`bluetoothAccess`	`AccessState \| null`
`scanning`	`boolean`
`monitor`	`ObdMonitor \| null`	The running monitor.

ObdTransportenum#

"Ble""Wifi"

ObdAdapterTypeenum#

"Unknown""Elm327""ObdLink"

AccessStateenum#

Where a permission stands. Reported by every bridge that needs one; the names match Shiny's own.

"Unknown""NotSupported""NotSetup""Disabled""Restricted""Denied""Available"

ObdMonitorobject#

`commands`	`string[]`
`intervalMs`	`number`

ObdCommandInfoobject#

`name`	`string`	Such as `engineRpm`.
`pid`	`string`	The raw request it sends.
`unit`	`string \| null`

ObdScanRequestobject#

`transport?`	`ObdTransport`
`scanMs?`	`number \| null`	Up to 30,000 ms; 5 seconds when null.
`nameFilter?`	`string \| null`	Only adapters whose name contains this; at most 64 characters.

ObdAdapterobject#

`id`	`string`	A Bluetooth peripheral id, or a Wi-Fi adapter's host and port.
`name`	`string`
`transport`	`ObdTransport`
`host`	`string \| null`
`port`	`number \| null`

ObdConnectRequestobject#

An adapter to connect to: peripheralUuid for Bluetooth, host and port for Wi-Fi.

`transport?`	`ObdTransport`
`peripheralUuid?`	`string \| null`
`host?`	`string \| null`
`port?`	`number \| null`
`timeoutMs?`	`number \| null`	Up to 60,000 ms; 30 seconds when null.
`serviceUuid?`	`string \| null`	For an adapter that does not use the usual GATT service.
`readCharacteristicUuid?`	`string \| null`
`writeCharacteristicUuid?`	`string \| null`

ObdReadRequestobject#

command string A name from the command list, such as engineRpm.

ObdReadingobject#

`command`	`string`
`value`	`number \| null`	A numeric reading.
`text`	`string \| null`	A text reading.
`unit`	`string \| null`

ObdRawRequestobject#

raw string Such as 010C or AT RV.

ObdRawResultobject#

`command`	`string`
`response`	`string`

ObdVinobject#

vin string

ObdTroubleCodesobject#

Each list is null where the vehicle did not answer that request.

`stored`	`string[] \| null`
`pending`	`string[] \| null`
`permanent`	`string[] \| null`

ObdClearResultobject#

cleared boolean

ObdMonitorRequestobject#

`commands`	`string[]`
`intervalMs?`	`number \| null`	250–60,000 ms; one second when null.

ObdMonitorReadingobject#

`command`	`string`
`value`	`number \| null`
`text`	`string \| null`
`unit`	`string \| null`
`error`	`string \| null`	Why the reading failed; the value is null then.
`timestamp`	`string`

ObdDisconnectedobject#

`reason`	`string`
`transport`	`ObdTransport`
`adapterId`	`string`

Security

These routes sit under AppDeviceBridgePolicies.Bridges like every other bridge: callers on this device by default. See Security.