This demo project consists of three sub examples:
The example demonstrates the mesh eco system containing devices acting in two roles, a Provisioner role, and a Node role. In addition, it demonstrates how to use custom models by using the Generic OnOff model in a real application.
See Compatibility for the supported boards.
SERVER_NODE_COUNT (in light_switch_example_common.h) to the number of boards available and rebuild the provisioner example.To build the examples, follow the instructions in Building the Mesh Stack. For commands required to program a device using nrfjprog, see the Running examples using nrfjprog section on the Running examples page.
To run the examples, the boards must be provisioned first. It can be done using either the development board or nRF Mesh mobile app.
To complete the provisioning process:
The provisioner prints details about the provisioning and the configuration process in the RTT log. When provisioner is scanning and provisioning a device, LED 1 on the Provisioner board is turned ON. When configuration procedure is underway, LED 2 on the provisioner board is turned ON.
The provisioner configures the client model instances on the client board. The client example is configured as follows:
If the provisioner encounters an error during the provisioning or configuration process for a certain node, you can reset the provisioner to restart this process for that node.
To provision using the mobile app, both on iOS and Android:
nRF5x Mesh Switch, the server board is nRF5x Mesh Light.Once provisioning and configuration of the client node and at least one of the server nodes is completed, you can press buttons on the client to see the LEDs getting toggled on the associated servers.
If an RTT terminal is available and connected to the client, sending the ASCII numbers 0–3 will have the same effect as pressing the buttons.
You can also press Button 1 on the servers to locally toggle the state of their LED 1, and the status reflecting this state will be sent to the client board. You can see the status printed in the RTT log of the client board.
If any of the devices are powered off and back on, they will remember their configuration in flash and rejoin the network. More information about the flash manager can be found in the flash manager documentation.
The provisoner provisions and configures the nodes to setup a demo mesh network. It is implemented as a multi-layered state machine due to the asynchronous nature of the provisioning and configuration process.
The provisioner first provisions and configures a client device with a known UUID. After this it moves on to provision and configure the server devices.
The following diagram shows the typical state transitions of the provisioner while provisioning and configuring light switch servers.
For more information on how a provisioner works, see the Mesh provisioning Guide.
The Light switch client has a provisionee role in the network. The client has four buttons to control the state of LED 1 on servers. It instantiates two instances of Generic OnOff Client model. It can either be provisioned and configured by the provisioner device or by a GATT-based provisioner. The provisioner configures this client model instances to communicate with servers.
The Light switch server has a provisionee role in the network. It instantiates one instance of the Generic OnOff server model to control the state of LED 1. It can either be provisioned and configured by the provisioner device or by a GATT-based provisioner. The provisioner configures this server model instance to communicate with the client model on the client board and to publish a message when value of the OnOff state changes.
After provisioning, the proxy server application starts advertising a connectable proxy beacon, which a Proxy Client can connect to in order to interact with the mesh. The Proxy Client acts like any other mesh device, but sends all of its mesh communication over a BLE connection to a Proxy Server, which relays it into the mesh.
As proxy is only supported on the nRF52, cmake will not generate the proxy server example for nRF51.
Both the Light switch server and Light switch client examples support provisioning over GATT (PB-GATT) and Proxy Server.
Read more about the Proxy feature in GATT provisioning and Proxy (experimental).
The Generic OnOff Client/Server is used for manipulating an on/off state. Note that when the server has a publish address set (as in this example), the server will publish any operation of its state change to its publish address.
More information about the Generic OnOff model can be found in the Generic OnOff model documentation and Generic OnOff server behaviour documentation.
See the Exploring Mesh APIs using light switch example document to get a quick overview of the various SDK APIs.