Skip to content

Commit

Permalink
MATTER-3150: add UMB BLE commissioning documentation
Browse files Browse the repository at this point in the history
Squashed commit of the following:

commit c98c37b228fbd882acb42d4147d2727547e17cea
Author: Satya Naag Bollimpalli <[email protected]>
Date:   Mon Apr 15 15:45:07 2024 +0000

    Pull request project-chip#1739: MATTER-3150: add UMB ble commissionning documentation

    Merge in WMN_TOOLS/matter from docs/MATTER-3150-umb-ble-commission-documentation to unify-silabs-24q2-develop

    Squashed commit of the following:

    commit 26ef1b7ed1359d689c48c9bfec0d124e43e5bbac
    Author: Boris Labbe <[email protected]>
    Date:   Mon Apr 15 12:03:13 2024 +0000

        Applied suggestion

    commit 8edfab8bcb0ccfdc9d506745b9d504babc91a5a0
    Author: sabollim <[email protected]>
    Date:   Mon Apr 15 14:42:11 2024 +0530

        addressing PR comments

    commit 31f4ec9f26d344bd6ce3f516c9db88dc0cb9ebf0
    Author: sabollim <[email protected]>
    Date:   Fri Apr 12 19:20:35 2024 +0530

        addressing PR comments

    ... and 1 more commit
  • Loading branch information
satyanaag-silabs committed Apr 15, 2024
1 parent aa36bbe commit b123328
Showing 1 changed file with 49 additions and 3 deletions.
52 changes: 49 additions & 3 deletions docs/silabs/unify/matter-bridge/readme_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,10 @@ the commissioning window again or the window can be opened by writing
`commission` in the CLI when running the bridge. The commission command may also
be used for multi-fabric commissioning.
The Unify Matter Bridge uses the "On Network" commissioning method. For now,
there is no Bluetooth commissioning support.
The Unify Matter Bridge now supports both "On Network" commissioning method and
bluetooth commissioning.
### On Network Commissioning
The commissioning procedure requires use of a pairing code. This pairing code is
written to the console when running the Matter Bridge. Look for something
Expand Down Expand Up @@ -124,7 +126,7 @@ Raspberry Pi. Note that by default the bridge binds to the eth0 interface. If
another interface is to be used, see the description of the command line
arguments for setting [Network Interface](#network-interface).
### Using the chip-tool to Commission
#### Using the chip-tool for On Network Commission
In the following procedure make sure to use the pairing code taken from the
console output, as described above. To commission the Matter Bridge with the
Expand All @@ -134,6 +136,50 @@ console output, as described above. To commission the Matter Bridge with the
chip-tool pairing code 1 MT:-24J0AFN00KA0648G00
```
### Bluetooth Commissioning
The commissioning procedure requires the use of Wi-Fi credentials(SSID, password), PIN code,
and discriminator. This pin code and discriminator are written to the console when running
the Matter Bridge. Look for something similar to '`Setup Pin Code (0 for UNKNOWN/ERROR)`',
and '`Setup Discriminator (0xFFFF for UNKNOWN/ERROR)`' used as the pin code and
discriminator in the following example. This pin code and discriminator can be used when
commissioning with the CLI commissioning tool `chip-tool`.
```bash
[1712812027.852009][22228:22228] CHIP:DL: Device Configuration:
[1712812027.852071][22228:22228] CHIP:DL: Serial Number: TEST_SN
[1712812027.852134][22228:22228] CHIP:DL: Vendor Id: 65521 (0xFFF1)
[1712812027.852176][22228:22228] CHIP:DL: Product Id: 32769 (0x8001)
[1712812027.852208][22228:22228] CHIP:DL: Product Name: TEST_PRODUCT
[1712812027.852244][22228:22228] CHIP:DL: Hardware Version: 0
[1712812027.852275][22228:22228] CHIP:DL: Setup Pin Code (0 for UNKNOWN/ERROR): 4000
[1712812027.852303][22228:22228] CHIP:DL: Setup Discriminator (0xFFFF for UNKNOWN/ERROR): 4094 (0xFFE)
```
Additionally, the pin code and discriminator can be set with the argument "--umb.pin 4000 --umb.discriminator 4094"
while bringing up the unify matter bridge in stand-alone mode.
```bash
./unify-matter-bridge --umb.interface eth0 --umb.kvs ./matter-bridge.kvs --umb.pin 4000 --umb.discriminator 4094
```
It should be noted that the Wi-Fi credentials **must** be of the same network as the
matter fabric. Note that by default the bridge binds to the eth0 interface. If
another interface is to be used, see the description of the command line
arguments for setting [Network Interface](#network-interface).
#### Using the chip-tool for Bluetooth Commission
In the following procedure make sure to use the pin code and discriminator taken
from the console output, as described above. To commission the Matter Bridge with
the `chip-tool` and assign the bridge the Node ID 1:
```bash
./chip-tool pairing ble-wifi 1 {SSID} {Password} {Pin code} {discriminator}
```
in the above example, the SSID and Password will be replaced with the Wifi SSID and password
of the network to which matter fabric is connected. Pincode and discriminator are replaced
with values derived from unify matter bridge logs as explained before.
### Using Google Nest Hub
Expand Down

0 comments on commit b123328

Please sign in to comment.