Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 3.38 KB

README.md

File metadata and controls

102 lines (70 loc) · 3.38 KB
Raw

Sure, here's the fixed markdown:

Flutter Accessory Kit

At this stage the library supports:

  • BLE
  • WiFi (work in progress)
  • Migration

‼️ One important remark: by Apple's design, the library works only with iOS 18 or above. ‼️

🚇 How to use

Install the library using the command line:

flutter pub get flutter_accessorysetup

⚙️ Setup

  • You should add the keys to the Info.plist of the iOS app to make it work. ⚠️ If you miss the required key the app will crash when you show the picker. ⚠️

    • ALWAYS: (Bluetooth or WiFi, or both)
    <key>NSAccessorySetupKitSupports</key>
<array>
  <string>Bluetooth</string>
  <string>WiFi</string>
</array>
    • When you use the ASDiscoveryDescriptor with bluetoothServiceUUID
      ⚠️ The UUID string must be upper-cased here. ⚠️
    <key>NSAccessorySetupBluetoothServices</key>
<array>
  <string>149E9E42-33AD-41AD-8665-70D153533EC1</string>
</array>
    • When you use the ASDiscoveryDescriptor with bluetoothNameSubstring
      ⚠️ Does not work in the iOS 18 Developer beta 2. ⚠️
    <key>NSAccessorySetupBluetoothNames</key>
<array>
  <string>DeviceName</string>
</array>
    • There is an option with manufacturer ID that is not covered here.

  • Use the FlutterAccessorysetup class. See the full code example in the Example app

final _flutterAccessorysetupPlugin = FlutterAccessorysetup();

_flutterAccessorysetupPlugin.sessionStream.listen((event) => setState(() {
    // handle session events here
    // async errors will be delivered as session events too
}));

try {
  await _flutterAccessorysetupPlugin.activate();
  await _flutterAccessorysetupPlugin.showPicker();
} on PlatformException {
  debugPrint('Failed to show the picker');
}

ℹ️ What we know

⚠️ The AccessorySetup does not work on the Simulator. ⚠️

  • When the user closes the Picker by tapping the cross button, the showPicker closure emits an error (ASErrorDomain, code 700).

  • ⚠️ When the person picks a BLE accessory, the picker sends an event of type ASAccessoryEventType.accessoryChanged. It might be that the picker sends an event of type ASAccessoryEventType.accessoryAdded, but I can't reproduce it at all. ⚠️

  • If the device has been connected previously, it will be in the session.accessories array right after the session is activated.
    ⚠️ This device will not be discoverable by the Setup Picker until the user disconnects it from the settings. ⚠️

  • When the user selects the device using the picker:

    • The device will be displayed in the My Devices section of the Settings/Bluetooth screen.
    • The device's info screen will display the image and name you provided to the ASPickerDisplayItem during the discovery process (the same that the user saw in the picker).

  • When the user deletes the app, the device will be disconnected automatically. It won't be displayed in the My Devices section of the Settings/Bluetooth screen anymore.

📗 References