This is the documentation for the latest (master) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

Shell

The Bluetooth Mesh Shell subsystem provides a set of Bluetooth Mesh commands for the Shell module. It allows for testing and exploring the Bluetooth Mesh API through an interactive interface, without having to write an application.

The Bluetooth Mesh Shell interface provides access to most Bluetooth Mesh features, including provisioning, configuration, and message sending.

Prerequisites

The Mesh Shell subsystem depends on the Configuration Client and Health Client models.

Mesh Shell application

The Mesh Shell subsystem is most easily used through the Mesh Shell application under tests/bluetooth/mesh_shell. See Shell for information on how to connect and interact with the shell application.

Basic usage

The Mesh Shell subsystem adds a single mesh command, which holds a set of sub-commands. Every time the device boots up, make sure to call mesh init before any of the other Mesh Shell commands can be called:

uart:~$ mesh init

Provisioning

The mesh node must be provisioned to become part of the network. This is only necessary the first time the device boots up, as the device will remember its provisioning data between reboots.

The simplest way to provision the device is through self-provisioning. To provision the device with the default network key and address 0x0001, execute:

uart:~$ mesh provision 0 0x0001

Since all mesh shell nodes use the same values for the default network key, this can be done on multiple devices, as long as they’re assigned non-overlapping unicast addresses. Alternatively, to provision the device into an existing network, the unprovisioned beacon can be enabled with mesh pb-adv on or mesh pb-gatt on. The beacons can be picked up by an external provisioner, which can provision the node into its network.

Once the mesh node is part of a network, its transmission parameters can be controlled by the general configuration commands:

  • To set the destination address, call mesh dst <addr>.

  • To set the network key index, call mesh netidx <NetIdx>.

  • To set the application key index, call mesh appidx <AppIdx>.

By default, the transmission parameters are set to send messages to the provisioned address and network key.

Configuration

By setting the destination address to the local unicast address (0x0001 in the mesh provision command above), we can perform self-configuration through any of the Configuration Client model commands.

A good first step is to read out the node’s own composition data:

uart:~$ mesh get-comp

This prints a list of the composition data of the node, including a list of its model IDs.

Next, since the device has no application keys by default, it’s a good idea to add one:

uart:~$ mesh app-key-add 0 0

Message sending

With an application key added (see above), the mesh node’s transition parameters are all valid, and the Mesh Shell can send raw mesh messages through the network.

For example, to send a Generic OnOff Set message, call:

uart:~$ mesh net-send 82020100

Note

All multibyte fields model messages are in little endian, except the opcode.

The message will be sent to the current destination address, using the current network and application key indexes. As the destination address points to the local unicast address by default, the device will only send packets to itself. To change the destination address to the All Nodes broadcast address, call:

uart:~$ mesh dst 0xffff

With the destination address set to 0xffff, any other mesh nodes in the network with the configured network and application keys will receive and process the messages we send.

Note

To change the configuration of the device, the destination address must be set back to the local unicast address before issuing any configuration commands.

Sending raw mesh packets is a good way to test model message handler implementations during development, as it can be done without having to implement the sending model. By default, only the reception of the model messages can be tested this way, as the Mesh Shell only includes the foundation models. To receive a packet in the Mesh Shell node, you have to add a model with a valid opcode handler list to the composition data in subsys/bluetooth/mesh/shell.c, and print the incoming message to the shell in the handler callback.

Parameter formats

The Mesh Shell commands are parsed with a variety of formats:

Parameter formats

Type

Description

Example

Integers

The default format unless something else is specified. Can be either decimal or hexadecimal.

1234, 0xabcd01234

Hexstrings

For raw byte arrays, like UUIDs, key values and message payloads, the parameters should be formatted as an unbroken string of hexadecimal values without any prefix.

deadbeef01234

Booleans

Boolean values are denoted in the API documentation as <val: on, off>.

on, off, enabled, disabled, 1, 0

Mesh Shell commands

The Mesh shell implements a large set of commands. Some of the commands accept parameters, which are mentioned in brackets after the command name. For example, mesh lpn <value: off, on>. Mandatory parameters are marked with angle brackets (e.g. <NetKeyIndex>), and optional parameters are marked with square brackets (e.g. [destination address]).

