FeasyBeacon SDK For Andorid

[中文]

FeasyBeacon SDK Android Integration Documentation

[Download FeasyBeacon_SDK_3.3.6]

Version	Writing date	Author
V3.3.6	2024年11月19日	Changjigang

SDK Function Overview

Integrating this SDK into Android applications can quickly achieve the following functions:

• Scanning and stopping scanning of Beacon modules

• Connection and disconnection of Beacon modules

• Beacon module information query and parameter modification

• Beacon module aerial upgrade

Understanding instance objects

The BluetoothDeviceWrapper class encapsulates information about Bluetooth devices, used to represent scanned Bluetooth devices

// The BluetoothDeviceWrapper class encapsulates information about Bluetooth devices, used to represent scanned Bluetooth devices.
public class BluetoothDeviceWrapper implements Serializable {

  // Beacon type constant
  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 intensity
  private long timestampNanos = 0; // time stamp

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

  private String completeLocalName = null; // Full local name

  // gSensor object
  private Monitor monitor = null;

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

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

  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;
  }
}

The EddystoneBeacon class represents the Beacon of the Eddystone protocol

// The EddystoneBeacon class represents the Beacon of the Eddystone protocol
public class EddystoneBeacon extends FeasyBeacon {

  private final String TAG = "FscEddystone";
  private String frameTypeString; // Eddystone type（URL、UID、TLM）
  private String frameTypeHex; // Hexadecimal representation of Eddystone type
  private int eddystoneRssiOrVersion; // Eddystone's transmission power or version number
  private String dataValue; // Eddystone's 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 a Bluetooth beacon of AltBeacon type

// The AltBeacon class represents Bluetooth beacons of AltBeacon type
public class AltBeacon extends FeasyBeacon {

  private String reservedId; // Reserve 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;
  }
}

The IBecon class represents beacon devices for the iBeacon protocol

// The IBecon class represents beacon devices for the iBeacon protocol
public class IBeacon extends FeasyBeacon {

  private String company; // Company identification
  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 beacons
  private int rssi; // Received Signal Strength Indication (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;
  }
}

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

// The Monitor class represents a type of monitor device, including its temperature, humidity, battery level, and name attributes
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;
  }
}

The FeasyBeacon class represents a beacon device, including its related properties and configuration information

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

  // Beacon type constant
  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; // grouping key
  private boolean gSensor; // Configure sensors
  private boolean buzzer; // Configure buzzer
  private boolean led; // Configure LED
  private boolean nfc; // Configure NFC
  private boolean longRange; // Configure Long Distance
  private boolean connectable; // Can it be connected
  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;
  }
}

The BeaconBean class is used to represent the attribute information of Bluetooth beacons (including iBeacon, eddystone_URL, eddystone_uid, altBeacon)

// The 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; // IBeacon's UUID
  private String major; // The Major value of iBeacon
  private String minor;// Minor value of iBeacon

  //eddystone_url
  private String url; // The URL of Eddystone_URL

  //eddystone_uid
  private String nameSpace; // The namespace of Eddystone_uid
  private String instance; // An instance of Eddystone_uid
  private String reserved; // EddyStoner's reserved fields

  //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 fields

  private String power; // Beacon TX power
  private boolean connectable; // Can it be connected
  private boolean enable; // Is broadcasting 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 of 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)

Integrated SDK

• If you have not yet installed Android Studio, please visit [Android official website]

Create Android project

• Create a new project in Android Studio.

Place the featybecon.jar and so libraries in the project libs directory

Configure the build.gradle file

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

Configure the AndroidManifest.xml file

• In your application, permission needs to be granted in the AndroidManifest.xml file. Please add the following code to your application 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">

  <!-- Bluetooth permissions -->
  <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
  <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />

  <!-- Location permissions -->
  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

  <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>

Example of interface usage method

Responsible for managing Bluetooth operations and related data

object BluetoothRepository {

  // Selected Bluetooth device mapping
  val selectedDeviceMap = LinkedHashMap<String, Any>()
  // Module number
  var mModule = 0
  // Version range
  var mVersionRange: Range<Int>? = null
  // Discovered Bluetooth device list
  var mDevices = mutableListOf<BluetoothDeviceWrapper>()
  // List for callbacks
  private val mCallbacks = mutableListOf<FscBleCallback>()
  // Bluetooth connection PIN code
  var mConnectPin = "000000"
  // Instruction 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 Bluetooth devices
   */
  fun startScan() = mFscBeaconCentralApi.startScan()

  /**
   * Start scanning at the specified time
   * @param scanTime
   */
  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 specified devices
   * @param device
   * @param pin
   */
  fun connect(device: BluetoothDeviceWrapper, pin: String) = mFscBeaconCentralApi.connect(device, pin)

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

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

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

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

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

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

  /**
   * Set broadcast interval
   * @param intervalTime
   */
  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 application key
   */
  fun setAppKey(key: String) = mFscBeaconCentralApi.setAppKey(key)

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

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

  /**
   * Set broadcast extension
   * @param isBroadcastExtensions
   */
  fun setBroadcastExtensions(isBroadcastExtensions: Boolean) = mFscBeaconCentralApi.setBroadcastExtensions(isBroadcastExtensions)

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

  /**
   * Starting OTA update
   * @param dfuFile
   * @param reset
   */
  fun startOtaUpdate(dfuFile: ByteArray, reset: Boolean) = mFscBeaconCentralApi.startOtaUpdate(dfuFile, reset)

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

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

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

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

  /**
   * Get device information
   * @param feasyBeacon
   * @param isTxPower
   */
  fun getDeviceInfo(feasyBeacon: FeasyBeacon, isTxPower: Boolean) {
      mFscBeaconCentralApi.getDeviceInfo(feasyBeacon, isTxPower)
  }

  /**
   * Internal callback class, used to handle callback events for Bluetooth operations
   */
  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) }
      }

      // Discovering Bluetooth peripherals
      override fun blePeripheralFound(device: BluetoothDeviceWrapper?, rssi: Int, record: ByteArray?) {
          // If the device is empty, return
          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) {
                  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) }
      }

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

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

      // Received 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 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 Usage Example

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 used to handle SUOTA (wireless firmware upgrade) events.
class SuotaCallback(@NonNull private val suotaActivityRef: SuotaActivity): SuotaManagerCallback() {

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

    }

    // When a service is discovered, it is called.
    override fun onServiceDiscovered() {

    }

    // Called when reading feature values.
    override fun onCharacteristicRead(characteristicGroup: SuotaProfile.CharacteristicGroup, characteristic: BluetoothGattCharacteristic) {

    }

    // Called when reading device information is complete.
    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 block data transmission.
    override fun onChunkSend(chunkCount: Int, totalChunks: Int, chunk: Int, block: Int, blockChunks: Int, totalBlocks: Int) {

    }

    // Update the progress bar when there is a change in upload progress.
    override fun onUploadProgress(percent: Float) {

    }

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

    }

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

    }

    // Called when sending a restart command.
    override fun onRebootSent() {

    }

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

    }

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

    }

    // Process the display of a suspended restart dialog box.
    override fun pendingRebootDialog(rebootDialog: SupportCustomDialogFragment) {

    }

}

Appendix

Download PDF Document

PDF Download