{"id":25272,"date":"2015-08-06T16:22:30","date_gmt":"2015-08-06T10:52:30","guid":{"rendered":"http:\/\/www.tothenew.com\/blog\/?p=25272"},"modified":"2015-10-13T14:34:53","modified_gmt":"2015-10-13T09:04:53","slug":"beacon-implementation-in-android","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/beacon-implementation-in-android\/","title":{"rendered":"Beacon Implementation in Android"},"content":{"rendered":"

In our previous post<\/a> we have given a overview of what Beacon is, so here we are with its practical implementation.<\/p>\n

There are two applications required to create Beacon experience.<\/p>\n

1. Transmitter
\n2. Receiver<\/p>\n

For Transmitter \u2013<\/p>\n

1. Bluetooth should be on
\ngetSystemService(Context.BLUETOOTH_SERVICE)<\/p>\n

2. BLE supported device
\nhasSystemFeature(PackageManager.FEATURE_BLUETOOTH_LE))<\/p>\n

<uses-permission android:name=”android.permission.BLUETOOTH” \/>
\n<uses-permission android:name=”android.permission.BLUETOOTH_ADMIN” \/><\/p>\n

If device supports BLE, then the Beacon Transmitter transmits the advertisements like this,<\/p>\n

\/**
\n* Simulates a new beacon every 10 seconds until it runs out of new ones to add.
\n*\/<\/p>\n

[code language=”java”]
\nBeacon beacon = new Beacon.Builder()
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .setId1(\u201c2f234454-cf6d-4a0f-adf2-f4911ba9ffa6\u201d)
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .setId2(\u201c1\u201d)
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .setId3(\u201c2\u201d)
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .setManufacturer(0x0118)
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .setTxPower(-59)
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .setDataFields(Arrays.asList(new Long[] {0l}))
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .build();
\nBeaconParser beaconParser = new BeaconParser()
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .setBeaconLayout("m:2-3=beac,i:4-19,i:20-21,i:22-23,p:24-24,d:25-25");
\nBeaconTransmitter beaconTransmitter = new BeaconTransmitter(getApplicationContext(), beaconParser);
\nbeaconTransmitter.startAdvertising(beacon);
\nscheduleTaskExecutor= Executors.newScheduledThreadPool(5);
\n\/\/ This schedules an beacon to appear every 10 seconds:
\nscheduleTaskExecutor.scheduleAtFixedRate(new Runnable(){
\n public void run() {
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 try{
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 \/\/putting a single beacon back into the beacons list.
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 if (finalBeacons.size() > beacons.size())
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 beacons.add(finalBeacons.get(beacons.size()));
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0else
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 scheduleTaskExecutor.shutdown();
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 }catch(Exception e){
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 e.printStackTrace();
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 }
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 }
\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 }, 0, 10, TimeUnit.SECONDS);
\n\u00a0\u00a0 \u00a0 }
\n }
\n[\/code]<\/p>\n

Beacon Advertisement Receiver<\/p>\n

Two classes are main in this receiver
\n1. Beacon Parser
\n2. Beacon Manager<\/p>\n

Beacon Parser \u2013 It parses the advertised data into relevant information.<\/p>\n

 <\/p>\n

[code language=”java”]
\n@TargetApi(5)
\nprotected Beacon fromScanData(byte[] scanData, int rssi, BluetoothDevice device, Beacon beacon) {
\nint startByte = 2;
\nboolean patternFound = false;
\nbyte[] typeCodeBytes = longToByteArray(getMatchingBeaconTypeCode(), mMatchingBeaconTypeCodeEndOffset-mMatchingBeaconTypeCodeStartOffset+1);<\/p>\n

while (startByte <= 5) {
\n\u00a0\u00a0\u00a0\u00a0\u00a0 if (byteArraysMatch(scanData, startByte+mMatchingBeaconTypeCodeStartOffset, typeCodeBytes, 0)) {
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 patternFound = true;
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 break;
\n\u00a0\u00a0\u00a0\u00a0\u00a0 }
\n\u00a0\u00a0\u00a0\u00a0\u00a0 startByte++;
\n}<\/p>\n

if (patternFound == false) {
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ This is not an beacon
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 BeaconManager.logDebug(TAG, "This is not a matching Beacon advertisement.\u00a0 (Was expecting "+byteArrayToString(typeCodeBytes)+".\u00a0 The bytes I see are: "+bytesToHex(scanData));
\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return null;
\n}
\nelse {
\n\/\/BeaconManager.logDebug(TAG, "This is a recognized beacon advertisement — "+String.format("%04x", getMatchingBeaconTypeCode())+" seen");
\nLog.e("rec beacon**", "This is a recognized beacon advertisement — "+String.format("%04x", getMatchingBeaconTypeCode())+" seen");
\n}<\/p>\n

ArrayList<Identifier> identifiers = new ArrayList<Identifier>();
\nfor (int i = 0; i < mIdentifierEndOffsets.size(); i++) {
\n\u00a0\u00a0\u00a0 String idString = byteArrayToFormattedString(scanData, mIdentifierStartOffsets.get(i)+startByte, mIdentifierEndOffsets.get(i)+startByte, mIdentifierLittleEndianFlags.get(i));
\n\u00a0\u00a0\u00a0 Log.e("idString",idString);
\n\u00a0\u00a0\u00a0 identifiers.add(Identifier.parse(idString));
\n}
\nArrayList<Long> dataFields = new ArrayList<Long>();
\nfor (int i = 0; i < mDataEndOffsets.size(); i++) {
\n\u00a0\u00a0\u00a0\u00a0 String dataString = byteArrayToFormattedString(scanData, mDataStartOffsets.get(i)+startByte, mDataEndOffsets.get(i)+startByte, mDataLittleEndianFlags.get(i));
\n\u00a0\u00a0\u00a0\u00a0 dataFields.add(Long.parseLong(dataString));
\n\u00a0\u00a0\u00a0\u00a0 BeaconManager.logDebug(TAG, "parsing found data field "+i);
\n\u00a0\u00a0\u00a0\u00a0 \/\/ TODO: error handling needed here on the parse
\n}<\/p>\n

int txPower = 0;
\nString powerString = byteArrayToFormattedString(scanData, mPowerStartOffset+startByte, mPowerEndOffset+startByte, false);
\ntxPower = Integer.parseInt(powerString);<\/p>\n

\/\/ make sure it is a signed integer
\nif (txPower > 127) {
\n\u00a0\u00a0\u00a0 txPower -= 256;
\n}
\nLog.e("txPower data",txPower+"");
\n\u00a0\u00a0\u00a0\u00a0 \u00a0
\n\/\/ TODO: error handling needed on the parse<\/p>\n

int beaconTypeCode = 0;
\nString beaconTypeString = byteArrayToFormattedString(scanData, mMatchingBeaconTypeCodeStartOffset+startByte, mMatchingBeaconTypeCodeEndOffset+startByte, false);
\nbeaconTypeCode = Integer.parseInt(beaconTypeString);
\n\/\/ TODO: error handling needed on the parse<\/p>\n

int manufacturer = 0;
\nString manufacturerString = byteArrayToFormattedString(scanData, startByte, startByte+1, true);
\nmanufacturer = Integer.parseInt(manufacturerString);<\/p>\n

String macAddress = null;
\nString name = null;
\nif (device != null) {
\n\u00a0\u00a0\u00a0 macAddress = device.getAddress();
\n\u00a0\u00a0\u00a0 name = device.getName();
\n}
\nbeacon.mIdentifiers = identifiers;
\nbeacon.mDataFields = dataFields;
\nbeacon.mTxPower = txPower;
\nbeacon.mRssi = rssi;
\nbeacon.mBeaconTypeCode = beaconTypeCode;
\nbeacon.mBluetoothAddress = macAddress;
\nbeacon.mBluetoothName= name;
\nbeacon.mManufacturer = manufacturer;
\nreturn beacon;
\n}<\/p>\n

[\/code]<\/p>\n

Beacon Manager \u2013 It specifies the time interval for scanning Beacons in range.<\/p>\n

public static final long DEFAULT_FOREGROUND_SCAN_PERIOD = 1000;
\n\/**
\n* The default duration in milliseconds spent not scanning between each bluetooth scan\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 cycle
\n*\/<\/p>\n

 <\/p>\n

[code language=”java”]
\npublic static final long DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD = 2*60*1000;\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/ 2 minutes in foreground<\/p>\n

[\/code]<\/p>\n

\/**
\n* The default duration in milliseconds of the bluetooth scan cycle when no \u00a0\u00a0 \u00a0ranging\/monitoring clients
\n*\/\u00a0\u00a0 \u00a0are in the foreground<\/p>\n

[code language=”java”]
\npublic static final long DEFAULT_BACKGROUND_SCAN_PERIOD = 10000;<\/p>\n

[\/code]<\/p>\n

\/**
\n* The default duration in milliseconds spent not scanning between each bluetooth scan \u00a0\u00a0 \u00a0cycle when no\u00a0\u00a0 *\/\u00a0\u00a0 \u00a0ranging\/monitoring clients are in the foreground<\/p>\n

[code language=”java”]
\npublic static final long DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD = 2*60*1000;\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/ 2 minutes in background<\/p>\n

[\/code]<\/p>\n

\"Beacon<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

In our previous post we have given a overview of what Beacon is, so here we are with its practical implementation. There are two applications required to create Beacon experience. 1. Transmitter 2. Receiver For Transmitter \u2013 1. Bluetooth should be on getSystemService(Context.BLUETOOTH_SERVICE) 2. BLE supported device hasSystemFeature(PackageManager.FEATURE_BLUETOOTH_LE)) <uses-permission android:name=”android.permission.BLUETOOTH” \/> <uses-permission android:name=”android.permission.BLUETOOTH_ADMIN” \/> If […]<\/p>\n","protected":false},"author":164,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":0},"categories":[518,446,1772,1],"tags":[2184],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/25272"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/164"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=25272"}],"version-history":[{"count":0,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/25272\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=25272"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=25272"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=25272"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}