The Mesh Shell commands are divided into the following groups:

Note

Some commands depend on specific features being enabled in the compile time configuration of the application. Not all features are enabled by default. The list of available Mesh Shell commands can be shown in the shell by calling mesh without any arguments.

General configuration

mesh init

Initialize the mesh. This command must be run before any other mesh command.

mesh reset <addr>

reset the local mesh node to its initial unprovisioned state or reset a remote node and remove it from the network. * addr: address of the node to reset.

mesh lpn <value: off, on>

Enable or disable Low Power operation. Once enabled, the device will turn off its radio and start polling for friend nodes. The device will not be able to receive messages from the mesh network until the friendship has been established.

  • value: Sets whether Low Power operation is enabled.

mesh poll

Perform a poll to the friend node, to receive any pending messages. Only available when LPN is enabled.

mesh ident

Enable the Proxy Node Identity beacon, allowing Proxy devices to connect explicitly to this device. The beacon will run for 60 seconds before the node returns to normal Proxy beacons.

mesh dst [destination address]

Get or set the message destination address. The destination address determines where mesh packets are sent with the shell, but has no effect on modules outside the shell’s control.

  • destination address: If present, sets the new 16-bit mesh destination address. If omitted, the current destination address is printed.

mesh netidx [NetIdx]

Get or set the message network index. The network index determines which network key is used to encrypt mesh packets that are sent with the shell, but has no effect on modules outside the shell’s control. The network key must already be added to the device, either through provisioning or by a Config Client.

  • NetIdx: If present, sets the new network index. If omitted, the current network index is printed.

mesh appidx [AppIdx]

Get or set the message application index. The application index determines which application key is used to encrypt mesh packets that are sent with the shell, but has no effect on modules outside the shell’s control. The application key must already be added to the device by a Config Client, and must be bound to the current network index.

  • AppIdx: If present, sets the new application index. If omitted, the current application index is printed.

mesh net-send <hex string>

Send a raw mesh message with the current destination address, network and application index. The message opcode must be encoded manually.

  • hex string Raw hexadecimal representation of the message to send.

Testing

mesh iv-update

Force an IV update.

mesh iv-update-test <value: off, on>

Set the IV update test mode. In test mode, the IV update timing requirements are bypassed.

  • value: Enable or disable the IV update test mode.

mesh rpl-clear

Clear the replay protection list, forcing the node to forget all received messages.

Warning

Clearing the replay protection list breaks the security mechanisms of the mesh node, making it susceptible to message replay attacks. This should never be performed in a real deployment.

Provisioning

mesh pb-gatt <val: off, on>

Start or stop advertising a connectable unprovisioned beacon. The connectable unprovisioned beacon allows the mesh node to be discovered by nearby GATT based provisioners, and provisioned through the GATT bearer.

  • val: Enable or disable provisioning with GATT

mesh pb-adv <val: off, on>

Start or stop advertising the unprovisioned beacon. The unprovisioned beacon allows the mesh node to be discovered by nearby advertising-based provisioners, and provisioned through the advertising bearer.

  • val: Enable or disable provisioning with advertiser

mesh provision-adv <UUID> <NetKeyIndex> <addr> <AttentionDuration>

Provision a nearby device into the mesh. The mesh node starts scanning for unprovisioned beacons with the given UUID. Once found, the unprovisioned device will be added to the mesh network with the given unicast address, and given the network key indicated by NetKeyIndex.

  • UUID: UUID of the unprovisioned device.

  • NetKeyIndex: Index of the network key to pass to the device.

  • addr: First unicast address to assign to the unprovisioned device. The device will occupy as many addresses as it has elements, and all must be available.

  • AttentionDuration: The duration in seconds the unprovisioned device will identify itself for, if supported. See Attention state for details.

mesh uuid <UUID: 1-16 hex values>

Set the mesh node’s UUID, used in the unprovisioned beacons.

  • UUID: New 128-bit UUID value. Any missing bytes will be zero.

mesh input-num <number>

