Before using beacon capabilities, you need to register beacon devices with your project. For details, please refer to Beacon Management.

Assigning Permissions in the Manifest File

Before calling the beacon awareness capability, assign required permissions in the manifest file.

<!-- Location permission. This permission is sensitive and needs to be dynamically applied for in the code after being declared. -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<!-- Bluetooth permission -->
<uses-permission android:name="android.permission.BLUETOOTH" />

Importing API Classes

To use the beacon awareness capability, you need to import the public capability classes of HUAWEI Awareness Kit, and also the beacon-related classes.

import com.huawei.hmf.tasks.OnFailureListener;
import com.huawei.hmf.tasks.OnSuccessListener;
import com.huawei.hms.kit.awareness.Awareness;
// Import the beacon capture-related classes.
import com.huawei.hms.kit.awareness.capture.BeaconStatusResponse;
import com.huawei.hms.kit.awareness.status.BeaconStatus;
// Import the beacon barrier-related classes.
import com.huawei.hms.kit.awareness.barrier.AwarenessBarrier;
import com.huawei.hms.kit.awareness.barrier.BarrierStatus;
import com.huawei.hms.kit.awareness.barrier.BeaconBarrier;
import com.huawei.hms.kit.awareness.barrier.BarrierUpdateRequest;

Developing Capabilities

Developing capture capabilities

1. Obtain the Capture Client object of HUAWEI Awareness Kit.

2. Call the beacon query capability API through the Capture Client object to obtain the user's context.

3. Enable your app to listen for the result returned by HUAWEI Awareness Kit for further processing.

String namespace = "sample namespace";
String type = "sample type";
byte[] content = new byte[]{'s', 'a', 'm', 'p', 'l', 'e'};
BeaconStatus.Filter filter = BeaconStatus.Filter.match(namespace, type, content);
Awareness.getCaptureClient(this).getBeaconStatus(filter)
        .addOnSuccessListener(new OnSuccessListener<BeaconStatusResponse>() {
            @Override
            public void onSuccess(BeaconStatusResponse beaconStatusResponse) {
                List<BeaconStatus.BeaconData> beaconDataList = beaconStatusResponse.
                        getBeaconStatus().getBeaconData();
                if (beaconDataList != null && beaconDataList.size() != 0) {
                    int i = 1;
                    StringBuilder builder = new StringBuilder();
                    for (BeaconStatus.BeaconData beaconData : beaconDataList) {
                        builder.append("Beacon Data ").append(i);
                        builder.append(" namespace:").append(beaconData.getNamespace());
                        builder.append(",type:").append(beaconData.getType());
                        builder.append(",content:").append(Arrays.toString(beaconData.getContent()));
                        builder.append("; ");
                        i++;
                    }
                    Log.i(TAG, builder.toString());
                } else {
                    Log.i(TAG, "no beacons match filter nearby");
                }
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(Exception e) {
                Log.e(TAG, "get beacon status failed", e);
            }
        });

Developing barrier capabilities

The following example illustrates how to develop a barrier triggered by the discover condition. That is, the barrier will be triggered when the filter parameters passed by a beacon match those defined here.

1. Define the barrier.

String namespace = "sample namespace";
String type = "sample type";
byte[] content = new byte[]{'s', 'a', 'm', 'p', 'l', 'e'};
BeaconStatus.Filter filter = BeaconStatus.Filter.match(namespace, type, content);
AwarenessBarrier discoverBeaconBarrier = BeaconBarrier.discover(filter);

2. Define PendingIntent that will be triggered upon a barrier status change, for example, to send a broadcast, and create a broadcast receiver to receive the broadcast.

final String BARRIER_RECEIVER_ACTION = getApplication().getPackageName() + "BEACON_BARRIER_RECEIVER_ACTION";
Intent intent = new Intent(BARRIER_RECEIVER_ACTION);
PendingIntent pendingIntent = PendingIntent.getBroadcast(this, 1, intent, PendingIntent.FLAG_UPDATE_CURRENT);
BeaconBarrierReceiver barrierReceiver = new BeaconBarrierReceiver();
registerReceiver(barrierReceiver, new IntentFilter(BARRIER_RECEIVER_ACTION));

3. Define the label for the barrier and add the barrier.

String beaconBarrierLabel = "discover beacon barrier";
BarrierUpdateRequest.Builder builder = new BarrierUpdateRequest.Builder();
BarrierUpdateRequest request = builder.addBarrier(beaconBarrierLabel, discoverBeaconBarrier,pendingIntent).build(); 
Awareness.getBarrierClient(context).updateBarriers(request)
        .addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void aVoid) {
                Toast.makeText(getApplicationContext(), "add barrier success", Toast.LENGTH_SHORT).show();
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(Exception e) {
                Toast.makeText(getApplicationContext(), "add barrier failed", Toast.LENGTH_SHORT).show();
                Log.e(TAG, "add barrier failed", e);
            }
        });

4. Define the broadcast receiver to listen for the barrier event for further processing.

class BeaconBarrierReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {
        BarrierStatus barrierStatus = BarrierStatus.extract(intent);
        String label = barrierStatus.getBarrierLabel();
        switch(barrierStatus.getPresentStatus()) {
            case BarrierStatus.TRUE:
                Log.i(TAG, label + " status:true");
                break;
            case BarrierStatus.FALSE:
                Log.i(TAG, label + " status:false");
                break;
            case BarrierStatus.UNKNOWN:
                Log.i(TAG, label + " status:unknown");
                break;
        }
    }
}