FeasyBeacon SDK Android Interface Guide

[中文版]

Corresponding SDK version	Document Version	Compilation Date	Author
FeasyBeacon-SDK-Android-3.3.6.zip	3.3.6.0	2024-11-19	Chang JiGang

SDK Overview

Android Integration

Integrating this SDK into an Android application enables quick implementation of the following features:

• Scanning and stopping scanning of the Beacon module

• Connecting and disconnecting from the Beacon module

• Information query and parameter modification of the Beacon module

• Over-the-air upgrade of the Beacon module

Understanding Instance Objects

BluetoothDeviceWrapper class wraps Bluetooth device information and is used to represent scanned Bluetooth devices.

// BluetoothDeviceWrapper class wraps Bluetooth device information and is used to represent scanned Bluetooth devices.
  public class BluetoothDeviceWrapper implements Serializable {

 // Beacon type constants
 public static final int EDDYSTONE_TYPE = 0x16;
 public static final int ALTBEACON_TYPE = 0xFF;
 public static final int COMPLETE_LOCAL_NAME = 0x09;

 private String address; // Bluetooth device address
 private String name;  // Bluetooth device name
 private Integer rssi; // Signal strength
 private long timestampNanos = 0; // Timestamp in nanoseconds

 // Beacon objects
 private IBeacon iBeacon = null;
 private EddystoneBeacon eddystoneBeacon = null;
 private AltBeacon altBeacon = null;
 private FeasyBeacon feasyBeacon = null;

 private String completeLocalName = null; // Complete local name

 // Listener object
 private Monitor monitor = null;

 // Constructor
 public BluetoothDeviceWrapper(String address) {
     this.address = address;
 }

 // Constructor
 public BluetoothDeviceWrapper(String address, String name, int rssi) {
     this.address = address;
     this.name = name;
     this.rssi = rssi;
 }

 // Constructor
 public BluetoothDeviceWrapper(String address, String name, int rssi, long timestampNanos) {
     this.address = address;
     this.name = name;
     this.rssi = rssi;
     this.timestampNanos = timestampNanos;
 }

 public String getAddress() {
     return address;
 }

 public void setAddress(String address) {
     this.address = address;
 }

 public String getName() {
     return name;
 }

 public void setName(String name) {
     this.name = name;
 }

 public Integer getRssi() {
     return rssi;
 }

 public void setRssi(Integer rssi) {
     this.rssi = rssi;
 }

 public long getTimestampNanos() {
     return timestampNanos;
 }

 public void setTimestampNanos(long timestampNanos) {
     this.timestampNanos = timestampNanos;
 }

 public IBeacon getIBeacon() {
     return iBeacon;
 }

 public void setIBeacon(IBeacon iBeacon) {
     if (iBeacon != null) {
         this.iBeacon = iBeacon;
         this.eddystoneBeacon = null;
         this.altBeacon = null;
     }
 }

 public EddystoneBeacon getEddystoneBeacon() {
     return eddystoneBeacon;
 }

 public void setEddystoneBeacon(EddystoneBeacon eddystoneBeacon) {
     if (eddystoneBeacon != null) {
         this.eddystoneBeacon = eddystoneBeacon;
         this.iBeacon = null;
         this.altBeacon = null;
     }
 }

 public AltBeacon getAltBeacon() {
     return altBeacon;
 }

 public void setAltBeacon(AltBeacon altBeacon) {
    if (altBeacon != null) {
         this.altBeacon = altBeacon;
         this.iBeacon = null;
         this.eddystoneBeacon = null;
     }
 }

 public FeasyBeacon getFeasyBeacon() {
     return feasyBeacon;
 }

 public void setFeasyBeacon(FeasyBeacon feasyBeacon) {
     this.feasyBeacon = feasyBeacon;
 }

 public String getCompleteLocalName() {
     return completeLocalName;
 }

 public void setCompleteLocalName(String completeLocalName) {
     this.completeLocalName = completeLocalName;
 }

 public Monitor getMonitor() {
     return monitor;
 }

 public void setMonitor(Monitor monitor) {
    this.monitor = monitor;
 }
}

