com.swirl

Class Config.Beacon

java.lang.Object

com.swirl.SObject

com.swirl.Signal

com.swirl.Beacon

com.swirl.Config.Beacon

Enclosing class:

Config

public static class Config.Beacon
extends Beacon

Field Summary

Fields inherited from class com.swirl.Beacon

ENTERED_RSSI, INVALID_RANGE, INVALID_RSSI, STATE_INSIDE, STATE_OUTSIDE, STATE_UNKNOWN

Fields inherited from class com.swirl.Signal

TYPE_BEACON, TYPE_GEOFENCE, TYPE_WIFI

Fields inherited from class com.swirl.SObject

properties

Constructor Summary

Constructors

Constructor and Description
Beacon(Config.Location location, org.json.JSONObject properties)

Method Summary

Modifier and Type	Method and Description
void	abortConfiguration() Discards any pending changes and resets the beacon to current settings.
void	beginConfiguration() Begin a set of beacon configuration operations.
void	commitConfiguration(boolean force, Completion completion) Flushes pending configuration changes to the server and calls the completion when all changes have been completed or an error occurs.
double	getBattery()
org.json.JSONObject	getDeviceConfigurationState()
android.graphics.Bitmap	getFarImage() Gets far image
void	getFarImage(Completion completion) Return the locally configured pending far image or fetch the previously configured image.
Config.ImageMarker	getFarImageMarker() Get the image marker associated with the far image
Config.Firmware	getFirmware()
Config.Floorplan	getFloorplan() Gets Floorplan
Config.ImageMarker	getFloorplanMarker() Get the pin location marker
Config.Location	getLocation() Return the current (possibly uncommitted) location for the beacon
java.lang.String	getMacAddress()
android.graphics.Bitmap	getNearImage() Gets near image
void	getNearImage(Completion completion) Return the locally configured pending near image or fetch the previously configured image.
Config.ImageMarker	getNearImageMarker() Get the image marker associated with the near image
static void	getPeripheralBeacon(Beacon beacon, java.lang.String urn, Completion completion)
static void	getPeripheralBeacon(Beacon beacon, java.lang.String urn, long timeout, Completion completion)
Placement	getPlacement() Returns the current (possibly uncommitted) placement for the beacon
org.json.JSONObject	getServerConfigurationState()
void	load(Completion completion)
boolean	needsUpdate()
void	setFarImage(android.graphics.Bitmap image) Associates a far image with a beacon and optional marker
void	setFarImageMarker(Config.ImageMarker marker) Set an image marker for the far image
void	setFirmware(Config.Firmware firmware) Set the firmware for this beacon.
void	setFloorplanLocation(Config.Floorplan floorplan, Config.ImageMarker marker) Sets the floorplan location (pin) for the beacon
void	setLocation(Config.Location location) Sets the new location for the beacon.
void	setNearImage(android.graphics.Bitmap image) Associates a near image with a beacon and optional marker
void	setNearImageMarker(Config.ImageMarker marker) Set an image marker for the near image
void	setPlacement(Placement placement) Set the current placement for the beacon
void	setServerConfigurationState(org.json.JSONObject serverState)
java.lang.String	toString()

Methods inherited from class com.swirl.Beacon

getAddress, getAdvertisements, getdBm1, getExtra, getLast, getLastDetected, getManufacturer, getModel, getName, getPartner, getPeripheral, getPower, getProtocol, getProtocolString, getRange, getRssi, getSerial, getState, getThreshold, getType, isConnectable, isOverlapping, setRssiParams

Methods inherited from class com.swirl.Signal

getAttachments, getAttributes, getError, getLabels, getURN, setError

Methods inherited from class com.swirl.SObject

equals, getArray, getArray, getDouble, getIdentifier, getInt, getObject, getObject, getString, getString, hashCode, setProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Beacon

public Beacon(Config.Location location,
              org.json.JSONObject properties)

Method Detail

