com.google.appinventor.components.runtime

Class BluetoothConnectionBase

java.lang.Object

com.google.appinventor.components.runtime.AndroidNonvisibleComponent

com.google.appinventor.components.runtime.BluetoothConnectionBase

All Implemented Interfaces:

Component, Deleteable, OnDestroyListener

Direct Known Subclasses:

BluetoothClient, BluetoothServer

public abstract class BluetoothConnectionBase
extends AndroidNonvisibleComponent
implements Component, OnDestroyListener, Deleteable

An abstract base class for the BluetoothClient and BluetoothServer component.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	logTag
protected boolean	secure

Fields inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

form

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BluetoothConnectionBase(ComponentContainer container, java.lang.String logTag) Creates a new BluetoothConnectionBase.
protected	BluetoothConnectionBase(java.io.OutputStream outputStream, java.io.InputStream inputStream) This constructor is for testing purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	Available() Returns true if Bluetooth is available on the device, false otherwise.
protected void	bluetoothError(java.lang.String functionName, int errorNumber, java.lang.Object... messageArgs)
void	BluetoothError(java.lang.String functionName, java.lang.String message)
int	BytesAvailableToReceive() Returns number of bytes available from the input stream.
java.lang.String	CharacterEncoding() Returns the character encoding to use when sending and receiving text.
void	CharacterEncoding(java.lang.String encoding) Sets the character encoding to use when sending and receiving text.
int	DelimiterByte() Returns the delimiter byte to use when passing a negative number for the numberOfBytes parameter when calling ReceiveText, ReceiveSignedBytes, or ReceiveUnsignedBytes.
void	DelimiterByte(int number) Sets the delimiter byte to use when passing a negative number for the numberOfBytes parameter when calling ReceiveText, ReceiveSignedBytes, or ReceiveUnsignedBytes.
void	Disconnect() Disconnects from the connected Bluetooth device.
boolean	Enabled() Returns true if Bluetooth is enabled, false otherwise.
boolean	HighByteFirst() Returns true if numbers are sent and received with the most significant byte first.
void	HighByteFirst(boolean highByteFirst) Specifies whether numbers are sent and received with the most significant byte first.
void	Initialize() Default Initialize
boolean	IsConnected() Returns true if a connection to a Bluetooth device has been made.
void	onDelete()
void	onDestroy()
protected byte[]	read(java.lang.String functionName, int numberOfBytes) Reads a number of bytes from the input stream.
int	ReceiveSigned1ByteNumber() Reads a signed 1-byte number.
int	ReceiveSigned2ByteNumber() Reads a signed 2-byte number.
long	ReceiveSigned4ByteNumber() Reads a signed 4-byte number.
java.util.List<java.lang.Integer>	ReceiveSignedBytes(int numberOfBytes) Reads a number of signed bytes from the input stream and returns them as a List.
java.lang.String	ReceiveText(int numberOfBytes) Reads a number of bytes from the input stream and converts them to text.
int	ReceiveUnsigned1ByteNumber() Reads an unsigned 1-byte number.
int	ReceiveUnsigned2ByteNumber() Reads an unsigned 2-byte number.
long	ReceiveUnsigned4ByteNumber() Reads an unsigned 4-byte number.
java.util.List<java.lang.Integer>	ReceiveUnsignedBytes(int numberOfBytes) Reads a number of unsigned bytes from the input stream and returns them as a List.
boolean	Secure() Returns whether a secure connection should be used.
void	Secure(boolean secure) Specifies whether a secure connection should be used.
void	Send1ByteNumber(java.lang.String number) Decodes the given number String to an integer and writes it as one byte to the output stream.
void	Send2ByteNumber(java.lang.String number) Decodes the given number String to an integer and writes it as two bytes to the output stream.
void	Send4ByteNumber(java.lang.String number) Decodes the given number String to an integer and writes it as four bytes to the output stream.
void	SendBytes(YailList list) Takes each element from the given list, converts it to a String, decodes the String to an integer, and writes it as one byte to the output stream.
void	SendText(java.lang.String text) Converts the given text to bytes and writes them to the output stream.
protected void	setConnection(java.lang.Object bluetoothSocket)
protected void	write(java.lang.String functionName, byte b) Writes the given byte to the output stream.
protected void	write(java.lang.String functionName, byte[] bytes) Writes the given bytes to the output stream.

Methods inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

getDispatchDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.appinventor.components.runtime.Component

getDispatchDelegate

Field Detail

logTag

protected final java.lang.String logTag

secure

protected boolean secure

Constructor Detail

BluetoothConnectionBase

protected BluetoothConnectionBase(ComponentContainer container,
                       java.lang.String logTag)

Creates a new BluetoothConnectionBase.

BluetoothConnectionBase

protected BluetoothConnectionBase(java.io.OutputStream outputStream,
                       java.io.InputStream inputStream)

This constructor is for testing purposes only.

Method Detail

Initialize

public final void Initialize()

Default Initialize

BluetoothError

public void BluetoothError(java.lang.String functionName,
                  java.lang.String message)

bluetoothError

protected void bluetoothError(java.lang.String functionName,
                  int errorNumber,
                  java.lang.Object... messageArgs)

Available

public boolean Available()

Returns true if Bluetooth is available on the device, false otherwise.

Returns:

true if Bluetooth is available on the device, false otherwise

Enabled

public boolean Enabled()

Returns true if Bluetooth is enabled, false otherwise.

Returns:

true if Bluetooth is enabled, false otherwise

setConnection

protected final void setConnection(java.lang.Object bluetoothSocket)
                            throws java.io.IOException

Throws:

java.io.IOException

Disconnect

public final void Disconnect()

Disconnects from the connected Bluetooth device.

IsConnected

public final boolean IsConnected()