EddystoneBeacon class represents a Beacon following the Eddystone protocol.

// EddystoneBeacon class represents a Beacon following the Eddystone protocol
public class EddystoneBeacon extends FeasyBeacon {
  
  private final String TAG = "FscEddystone";
  private String frameTypeString; // Eddystone type (URL, UID, TLM)
  private String frameTypeHex; // Eddystone type (HEX)
  private int eddystoneRssiOrVersion; // Eddystone transmit power or version
  private String dataValue; // Eddystone broadcast data

  private String url;
  private String nameSpace;
  private String instance;
  private String reserved;

  private String batteryVoltage;
  private String temperature;
  private String advertisementsCount;
  private String timeSincePowerUp;

  public int getEddystoneRssiOrVersion() {
     return eddystoneRssiOrVersion;
  }

  public void setEddystoneRssiOrVersion(int eddystoneRssiOrVersion) {
      this.eddystoneRssiOrVersion = eddystoneRssiOrVersion;
  }

  public String getFrameTypeString() {
      return frameTypeString;
  }

  public void setFrameTypeString(String frameTypeString) {
      this.frameTypeString = frameTypeString;
  }

  public String getFrameTypeHex() {
      return frameTypeHex;
  }

  public void setFrameTypeHex(String frameTypeHex) {
      if (frameTypeHex.length() == 1) {
          frameTypeHex = "0" + frameTypeHex;
     }
      this.frameTypeHex = frameTypeHex;
  }

  public String getDataValue() {
      return dataValue;
  }

  public void setDataValue(String dataValue) {
      this.dataValue = dataValue;
  }

  public String getUrl() {
      return url;
  }

  public void setUrl(String url) {
      this.url = url;
  }

  public String getNameSpace() {
      return nameSpace;
  }

  public void setNameSpace(String nameSpace) {
      this.nameSpace = nameSpace;
  }

  public String getInstance() {
      return instance;
  }

  public void setInstance(String instance) {
      this.instance = instance;
  }

  public String getReserved() {
      return reserved;
  }

  public void setReserved(String reserved) {
      this.reserved = reserved;
  }

  public String getBatteryVoltage() {
      return batteryVoltage;
  }

  public void setBatteryVoltage(String batteryVoltage) {
      this.batteryVoltage = batteryVoltage;
  }

  public String getTemperature() {
      return temperature;
  }

  public void setTemperature(String temperature) {
      this.temperature = temperature;
  }

  public String getAdvertisementsCount() {
      return advertisementsCount;
  }

  public void setAdvertisementsCount(String advertisementsCount) {
      this.advertisementsCount = advertisementsCount;
  }

  public String getTimeSincePowerUp() {
      return timeSincePowerUp;
  }

  public void setTimeSincePowerUp(String timeSincePowerUp) {
      this.timeSincePowerUp = timeSincePowerUp;
  }
}

AltBeacon represents an AltBeacon-type Bluetooth beacon.

// AltBeacon class represents an AltBeacon-type Bluetooth beacon
public class AltBeacon extends FeasyBeacon {
  
  private String reservedId; // Reserved ID
  private String manufacturerId; // Manufacturer ID
  private String beaconId; // Beacon ID
  private int altBeaconRssi; // RSSI value of AltBeacon
  private String feature; // Feature

  public int getAltBeaconRssi() {
      return altBeaconRssi;
  }

  public void setAltBeaconRssi(int altBeaconRssi) {
      this.altBeaconRssi = altBeaconRssi;
  }

  public String getBeaconId() {
      return beaconId;
  }

  public void setBeaconId(String beaconId) {
      this.beaconId = beaconId;
  }

  public String getManufacturerId() {
      return manufacturerId;
  }

  public void setManufacturerId(String manufacturerId) {
      this.manufacturerId = manufacturerId;
  }

  public String getReservedId() {
      return reservedId;
  }

  public void setReservedId(String reservedId) {
      this.reservedId = reservedId;
  }

  public String getFeature() {
      return feature;
  }

  public void setFeature(String feature) {
      this.feature = feature;
  }
}

IBeacon class represents a beacon device following the iBeacon protocol.