Input a numeric OOB authentication value. Only valid when prompted by the shell during provisioning. The input number must match the number presented by the other participant in the provisioning.

  • number: Decimal authentication number.

mesh input-str <string>

Input an alphanumeric OOB authentication value. Only valid when prompted by the shell during provisioning. The input string must match the string presented by the other participant in the provisioning.

  • string: Unquoted alphanumeric authentication string.

mesh static-oob [val: 1-16 hex values]

Set or clear the static OOB authentication value. The static OOB authentication value must be set before provisioning starts to have any effect. The static OOB value must be same on both participants in the provisioning.

  • val: If present, indicates the new hexadecimal value of the static OOB. If omitted, the static OOB value is cleared.

mesh provision <NetKeyIndex> <addr> [IVIndex]

Provision the mesh node itself. If the Configuration database is enabled, the network key must be created. Otherwise, the default key value is used.

  • NetKeyIndex: Index of the network key to provision.

  • addr: First unicast address to assign to the device. The device will occupy as many addresses as it has elements, and all must be available.

  • IVindex: Indicates the current network IV index. Defaults to 0 if omitted.

mesh beacon-listen <val: off, on>

Enable or disable printing of incoming unprovisioned beacons. Allows a provisioner device to detect nearby unprovisioned devices and provision them.

  • val: Whether to enable the unprovisioned beacon printing.

Configuration Client model

The Mesh Shell module instantiates a Configuration Client model for configuring itself and other nodes in the mesh network.

The Configuration Client uses the general messages parameters set by mesh dst and mesh netidx to target specific nodes. When the Mesh Shell node is provisioned, the Configuration Client model targets itself by default. When another node has been provisioned by the Mesh Shell, the Configuration Client model targets the new node. The Configuration Client always sends messages using the Device key bound to the destination address, so it will only be able to configure itself and mesh nodes it provisioned.

mesh timeout [timeout in seconds]

Get and set the Config Client model timeout used during message sending.

  • timeout in seconds: If present, set the Config Client model timeout in seconds. If omitted, the current timeout is printed.

mesh get-comp [page]

Read a composition data page. The full composition data page will be printed. If the target does not have the given page, it will return the last page before it.

  • page: The composition data page to request. Defaults to 0 if omitted.

mesh beacon [val: off, on]

Get or set the network beacon transmission.

  • val: If present, enables or disables sending of the network beacon. If omitted, the current network beacon state is printed.

mesh ttl [ttl: 0x00, 0x02-0x7f]

Get or set the default TTL value.

  • ttl: If present, sets the new default TTL value. If omitted, the current default TTL value is printed.

mesh friend [val: off, on]

Get or set the Friend feature.

  • val: If present, enables or disables the Friend feature. If omitted, the current Friend feature state is printed:

    • 0x00: The feature is supported, but disabled.

    • 0x01: The feature is enabled.

    • 0x02: The feature is not supported.

mesh gatt-proxy [val: off, on]

Get or set the GATT Proxy feature.

  • val: If present, enables or disables the GATT Proxy feature. If omitted, the current GATT Proxy feature state is printed:

    • 0x00: The feature is supported, but disabled.

    • 0x01: The feature is enabled.

    • 0x02: The feature is not supported.

mesh relay [<val: off, on> [<count: 0-7> [interval: 10-320]]]

Get or set the Relay feature and its parameters.

  • val: If present, enables or disables the Relay feature. If omitted, the current Relay feature state is printed:

    • 0x00: The feature is supported, but disabled.

    • 0x01: The feature is enabled.

    • 0x02: The feature is not supported.

  • count: Sets the new relay retransmit count if val is on. Ignored if val is off. Defaults to 2 if omitted.

  • interval: Sets the new relay retransmit interval in milliseconds if val is on. Ignored if val is off. Defaults to 20 if omitted.

mesh net-transmit-param [<count: 0-7> <interval: 10-320>]

Get or set the network transmit parameters.

  • count: Sets the number of additional network transmits for every sent message.

  • interval: Sets the new network retransmit interval in milliseconds.

mesh net-key-add <NetKeyIndex> [val]

