org.altbeacon.beacon

Class BeaconTransmitter

java.lang.Object

org.altbeacon.beacon.BeaconTransmitter

public class BeaconTransmitter
extends Object

Provides a mechanism for transmitting as a beacon. Requires Android 5.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOT_SUPPORTED_BLE
static int	NOT_SUPPORTED_CANNOT_GET_ADVERTISER
static int	NOT_SUPPORTED_CANNOT_GET_ADVERTISER_MULTIPLE_ADVERTISEMENTS
static int	NOT_SUPPORTED_MIN_SDK
static int	NOT_SUPPORTED_MULTIPLE_ADVERTISEMENTS Deprecated.
static int	SUPPORTED

Constructor Summary

Constructors

Constructor and Description
BeaconTransmitter(Context context, BeaconParser parser) Creates a new beacon transmitter capable of transmitting beacons with the format specified in the BeaconParser and with the data fields specified in the Beacon object

Method Summary

Modifier and Type	Method and Description
static int	checkTransmissionSupported(Context context) Checks to see if this device supports beacon advertising
int	getAdvertiseMode()
int	getAdvertiseTxPowerLevel()
boolean	isConnectable()
boolean	isStarted() Tells if transmission has started
void	setAdvertiseMode(int mAdvertiseMode) AdvertiseSettings.ADVERTISE_MODE_BALANCED 3 Hz AdvertiseSettings.ADVERTISE_MODE_LOW_LATENCY 10 Hz AdvertiseSettings.ADVERTISE_MODE_LOW_POWER 1 Hz
void	setAdvertiseTxPowerLevel(int mAdvertiseTxPowerLevel) AdvertiseSettings.ADVERTISE_TX_POWER_HIGH -56 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_LOW -75 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_MEDIUM -66 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_ULTRA_LOW not detected with Nexus 5
void	setBeacon(Beacon beacon) Sets the beacon whose fields will be transmitted
void	setBeaconParser(BeaconParser beaconParser) Sets the beaconParsser used for formatting the transmission
void	setConnectable(boolean connectable) Whether the advertisement should indicate the device is connectable.
void	startAdvertising() Starts this beacon advertising
void	startAdvertising(Beacon beacon) Starts advertising with fields from the passed beacon
void	startAdvertising(Beacon beacon, AdvertiseCallback callback) Starts advertising with fields from the passed beacon
void	stopAdvertising() Stops this beacon from advertising

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED

public static final int SUPPORTED

See Also:

Constant Field Values

NOT_SUPPORTED_MIN_SDK

public static final int NOT_SUPPORTED_MIN_SDK

See Also:

Constant Field Values

NOT_SUPPORTED_BLE

public static final int NOT_SUPPORTED_BLE

See Also:

Constant Field Values

NOT_SUPPORTED_MULTIPLE_ADVERTISEMENTS

@Deprecated
public static final int NOT_SUPPORTED_MULTIPLE_ADVERTISEMENTS

Deprecated.

See Also:

Constant Field Values

NOT_SUPPORTED_CANNOT_GET_ADVERTISER

public static final int NOT_SUPPORTED_CANNOT_GET_ADVERTISER

See Also:

Constant Field Values

NOT_SUPPORTED_CANNOT_GET_ADVERTISER_MULTIPLE_ADVERTISEMENTS

public static final int NOT_SUPPORTED_CANNOT_GET_ADVERTISER_MULTIPLE_ADVERTISEMENTS

See Also:

Constant Field Values

Constructor Detail

BeaconTransmitter

public BeaconTransmitter(Context context,
                         BeaconParser parser)

Creates a new beacon transmitter capable of transmitting beacons with the format specified in the BeaconParser and with the data fields specified in the Beacon object

Parameters:

context -

parser - specifies the format of the beacon transmission

Method Detail

isStarted

public boolean isStarted()

Tells if transmission has started

Returns:

setBeacon

public void setBeacon(Beacon beacon)

Sets the beacon whose fields will be transmitted

Parameters:

beacon -

setBeaconParser

public void setBeaconParser(BeaconParser beaconParser)

Sets the beaconParsser used for formatting the transmission

Parameters:

beaconParser -

getAdvertiseMode

public int getAdvertiseMode()

Returns:

advertiseMode

See Also:

setAdvertiseMode(int)

setAdvertiseMode

public void setAdvertiseMode(int mAdvertiseMode)

AdvertiseSettings.ADVERTISE_MODE_BALANCED 3 Hz AdvertiseSettings.ADVERTISE_MODE_LOW_LATENCY 10 Hz AdvertiseSettings.ADVERTISE_MODE_LOW_POWER 1 Hz

Parameters:

mAdvertiseMode -

getAdvertiseTxPowerLevel

public int getAdvertiseTxPowerLevel()

Returns:

txPowerLevel

See Also:

setAdvertiseTxPowerLevel(int mAdvertiseTxPowerLevel)

setAdvertiseTxPowerLevel

public void setAdvertiseTxPowerLevel(int mAdvertiseTxPowerLevel)

AdvertiseSettings.ADVERTISE_TX_POWER_HIGH -56 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_LOW -75 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_MEDIUM -66 dBm @ 1 meter with Nexus 5 AdvertiseSettings.ADVERTISE_TX_POWER_ULTRA_LOW not detected with Nexus 5

Parameters:

mAdvertiseTxPowerLevel -

setConnectable

public void setConnectable(boolean connectable)

Whether the advertisement should indicate the device is connectable.

Parameters:

connectable -

isConnectable

public boolean isConnectable()

Returns:

connectable

See Also:

setConnectable(boolean)

startAdvertising

public void startAdvertising(Beacon beacon)

Starts advertising with fields from the passed beacon

Parameters:

beacon -

startAdvertising

public void startAdvertising(Beacon beacon,
                             AdvertiseCallback callback)

Starts advertising with fields from the passed beacon

Parameters:

beacon -

startAdvertising

public void startAdvertising()

Starts this beacon advertising

stopAdvertising

public void stopAdvertising()

Stops this beacon from advertising

checkTransmissionSupported

public static int checkTransmissionSupported(Context context)

Checks to see if this device supports beacon advertising

Returns:

SUPPORTED if yes, otherwise: NOT_SUPPORTED_MIN_SDK NOT_SUPPORTED_BLE NOT_SUPPORTED_MULTIPLE_ADVERTISEMENTS NOT_SUPPORTED_CANNOT_GET_ADVERTISER