// IBeacon class represents a beacon device following the iBeacon protocol
public class IBeacon extends FeasyBeacon {
  
  private String company; // Company identifier
  private String type; // Beacon type
  private String dataLength; // Data length
  private int major; // Major value, used to distinguish beacons
  private int minor; // Minor value, used to distinguish beacons
  private String uuid; // UUID, used to uniquely identify the beacon
  private int rssi; // Received Signal Strength Indicator (RSSI)

  public String getCompany() {
      return company;
  }

  public void setCompany(String company) {
      this.company = company;
  }

  public String getType() {
      return type;
  }

  public void setType(String type) {
      this.type = type;
  }

  public String getDataLength() {
      return dataLength;
  }

  public void setDataLength(String dataLength) {
      this.dataLength = dataLength;
  }

  public int getMajor() {
      return major;
  }

  public void setMajor(int major) {
      this.major = major;
  }

  public int getMinor() {
      return minor;
  }

  public void setMinor(int minor) {
      this.minor = minor;
  }

  public String getUuid() {
      return uuid;
  }

  public void setUuid(String uuid) {
      this.uuid = uuid;
  }

  public int getRssi() {
      return rssi;
  }

  public void setRssi(int rssi) {
      this.rssi = rssi;
  }
}

Monitor class represents a monitor device, including its attributes of temperature, humidity, battery level, and name.

// Monitor class represents a monitor device, including its attributes of temperature, humidity, battery level, and name
public class Monitor extends FeasyBeacon {
  
  private String temperature; // Temperature value
  private String humidity; // Humidity value
  private int battery; // Battery level
  private String name; // Monitor name

  public String getTemperature() {
      return temperature;
  }

  public void setTemperature(String temperature) {
      this.temperature = temperature;
  }

  public String getHumidity() {
      return humidity;
  }

  public void setHumidity(String humidity) {
      this.humidity = humidity;
  }

  @Override
  public int getBattery() {
      return battery;
  }

  @Override
  public void setBattery(int battery) {
     this.battery = battery;
  }

  public String getName() {
     return name;
  }

  public void setName(String name) {
     this.name = name;
  }
}

FeasyBeacon class represents a beacon device, including its related attributes and configuration information.

// FeasyBeacon class represents a beacon device, including its related attributes and configuration information
public class FeasyBeacon implements Serializable {

  // Beacon type constants
  public static final String BEACON_TYPE_EDDYSTONE_URL = "URL";
  public static final String BEACON_TYPE_EDDYSTONE_UID = "UID";
  public static final String BEACON_TYPE_EDDYSTONE_TLM = "TLM";
  public static final String BEACON_TYPE_I_BEACON = "iBeacon";
  public static final String BEACON_TYPE_ALTBEACON = "AltBeacon";
  public static final String BEACON_TYPE_NULL = "";
  public static final int BEACON_COUNT = 10;
  public static final String ENCRYPT_BEACON = "Beacon";
  public static final String ENCRYPT_UNIVERSAL = "Universal";

  private boolean keyConfig; // Configuration key
  private boolean gSensor; // Configure G-sensor
  private boolean buzzer; // Configure buzzer
  private boolean led; // Configure LED
  private boolean nfc; // Configure NFC
  private boolean longRange; // Configure long range
  private boolean connectable; // Whether connectable
  private String module; // Module type
  private String version; // Version information
  private String deviceName; // Device name
  private String deviceAddress; // Device address
  private int battery = -1; // Battery level
  private String encryptionWay; // Encryption method

  public int getBattery() {
      return battery;
  }

  public void setBattery(int battery) {
      this.battery = battery;
  }

  public boolean getConnectable() {
      return connectable;
  }

  public void setConnectable(boolean connectable) {
      this.connectable = connectable;
  }

  public String getVersion() {
      return version;
  }

  public void setVersion(String version) {
      this.version = version;
  }

  public String getDeviceName() {
      return deviceName;
  }

  public void setDeviceName(String deviceName) {
      this.deviceName = deviceName;
  }

  public String getDeviceAddress() {
      return deviceAddress;
  }