Add a network key to the target node. Adds the key to the Configuration Database if enabled.

  • NetKeyIndex: The network key index to add.

  • val: If present, sets the key value as a 128-bit hexadecimal value. Any missing bytes will be zero. Only valid if the key does not already exist in the Configuration Database. If omitted, the default key value is used.

mesh net-key-get

Get a list of known network key indexes.

mesh net-key-del <NetKeyIndex>

Delete a network key from the target node.

  • NetKeyIndex: The network key index to delete.

mesh app-key-add <NetKeyIndex> <AppKeyIndex> [val]

Add an application key to the target node. Adds the key to the Configuration Database if enabled.

  • NetKeyIndex: The network key index the application key is bound to.

  • AppKeyIndex: The application key index to add.

  • val: If present, sets the key value as a 128-bit hexadecimal value. Any missing bytes will be zero. Only valid if the key does not already exist in the Configuration Database. If omitted, the default key value is used.

mesh app-key-get <NetKeyIndex>

Get a list of known application key indexes bound to the given network key index.

  • NetKeyIndex: Network key indexes to get a list of application key indexes from.

mesh app-key-del <NetKeyIndex> <AppKeyIndex>

Delete an application key from the target node.

  • NetKeyIndex: The network key index the application key is bound to.

  • AppKeyIndex: The application key index to delete.

mesh mod-app-bind <addr> <AppIndex> <Model ID> [Company ID]

Bind an application key to a model. Models can only encrypt and decrypt messages sent with application keys they are bound to.

  • addr: Address of the element the model is on.

  • AppIndex: The application key to bind to the model.

  • Model ID: The model ID of the model to bind the key to.

  • Company ID: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

mesh mod-app-unbind <addr> <AppIndex> <Model ID> [Company ID]

Unbind an application key from a model.

  • addr: Address of the element the model is on.

  • AppIndex: The application key to unbind from the model.

  • Model ID: The model ID of the model to unbind the key from.

  • Company ID: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

mesh mod-app-get <elem addr> <Model ID> [Company ID]

Get a list of application keys bound to a model.

  • elem addr: Address of the element the model is on.

  • Model ID: The model ID of the model to get the bound keys of.

  • Company ID: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

mesh mod-pub <addr> <mod id> [cid] [<PubAddr> <AppKeyIndex> <cred: off, on> <ttl> <period> <count> <interval>]

Get or set the publication parameters of a model. If all publication parameters are included, they become the new publication parameters of the model. If all publication parameters are omitted, print the current publication parameters of the model.

  • addr: Address of the element the model is on.

  • Model ID: The model ID of the model to get the bound keys of.

  • cid: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

Publication parameters:

  • PubAddr: The destination address to publish to.

  • AppKeyIndex: The application key index to publish with.

  • cred: Whether to publish with Friendship credentials when acting as a Low Power Node.

  • ttl: TTL value to publish with (0x00 to 0x07f).

  • period: Encoded publication period, or 0 to disable periodic publication.

  • count: Number of retransmission for each published message (0 to 7).

  • interval The interval between each retransmission, in milliseconds. Must be a multiple of 50.

mesh mod-sub-add <elem addr> <sub addr> <Model ID> [Company ID]

Subscription the model to a group address. Models only receive messages sent to their unicast address or a group or virtual address they subscribe to. Models may subscribe to multiple group and virtual addresses.

  • elem addr: Address of the element the model is on.

  • sub addr: 16-bit group address the model should subscribe to (0xc000 to 0xFEFF).

  • Model ID: The model ID of the model to add the subscription to.

  • Company ID: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

mesh mod-sub-del <elem addr> <sub addr> <Model ID> [Company ID]

Unsubscribe a model from a group address.

  • elem addr: Address of the element the model is on.

  • sub addr: 16-bit group address the model should remove from its subscription list (0xc000 to 0xFEFF).

  • Model ID: The model ID of the model to add the subscription to.

  • Company ID: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

mesh mod-sub-add-va <elem addr> <Label UUID> <Model ID> [Company ID]

