This is a simple test application designed to aid in the porting of OpenWeave and the OpenWeave Device Layer to the Nordic nRF52840.
The code here is intended as a tool for developers to exercise OpenWeave functionality on the nRF52840. It is not a demo application, and it implements no particularly interesting high-level behavior. Furthermore, the code is very likely to be unstable, and/or require manual edits to operate correctly in some environments. Anyone using the code should expect to get their hands dirty making things work.
At some point, this code will be abandoned and a proper demo application will be built, similar to that which is available for the Espressif ESP32. Once this happens, the bring-up application will be removed from the OpenWeave source tree.
In the meantime, this directory, and the OpenWeave branch it exists on (feature/nrf52840-device-layer), will be the focal point for efforts to port the OpenWeave Device Layer to the nRF52840.
Download and install the Nordic nRF5 SDK for Thread and Zigbee (Direct download link)
Download and install the Nordic nRF5x Command Line Tools (Direct download link: Linux Mac OS X)
Download and install a suitable ARM gcc tool chain: GNU Arm Embedded Toolchain 7-2018-q2-update (Direct download link: Linux Mac OS X)
Install some necessary components:
# On Linux... sudo apt-get install ccache # On Mac OS X... brew install --HEAD ccache
Set the following environment variables based on the locations/versions of the above packages:
export NRF5_SDK_ROOT=${HOME}/tools/nRF5_SDK_for_Thread_and_Zigbee
export NRF5_TOOLS_ROOT=${HOME}/tools/nRFe-Command-Line-Tools
export GNU_INSTALL_ROOT=${HOME}/tools/gcc-arm-none-eabi-7-2018-q2-update/bin/
export GNU_VERSION=7.3.1
export PATH=${PATH}:${NRF5_TOOLS_ROOT}/nrfjprog
Run make to build the application
$ cd openweave-nrf52840-bringup $ make clean $ make
The bring-up application is designed to run on the Nordic nRF52840 DK development kit. Prior to installing the application, the device's flash memory should be erased and the Nordic SoftDevice image installed.
Connect the host machine to the J-Link Interface MCU USB connector on the nRF52840 DK. The Interface MCU connector is the one on the short side of the board.
Use the Makefile to erase the flash and program the Nordic SoftDevice image.
$ cd openweave-nrf52840-bringup $ make erase $ make flash_softdevice
Once the above is complete, it shouldn't need be done again unless the SoftDevice image or the configuration storage (fds) area becomes corrupt. If you are forced to erase the device, the application will need to be flashed again.
To flash the bring-up app, run the following commands:
$ cd openweave-nrf52840-bringup
$ make flash
The bring-up application is built to use the SEGGER Real Time Transfer (RTT) facility for log output. RTT is a feature built-in to the J-Link Interface MCU on the development kit board. It allows bi-directional communication with an embedded application without the need for a dedicated UART.
Using the RTT facility requires downloading and installing the SEGGER J-Link Software and Documentation Pack (web site).
Install the J-Link software
# On Linux... $ cd ~/Downloads $ sudo dpkg -i JLink_Linux_V*_x86_64.deb # On Mac OS X... $ cd ~/Downloads $ sudo installer -pkg JLink_MacOSX_V*.pkg
In Linux, grant the logged in user the ability to talk to the development hardware via the linux tty device (/dev/ttyACMx) by adding them to the dialout group.
$ sudo usermod -a -G dialout ${USER}
Once the above is complete, log output can be viewed using the JLinkExe tool in combination with JLinkRTTClient as follows:
Run the JLinkExe tool with arguments to autoconnect to the nRF82480 DK board:
$ JLinkExe -device NRF52840_XXAA -if SWD -speed 4000 -autoconnect 1
In a second terminal, run the JLinkRTTClient:
$ JLinkRTTClient
Logging output will appear in the second termnal.
An alternative, and often preferable way to view log output is to use the J-Link GDB server described in the following section.
SEGGER provides a GDB server tool which can be used to debug a running application on the nRF82480 DK board. The GDB server also provides a local telnet port which can be used to communicate with the device over RTT. This can be used to view logging output. Note that you do not need to actually run gdb to see the logging output from the GDB server. This means that the GDB server can be used as a convenient way to monitor the activity of the application in between debugging sessions.
The openweave-nrf52840-bringup directory contains a shell script, start-jlink-gdb-server.sh, that makes it easy to start the GDB server:
$ cd openweave-nrf52840-bringup
$ ./start-jlink-gdb-server.sh
The start-jlink-gdb-server.sh script automatically initiates a telnet session to the RTT output port of the GDB server. Log output from the application is then intermingled with output from the GDB server.
To shutdown the GDB server, type CTRL-C.
Because of the way the Nordic SoftDevice works, actual debugging of a running nRF82480 application requires the use of the SEGGER J-Link monitor mode debugging feature. This feature works in conjunction with the J-Link GDB server to allow parts of the system to continue running while the target device is ‘stopped’ at a breakpoint. Use of monitor mode debugging is essential to avoid the SoftDevice crashing with a fatal error whenever the target is resumed from a breakpoint.
Unfortunately, J-Link monitor mode requires the use of the ludicrously expensive J-Link Plus (or better) debug probe. The on-board J-Link debugger included with the nRF52840 DK board cannot be used for GDB debugging. Additionally, the J-Link monitor mode feature requires the application to be built with special code supplied by SEGGER. The licensing of this code requires that it be downloaded separately from the SEGGER site.
To build the bring-up application for use with GDB, perform the following steps:
Download and unpack the J-Link monitor mode sample project:
$ cd openweave-nrf52840-bringup $ wget https://www.segger.com/fileadmin/images/products/J-Link/Technology/Monitor_Mode_Debugging/Generic_Cortex-M_MonitorModeSystickExample_SES.zip $ unzip Generic_Cortex-M_MonitorModeSystickExample_SES.zip
Copy or link the debug mode implementation file into the root directory of the bring-up application:
$ cd openweave-nrf52840-bringup $ ln -s ./Generic_Cortex-M_MonitorModeSystickExample_SES/Src/JLINK_MONITOR_ISR_SES.s .
Rebuild the bring-up application with monitor mode debugging support (MMD) enabled:
$ cd openweave-nrf52840-bringup $ make clean $ make MMD=1
Once the application has been built with monitor mode debugging support (MMD) enabled, a debugging session can be initiated using an appropriate J-Link debug probe:
Connect the J-Link debug probe to the 10-pin “Debug In” connector located near the center of the nRF52840 DK board.
Slide the “nRF Power Source” switch to the “USB” position.
Power the device by connecting USB power to the board's “nRF USB” connector (the connector on the long edge of the board).
Start the GDB server using the start-jlink-gdb-server.sh script:
$ cd openweave-nrf52840-bringup $ ./start-jlink-gdb-server.sh
Start GDB using the start-gdb.sh script:
$ cd openweave-nrf52840-bringup $ ./start-gdb.sh
The start-gdb.sh script will automatically launch gdb and instruct it to connect to the GDB server. It will also issue the necessary commands to enable monitor mode debugging.
By default, gdb is started with the openweave-nrf52840-bringup executable located in the build directory (./build/openweave-nrf52840-bringup.out). Alternatively one can pass the name of a different executable as an argument to the start-gdb.sh script.
The current version of the bring-up app uses hard-coded configuration values for provisioning the Thread network. Eventually this will be elimiated once support for the Weave Network Provisioning protocol is in place. In the mean time, the following instructions can be used to build a test Thread network and test Weave communication using the bring-up app.
Creating a minimal test network requires two nRF52840 DK dev boards--one on which to run the bring-up app and a second to act as an NCP for a host machine that will communicate with the bring-up app. We will refer to these two devices as the Weave device and the NCP device.
Follow the instructions in the OpenThread code lab for building OpenThread and wpantund, and setting up an NCP device.
Connect the NCP device to the host machine and start wpantund
$ sudo /usr/local/sbin/wpantund -o Config:NCP:SocketPath /dev/ttyACM0 \ -o Config:TUN:InterfaceName utun7 \ -o Daemon:SyslogMask " -info"
Note that the host should be connected to the NCP device via its nRF USB connector (the connector on the long edge of the board).
Using wpanctl, instruct the NCP device to form the test network
$ sudo /usr/local/bin/wpanctl -I utun7 wpanctl:utun7> form -p 0x7777 -x 8877665544332211 -c 26 -k B8983AED954064CC4BACB3F6F145D198 -T router WARP
Connect the Weave device to the host machine and follow the instructions above for initializing the device and flashing the bring-up app.
Start the J-Link GDB server using the supplied helper script as described above.
Reset the device by pressing the IP BOOT/RESET button.
In the GDB server window you should see logging output from the Weave device similar to this:
<info> app: ================================================== <info> app: openweave-nrf52840-bringup starting <info> app: ================================================== <info> app: Enabling SoftDevice <info> app: Waiting for SoftDevice to be enabled <info> app: SoftDevice enable complete <info> app: Initializing Weave stack <info> weave: [DL] FDS set: 0x235C/0x0002 = 12288 (0x3000) <info> weave: [DL] BLEManagerImpl::Init() complete <info> weave: [ML] Binding IPv6 TCP listen endpoint to [::]:11095 <info> weave: [ML] Listening on IPv6 TCP endpoint <info> weave: [ML] Binding general purpose IPv6 UDP endpoint to [::]:11095 () <info> weave: [ML] Listening on general purpose IPv6 UDP endpoint <info> weave: [DL] Pairing code not found; using default: NESTUS <info> weave: [DL] Device Configuration: <info> weave: [DL] Device Id: 18B4300000000003 <info> weave: [DL] Serial Number: (not set) <info> weave: [DL] Vendor Id: 9050 (0x235A) (Nest) <info> weave: [DL] Product Id: 65279 (0xFEFF) <info> weave: [DL] Fabric Id: (none) <info> weave: [DL] Pairing Code: NESTUS
Search the log output for a message showing the addresses that have been assigned to the Thread interface:
<debug> weave: [DL] Updating Thread interface addresses <debug> weave: [DL] FE80::6491:B6D2:193A:5251 (0, preferred) <debug> weave: [DL] FD88:7766:5544::FF:FE00:F400 (1) <debug> weave: [DL] FD88:7766:5544:0:9F2E:8721:E8A1:D7F3 (2, preferred)
Copy the address that begins with FD88:7766:5544:0... and is marked “preferred”. This is the device's mesh-local address.
On the host machine, use ping6 to verify connectivity to the device.
$ ping6 FD88:7766:5544:0:9F2E:8721:E8A1:D7F3 PING FD88:7766:5544:0:9F2E:8721:E8A1:D7F3(fd88:7766:5544:0:9f2e:8721:e8a1:d7f3) 56 data bytes 64 bytes from fd88:7766:5544:0:9f2e:8721:e8a1:d7f3: icmp_seq=1 ttl=255 time=49.5 ms 64 bytes from fd88:7766:5544:0:9f2e:8721:e8a1:d7f3: icmp_seq=2 ttl=255 time=18.4 ms 64 bytes from fd88:7766:5544:0:9f2e:8721:e8a1:d7f3: icmp_seq=3 ttl=255 time=17.0 ms 64 bytes from fd88:7766:5544:0:9f2e:8721:e8a1:d7f3: icmp_seq=4 ttl=255 time=18.4 ms
The following examples show how to use the stand-alone version of the weave-ping tool (built on linux or Mac) to exchange Weave Echo Profile messages with a test device.
The examples show communicating with the device using its Thread mesh-local address. As an option, one can also communicate with the device using its IPv6 link-local address. To do so, change the argument to the --dest-addr option to the device's link-local address followed by a percent sign (%) and the name of the wpan interface on the host machine. E.g.:
--dest-addr FE80::6491:B6D2:193A:5251%wpan7
This shows sending unencrypted Weave Echo messages to a device using UDP and Weave Reliable Messaging (WRM).
$ weave-ping --node-id 18b4300000000001 --udp --dest-addr FD88:7766:5544:0:9F2E:8721:E8A1:D7F3 18B4300000000003
WEAVE:ML: Binding IPv4 TCP listen endpoint to [::]:11095
WEAVE:ML: Listening on IPv4 TCP endpoint
WEAVE:ML: Binding IPv6 TCP listen endpoint to [::]:11095
WEAVE:ML: Listening on IPv6 TCP endpoint
WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095
WEAVE:IN: IPV6_PKTINFO: 92
WEAVE:ML: Listening on general purpose IPv4 UDP endpoint
WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [::]:11095 ()
WEAVE:ML: Listening on general purpose IPv6 UDP endpoint
WEAVE:ML: Adding ens33 to interface table
WEAVE:ML: Adding wpan7 to interface table
WEAVE:EM: Cannot listen for BLE connections, null BleLayer
WEAVE:SD: init()
Weave Node Configuration:
Fabric Id: 1
Subnet Number: 1
Node Id: 18B4300000000001
Listening Addresses: any
Sending Echo requests to node 18B4300000000003 at FD88:7766:5544:0:9F2E:8721:E8A1:D7F3
Iteration 0
Weave Node ready to service events; PID: 57910; PPID: 4808
WEAVE:EM: ec id: 1, AppState: 0x4d008aa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 0000 8E18 0 MsgId:4DCC103B
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 0000 8E18 0 MsgId:207817AA
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 1/1(100.00%) len=15 time=30.936ms
WEAVE:EM: ec id: 1, AppState: 0x4d008aa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 0000 8E19 0 MsgId:4DCC103C
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 0000 8E19 0 MsgId:207817AB
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 2/2(100.00%) len=15 time=19.612ms
WEAVE:EM: ec id: 1, AppState: 0x4d008aa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 0000 8E1A 0 MsgId:4DCC103D
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 0000 8E1A 0 MsgId:207817AC
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 3/3(100.00%) len=15 time=18.866ms
This shows sending encrypted Weave Echo messages to a device using UDP and Weave Reliable Messaging (WRM), where the encryption keys have been established using the Weave Certificate Authenticated Session Establishment (CASE) protocol.
$ weave-ping --node-id 18b4300000000001 --udp --dest-addr FD88:7766:5544:0:9F2E:8721:E8A1:D7F3 --case 18B4300000000003
WEAVE:ML: Binding IPv4 TCP listen endpoint to [::]:11095
WEAVE:ML: Listening on IPv4 TCP endpoint
WEAVE:ML: Binding IPv6 TCP listen endpoint to [::]:11095
WEAVE:ML: Listening on IPv6 TCP endpoint
WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095
WEAVE:IN: IPV6_PKTINFO: 92
WEAVE:ML: Listening on general purpose IPv4 UDP endpoint
WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [::]:11095 ()
WEAVE:ML: Listening on general purpose IPv6 UDP endpoint
WEAVE:ML: Adding ens33 to interface table
WEAVE:ML: Adding wpan7 to interface table
WEAVE:EM: Cannot listen for BLE connections, null BleLayer
WEAVE:SD: init()
Weave Node Configuration:
Fabric Id: 1
Subnet Number: 1
Node Id: 18B4300000000001
Listening Addresses: any
Sending Echo requests to node 18B4300000000003 at FD88:7766:5544:0:9F2E:8721:E8A1:D7F3
Iteration 0
Weave Node ready to service events; PID: 57931; PPID: 4808
WEAVE:EM: ec id: 1, AppState: 0x52d28c0
WEAVE:SM: CASE:GenerateBeginSessionRequest
WEAVE:SM: CASE:AppendNewECDHKey
WEAVE:SM: CASE:AppendCertInfo
WEAVE:SM: CASE:AppendPayload
WEAVE:SM: CASE:AppendSignature
WEAVE:SM: CASE:GenerateSignature
WEAVE:EM: Msg sent 00000004:10 715 18B4300000000003 0000 B2E8 0 MsgId:A363FD8F
WEAVE:SM: StartSessionTimer
WEAVE:EM: Msg rcvd 00000000:2 0 18B4300000000003 0000 B2E8 0 MsgId:207817B3
WEAVE:EM: Rxd Ack; Removing MsgId:A363FD8F from Retrans Table
WEAVE:SM: WRMPHandleAckRcvd
WEAVE:EM: Removed Weave MsgId:A363FD8F from RetransTable
WEAVE:EM: Msg rcvd 00000004:11 430 18B4300000000003 0000 B2E8 0 MsgId:207817B4
WEAVE:EM: Weave MsgId:A363FD8F not in RetransTable
WEAVE:EM: Piggybacking Ack for MsgId:207817B4 with msg
WEAVE:EM: Msg sent 00000000:2 0 18B4300000000003 0000 B2E8 0 MsgId:A363FD90
WEAVE:EM: Flushed pending ack for MsgId:207817B4 to Peer 18B4300000000003
WEAVE:SM: CASE:ProcessBeginSessionResponse
WEAVE:SM: CASE:VerifySignature
WEAVE:SM: CASE:DecodeCertificateInfo
WEAVE:SM: CASE:ValidateCert
WEAVE:SM: CASE:DecodeWeaveECDSASignature
WEAVE:SM: CASE:VerifyECDSASignature
WEAVE:SM: CASE:DeriveSessionKeys
WEAVE:SM: CASE:GenerateInitiatorKeyConfirm
WEAVE:EM: Piggybacking Ack for MsgId:207817B4 with msg
WEAVE:EM: Msg sent 00000004:12 32 18B4300000000003 0000 B2E8 0 MsgId:A363FD91
WEAVE:ML: Message Encryption Key: Id=2A6F Type=SessionKey Peer=18B4300000000003 EncType=01 Key=8F4845838678FA1E346F84AB6B3463AD,409B7FA15507DAB756BD66BD441CAD1507133E2E
WEAVE:EM: Msg rcvd 00000000:2 0 18B4300000000003 0000 B2E8 0 MsgId:207817B5
WEAVE:EM: Rxd Ack; Removing MsgId:A363FD91 from Retrans Table
WEAVE:SM: WRMPHandleAckRcvd
WEAVE:SM: CancelSessionTimer
Secure session established with node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3)
WEAVE:EM: Removed Weave MsgId:A363FD91 from RetransTable
WEAVE:EM: ec id: 1, AppState: 0x52beaa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 0000 B2E9 0 MsgId:00000000
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 0000 B2E9 0 MsgId:00000000
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 1/1(100.00%) len=15 time=24.205ms
WEAVE:EM: ec id: 1, AppState: 0x52beaa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 0000 B2EA 0 MsgId:00000001
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 0000 B2EA 0 MsgId:00000001
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 2/2(100.00%) len=15 time=34.185ms
WEAVE:EM: ec id: 1, AppState: 0x52beaa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 0000 B2EB 0 MsgId:00000002
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 0000 B2EB 0 MsgId:00000002
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 3/3(100.00%) len=15 time=23.653ms
WEAVE:EM: ec id: 1, AppState: 0x52beaa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 0000 B2EC 0 MsgId:00000003
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 0000 B2EC 0 MsgId:00000003
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 4/4(100.00%) len=15 time=24.373ms
This shows sending encrypted Weave Echo messages to a device using TCP, where the encryption keys have been established using the Weave Password Authenticated Session Establishment (PASE) protocol.
$ weave-ping --node-id 18b4300000000001 --tcp --dest-addr FD88:7766:5544:0:9F2E:8721:E8A1:D7F3 --pase --pairing-code NESTUS 18B4300000000003
WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095
WEAVE:IN: IPV6_PKTINFO: 92
WEAVE:ML: Listening on general purpose IPv4 UDP endpoint
WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [::]:11095 ()
WEAVE:ML: Listening on general purpose IPv6 UDP endpoint
WEAVE:ML: Adding ens33 to interface table
WEAVE:ML: Adding wpan7 to interface table
WEAVE:EM: Cannot listen for BLE connections, null BleLayer
WEAVE:SD: init()
Weave Node Configuration:
Fabric Id: 1
Subnet Number: 1
Node Id: 18B4300000000001
Listening Addresses: any
Sending Echo requests to node 18B4300000000003 at FD88:7766:5544:0:9F2E:8721:E8A1:D7F3
Iteration 0
Weave Node ready to service events; PID: 57936; PPID: 4808
WEAVE:ML: Con start 58A0 18B4300000000003 1001
WEAVE:ML: Con DNS complete 58A0 0
WEAVE:ML: TCP con start 58A0 fd88:7766:5544:0:9f2e:8721:e8a1:d7f3 11095
WEAVE:ML: TCP con complete 58A0 0
WEAVE:EM: ec id: 1, AppState: 0x844aa8c0
WEAVE:EM: Msg sent 00000004:1 296 18B4300000000003 58A0 71B3 0 MsgId:00000000
WEAVE:SM: StartSessionTimer
WEAVE:EM: Msg rcvd 00000004:2 284 18B4300000000003 58A0 71B3 0 MsgId:00000000
WEAVE:EM: Msg rcvd 00000004:3 144 18B4300000000003 58A0 71B3 0 MsgId:00000001
WEAVE:EM: Msg sent 00000004:4 176 18B4300000000003 58A0 71B3 0 MsgId:00000001
WEAVE:EM: Msg rcvd 00000004:5 32 18B4300000000003 58A0 71B3 0 MsgId:00000002
WEAVE:ML: Message Encryption Key: Id=27A2 Type=SessionKey Peer=18B4300000000003 EncType=01 Key=907A6B3B62DE0A2D273EA43AD10B1A12,1D3DCB3F1C85A8D9A5C05089C98A052057B73CBE
WEAVE:SM: CancelSessionTimer
WEAVE:ML: Con complete 58A0
Connection established to node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3)
WEAVE:EM: ec id: 1, AppState: 0x84496aa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 58A0 71B4 0 MsgId:00000000
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 58A0 71B4 0 MsgId:00000000
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 1/1(100.00%) len=15 time=31.973ms
WEAVE:EM: ec id: 1, AppState: 0x84496aa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 58A0 71B5 0 MsgId:00000001
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 58A0 71B5 0 MsgId:00000001
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 2/2(100.00%) len=15 time=32.458ms
WEAVE:EM: ec id: 1, AppState: 0x84496aa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 58A0 71B6 0 MsgId:00000002
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 58A0 71B6 0 MsgId:00000002
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 3/3(100.00%) len=15 time=32.348ms
WEAVE:EM: ec id: 1, AppState: 0x84496aa0
WEAVE:EM: Msg sent 00000001:1 15 18B4300000000003 58A0 71B7 0 MsgId:00000003
WEAVE:EM: Msg rcvd 00000001:2 15 18B4300000000003 58A0 71B7 0 MsgId:00000003
Echo Response from node 18B4300000000003 (fd88:7766:5544:0:9f2e:8721:e8a1:d7f3): 4/4(100.00%) len=15 time=32.363ms
Using the Weave Device Manager Shell, one can send management commands to a device over either Thread or BLE. Device management commands are typically used during the process of pairing a device, wherein a device is configured (provisioned) to connect to a user‘s home network, and associate with a user’s account. They can also be used after a device has been paired, to inspect or alter the device's configuration.
Because pairing is typically orchestrated by a mobile device which lacks a Thread radio, the associated device management interactions usually take place over BLE. However, Weave device management interactions can also happen over Thread, given a suitably configured host device.
The examples given in this section use the Weave Device Manager Shell command-line tool (weave-device-manager) to send commands to the test device. The Weave Device Manager Shell is produced as part of a stand-alone (desktop) build of OpenWeave.
The examples using BLE require the use of a BLE-capable host machine. This can be either a Mac laptop, or a linux machine with BlueZ-supported BlueTooth radio.
The examples using Thread require the use of wpantund and an NCP device connected via USB to the host machine (see above for how to set this up).
This example shows connecting to a test device over Thread using the rendezvous command in the Weave Device Manager Shell. The rendezvous command uses the multicast Weave Device Identify protocol to locate the target device, and then establishes a Weave TCP connection over which management commands can be sent. The rendezvous command accepts various criteria arguments that serve to select the correct device out of all devices in multicast range. In this example, the device's Weave Device id is used.
To determine the test device's Weave Device id, look for the following text in the log output of the device:
<info> weave: [DL] Device Configuration:
<info> weave: [DL] Device Id: 18B4300000000003
<info> weave: [DL] Serial Number: (not set)
<info> weave: [DL] Vendor Id: 9050 (0x235A) (Nest)
<info> weave: [DL] Product Id: 65279 (0xFEFF)
<info> weave: [DL] Fabric Id: (none)
<info> weave: [DL] Pairing Code: NESTUS
Start the Weave Device Manager Shell
$ weave-device-mgr WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095 WEAVE:IN: IPV6_PKTINFO: 92 WEAVE:ML: Listening on general purpose IPv4 UDP endpoint WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [::]:11095 () WEAVE:ML: Listening on general purpose IPv6 UDP endpoint WEAVE:ML: Adding ens33 to interface table WEAVE:ML: Adding wpan0 to interface table WEAVE:ML: Binding IPv6 UDP interface endpoint to [fd88:7766:5544:0:c0b5:65ec:454f:e276]:11095 (wpan0) WEAVE:ML: Listening on IPv6 UDP interface endpoint Weave Device Manager Shell weave-device-mgr >
Rendezvous with the target device
weave-device-mgr > rendezvous --target-device 18B4300000000003 WEAVE:DM: Initiating connection to device WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095 WEAVE:IN: IPV6_PKTINFO: 92 WEAVE:ML: Listening on general purpose IPv4 UDP endpoint WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [::]:11095 () WEAVE:ML: Listening on general purpose IPv6 UDP endpoint WEAVE:ML: Adding ens33 to interface table WEAVE:ML: Adding wpan0 to interface table WEAVE:ML: Binding IPv6 UDP interface endpoint to [fd88:7766:5544:0:c0b5:65ec:454f:e276]:11095 (wpan0) WEAVE:ML: Listening on IPv6 UDP interface endpoint WEAVE:EM: ec id: 1, AppState: 0x50d35480 WEAVE:DM: Sending IdentifyRequest to locate device WEAVE:EM: Msg sent 0000000E:1 16 18B4300000000003 0000 9869 0 MsgId:23C64567 WEAVE:EM: Msg rcvd 0000000E:2 29 18B4300000000003 0000 9869 0 MsgId:A1553D7D WEAVE:DM: Received identify response from device 18B4300000000003 ([fe80::9c25:f8c:7c62:14b3]:11095%wpan0) WEAVE:DM: Initiating weave connection to device 18B4300000000003 (fe80::9c25:f8c:7c62:14b3) WEAVE:ML: Con start BB20 18B4300000000003 0001 WEAVE:ML: TCP con start BB20 fe80::9c25:f8c:7c62:14b3 11095 WEAVE:ML: TCP con complete BB20 0 WEAVE:ML: Con complete BB20 WEAVE:DM: Connected to device Connected to device 18B4300000000003 at fe80::9c25:f8c:7c62:14b3 weave-device-mgr (18B4300000000003 @ fe80::9c25:f8c:7c62:14b3) >
Once the connection has been established, it can be used to issue commands to the device, as shown below.
This example shows connecting to a device using Weave-over-BLE. To connect to a device using BLE, the device must be advertising in connectable mode. (Weave devices do this automatically unless disabled by the application). Additionally, one must know the device's BLE device name. This can be found in the log output of the test device when it boots:
<info> weave: [DL] Configuring BLE advertising (interval 500 ms, connectable, device name NEST-0003)
Start the Weave Device Manager Shell
$ weave-device-mgr WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095 WEAVE:IN: IPV6_PKTINFO: 22 WEAVE:ML: Listening on general purpose IPv4 UDP endpoint WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [::]:11095 () WEAVE:IN: IP_PKTINFO: 22 WEAVE:ML: Listening on general purpose IPv6 UDP endpoint WEAVE:ML: Adding lo0 to interface table WEAVE:ML: Adding en0 to interface table WEAVE:ML: Adding awdl0 to interface table WEAVE:ML: Adding utun0 to interface table Weave Device Manager Shell weave-device-mgr >
Scan for the test device and establish a BLE connection
weave-device-mgr > ble-scan-connect NEST-0003
2019-03-22 12:43:05,744 WeaveBLEMgr INFO BLE is ready!
2019-03-22 12:43:06,101 WeaveBLEMgr INFO adding to scan list:
2019-03-22 12:43:06,101 WeaveBLEMgr INFO
2019-03-22 12:43:06,101 WeaveBLEMgr INFO Name = NEST-0003
2019-03-22 12:43:06,101 WeaveBLEMgr INFO ID = 63B7C6D9-DF17-4E0A-89B6-58FDD58DE718
2019-03-22 12:43:06,101 WeaveBLEMgr INFO RSSI = -59
2019-03-22 12:43:06,101 WeaveBLEMgr INFO ADV data: {
kCBAdvDataIsConnectable = 1;
kCBAdvDataLocalName = "NEST-0003";
kCBAdvDataServiceUUIDs = (
FEAF
);
}
2019-03-22 12:43:06,101 WeaveBLEMgr INFO
2019-03-22 12:43:06,102 WeaveBLEMgr INFO scanning stopped
2019-03-22 12:43:06,102 WeaveBLEMgr INFO trying to connect to NEST-0003
2019-03-22 12:43:07,204 WeaveBLEMgr INFO Discovering services
2019-03-22 12:43:07,208 WeaveBLEMgr INFO Discovering services
2019-03-22 12:43:07,363 WeaveBLEMgr INFO connect success
weave-device-mgr >
Establish a Weave-over-BLE connection with the device:
weave-device-mgr > connect --ble WEAVE:BLE: subscribe complete, ep = 0x1080c5d30 WEAVE:BLE: peripheral chose BTP version 3; central expected between 2 and 3 WEAVE:BLE: using BTP fragment sizes rx 20 / tx 101. WEAVE:BLE: local and remote recv window size = 3 WEAVE:ML: WoBle con complete BBD0 WEAVE:ML: Con complete BBD0 WEAVE:DM: Connected to device WEAVE:DM: Initializing Weave BLE connection WEAVE:EM: ec id: 1, AppState: 0x6b018800 WEAVE:DM: Sending IdentifyRequest to device WEAVE:EM: Msg sent 0000000E:1 16 FFFFFFFFFFFFFFFF BBD0 ACD9 0 MsgId:00000000 WEAVE:EM: Msg rcvd 0000000E:2 29 18B4300000000003 BBD0 ACD9 0 MsgId:00000000 WEAVE:DM: Received identify response from device 18B4300000000003 (ble con BBD0) Connected to device. weave-device-mgr (18B4300000000003 @ ::) >
Once the WoBLE connection has been established, it can be used to issue commands to the device, as shown below.
The identify command sends a Weave Device Identify request to the connected device and displays the device's response.
weave-device-mgr (18B4300000000003 @ fe80::9c25:f8c:7c62:14b3) > identify
WEAVE:EM: ec id: 1, AppState: 0x50d35480
WEAVE:EM: Msg sent 0000000E:1 16 18B4300000000003 BB20 986B 0 MsgId:00000001
WEAVE:EM: Msg rcvd 0000000E:2 29 18B4300000000003 BB20 986B 0 MsgId:00000001
Identify device complete
Device Id: 18B4300000000003
Vendor Id: 235A
Product Id: FEFF
Product Revision: 1
Pairing Compatibility Major Id: 0
Pairing Compatibility Minor Id: 0
Device Features:
weave-device-mgr (18B4300000000003 @ fe80::9c25:f8c:7c62:14b3) >
The ping command sends a Weave Echo request to the connected device and awaits the device's response.
weave-device-mgr (18B4300000000003 @ fe80::9c25:f8c:7c62:14b3) > create-fabric
WEAVE:EM: ec id: 1, AppState: 0x50d35480
WEAVE:EM: Msg sent 00000005:1 0 18B4300000000003 BB20 986C 0 MsgId:00000002
WEAVE:EM: Msg rcvd 00000000:1 6 18B4300000000003 BB20 986C 0 MsgId:00000002
Create fabric complete
weave-device-mgr (18B4300000000003 @ fe80::9c25:f8c:7c62:14b3) > ping
WEAVE:DM: DataLength: 0, payload: 0, next: (nil)
WEAVE:EM: ec id: 1, AppState: 0x50d35480
WEAVE:EM: Msg sent 00000001:1 0 18B4300000000003 BB20 986D 0 MsgId:00000003
WEAVE:EM: Msg rcvd 00000001:2 0 18B4300000000003 BB20 986D 0 MsgId:00000003
Ping complete
weave-device-mgr (18B4300000000003 @ fe80::9c25:f8c:7c62:14b3) >