getMacAddress

public java.lang.String getMacAddress()

getBattery

public double getBattery()

needsUpdate

public boolean needsUpdate()

load

public void load(Completion completion)

beginConfiguration

public void beginConfiguration()

Begin a set of beacon configuration operations. Reset internal state.

setLocation

public void setLocation(Config.Location location)

Sets the new location for the beacon.

Parameters:

location - the location to change the beacon placement for

getLocation

public Config.Location getLocation()

Return the current (possibly uncommitted) location for the beacon

Overrides:

getLocation in class Signal

Returns:

returns the current location

See Also:

Location

setPlacement

public void setPlacement(Placement placement)

Set the current placement for the beacon

Parameters:

placement -

getPlacement

public Placement getPlacement()

Returns the current (possibly uncommitted) placement for the beacon

Returns:

placement

setFloorplanLocation

public void setFloorplanLocation(Config.Floorplan floorplan,
                                 Config.ImageMarker marker)

Sets the floorplan location (pin) for the beacon

Parameters:

floorplan -

getFloorplan

public Config.Floorplan getFloorplan()

Gets Floorplan

Returns:

floorplan associated with the beacon

getFloorplanMarker

public Config.ImageMarker getFloorplanMarker()

Get the pin location marker

Returns:

image marker for x,y raius is ignored

setFarImage

public void setFarImage(android.graphics.Bitmap image)

Associates a far image with a beacon and optional marker

Parameters:

image -

setNearImage

public void setNearImage(android.graphics.Bitmap image)

Associates a near image with a beacon and optional marker

Parameters:

image -

getFarImage

public android.graphics.Bitmap getFarImage()

Gets far image

Returns:

far image associated with the beacon

getNearImage

public android.graphics.Bitmap getNearImage()

Gets near image

Returns:

near image associated with the beacon

getFarImage

public void getFarImage(Completion completion)

Return the locally configured pending far image or fetch the previously configured image.

Parameters:

completion - returns the Bitmap in the data portion

getNearImage

public void getNearImage(Completion completion)

Return the locally configured pending near image or fetch the previously configured image.

Parameters:

completion - returns the Bitmap in the data portion

setFarImageMarker

public void setFarImageMarker(Config.ImageMarker marker)

Set an image marker for the far image

Parameters:

marker - (x, y, radius) of image marker

setNearImageMarker

public void setNearImageMarker(Config.ImageMarker marker)

Set an image marker for the near image

Parameters:

marker - (x, y, radius) of image marker

getFarImageMarker

public Config.ImageMarker getFarImageMarker()

Get the image marker associated with the far image

Returns:

an image marker

getNearImageMarker

public Config.ImageMarker getNearImageMarker()

Get the image marker associated with the near image

Returns:

an image marker

setFirmware

public void setFirmware(Config.Firmware firmware)

Set the firmware for this beacon.

Parameters:

firmware - A firmware object valid for this beacon

getFirmware

public Config.Firmware getFirmware()

getDeviceConfigurationState

public org.json.JSONObject getDeviceConfigurationState()

getServerConfigurationState

public org.json.JSONObject getServerConfigurationState()

setServerConfigurationState

public void setServerConfigurationState(org.json.JSONObject serverState)

abortConfiguration

public void abortConfiguration()

Discards any pending changes and resets the beacon to current settings.

commitConfiguration

public void commitConfiguration(boolean force,
                                Completion completion)

Flushes pending configuration changes to the server and calls the completion when all changes have been completed or an error occurs.

Parameters:

force -

completion -

getPeripheralBeacon

public static void getPeripheralBeacon(Beacon beacon,
                                       java.lang.String urn,
                                       Completion completion)

getPeripheralBeacon

public static void getPeripheralBeacon(Beacon beacon,
                                       java.lang.String urn,
                                       long timeout,
                                       Completion completion)

toString

public java.lang.String toString()

Overrides:

toString in class Beacon