Subscribe the model to a virtual address. Models only receive messages sent to their unicast address or a group or virtual address they subscribe to. Models may subscribe to multiple group and virtual addresses.

  • elem addr: Address of the element the model is on.

  • Label UUID: 128-bit label UUID of the virtual address to subscribe to. Any omitted bytes will be zero.

  • Model ID: The model ID of the model to add the subscription to.

  • Company ID: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

mesh mod-sub-del-va <elem addr> <Label UUID> <Model ID> [Company ID]

Unsubscribe a model from a virtual address.

  • elem addr: Address of the element the model is on.

  • Label UUID: 128-bit label UUID of the virtual address to remove the subscribtion of. Any omitted bytes will be zero.

  • Model ID: The model ID of the model to add the subscription to.

  • Company ID: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

mesh mod-sub-get <elem addr> <Model ID> [Company ID]

Get a list of addresses the model subscribes to.

  • elem addr: Address of the element the model is on.

  • Model ID: The model ID of the model to get the subscription list of.

  • Company ID: If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defined model.

mesh hb-sub [<src> <dst> <period>]

Get or set the Heartbeat subscription parameters. A node only receives Heartbeat messages matching the Heartbeat subscription parameters. Sets the Heartbeat subscription parameters if present, or prints the current Heartbeat subscription parameters if called with no parameters.

  • src: Unicast source address to receive Heartbeat messages from.

  • dst: Destination address to receive Heartbeat messages on.

  • period: Logarithmic representation of the Heartbeat subscription period:

    • 0: Heartbeat subscription will be disabled.

    • 1 to 17: The node will subscribe to Heartbeat messages for 2(period - 1) seconds.

mesh hb-pub [<dst> <count> <period> <ttl> <features> <NetKeyIndex>]

Get or set the Heartbeat publication parameters. Sets the Heartbeat publication parameters if present, or prints the current Heartbeat publication parameters if called with no parameters.

  • dst: Destination address to publish Heartbeat messages to.

  • count: Logarithmic representation of the number of Heartbeat messages to publish periodically:

    • 0: Heartbeat messages are not published periodically.

    • 1 to 17: The node will periodically publish 2(count - 1) Heartbeat messages.

    • 255: Heartbeat messages will be published periodically indefinitely.

  • period: Logarithmic representation of the Heartbeat publication period:

    • 0: Heartbeat messages are not published periodically.

    • 1 to 17: The node will publish Heartbeat messages every 2(period - 1) seconds.

  • ttl: The TTL value to publish Heartbeat messages with (0x00 to 0x7f).

  • features: Bitfield of features that should trigger a Heartbeat publication when changed:

    • Bit 0: Relay feature.

    • Bit 1: Proxy feature.

    • Bit 2: Friend feature.

    • Bit 3: Low Power feature.

  • NetKeyIndex: Index of the network key to publish Heartbeat messages with.

Health Client model

The Mesh Shell module instantiates a Health Client model for configuring itself and other nodes in the mesh network.

The Health Client uses the general messages parameters set by mesh dst and mesh netidx to target specific nodes. When the Mesh Shell node is provisioned, the Health Client model targets itself by default. When another node has been provisioned by the Mesh Shell, the Health Client model targets the new node. The Health Client always sends messages using the Device key bound to the destination address, so it will only be able to configure itself and mesh nodes it provisioned.

mesh fault-get <Company ID>

Get a list of registered faults for a Company ID.

  • Company ID: Company ID to get faults for.

mesh fault-clear <Company ID>

Clear the list of faults for a Company ID.

  • Company ID: Company ID to clear the faults for.

mesh fault-clear-unack <Company ID>

Clear the list of faults for a Company ID without requesting a response.

  • Company ID: Company ID to clear the faults for.

mesh fault-test <Company ID> <Test ID>

Invoke a self-test procedure, and show a list of triggered faults.

  • Company ID: Company ID to perform self-tests for.

  • Test ID: Test to perform.

mesh fault-test-unack <Company ID> <Test ID>

Invoke a self-test procedure without requesting a response.

  • Company ID: Company ID to perform self-tests for.

  • Test ID: Test to perform.

mesh period-get

Get the current Health Server publish period divisor.

