• gatt

    Gatt Primitives

    • Object XYBluetoothBase

      • Super class
        XYBase
    • Object XYBluetoothError

      • Super class
        XYBase
    • Object XYBluetoothGattClient

      • Super class
        XYBluetoothBase
      • Enumerations
        • Name ConnectionState
          Values
          • Unknown
          • Diconnected
          • Connected
          • Connecting
          • Disconnecting
      • Properties
        • Name closed
          Type Boolean
        • Name connectionState
          Type ConnectionState
        • Name stayConnected
          Type Boolean
      • Functions
        • async connection(closure: function) => XYBluetoothResult
    • Object XYBluetoothGattServer

      • Super class
        XYBluetoothBase
    • Object XYBluetoothResult

      • Super class
        XYBase
  • ads

    BLE Advertisement classes

    • Object XYBleAd

      • Super class
        XYBase
  • devices

    Device Specific Client Implementations

    • Object XY2BluetoothDevice

      • Super class
        XYFinderBluetoothDevice
      • Enumerations
        • Name StayAwake
          Values
          • Off
          • On
    • Object XY3BluetoothDevice

      • Super class
        XYFinderBluetoothDevice
      • Enumerations
        • Name ButtonPress
          Values
          • Single
          • Double
          • Long
        • Name StayAwake
          Values
          • Off
          • On
      • Properties
        • Name DefaultLockCode
          Type ByteArray
          Description The lock code that XY4+ devices are shipped with.
        • Name compareDistance
          Type Comparator<XYFinderBluetoothDevice>
          Description Comparator that compares two devices based on distance
    • Object XYAppleBluetoothDevice

      • Super class
        XYBluetoothDevice
    • Object XYBluetoothDevice

      • Super class
        XYBluetoothGattClient
      • Properties
        • Name manufacturerToCreator
          Type HashMap<Int, XYCreator>
          Description Mapping for device creators that key off manufacturer id
        • Name rssi
          Type Int
          Description The most recent rssi reading from the device
        • Name serviceToCreator
          Type HashMap<Int, XYCreator>
          Description Mapping for device creators that key off service uuid
    • Object XYCreator

    • Object XYFinderBluetoothDevice

      • Super class
        XYIBeaconBluetoothDevice
    • Object XYGpsBluetoothDevice

      • Super class
        XYFinderBluetoothDevice
    • Object XYIBeaconBluetoothDevice

      • Super class
        XYBluetoothDevice
    • Object XYMobileBluetoothDevice

      • Super class
        XYFinderBluetoothDevice
  • scanner

    Central scanner used to find peripherals

    • Object XYSmartScan