  public void setDeviceAddress(String deviceAddress) {
      this.deviceAddress = deviceAddress;
  }

  public String getModule() {
      return module;
  }

  public void setModule(String module) {
      this.module = module;
  }

  public String getEncryptionWay() {
      return encryptionWay;
  }

  public void setEncryptionWay(String encryptionWay) {
      this.encryptionWay = encryptionWay;
  }

  public boolean getKeyConfig() {
      return keyConfig;
  }

  public void setKeyConfig(boolean keyConfig) {
      this.keyConfig = keyConfig;
  }

  public boolean getGSensor() {
      return gSensor;
  }

  public void setGSensor(boolean gSensor) {
      this.gSensor = gSensor;
  }

  public boolean getBuzzer() {
      return buzzer;
  }

  public void setBuzzer(boolean buzzer) {
      this.buzzer = buzzer;
  }

  public boolean getLed() {
      return led;
  }

  public void setLed(boolean led) {
      this.led = led;
  }

  public boolean getNfc() {
      return nfc;
  }

  public void setNfc(boolean nfc) {
      this.nfc = nfc;
  }

  public boolean isLongRange() {
      return longRange;
  }

  public void setLongRange(boolean longRange) {
      this.longRange = longRange;
  }
 }

BeaconBean class is used to represent the attribute information of Bluetooth beacons (including iBeacon, eddystone_url, eddystone_uid, and altBeacon).

// BeaconBean class is used to represent the attribute information of Bluetooth beacons
public class BeaconBean implements Serializable {
private String index; // Index
private String beaconType; // Beacon type(iBeacon, Eddystone_url, Eddystone_uid)

//iBeacon
private String uuid; // UUID of iBeacon
private String major; // Major value of iBeacon
private String minor;// Minor value of iBeacon

//eddystone_url
private String url; // URL of Eddystone_url

//eddystone_uid
private String nameSpace; // Namespace of Eddystone_uid
private String instance; // Instance of Eddystone_uid
private String reserved; // Reserved field of Eddystone

//altBeacon
private String id1; // ID1 of AltBeacon
private String id2; // ID2 of AltBeacon
private String id3; // ID3 of AltBeacon
private String manufacturerId; // Manufacturer ID
private String manufacturerReserved; // Manufacturer reserved field

private String power; // Beacon TX power
private boolean connectable; // Whether connectable
private boolean enable; // Whether broadcasting is enabled
private String version;// Firmware version
private int interval = 1000; // Beacon interval, default value is 1000ms
private String parentName; // Parent node name
private String txpower = "2"; // Beacon TX power, default value is 2
private String phy = "0"; // Physical layer, default value is 0

public BeaconBean() {
}

public BeaconBean(String index, String beaconType) {
    this.index = index;
    this.beaconType = beaconType;
}

public String getIndex() {
    return index;
}

public void setIndex(String index) {
    this.index = index;
}

public String getBeaconType() {
    return beaconType;
}

public void setBeaconType(String beaconType) {
    this.beaconType = beaconType;
}

public String getUuid() {
    return uuid;
}

public void setUuid(String uuid) {
    this.uuid = uuid;
}

public String getMajor() {
    return major;
}

public void setMajor(String major) {
    this.major = major;
}

public String getMinor() {
    return minor;
}

public void setMinor(String minor) {
    this.minor = minor;
}

public String getUrl() {
    return url;
}

public void setUrl(String url) {
    this.url = url;
}

public String getNameSpace() {
    return nameSpace;
}

public void setNameSpace(String nameSpace) {
    this.nameSpace = nameSpace;
}

public String getInstance() {
    return instance;
}

public void setInstance(String instance) {
    this.instance = instance;
}

public String getReserved() {
    return reserved;
}

public void setReserved(String reserved) {
    this.reserved = reserved;
}

public String getId1() {
    return id1;
}

public void setId1(String id1) {
    this.id1 = id1;
}

public String getId2() {
    return id2;
}

public void setId2(String id2) {
    this.id2 = id2;
}

public String getId3() {
    return id3;
}

public void setId3(String id3) {
    this.id3 = id3;
}

public String getManufacturerId() {
    return manufacturerId;
}

public void setManufacturerId(String manufacturerId) {
    this.manufacturerId = manufacturerId;
}

public String getManufacturerReserved() {
    return manufacturerReserved;
}

public void setManufacturerReserved(String manufacturerReserved) {
    this.manufacturerReserved = manufacturerReserved;
}

public String getPower() {
    return power;
}

public void setPower(String power) {
    this.power = power;
}

public boolean isConnectable() {
    return connectable;
}

public void setConnectable(boolean connectable) {
    this.connectable = connectable;
}

public boolean isEnable() {
    return enable;
}

public void setEnable(boolean enable) {
    this.enable = enable;
}

public String getVersion() {
    return version;
}

public void setVersion(String version) {
    this.version = version;
}

public int getInterval() {
    return interval;
}

public void setInterval(int interval) {
    this.interval = interval;
}

public String getParentName() {
    return parentName;
}

public void setParentName(String parentName) {
    this.parentName = parentName;
}

public String getTxpower() {
    return txpower;
}

public void setTxpower(String txpower) {
    this.txpower = txpower;
}

public String getPhy() {
    return phy;
}

public void setPhy(String phy) {
    this.phy = phy;
}
}

