com.openxc.interfaces

Interface VehicleInterface

All Superinterfaces:

DataPipeline.Operator, VehicleDataSink, VehicleDataSource

All Known Implementing Classes:

BluetoothVehicleInterface, NetworkVehicleInterface, TestVehicleInterface, UsbVehicleInterface

public interface VehicleInterface
extends VehicleDataSource, VehicleDataSink

A connection to a physical vehicle interface that is capable of full duplex communication. This is a simple combination of two other interfaces to represent an interface capable of full duplex communication. The methods of VehicleDataSource are used to receive data from the vehicle, and the methods of VehicleDataSink are used to send data back to the vehicle. Implementation of this interface are expected to have a constructor that accepts (Context context, String resource) where "context" is an active Android application context (used to be able to refer to Android services and system managers) and "resource" is a String, the format of which is defined by the implementer (e.g. a URI, a MAC address, etc).

Method Summary

Modifier and Type	Method and Description
boolean	isConnected() Return true if the interface is actively connected to the vehicle.
boolean	setResource(java.lang.String resource) Change the resource used by the instance to connect to the interface, restarting any necessary services.

Methods inherited from interface com.openxc.sources.VehicleDataSource

setCallback, stop

Methods inherited from interface com.openxc.DataPipeline.Operator

onPipelineActivated, onPipelineDeactivated

Methods inherited from interface com.openxc.sinks.VehicleDataSink

receive, stop

Method Detail

setResource

boolean setResource(java.lang.String resource)
             throws DataSourceException

Change the resource used by the instance to connect to the interface, restarting any necessary services.

Parameters:

resource - The new resource to use for the interface.

Returns:

true if the resource was different and the interface was restarted.

Throws:

DataSourceException

isConnected

boolean isConnected()

Return true if the interface is actively connected to the vehicle.

Specified by:

isConnected in interface VehicleDataSource