Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
philips77 committed Oct 10, 2023
1 parent 782b9cd commit 8ea6cff
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2019, Nordic Semiconductor ASA
Copyright (c) 2019-2023, Nordic Semiconductor ASA
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

The nRF Mesh library allows to provision Bluetooth mesh devices into a mesh network, configure them and send and receive messages.

The library is compatible with the following [Bluetooth specifications](https://www.bluetooth.com/specifications/specs/?status=active&show_latest_version=1&keyword=mesh):
- Mesh Profile 1.0.1 (with experimental support for Mesh Protocol 1.1)
- Mesh Model 1.0.1
The library is compatible with the following [Bluetooth specifications](https://www.bluetooth.com/specifications/specs/?types=adopted&keyword=mesh):
- Mesh Protocol 1.1 (backwards compatible with **Mesh Profile 1.0.1**)
- Mesh Model 1.1
- Mesh Device Properties 2
- Configuration Database Profile 1.0.1

Expand All @@ -18,15 +18,16 @@ See [documentation](https://nordicsemiconductor.github.io/IOS-nRF-Mesh-Library/d
> **Note**
>
> Implementing ADV Bearer on iOS is not possible due to API limitations. The library is using *GATT Proxy protocol*,
specified in the Bluetooth Mesh Profile 1.0.1, and requires a Node with Proxy functionality to relay messages to the mesh network.
specified in the Bluetooth Mesh Protocol 1.1, and requires a Node with Proxy feature to relay messages to the mesh network.

## Supported features

1. Provisioning with:
- OOB[^1] Public Key (most secure)
- Input and Output OOB
- No OOB (insecure)
- Experimental support for enhanced security added in Mesh Protocol 1.1.
- Enhanced security, added in Mesh Protocol 1.1.
- Remote Provisioning (requires a node with Remote Provisioning Server model to proxy provisioning messages)
2. Configuration, including managing keys, publications, subscription, and heartbeats (both as client and server).
3. Support for client and server models.
4. Groups, including those with virtual labels.
Expand All @@ -50,8 +51,7 @@ 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.*
4. Device Firmware Update (DFU) - *coming next!*

## How to start

Expand Down
6 changes: 3 additions & 3 deletions nRFMeshProvision/Documentation.docc/nRFMeshProvision.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Provision, configure and control Bluetooth mesh devices with nRF Mesh library.
The nRF Mesh library allows to provision Bluetooth mesh devices into a mesh network, configure
them and send and receive messages.

The library is compatible with the following [Bluetooth specifications](https://www.bluetooth.com/specifications/specs/?status=active&show_latest_version=0&show_latest_version=1&keyword=mesh&filter=):
The library is compatible with the following [Bluetooth specifications](https://www.bluetooth.com/specifications/specs/?types=adopted&keyword=mesh):
- **Mesh Protocol 1.1** (backwards compatible with **Mesh Profile 1.0.1**)
- **Mesh Model 1.1**
- **Mesh Device Properties 2**
- **Configuration Database Profile 1.0.1**

> Important: Implementing ADV Bearer on iOS is not possible due to API limitations.
The library is using GATT Proxy protocol, specified in the Bluetooth Mesh Profile 1.0.1,
and requires a Node with GATT Proxy functionality to relay messages to the mesh network.
The library is using GATT Proxy protocol, specified in the Bluetooth Mesh Protocol 1.1,
and requires a Node with GATT Proxy feature to relay messages to the mesh network.

## Usage

Expand Down

0 comments on commit 8ea6cff

Please sign in to comment.