Quick Integration (Android)

Integrate the SDK

• If you haven’t installed Android Studio yet, please visit the Android Studio

Create an Android Project

• Create a new project in Android Studio.

Place FeasyBeaconLibrary-release.aar, suotalib-release.aar, and so libraries in the project’s libs directory

Config build.gradle

  dependencies {
    implementation fileTree(include: ['*.jar','*.aar'], dir: 'libs')
  }

Config AndroidManifest.xml

• In your application, you need to grant permissions in the AndroidManifest.xml . Please add the following code in your application’s manifest file.

  <?xml version="1.0" encoding="utf-8"?>
    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        package="com.feasycom.feasybeacon">
        
    <!-- Network and Location Permissions -->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.WAKE_LOCK" />
    
    <!-- Bluetooth Permissions -->
    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
    <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
    
    <!-- Add Bluetooth Permission Declaration -->
    <uses-permission android:name="android.permission.BLUETOOTH" />
    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
    
    <!-- External Storage Permission -->
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    
    <!-- Read and Write Privilege Permissions -->
    <uses-permission
       android:name="android.permission.READ_PRIVILEGED_PHONE_STATE"
       tools:ignore="ProtectedPermissions" />
    <uses-permission
       android:name="android.permission.WRITE_SECURE_SETTINGS"
       tools:ignore="ProtectedPermissions" />
    
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
    
    <uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
    
    <uses-permission android:name="android.permission.BLUETOOTH_ADVERTISE" />
    
    <application
       android:name=".App"
       android:allowBackup="true"
       android:icon="@mipmap/ic_launcher"
       android:label="@string/app_name"
       android:roundIcon="@mipmap/ic_launcher_round"
       android:supportsRtl="true"
       android:theme="@style/Theme.FeasyBeacon1">
    
       <!-- Service -->
     <service android:name="com.feasycom.service.AtCommandService" android:enabled="true"    android:exported="false" />
    <service android:name="com.feasycom.service.OTABLEService" android:enabled="true" android:exported="false" />
    </application>
  
  </manifest>
  

Interface Usage Example

Responsible for managing Bluetooth operations and related data

