Bluetooth: Mesh: Shell: Align commands
Aligns subnet bridge related commands according to conventions used for rest of the shell commands. Also updates documentations to reflect the change. Signed-off-by: Omkar Kulkarni <omkar.kulkarni@nordicsemi.no>
This commit is contained in:
parent
ae256e1f6c
commit
95fff388ba
2 changed files with 21 additions and 21 deletions
|
@ -1795,25 +1795,25 @@ The Bridge Configuration Client model is an optional Bluetooth Mesh model that c
|
|||
:kconfig:option:`CONFIG_BT_MESH_BRG_CFG_CLI` configuration option. The model provides functionality
|
||||
for configuring the subnet bridge functionality of a mesh node.
|
||||
|
||||
``mesh models brg_cfg bridge-get``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
``mesh models brg get``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Get the current Subnet Bridge state.
|
||||
|
||||
``mesh models brg_cfg bridge-set <State(disable, enable)>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
``mesh models brg set <State(disable, enable)>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Set the Subnet Bridge state.
|
||||
|
||||
* ``State``: Disable or enable the Subnet Bridge functionality.
|
||||
|
||||
``mesh models brg_cfg table-size-get``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
``mesh models brg table-size-get``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Get the current size of the Bridging Table.
|
||||
|
||||
``mesh models brg_cfg table-add <Directions> <NetIdx1> <NetIdx2> <Addr1> <Addr2>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
``mesh models brg table-add <Directions> <NetIdx1> <NetIdx2> <Addr1> <Addr2>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Add an entry to the Bridging Table.
|
||||
|
||||
|
@ -1827,8 +1827,8 @@ for configuring the subnet bridge functionality of a mesh node.
|
|||
* ``Addr1``: Address of the node in the first subnet.
|
||||
* ``Addr2``: Address of the node in the second subnet.
|
||||
|
||||
``mesh models brg_cfg table-remove <NetIdx1> <NetIdx2> <Addr1> <Addr2>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
``mesh models brg table-remove <NetIdx1> <NetIdx2> <Addr1> <Addr2>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Remove an entry from the Bridging Table.
|
||||
|
||||
|
@ -1837,8 +1837,8 @@ for configuring the subnet bridge functionality of a mesh node.
|
|||
* ``Addr1``: Address of the node in the first subnet.
|
||||
* ``Addr2``: Address of the node in the second subnet.
|
||||
|
||||
``mesh models brg_cfg subnets-get <Filter> <NetIdx> <StartIdx>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
``mesh models brg subnets-get <Filter> <NetIdx> <StartIdx>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Get a filtered set of NetKey index pairs extracted from the Bridging Table.
|
||||
|
||||
|
@ -1852,8 +1852,8 @@ for configuring the subnet bridge functionality of a mesh node.
|
|||
* ``NetIdx``: NetKey index of any of the subnets.
|
||||
* ``StartIdx``: Start offset in units of pairs of NetKey indexes to read.
|
||||
|
||||
``mesh models brg_cfg table-get <NetIdx1> <NetIdx2> <StartIdx>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
``mesh models brg table-get <NetIdx1> <NetIdx2> <StartIdx>``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Get a list of addresses and allowed traffic directions of the Bridging Table entries.
|
||||
|
||||
|
|
|
@ -231,16 +231,16 @@ static int cmd_bridging_table_get(const struct shell *sh, size_t argc, char *arg
|
|||
}
|
||||
|
||||
SHELL_STATIC_SUBCMD_SET_CREATE(
|
||||
brg_cfg_cmds, SHELL_CMD_ARG(bridge - get, NULL, NULL, cmd_subnet_bridge_get, 1, 0),
|
||||
SHELL_CMD_ARG(bridge - set, NULL, "<State(disable, enable)>", cmd_subnet_bridge_set, 2, 0),
|
||||
SHELL_CMD_ARG(table - size - get, NULL, NULL, cmd_bridging_table_size_get, 1, 0),
|
||||
SHELL_CMD_ARG(table - add, NULL, "<Directions> <NetIdx1> <NetIdx2> <Addr1> <Addr2>",
|
||||
brg_cfg_cmds, SHELL_CMD_ARG(get, NULL, NULL, cmd_subnet_bridge_get, 1, 0),
|
||||
SHELL_CMD_ARG(set, NULL, "<State(disable, enable)>", cmd_subnet_bridge_set, 2, 0),
|
||||
SHELL_CMD_ARG(table-size-get, NULL, NULL, cmd_bridging_table_size_get, 1, 0),
|
||||
SHELL_CMD_ARG(table-add, NULL, "<Directions> <NetIdx1> <NetIdx2> <Addr1> <Addr2>",
|
||||
cmd_bridging_table_add, 6, 0),
|
||||
SHELL_CMD_ARG(table - remove, NULL, "<NetIdx1> <NetIdx2> <Addr1> <Addr2>",
|
||||
SHELL_CMD_ARG(table-remove, NULL, "<NetIdx1> <NetIdx2> <Addr1> <Addr2>",
|
||||
cmd_bridging_table_remove, 5, 0),
|
||||
SHELL_CMD_ARG(subnets - get, NULL, "<Filter> <NetIdx> <StartIdx>", cmd_bridged_subnets_get,
|
||||
SHELL_CMD_ARG(subnets-get, NULL, "<Filter> <NetIdx> <StartIdx>", cmd_bridged_subnets_get,
|
||||
4, 0),
|
||||
SHELL_CMD_ARG(table - get, NULL, "<NetIdx1> <NetIdx2> <StartIdx>", cmd_bridging_table_get,
|
||||
SHELL_CMD_ARG(table-get, NULL, "<NetIdx1> <NetIdx2> <StartIdx>", cmd_bridging_table_get,
|
||||
4, 0),
|
||||
SHELL_SUBCMD_SET_END);
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue