com.openxc.interfaces.bluetooth

Class BluetoothVehicleInterface

java.lang.Object

com.openxc.sources.BaseVehicleDataSource

com.openxc.sources.ContextualVehicleDataSource

com.openxc.sources.BytestreamDataSource

com.openxc.interfaces.bluetooth.BluetoothVehicleInterface

All Implemented Interfaces:

DataPipeline.Operator, VehicleInterface, VehicleDataSink, VehicleDataSource, java.lang.Runnable

public class BluetoothVehicleInterface
extends BytestreamDataSource
implements VehicleInterface

A vehicle data source reading measurements from an Bluetooth-enabled OpenXC device.

This class tries to connect to a previously paired Bluetooth device with a given MAC address. If found, it opens a socket to the device and streams both read and write OpenXC messages.

This class requires both the android.permission.BLUETOOTH and android.permission.BLUETOOTH_ADMIN permissions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEVICE_NAME_PREFIX

Fields inherited from class com.openxc.sources.BytestreamDataSource

mConnectionLock, mDataFormatValue, mDeviceChanged, RECONNECTION_ATTEMPT_WAIT_TIME_S, SLOW_RECONNECTION_ATTEMPT_WAIT_TIME_S

Constructor Summary

Constructors

Constructor and Description
BluetoothVehicleInterface(android.content.Context context, java.lang.String address)
BluetoothVehicleInterface(SourceCallback callback, android.content.Context context, java.lang.String address)

Method Summary

Modifier and Type	Method and Description
protected void	connect() Initiate a connection to the vehicle interface.
protected void	disconnect() Perform any cleanup necessary to disconnect from the interface.
protected java.lang.String	getTag() Return a string suitable as a tag for logging.
boolean	isConnected() Return true if the data source is actively connected to its target, be it a USB endpoint, a Bluetooth channel, a trace file, etc.
protected int	read(byte[] bytes) Read data from the source into the given array.
void	setPollingStatus(boolean enabled) Control whether periodic polling is used to detect a Bluetooth VI.
boolean	setResource(java.lang.String otherAddress) Change the resource used by the instance to connect to the interface, restarting any necessary services.
void	stop() Clear the callback so no further updates are sent.
java.lang.String	toString()
protected boolean	write(byte[] bytes)

Methods inherited from class com.openxc.sources.BytestreamDataSource

connected, disconnected, isRunning, receive, run, setFastPolling, start, stopConnectionAttempts, waitForConnection

Methods inherited from class com.openxc.sources.ContextualVehicleDataSource

getContext

Methods inherited from class com.openxc.sources.BaseVehicleDataSource

getCallback, handleMessage, onPipelineActivated, onPipelineDeactivated, setCallback, waitForCallback

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.openxc.sources.VehicleDataSource

setCallback

Methods inherited from interface com.openxc.DataPipeline.Operator

onPipelineActivated, onPipelineDeactivated

Methods inherited from interface com.openxc.sinks.VehicleDataSink

receive

Field Detail

DEVICE_NAME_PREFIX

public static final java.lang.String DEVICE_NAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

BluetoothVehicleInterface

public BluetoothVehicleInterface(SourceCallback callback,
                                 android.content.Context context,
                                 java.lang.String address)
                          throws DataSourceException

Throws:

DataSourceException

BluetoothVehicleInterface

public BluetoothVehicleInterface(android.content.Context context,
                                 java.lang.String address)
                          throws DataSourceException

Throws:

DataSourceException

Method Detail

setPollingStatus

public void setPollingStatus(boolean enabled)

Control whether periodic polling is used to detect a Bluetooth VI.

This class opens a Bluetooth socket and will accept incoming connections from a VI that can act as the Bluetooth master. For VIs that are only able to act as slave, we have to poll for a connection occasionally to see if it's within range.

setResource

public boolean setResource(java.lang.String otherAddress)
                    throws DataSourceException

Description copied from interface: VehicleInterface

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

Specified by:

setResource in interface VehicleInterface

Parameters:

otherAddress - The new resource to use for the interface.

Returns:

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

Throws:

DataSourceException

isConnected

public boolean isConnected()

Description copied from interface: VehicleDataSource

Return true if the data source is actively connected to its target, be it a USB endpoint, a Bluetooth channel, a trace file, etc. The source is capable of providing new vehicle data. Returns true if connected, false otherwise.

Specified by:

isConnected in interface VehicleInterface

Specified by:

isConnected in interface VehicleDataSource

Overrides:

isConnected in class BytestreamDataSource

stop

public void stop()

Description copied from class: BaseVehicleDataSource

Clear the callback so no further updates are sent. Subclasses should be sure to call super.stop() so they also stop sending updates when killed by a user.

Specified by:

stop in interface VehicleDataSink

Specified by:

stop in interface VehicleDataSource

Overrides:

stop in class BytestreamDataSource

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

connect

protected void connect()

Description copied from class: BytestreamDataSource

Initiate a connection to the vehicle interface.

Specified by:

connect in class BytestreamDataSource

read

protected int read(byte[] bytes)
            throws java.io.IOException

Description copied from class: BytestreamDataSource

Read data from the source into the given array. No more than bytes.length bytes will be read, and there is no guarantee that any bytes will be read at all.

Specified by:

read in class BytestreamDataSource

Parameters:

bytes - the destination array for bytes from the data source.

Returns:

the number of bytes that were actually copied into bytes.

Throws:

java.io.IOException - if the source is unexpectedly closed or returns an error.

write

protected boolean write(byte[] bytes)

Specified by:

write in class BytestreamDataSource

disconnect

protected void disconnect()

Description copied from class: BytestreamDataSource

Perform any cleanup necessary to disconnect from the interface.

Specified by:

disconnect in class BytestreamDataSource

getTag

protected java.lang.String getTag()

Description copied from class: BaseVehicleDataSource

Return a string suitable as a tag for logging.

Overrides:

getTag in class BaseVehicleDataSource