object BluetoothRepository {

// Selected Bluetooth device map
val selectedDeviceMap = LinkedHashMap<String, Any>()
// Module number
var mModule = 0
// Version range
var mVersionRange: Range<Int>? = null
// List of discovered Bluetooth devices
var mDevices = mutableListOf<BluetoothDeviceWrapper>()
// List for callbacks
private val mCallbacks = mutableListOf<FscBleCallback>()
// Bluetooth connection PIN code
var mConnectPin = "000000"
// Command Bean
val commandBean: CommandBean = CommandBean()
// FscBeacon central API instance
private val mFscBeaconCentralApi by lazy {
    FscBeaconApiImp.getInstance(App.sContext).apply {
        initialize()
        setCallbacks(BeaconCallbacks())
    }
}

/**
 * Check if Bluetooth is enabled
 */
fun isBluetoothEnabled() = mFscBeaconCentralApi.isBluetoothEnabled

/**
 * Start scanning for Bluetooth devices
 */
fun startScan() = mFscBeaconCentralApi.startScan()

/**
 * Start scanning for a specified duration
 * @param scanTime Scanning duration
 */
fun startScanTime(scanTime: Int) = mFscBeaconCentralApi.startScan(scanTime)

/**
 * Stop scanning
 */
fun stopScan() = mFscBeaconCentralApi.stopScan()

/**
 * Determine if the device is connected
 */
fun isConnect() = mFscBeaconCentralApi.isConnected

/**
 * Connect to a specified device
 * @param device Bluetooth device wrapper
 * @param pin PIN code
 */
fun connect(device: BluetoothDeviceWrapper, pin: String) = mFscBeaconCentralApi.connect(device, pin)

/**
 * Disconnect
 */
fun disconnect() = mFscBeaconCentralApi.disconnect()

/**
 * Check if Beacon information is complete
 */
fun isBeaconInfoFull() = mFscBeaconCentralApi.isBeaconInfoFull

/**
 * Add Beacon information
 * @param beaconBean BeaconBean instance
 */
fun addBeaconInfo(beaconBean: BeaconBean) = mFscBeaconCentralApi.addBeaconInfo(beaconBean)

/**
 * Delete Beacon information
 * @param beaconBean BeaconBean instance
 */
fun deleteBeaconInfo(beaconBean: BeaconBean) {
    mFscBeaconCentralApi.deleteBeaconInfo(beaconBean.index)
    mCallbacks.forEach { it.onDeleteBeaconInfo(beaconBean) }
}

/**
 * Set device name
 * @param deviceName Device name
 */
fun setDeviceName(deviceName: String) = mFscBeaconCentralApi.setDeviceName(deviceName)

/**
 * Set device PIN code
 * @param pin PIN code
 */
fun setDevicePin(pin: String) = mFscBeaconCentralApi.setDevicePin(pin)

/**
 * Set broadcast interval
 * @param intervalTime Interval time
 */
fun setBroadcastInterval(intervalTime: String) = mFscBeaconCentralApi.setBroadcastInterval(intervalTime)

/**
 * Restore device
 */
fun restore() = mFscBeaconCentralApi.restore()

/**
 * Query or set firmware key
 */
fun setFirmwareKey(command : String) = mFscBeaconCentralApi.setFirmwareKey(command)

/**
 * Set app key
 */
fun setAppKey(key: String) = mFscBeaconCentralApi.setAppKey(key)

/**
 * Get Beacon broadcast parameters
 */
fun beaconBroadcastParameters() = mFscBeaconCentralApi.beaconBroadcastParameters();

/**
 * Set TLM status
 * @param isTlm Whether to enable TLM
 */
fun setTlm(isTlm: Boolean) = mFscBeaconCentralApi.setTlm(isTlm)

/**
 * Set broadcast extensions
 * @param isBroadcastExtensions Whether to enable broadcast extensions
 */
fun setBroadcastExtensions(isBroadcastExtensions: Boolean) = mFscBeaconCentralApi.setBroadcastExtensions(isBroadcastExtensions)

/**
 * Check DFU file
 * @param dfuFile DFU file byte array
 */
fun checkDfuFile(dfuFile: ByteArray) = mFscBeaconCentralApi.checkDfuFile(dfuFile)!!

/**
 * Start OTA update
 * @param dfuFile DFU file byte array
 * @param reset Whether to reset
 */
fun startOtaUpdate(dfuFile: ByteArray, reset: Boolean) = mFscBeaconCentralApi.startOtaUpdate(dfuFile, reset)

/**
 * Set Beacon information
 */
fun setBeaconInfo() = mFscBeaconCentralApi.saveBeaconInfo()

/**
 * Batch set Beacon information
 */
fun setBatchBeaconInfo() = mFscBeaconCentralApi.saveBatch(commandBean)

/**
 * Register view callback
 * @param callback Callback interface
 */
fun registerViewCallback(callback: FscBleCallback) {
    if (mCallbacks.contains(callback)) return
    try {
        mCallbacks.add(callback)
    } catch (e: Exception) {
        e.printStackTrace()
    }
}

/**
 * Unregister view callback
 * @param callback Callback interface
 */
fun unRegisterViewCallback(callback: FscBleCallback) {
    try {
        mCallbacks.remove(callback)
    } catch (e: Exception) {
        e.printStackTrace()
    }
}

/**
 * Get device information
 * @param feasyBeacon FeasyBeacon instance
 * @param isTxPower Whether it is transmit power
 */
fun getDeviceInfo(feasyBeacon: FeasyBeacon, isTxPower: Boolean) {
    mFscBeaconCentralApi.getDeviceInfo(feasyBeacon, isTxPower)
}

/**
 * Internal callback class for handling Bluetooth operation callback events
 */
class BeaconCallbacks : FscBeaconCallbacks {

