orbital-systems / react-native-esp-idf-provisioning

ESP IDF provisioning and custom data library for react-native
MIT License
24 stars 5 forks source link

README Corrections #30

Closed grasmash closed 8 months ago

grasmash commented 8 months ago

A few suggested changes to the README:

  1. Missing arguments in example code In the example in the README, this is shown: const devices = ESPProvisionManager.searchESPDevices('prefix'); However, running this causes the following error: Argument 2 (NSInteger) of EspIdfProvisioning.searchESPDevices must not be null At least 2 arguments must be passed to searchESPDevices() for it to work.

  2. Undocumented iOS permissions. It is undocumented that the app.json for the module must provide a string for NSBluetoothAlwaysUsageDescription. Failing to add it causes this error:

    This app has crashed because it attempted to access privacy-sensitive data without a usage description.  The app's Info.plist must contain an NSBluetoothAlwaysUsageDescription key with a string value explaining to the user how the app uses this data.

    This error is a bit tough to find because it doesn't appear in the react native or expo loggers, only the xcode debug panel.

grasmash commented 8 months ago

Opened https://github.com/orbital-systems/react-native-esp-idf-provisioning/pull/32