mesh period-set <divisor>

Set the current Health Server publish period divisor. When a fault is detected, the Health Server will start publishing is fault status with a reduced interval. The reduced interval is determined by the Health Server publish period divisor: Fault publish period = Publish period / 2divisor.

  • divisor: The new Health Server publish period divisor.

mesh period-set-unack <divisor>

Set the current Health Server publish period divisor. When a fault is detected, the Health Server will start publishing is fault status with a reduced interval. The reduced interval is determined by the Health Server publish period divisor: Fault publish period = Publish period / 2divisor.

  • divisor: The new Health Server publish period divisor.

mesh attention-get

Get the current Health Server attention state.

mesh attention-set <timer>

Enable the Health Server attention state for some time.

  • timer: Duration of the attention state, in seconds (0 to 255)

mesh attention-set-unack <timer>

Enable the Health Server attention state for some time without requesting a response.

  • timer: Duration of the attention state, in seconds (0 to 255)

Health Server model

mesh add-fault <Fault ID>

Register a new Fault for the Linux Foundation Company ID.

  • Fault ID: ID of the fault to register (0x0001 to 0xFFFF)

mesh del-fault [Fault ID]

Remove registered faults for the Linux Foundation Company ID.

  • Fault ID: If present, the given fault ID will be deleted. If omitted, all registered faults will be cleared.

Configuration database

The Configuration database is an optional Mesh subsystem that can be enabled through the CONFIG_BT_MESH_CDB configuration option. The Configuration database is only available on provisioner devices, and allows them to store all information about the mesh network. To avoid conflicts, there should only be one mesh node in the network with the Configuration database enabled. This node is the Configurator, and is responsible for adding new nodes to the network and configuring them.

mesh cdb-create [NetKey]

Create a Configuration database.

  • NetKey: Optional network key value of the primary network key (NetKeyIndex=0). Defaults to the default key value if omitted.

mesh cdb-clear

Clear all data from the Configuration database.

mesh cdb-show

Show all data in the Configuration database.

mesh cdb-node-add <UUID> <addr> <num-elem> <NetKeyIdx> [DevKey]

Manually add a mesh node to the configuration database. Note that devices provisioned with mesh provision and mesh provision-adv will be added automatically if the Configuration Database is enabled and created.

  • UUID: 128-bit hexadecimal UUID of the node. Any omitted bytes will be zero.

  • addr: Unicast address of the node, or 0 to automatically choose the lowest available address.

  • num-elem: Number of elements on the node.

  • NetKeyIdx: The network key the node was provisioned with.

  • DevKey: Optional 128-bit device key value for the device. If omitted, a random value will be generated.

mesh cdb-node-del <addr>

Delete a mesh node from the Configuration database. If possible, the node should be reset with mesh reset before it is deleted from the Configuration database, to avoid unexpected behavior and uncontrolled access to the network.

  • addr Address of the node to delete.

mesh cdb-subnet-add <NeyKeyIdx> [<NetKey>]

Add a network key to the Configuration database. The network key can later be passed to mesh nodes in the network. Note that adding a key to the Configuration database does not automatically add it to the local node’s list of known network keys.

  • NetKeyIdx: Key index of the network key to add.

  • NetKey: Optional 128-bit network key value. Any missing bytes will be zero. If omitted, a random value will be generated.

mesh cdb-subnet-del <NetKeyIdx>

Delete a network key from the Configuration database.

  • NetKeyIdx: Key index of the network key to delete.

mesh cdb-app-key-add <NetKeyIdx> <AppKeyIdx> [<AppKey>]

Add an application key to the Configuration database. The application key can later be passed to mesh nodes in the network. Note that adding a key to the Configuration database does not automatically add it to the local node’s list of known application keys.

  • NetKeyIdx: Network key index the application key is bound to.

  • AppKeyIdx: Key index of the application key to add.

  • AppKey: Optional 128-bit application key value. Any missing bytes will be zero. If omitted, a random value will be generated.

mesh cdb-app-key-del <AppKeyIdx>

Delete an application key from the Configuration database.

  • AppKeyIdx: Key index of the application key to delete.