    // Start scanning
    override fun startScan() {}

    // Stop scanning
    override fun stopScan() {}

    // Connection progress update
    override fun connectProgressUpdate(device: BluetoothDevice?, status: Int) {
        mCallbacks.forEach { it.onConnectProgressUpdate(status) }
    }

    // Discover Bluetooth peripheral
    override fun blePeripheralFound(device: BluetoothDeviceWrapper?, rssi: Int, record: ByteArray?) {
        // Return if device is null
        if (device == null)  return

        try {
            // Check if the device is iBeacon, EddystoneBeacon, or AltBeacon
            if (device.iBeacon != null || device.eddystoneBeacon != null || device.altBeacon != null) {
                notifyCallbacks { it.onBeacon(device) }
            }

            // If the device contains monitoring data
            device.monitor?.let {
                notifyCallbacks { it.onSensor(device) }
            }

            // If the device contains FeasyBeacon module data
            device.feasyBeacon?.module?.let {
                notifyCallbacks { it.onSetting(device) }
            }
        } catch (e: Exception) {
            e.printStackTrace()
        }
    }

    // Notify all callback functions
    private inline fun notifyCallbacks(action: (FscBleCallback) -> Unit) {
        mCallbacks.forEach { callback ->
            try {
                action(callback)
            } catch (e: Exception) {
                // Catch exception and print stack trace
                e.printStackTrace()
            }
        }
    }

    // Bluetooth peripheral connected
    override fun blePeripheralConnected(gatt: BluetoothGatt?, device: BluetoothDevice?) {
        mCallbacks.forEach { it.onConnectedSuccess() }
    }

    // Bluetooth peripheral disconnected
    override fun blePeripheralDisconnected(gatt: BluetoothGatt?, device: BluetoothDevice?) {
        mCallbacks.forEach { it.onDisconnect() }
    }

    // AT command callback
    override fun atCommandCallBack(command: String?, param: String?, status: String?) {
        mCallbacks.forEach { it.onAtCommandCallBack(command, param, status) }
    }

    // Discover services
    override fun servicesFound(
        gatt: BluetoothGatt?,
        device: BluetoothDevice?,
        services: ArrayList<BluetoothGattService>?
    ) {}

    // Discover characteristic in service
    override fun characteristicForService(
        gatt: BluetoothGatt?,
        device: BluetoothDevice?,
        service: BluetoothGattService?,
        characteristic: BluetoothGattCharacteristic?
    ) {}

    // Received data packet
    override fun packetReceived(
        gatt: BluetoothGatt?,
        device: BluetoothDevice?,
        service: BluetoothGattService?,
        ch: BluetoothGattCharacteristic?,
        strValue: String,
        hexString: String,
        rawValue: ByteArray,
        timestamp: String?
    ) {
        mCallbacks.forEach { it.onPacketReceived(strValue, hexString, rawValue) }
    }

    // Received read response
    override fun readResponse(
        gatt: BluetoothGatt?,
        device: BluetoothDevice?,
        service: BluetoothGattService?,
        ch: BluetoothGattCharacteristic?,
        strValue: String?,
        hexString: String?,
        rawValue: ByteArray?,
        timestamp: String?
    ) {}