Returns true if a connection to a Bluetooth device has been made.

Secure

public boolean Secure()

Returns whether a secure connection should be used.

Secure

public void Secure(boolean secure)

Specifies whether a secure connection should be used.

Parameters:

secure - true to use a secure connection

HighByteFirst

public boolean HighByteFirst()

Returns true if numbers are sent and received with the most significant byte first.

Returns:

true for high byte first, false for low byte first

HighByteFirst

public void HighByteFirst(boolean highByteFirst)

Specifies whether numbers are sent and received with the most significant byte first.

Parameters:

highByteFirst - true for high byte first, false for low byte first

CharacterEncoding

public void CharacterEncoding(java.lang.String encoding)

Sets the character encoding to use when sending and receiving text.

CharacterEncoding

public java.lang.String CharacterEncoding()

Returns the character encoding to use when sending and receiving text.

DelimiterByte

public void DelimiterByte(int number)

Sets the delimiter byte to use when passing a negative number for the numberOfBytes parameter when calling ReceiveText, ReceiveSignedBytes, or ReceiveUnsignedBytes.

DelimiterByte

public int DelimiterByte()

Returns the delimiter byte to use when passing a negative number for the numberOfBytes parameter when calling ReceiveText, ReceiveSignedBytes, or ReceiveUnsignedBytes.

SendText

public void SendText(java.lang.String text)

Converts the given text to bytes and writes them to the output stream.

Parameters:

text - the text to write

Send1ByteNumber

public void Send1ByteNumber(java.lang.String number)

Decodes the given number String to an integer and writes it as one byte to the output stream. If the number could not be decoded to an integer, or the integer would not fit in one byte, then the Form's ErrorOccurred event is triggered and this method returns without writing any bytes to the output stream.

Parameters:

number - the number to write

Send2ByteNumber

public void Send2ByteNumber(java.lang.String number)

Decodes the given number String to an integer and writes it as two bytes to the output stream. If the number could not be decoded to an integer, or the integer would not fit in two bytes, then the Form's ErrorOccurred event is triggered and this method returns without writing any bytes to the output stream.

Parameters:

number - the number to write

Send4ByteNumber

public void Send4ByteNumber(java.lang.String number)

Decodes the given number String to an integer and writes it as four bytes to the output stream. If the number could not be decoded to an integer, or the integer would not fit in four bytes, then the Form's ErrorOccurred event is triggered and this method returns without writing any bytes to the output stream.

Parameters:

number - the number to write

SendBytes

public void SendBytes(YailList list)

Takes each element from the given list, converts it to a String, decodes the String to an integer, and writes it as one byte to the output stream. If an element could not be decoded to an integer, or the integer would not fit in one byte, then the Form's ErrorOccurred event is triggered and this method returns without writing any bytes to the output stream.

Parameters:

list - the list of numeric values to write

write

protected void write(java.lang.String functionName,
         byte b)

Writes the given byte to the output stream.

Parameters:

functionName - the name of the SimpleFunction calling this method

b - the byte to write

write

protected void write(java.lang.String functionName,
         byte[] bytes)

Writes the given bytes to the output stream.

Parameters:

functionName - the name of the SimpleFunction calling this method

bytes - the bytes to write

BytesAvailableToReceive

public int BytesAvailableToReceive()

Returns number of bytes available from the input stream.

ReceiveText

public java.lang.String ReceiveText(int numberOfBytes)

Reads a number of bytes from the input stream and converts them to text. If numberOfBytes is negative, read until a delimiter byte value is read.

Parameters:

numberOfBytes - the number of bytes to read; a negative number indicates to read until a delimiter byte value is read

ReceiveSigned1ByteNumber

public int ReceiveSigned1ByteNumber()

Reads a signed 1-byte number.

ReceiveUnsigned1ByteNumber

public int ReceiveUnsigned1ByteNumber()

Reads an unsigned 1-byte number.

ReceiveSigned2ByteNumber

public int ReceiveSigned2ByteNumber()

Reads a signed 2-byte number.

ReceiveUnsigned2ByteNumber

public int ReceiveUnsigned2ByteNumber()

Reads an unsigned 2-byte number.

ReceiveSigned4ByteNumber

public long ReceiveSigned4ByteNumber()

Reads a signed 4-byte number.

ReceiveUnsigned4ByteNumber

public long ReceiveUnsigned4ByteNumber()

Reads an unsigned 4-byte number.

ReceiveSignedBytes

public java.util.List<java.lang.Integer> ReceiveSignedBytes(int numberOfBytes)

Reads a number of signed bytes from the input stream and returns them as a List. If numberOfBytes is negative, this method reads until a delimiter byte value is read. The delimiter byte value is included in the returned list.

Parameters:

numberOfBytes - the number of bytes to read; a negative number indicates to read until a delimiter byte value is read

ReceiveUnsignedBytes

public java.util.List<java.lang.Integer> ReceiveUnsignedBytes(int numberOfBytes)

Reads a number of unsigned bytes from the input stream and returns them as a List. If numberOfBytes is negative, this method reads until a delimiter byte value is read. The delimiter byte value is included in the returned list.

Parameters:

numberOfBytes - the number of bytes to read; a negative number indicates to read until a delimiter byte value is read

read

protected final byte[] read(java.lang.String functionName,
          int numberOfBytes)

Reads a number of bytes from the input stream. If numberOfBytes is negative, this method reads until a delimiter byte value is read. The delimiter byte is included in the returned array.

Parameters:

functionName - the name of the SimpleFunction calling this method

numberOfBytes - the number of bytes to read; a negative number indicates to read until a delimiter byte value is read

onDestroy

public void onDestroy()

Specified by:

onDestroy in interface OnDestroyListener

onDelete

public void onDelete()

Specified by:

onDelete in interface Deleteable