Skip to content

igathedub/IOS-nRF-Mesh-Library

 
 

Repository files navigation

nRF Mesh for iOS

Version Carthage compatible

About

The nRF Mesh Provision library allows to provision and send messages to Bluetooth Mesh devices.

Bluetooth Mesh specification may be found here: https://www.bluetooth.com/specifications/mesh-specifications/

The library is compatible with version 1.0.1 of the Bluetooth Mesh Profile Specification.

This is the second version of the nRF Mesh Provision library for iOS. All features are tested againt nRF Mesh SDK and Zephyr based mesh devices.

The first version of this library is no longer maintained. The application available on App Store will eventually be replaced with the new sample application.

Sample app

The sample application demonstrates how to use the library. It may also be used to configure your Mesh network. Use pod try to install and set up the sample app when using CocoaPods. The app and the library are released under BSD-3 license. Feel free to modify them as you want.

Supported features

  1. Provisionig with all features that available in Bluetooth Mesh Profile 1.0.1, including OOB Public Key and all types of OOB.
  2. Managing Provisioners, Network Keys, Application Keys, resetting network, etc.
  3. All network layers are working.
  4. Parsing Secure Network beacons.
  5. Adding, removing and refreshing Network and Application Keys to Nodes.
  6. Binging and unbinding Application Keys to Models.
  7. Setting and clearing publication to a Model.
  8. Setting and removing subscriptions to a Model.
  9. Groups, including those with Virtual Addresses.
  10. UI for controlling groups (Generic OnOff and Generic Level (delta) are supported).
  11. Handling Configuration Server message sent by other Provisioner.
  12. Generic OnOff and Vendor model have dedicated controls in sample app.
  13. Proxy Filter.
  14. IV Index update (handling updates received in Secure Network beacons).

NOT (yet) supported features

  1. Many SIG defined models, except from supported ones.
  2. Key Refresh Procedure, IV Index update (initiation).
  3. Health server messages.
  4. Hearbeats.
  5. Remote Provisioning.

Documentation

The documentation for this library may be found here.

Requirements

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

Optional

  • nrf52832 or nrf52840 based Development Kit(s) to test the sample firmwares on.

Feedback

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

License

BSD 3-Clause License

About

The Bluetooth Mesh Provisioner and Configurator library.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 98.9%
  • Other 1.1%