    // Send data packet progress
    override fun sendPacketProgress(
        gatt: BluetoothGatt?,
        device: BluetoothDevice?,
        ch: BluetoothGattCharacteristic?,
        percentage: Int,
        sendByte: ByteArray?
    ) {}

    // OTA progress update
    override fun otaProgressUpdate(percentage: Int, status: Int) {
        mCallbacks.forEach { it.onOtaProgressUpdate(percentage) }
    }

    // Received device information
    override fun onDeviceInfoReceived(parameterName: String?, parameter: Any?) {
        mCallbacks.forEach { it.onDeviceInfo(parameterName, parameter) }
    }
}
}

SUOTA SDK Upgrade

class SuotaActivity : BaseActivity<ActivitySuotaBinding>(),
    DeviceInfoFragment.OnDeviceInfoFragmentInteractionListener,
    AvailableFirmwareFragment.OnAvailableFirmwareFragmentInteractionListener,
    UpdateFirmwareFragment.OnUpdateFirmwareFragmentInteractionListener,
    BaseSuotaFragment.OnBaseSuotaFragmentInteractionListener {

    private lateinit var suotaFile: SuotaFile
    private lateinit var suotaManager: SuotaManager

    // Establish GATT connection
    override fun connect() {
        // Initialize SuotaManager
        suotaManager = SuotaManager(lifecycle, this, bluetoothDevice, SuotaCallback(this)).apply {
            setUiContext(this@SuotaActivity)
            connect()
        }
    }

    // Set upgrade file
    override fun onFirmwareSelected(suotaFile: SuotaFile?) {
        suotaManager.suotaFile = suotaFile
        suotaManager.initializeSuota(240, 3, 0, 1, 4, 2)
    }

    // Start firmware upgrade
    override fun startSuotaProtocol() {
        suotaManager.startUpdate()
    }

}

// A callback class for handling SUOTA (Secure Over-the-Air) firmware update events.
class SuotaCallback(@NonNull private val suotaActivityRef: SuotaActivity) : SuotaManagerCallback() {

    // Called when the connection state changes.
    override fun onConnectionStateChange(newStatus: SuotaProfile.SuotaManagerStatus) {

    }

    // Called when the service is discovered.
    override fun onServiceDiscovered() {

    }

    // Called when the characteristic value is read.
    override fun onCharacteristicRead(characteristicGroup: SuotaProfile.CharacteristicGroup, characteristic: BluetoothGattCharacteristic) {
        
    }

    // Called when device information reading is completed.
    override fun onDeviceInfoReadCompleted(status: SuotaProfile.DeviceInfoReadStatus) {
    
    }

    // Called when the device is ready for SUOTA.
    override fun onDeviceReady() {
    
    }

    // Record SUOTA status and additional information.
    override fun onSuotaLog(state: SuotaProfile.SuotaProtocolState, type: ISuotaManagerCallback.SuotaLogType, log: String) {

    }

    // Called during chunked data transmission.
    override fun onChunkSend(chunkCount: Int, totalChunks: Int, chunk: Int, block: Int, blockChunks: Int, totalBlocks: Int) {

    }

    // Update the progress bar when the upload progress changes.
    override fun onUploadProgress(percent: Float) {

    }

    // Called when the SUOTA process is successfully completed.
    override fun onSuccess(totalElapsedSeconds: Double, imageUploadElapsedSeconds: Double) {
   
    }

    // Called when the SUOTA process fails.
    override fun onFailure(errorCode: Int) {
    
    }

    // Called when the reboot command is sent.
    override fun onRebootSent() {
    
    }

    // Update speed statistics during upload.
    override fun updateSpeedStatistics(current: Double, max: Double, min: Double, avg: Double) {
    
    }

    // Update current speed during upload.
    override fun updateCurrentSpeed(currentSpeed: Double) {
    
    }

    // Handle displaying the pending reboot dialog.
    override fun pendingRebootDialog(rebootDialog: SupportCustomDialogFragment) {
    
    }

}

Appendix

Download PDF

• FeasyBeacon SDK Android Interface Guide (PDF)