zinwalin / ios-nrf-mesh-library

The Bluetooth Mesh Provisioner and Configurator library.

Bluetooth mesh library for iOS

The nRF Mesh library allows to provision Bluetooth mesh devices, configure and exchange messages.

It is written in Swift, and can be easily added to a 3rd part project using CocoaPods, SPM or Carthage.

See documentation for more information.

Features

The library is compatible with

• Mesh Profile 1.0.1,
• Mesh Model 1.0.1,
• Mesh Device Properties 2.

The mesh network configuration (JSON schema) is compatible with

• Mesh Configuration Database Profile 1.0.

Bluetooth mesh specifications are available at Bluetooth.com.

Supported features

1. Provisioning with all features available in Mesh Profile 1.0.1, including OOB Public Key and all types of OOB, using GATT bearer.
2. Configuration, including managing keys, publications, subscription, and hearbeats (both as client and server).
3. Support for client and server models.
4. Groups, including those with virtual labels.
5. Scenes (both as client and server).
6. Managing proxy filter.
7. IV Index update (handled by Secure Network beacons).
8. Key Refresh Procedure (using ConfigKeyRefreshPhaseSet messages, not Secure Network beacon).
9. Hearbeats (both as client and server).
10. Exporting network state with format compatible to Configuration Database Profile 1.0, including partial export.
11. Option to use own transport layer with default GATT Bearer implementation available.

NOT (yet) supported features

The following features are not (yet) supported:

1. The rest of models defined by Bluetooth SIG - PRs are welcome!*
2. IV Index update (initiation) - not a top priority, as other nodes may initiate the update.
3. Health server messages - in our TODO list.
4. Remote provisioning - in our TODO list.
5. Device Firmware Update (DFU) - in our TODO list.

nRF Mesh sample app

Most of the features listed above are demonstrated in nRF Mesh sample application.

Use pod try to install and set up the sample app when using CocoaPods.

The app is available on App Store.

Supported features

1. Provisioning with all available features.
2. Configuration of local and remote nodes.
3. Managing network (provisioners, network and application keys, scenes), resetting and exporting configuration.
4. Managing groups, including those with virtual labels.
5. Sending group messages.
6. UI for local models, which include:
   • Generic OnOff Client and Server,
   • Generic Level Client and Server,
   • Simple OnOff vendor model by Nordic.
7. Support for some server models:
   • Generic OnOff,
   • Generic Level,
   • Vendor models.
8. Scenes, both as client and server.
9. Automatic connection to nearby nodes and automatic proxy filter management.

Testing

All features are tested against nRF5 SDK for Mesh and nRF Connect SDK based mesh devices.

Requirements

• Xcode 12 or newer.
• An iOS 10.0 or newer device with BLE capabilities.

Optional

• nRF5 Development Kit(s) for developing and testing firmware.

Feedback

Any feedback is more than welcome. Please, test the app, test the library and check out the API.

Use Issues to report a bug, or ask a question. We also encourage to submit Pull Requests with new features or bug fixes.

License

BSD 3-Clause License.