com.idevicesinc.sweetblue

Class BleWrite

java.lang.Object

com.idevicesinc.sweetblue.BleOp<BleWrite>

com.idevicesinc.sweetblue.BleWrite

public final class BleWrite
extends BleOp<BleWrite>

Builder-type class for sending a write over BLE. Use this class to set the service and/or characteristic UUIDs, and the data you'd like to write. This class provides convenience methods for sending booleans, ints, shorts, longs, and Strings. Use with BleDevice.write(BleWrite), or BleDevice.write(BleWrite, ReadWriteListener). Note that all BleOp classes assume the device you're talking to is ByteOrder.BIG_ENDIAN. While Java is ByteOrder.BIG_ENDIAN by default, android actually is ByteOrder.LITTLE_ENDIAN, so the convenience methods take this into account by reversing the bytes. If you don't want this to happen, the call setIsBigEndian(boolean) to false.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BleWrite.Builder Builder class to build out a list (or array) of BleWrite instances.

Field Summary

Fields

Modifier and Type	Field and Description
static BleWrite	INVALID "Invalid" static instance used when doing things like setting connection parameters

Constructor Summary

Constructors

Constructor and Description
BleWrite()
BleWrite(BleWrite write) Constructor which creates a new BleWrite from an existing one.
BleWrite(boolean bigEndian)
BleWrite(java.util.UUID characteristicUuid)
BleWrite(java.util.UUID serviceUuid, java.util.UUID characteristicUuid)

Method Summary

Modifier and Type	Method and Description
ReadWriteListener.Type	getWriteType_safe() This is almost the same as getWriteType(), only that this will never return null.
ReadWriteListener.Type	getWriteType()
boolean	isValid() Returns true if the minimum values have been set for this operation
BleWrite	setBoolean(boolean value) Set the boolean to write.
BleWrite	setBytes(byte[] data) Set the raw bytes to write.
BleWrite	setInt(int val) Set an int to be written.
BleWrite	setIsBigEndian(boolean isBigEndian) Tells SweetBlue the endianness of the BLE device you want to perform a write to.
BleWrite	setLong(long val) Set a long to be written.
BleWrite	setShort(short val) Set a short to be written.
BleWrite	setString(java.lang.String value) Set a string to be written.
BleWrite	setString(java.lang.String value, java.lang.String stringEncoding) Set a string to be written.
BleWrite	setWriteType(ReadWriteListener.Type writeType) Set the ReadWriteListener.Type of the write to perform.

Methods inherited from class com.idevicesinc.sweetblue.BleOp

getCharacteristicUuid, getData, getDescriptorFilter, getDescriptorUuid, getReadWriteListener, getServiceUuid, isCharUuidValid, isNotify, isRead, isServiceUuidValid, isWrite, setCharacteristicUUID, setData, setDescriptorFilter, setReadWriteListener, setServiceUUID

Methods inherited from class java.lang.Object

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

Field Detail

INVALID

public static final BleWrite INVALID

"Invalid" static instance used when doing things like setting connection parameters

Constructor Detail

BleWrite

public BleWrite()

BleWrite

public BleWrite(java.util.UUID serviceUuid,
                java.util.UUID characteristicUuid)

BleWrite

public BleWrite(java.util.UUID characteristicUuid)

BleWrite

public BleWrite(boolean bigEndian)

BleWrite

public BleWrite(BleWrite write)

Constructor which creates a new BleWrite from an existing one. This only copies over the service, characteristic, the writeType, and if it's bigEndian or not. This does NOT copy over any listeners, filters, or data.

Method Detail

isValid

public final boolean isValid()

Description copied from class: BleOp

Returns true if the minimum values have been set for this operation

Specified by:

isValid in class BleOp<BleWrite>

setIsBigEndian

public final BleWrite setIsBigEndian(boolean isBigEndian)

Tells SweetBlue the endianness of the BLE device you want to perform a write to. This value only matters if you are using any of the convenience methods:

setBoolean(boolean)
setInt(int)
setLong(long)
setShort(short)
setString(String)
setString(String, String)

setWriteType

public final BleWrite setWriteType(ReadWriteListener.Type writeType)

Set the ReadWriteListener.Type of the write to perform. This is here in the case that the characteristic you are writing to has more than one write type associated with it eg. BluetoothGattCharacteristic.WRITE_TYPE_NO_RESPONSE, BluetoothGattCharacteristic.WRITE_TYPE_SIGNED along with standard writes.

getWriteType

public final ReadWriteListener.Type getWriteType()

getWriteType_safe

public final ReadWriteListener.Type getWriteType_safe()

This is almost the same as getWriteType(), only that this will never return null. If the writetype wasn't explicitly set, it will be null, in this case, this method will return the type as ReadWriteListener.Type.WRITE.

setBytes

public final BleWrite setBytes(byte[] data)

Set the raw bytes to write.

setBoolean

public final BleWrite setBoolean(boolean value)

Set the boolean to write.

setInt

public final BleWrite setInt(int val)

Set an int to be written.

setShort

public final BleWrite setShort(short val)

Set a short to be written.

setLong

public final BleWrite setLong(long val)

Set a long to be written.

setString

public final BleWrite setString(java.lang.String value,
                                java.lang.String stringEncoding)

Set a string to be written. This method also allows you to specify the string encoding. If the encoding fails, then String.getBytes() is used instead, which uses "UTF-8" by default.

setString

public final BleWrite setString(java.lang.String value)

Set a string to be written. This defaults to "UTF-8" encoding.