Bluetooth: Mesh: Shell: Align parameter docs

Aligns Bluetooth mesh shell parameter documentation to use the
same syntax, abbrevations and formating.

Signed-off-by: Anders Storrø <anders.storro@nordicsemi.no>
This commit is contained in:
Anders Storrø 2023-03-30 10:33:08 +02:00 committed by Carles Cufí
commit fc49ad3ac6
15 changed files with 609 additions and 587 deletions

File diff suppressed because it is too large Load diff

View file

@ -569,13 +569,13 @@ BT_MESH_SHELL_MDL_INSTANCE_CMDS(srv_instance_cmds, BT_MESH_MODEL_ID_BLOB_SRV, mo
SHELL_STATIC_SUBCMD_SET_CREATE(
blob_cli_cmds,
/* BLOB Client Model Operations */
SHELL_CMD_ARG(target, NULL, "<addr>", cmd_target, 2, 0),
SHELL_CMD_ARG(caps, NULL, "[<group> [<timeout base>]]", cmd_caps, 1, 2),
SHELL_CMD_ARG(tx, NULL, "<id> <size> <block size log> "
"<chunk size> [<group> [<mode: push, pull> "
"[<timeout base>]]]", cmd_tx, 5, 3),
SHELL_CMD_ARG(target, NULL, "<Addr>", cmd_target, 2, 0),
SHELL_CMD_ARG(caps, NULL, "[<Group> [<TimeoutBase>]]", cmd_caps, 1, 2),
SHELL_CMD_ARG(tx, NULL, "<ID> <Size> <BlockSizeLog> "
"<ChunkSize> [<Group> [<Mode(push, pull)> "
"[<TimeoutBase>]]]", cmd_tx, 5, 3),
SHELL_CMD_ARG(tx-cancel, NULL, NULL, cmd_tx_cancel, 1, 0),
SHELL_CMD_ARG(tx-get, NULL, "[group]", cmd_tx_get, 1, 1),
SHELL_CMD_ARG(tx-get, NULL, "[Group]", cmd_tx_get, 1, 1),
SHELL_CMD_ARG(tx-suspend, NULL, NULL, cmd_tx_suspend, 1, 0),
SHELL_CMD_ARG(tx-resume, NULL, NULL, cmd_tx_resume, 1, 0),
SHELL_CMD(instance, &cli_instance_cmds, "Instance commands", bt_mesh_shell_mdl_cmds_help),
@ -586,7 +586,7 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
SHELL_STATIC_SUBCMD_SET_CREATE(
blob_srv_cmds,
/* BLOB Server Model Operations */
SHELL_CMD_ARG(rx, NULL, "<id> [<timeout base>]", cmd_rx, 2, 1),
SHELL_CMD_ARG(rx, NULL, "<ID> [<TimeoutBase(10s steps)>]", cmd_rx, 2, 1),
SHELL_CMD_ARG(rx-cancel, NULL, NULL, cmd_rx_cancel, 1, 0),
SHELL_CMD(instance, &srv_instance_cmds, "Instance commands", bt_mesh_shell_mdl_cmds_help),
SHELL_SUBCMD_SET_END);
@ -595,7 +595,7 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
SHELL_STATIC_SUBCMD_SET_CREATE(
blob_cmds,
#if defined(CONFIG_BT_MESH_SHELL_BLOB_IO_FLASH)
SHELL_CMD_ARG(flash-stream-set, NULL, "<area id> [<offset>]",
SHELL_CMD_ARG(flash-stream-set, NULL, "<AreaID> [<Offset>]",
cmd_flash_stream_set, 2, 1),
SHELL_CMD_ARG(flash-stream-unset, NULL, NULL, cmd_flash_stream_unset, 1, 0),
#endif

View file

@ -1763,54 +1763,54 @@ static int cmd_hb_pub(const struct shell *sh, size_t argc, char *argv[])
}
SHELL_STATIC_SUBCMD_SET_CREATE(model_cmds,
SHELL_CMD_ARG(app-bind, NULL, "<Addr> <AppIndex> <Model ID> [Company ID]",
SHELL_CMD_ARG(app-bind, NULL, "<Addr> <AppKeyIdx> <MID> [CID]",
cmd_mod_app_bind, 4, 1),
SHELL_CMD_ARG(app-get, NULL, "<Elem addr> <Model ID> [Company ID]", cmd_mod_app_get,
SHELL_CMD_ARG(app-get, NULL, "<ElemAddr> <MID> [CID]", cmd_mod_app_get,
3, 1),
SHELL_CMD_ARG(app-unbind, NULL, "<Addr> <AppIndex> <Model ID> [Company ID]",
SHELL_CMD_ARG(app-unbind, NULL, "<Addr> <AppKeyIdx> <MID> [CID]",
cmd_mod_app_unbind, 4, 1),
SHELL_CMD_ARG(pub, NULL,
"<Addr> <Model ID> [Company ID] [<PubAddr> "
"<AppKeyIndex> <Cred: off, on> <TTL> <PeriodRes> <PeriodSteps> <Count> "
"<Interval>]",
"<Addr> <MID> [CID] [<PubAddr> "
"<AppKeyIdx> <Cred(off, on)> <TTL> <PerRes> <PerSteps> <Count> "
"<Int(ms)>]",
cmd_mod_pub, 3, 1 + 8),
SHELL_CMD_ARG(pub-va, NULL,
"<Addr> <UUID: 16 hex values> "
"<AppKeyIndex> <Cred: off, on> <TTL> <PeriodRes> <PeriodSteps> <Count> "
"<Interval> <Model ID> [Company ID]",
"<Addr> <UUID(1-16 hex)> "
"<AppKeyIdx> <Cred(off, on)> <TTL> <PerRes> <PerSteps> <Count> "
"<Int(ms)> <MID> [CID]",
cmd_mod_pub_va, 11, 1),
SHELL_CMD_ARG(sub-add, NULL, "<Elem addr> <Sub addr> <Model ID> [Company ID]",
SHELL_CMD_ARG(sub-add, NULL, "<ElemAddr> <SubAddr> <MID> [CID]",
cmd_mod_sub_add, 4, 1),
SHELL_CMD_ARG(sub-del, NULL, "<Elem addr> <Sub addr> <Model ID> [Company ID]",
SHELL_CMD_ARG(sub-del, NULL, "<ElemAddr> <SubAddr> <MID> [CID]",
cmd_mod_sub_del, 4, 1),
SHELL_CMD_ARG(sub-add-va, NULL,
"<Elem addr> <Label UUID> <Model ID> [Company ID]", cmd_mod_sub_add_va, 4, 1),
"<ElemAddr> <LabelUUID(1-16 hex)> <MID> [CID]", cmd_mod_sub_add_va, 4, 1),
SHELL_CMD_ARG(sub-del-va, NULL,
"<Elem addr> <Label UUID> <Model ID> [Company ID]", cmd_mod_sub_del_va, 4, 1),
SHELL_CMD_ARG(sub-ow, NULL, "<Elem addr> <Sub addr> <Model ID> [Company ID]",
"<ElemAddr> <LabelUUID(1-16 hex)> <MID> [CID]", cmd_mod_sub_del_va, 4, 1),
SHELL_CMD_ARG(sub-ow, NULL, "<ElemAddr> <SubAddr> <MID> [CID]",
cmd_mod_sub_ow, 4, 1),
SHELL_CMD_ARG(sub-ow-va, NULL, "<Elem addr> <Label UUID> <Model ID> [Company ID]",
SHELL_CMD_ARG(sub-ow-va, NULL, "<ElemAddr> <LabelUUID(1-16 hex)> <MID> [CID]",
cmd_mod_sub_ow_va, 4, 1),
SHELL_CMD_ARG(sub-del-all, NULL, "<Elem addr> <Model ID> [Company ID]",
SHELL_CMD_ARG(sub-del-all, NULL, "<ElemAddr> <MID> [CID]",
cmd_mod_sub_del_all, 3, 1),
SHELL_CMD_ARG(sub-get, NULL, "<Elem addr> <Model ID> [Company ID]", cmd_mod_sub_get,
SHELL_CMD_ARG(sub-get, NULL, "<ElemAddr> <MID> [CID]", cmd_mod_sub_get,
3, 1),
SHELL_SUBCMD_SET_END);
SHELL_STATIC_SUBCMD_SET_CREATE(netkey_cmds,
SHELL_CMD_ARG(add, NULL, "<NetKeyIndex> [Val]", cmd_net_key_add, 2, 1),
SHELL_CMD_ARG(upd, NULL, "<NetKeyIndex> [Val]", cmd_net_key_update, 2, 1),
SHELL_CMD_ARG(add, NULL, "<NetKeyIdx> [Key(1-16 hex)]", cmd_net_key_add, 2, 1),
SHELL_CMD_ARG(upd, NULL, "<NetKeyIdx> [Key(1-16 hex)]", cmd_net_key_update, 2, 1),
SHELL_CMD_ARG(get, NULL, NULL, cmd_net_key_get, 1, 0),
SHELL_CMD_ARG(del, NULL, "<NetKeyIndex>", cmd_net_key_del, 2, 0),
SHELL_CMD_ARG(del, NULL, "<NetKeyIdx>", cmd_net_key_del, 2, 0),
SHELL_SUBCMD_SET_END);
SHELL_STATIC_SUBCMD_SET_CREATE(appkey_cmds,
SHELL_CMD_ARG(add, NULL, "<NetKeyIndex> <AppKeyIndex> [Val]", cmd_app_key_add,
SHELL_CMD_ARG(add, NULL, "<NetKeyIdx> <AppKeyIdx> [Key(1-16 hex)]", cmd_app_key_add,
3, 1),
SHELL_CMD_ARG(upd, NULL, "<NetKeyIndex> <AppKeyIndex> [Val]", cmd_app_key_upd,
SHELL_CMD_ARG(upd, NULL, "<NetKeyIdx> <AppKeyIdx> [Key(1-16 hex)]", cmd_app_key_upd,
3, 1),
SHELL_CMD_ARG(del, NULL, "<NetKeyIndex> <AppKeyIndex>", cmd_app_key_del, 3, 0),
SHELL_CMD_ARG(get, NULL, "<NetKeyIndex>", cmd_app_key_get, 2, 0),
SHELL_CMD_ARG(del, NULL, "<NetKeyIdx> <AppKeyIdx>", cmd_app_key_del, 3, 0),
SHELL_CMD_ARG(get, NULL, "<NetKeyIdx>", cmd_app_key_get, 2, 0),
SHELL_SUBCMD_SET_END);
@ -1818,23 +1818,21 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
cfg_cli_cmds,
/* Configuration Client Model operations */
SHELL_CMD_ARG(reset, NULL, NULL, cmd_reset, 1, 0),
SHELL_CMD_ARG(timeout, NULL, "[Timeout in seconds]", cmd_timeout, 1, 1),
SHELL_CMD_ARG(timeout, NULL, "[Timeout(s)]", cmd_timeout, 1, 1),
SHELL_CMD_ARG(get-comp, NULL, "[Page]", cmd_get_comp, 1, 1),
SHELL_CMD_ARG(beacon, NULL, "[Val: off, on]", cmd_beacon, 1, 1),
SHELL_CMD_ARG(ttl, NULL, "[TTL: 0x00, 0x02-0x7f]", cmd_ttl, 1, 1),
SHELL_CMD_ARG(friend, NULL, "[Val: off, on]", cmd_friend, 1, 1),
SHELL_CMD_ARG(gatt-proxy, NULL, "[Val: off, on]", cmd_gatt_proxy, 1, 1),
SHELL_CMD_ARG(relay, NULL, "[<Val: off, on> [<Count: 0-7> [Interval: 10-320]]]", cmd_relay,
SHELL_CMD_ARG(beacon, NULL, "[Val(off, on)]", cmd_beacon, 1, 1),
SHELL_CMD_ARG(ttl, NULL, "[TTL]", cmd_ttl, 1, 1),
SHELL_CMD_ARG(friend, NULL, "[Val(off, on)]", cmd_friend, 1, 1),
SHELL_CMD_ARG(gatt-proxy, NULL, "[Val(off, on)]", cmd_gatt_proxy, 1, 1),
SHELL_CMD_ARG(relay, NULL, "[<Val(off, on)> [<Count> [Int(ms)]]]", cmd_relay,
1, 3),
SHELL_CMD_ARG(node-id, NULL, "<NetKeyIndex> [Identify]", cmd_node_id, 2, 1),
SHELL_CMD_ARG(polltimeout-get, NULL, "<LPN Address>", cmd_polltimeout_get, 2, 0),
SHELL_CMD_ARG(net-transmit-param, NULL,
"[<Count: 0-7>"
" <Interval: 10-320>]",
SHELL_CMD_ARG(node-id, NULL, "<NetKeyIdx> [Identify]", cmd_node_id, 2, 1),
SHELL_CMD_ARG(polltimeout-get, NULL, "<LPNAddr>", cmd_polltimeout_get, 2, 0),
SHELL_CMD_ARG(net-transmit-param, NULL, "[<Count> <Int(ms)>]",
cmd_net_transmit, 1, 2),
SHELL_CMD_ARG(krp, NULL, "<NetKeyIndex> [Phase]", cmd_krp, 2, 1),
SHELL_CMD_ARG(hb-sub, NULL, "[<Src> <Dst> <Period>]", cmd_hb_sub, 1, 3),
SHELL_CMD_ARG(hb-pub, NULL, "[<Dst> <Count> <Period> <TTL> <Features> <NetKeyIndex>]",
SHELL_CMD_ARG(krp, NULL, "<NetKeyIdx> [Phase]", cmd_krp, 2, 1),
SHELL_CMD_ARG(hb-sub, NULL, "[<Src> <Dst> <Per>]", cmd_hb_sub, 1, 3),
SHELL_CMD_ARG(hb-pub, NULL, "[<Dst> <Count> <Per> <TTL> <Features> <NetKeyIdx>]",
cmd_hb_pub, 1, 6),
SHELL_CMD(appkey, &appkey_cmds, "Appkey config commands", bt_mesh_shell_mdl_cmds_help),
SHELL_CMD(netkey, &netkey_cmds, "Netkey config commands", bt_mesh_shell_mdl_cmds_help),

View file

@ -412,22 +412,22 @@ BT_MESH_SHELL_MDL_INSTANCE_CMDS(instance_cmds, BT_MESH_MODEL_ID_DFD_SRV, mod);
SHELL_STATIC_SUBCMD_SET_CREATE(
dfd_cmds,
SHELL_CMD_ARG(receivers-add, NULL, "<addr>,<fw_idx>[;<addr>,<fw_idx>]...",
SHELL_CMD_ARG(receivers-add, NULL, "<Addr>,<FwIdx>[;<Addr>,<FwIdx>]...",
cmd_dfd_receivers_add, 2, 0),
SHELL_CMD_ARG(receivers-delete-all, NULL, NULL, cmd_dfd_receivers_delete_all, 1, 0),
SHELL_CMD_ARG(receivers-get, NULL, "<first> <count>", cmd_dfd_receivers_get, 3, 0),
SHELL_CMD_ARG(receivers-get, NULL, "<First> <Count>", cmd_dfd_receivers_get, 3, 0),
SHELL_CMD_ARG(capabilities-get, NULL, NULL, cmd_dfd_capabilities_get, 1, 0),
SHELL_CMD_ARG(get, NULL, NULL, cmd_dfd_get, 1, 0),
SHELL_CMD_ARG(start, NULL,
"<app_idx> <slot_idx> [<group> [<policy_apply> [<ttl> "
"[<timeout_base> [<xfer_mode>]]]]]",
"<AppKeyIdx> <SlotIdx> [<Group> [<PolicyApply> [<TTL> "
"[<TimeoutBase> [<XferMode>]]]]]",
cmd_dfd_start, 3, 5),
SHELL_CMD_ARG(suspend, NULL, NULL, cmd_dfd_suspend, 1, 0),
SHELL_CMD_ARG(cancel, NULL, NULL, cmd_dfd_cancel, 1, 0),
SHELL_CMD_ARG(apply, NULL, NULL, cmd_dfd_apply, 1, 0),
SHELL_CMD_ARG(fw-get, NULL, "<fwid>", cmd_dfd_fw_get, 2, 0),
SHELL_CMD_ARG(fw-get-by-idx, NULL, "<idx>", cmd_dfd_fw_get_by_idx, 2, 0),
SHELL_CMD_ARG(fw-delete, NULL, "<fwid>", cmd_dfd_fw_delete, 2, 0),
SHELL_CMD_ARG(fw-get, NULL, "<FwID>", cmd_dfd_fw_get, 2, 0),
SHELL_CMD_ARG(fw-get-by-idx, NULL, "<Idx>", cmd_dfd_fw_get_by_idx, 2, 0),
SHELL_CMD_ARG(fw-delete, NULL, "<FwID>", cmd_dfd_fw_delete, 2, 0),
SHELL_CMD_ARG(fw-delete-all, NULL, NULL, cmd_dfd_fw_delete_all, 1, 0),
SHELL_CMD(instance, &instance_cmds, "Instance commands", bt_mesh_shell_mdl_cmds_help),
SHELL_SUBCMD_SET_END);

View file

@ -954,14 +954,14 @@ BT_MESH_SHELL_MDL_INSTANCE_CMDS(srv_instance_cmds, BT_MESH_MODEL_ID_DFU_SRV, mod
SHELL_STATIC_SUBCMD_SET_CREATE(
dfu_metadata_cmds,
SHELL_CMD_ARG(comp-clear, NULL, NULL, cmd_dfu_comp_clear, 1, 0),
SHELL_CMD_ARG(comp-add, NULL, "<cid> <pid> <vid> <crpl> <features>",
SHELL_CMD_ARG(comp-add, NULL, "<CID> <ProductID> <VendorID> <Crpl> <Features>",
cmd_dfu_comp_add, 6, 0),
SHELL_CMD_ARG(comp-elem-add, NULL, "<loc> <nums> <numv> "
"{<sig model id>|<vnd company id> <vnd model id>}...",
SHELL_CMD_ARG(comp-elem-add, NULL, "<Loc> <NumS> <NumV> "
"{<SigMID>|<VndCID> <VndMID>}...",
cmd_dfu_comp_elem_add, 5, 10),
SHELL_CMD_ARG(comp-hash-get, NULL, "[<128-bit key>]", cmd_dfu_comp_hash_get, 1, 1),
SHELL_CMD_ARG(metadata-encode, NULL, "<major> <minor> <rev> <build_num> <size> "
"<core type> <hash> <elems> [<user data>]",
SHELL_CMD_ARG(comp-hash-get, NULL, "[<Key>]", cmd_dfu_comp_hash_get, 1, 1),
SHELL_CMD_ARG(metadata-encode, NULL, "<Major> <Minor> <Rev> <BuildNum> <Size> "
"<CoreType> <Hash> <Elems> [<UserData>]",
cmd_dfu_metadata_encode, 9, 1),
SHELL_SUBCMD_SET_END);
#endif
@ -970,11 +970,11 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
SHELL_STATIC_SUBCMD_SET_CREATE(
dfu_slot_cmds,
SHELL_CMD_ARG(add, NULL,
"<size> [<fwid> [<metadata> [<uri>]]]",
"<Size> [<FwID> [<Metadata> [<URI>]]]",
cmd_dfu_slot_add, 2, 3),
SHELL_CMD_ARG(del, NULL, "<slot idx>", cmd_dfu_slot_del, 2, 0),
SHELL_CMD_ARG(del, NULL, "<SlotIdx>", cmd_dfu_slot_del, 2, 0),
SHELL_CMD_ARG(del-all, NULL, NULL, cmd_dfu_slot_del_all, 1, 0),
SHELL_CMD_ARG(get, NULL, "<slot idx>", cmd_dfu_slot_get, 2, 0),
SHELL_CMD_ARG(get, NULL, "<SlotIdx>", cmd_dfu_slot_get, 2, 0),
SHELL_SUBCMD_SET_END);
#endif
@ -982,17 +982,17 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
SHELL_STATIC_SUBCMD_SET_CREATE(
dfu_cli_cmds,
/* DFU Client Model Operations */
SHELL_CMD_ARG(target, NULL, "<addr> <img idx>", cmd_dfu_target, 3,
SHELL_CMD_ARG(target, NULL, "<Addr> <ImgIdx>", cmd_dfu_target, 3,
0),
SHELL_CMD_ARG(targets-reset, NULL, NULL, cmd_dfu_targets_reset, 1, 0),
SHELL_CMD_ARG(target-state, NULL, NULL, cmd_dfu_target_state, 1, 0),
SHELL_CMD_ARG(target-imgs, NULL, "[<max count>]",
SHELL_CMD_ARG(target-imgs, NULL, "[<MaxCount>]",
cmd_dfu_target_imgs, 1, 1),
SHELL_CMD_ARG(target-check, NULL, "<slot idx> <target img idx>",
SHELL_CMD_ARG(target-check, NULL, "<SlotIdx> <TargetImgIdx>",
cmd_dfu_target_check, 3, 0),
SHELL_CMD_ARG(send, NULL, "<slot idx> [<group> "
"[<mode: push, pull> [<block size log> <chunk size>]]]", cmd_dfu_send, 2, 4),
SHELL_CMD_ARG(cancel, NULL, "[<addr>]", cmd_dfu_tx_cancel, 1, 1),
SHELL_CMD_ARG(send, NULL, "<SlotIdx> [<Group> "
"[<Mode(push, pull)> [<BlockSizeLog> <ChunkSize>]]]", cmd_dfu_send, 2, 4),
SHELL_CMD_ARG(cancel, NULL, "[<Addr>]", cmd_dfu_tx_cancel, 1, 1),
SHELL_CMD_ARG(apply, NULL, NULL, cmd_dfu_apply, 0, 0),
SHELL_CMD_ARG(confirm, NULL, NULL, cmd_dfu_confirm, 0, 0),
SHELL_CMD_ARG(suspend, NULL, NULL, cmd_dfu_suspend, 0, 0),

View file

@ -322,18 +322,18 @@ BT_MESH_SHELL_MDL_INSTANCE_CMDS(instance_cmds, BT_MESH_MODEL_ID_HEALTH_CLI, mod)
SHELL_STATIC_SUBCMD_SET_CREATE(
health_cli_cmds,
/* Health Client Model Operations */
SHELL_CMD_ARG(fault-get, NULL, "<Company ID>", cmd_fault_get, 2, 0),
SHELL_CMD_ARG(fault-clear, NULL, "<Company ID>", cmd_fault_clear, 2, 0),
SHELL_CMD_ARG(fault-clear-unack, NULL, "<Company ID>", cmd_fault_clear_unack, 2, 0),
SHELL_CMD_ARG(fault-test, NULL, "<Company ID> <Test ID>", cmd_fault_test, 3, 0),
SHELL_CMD_ARG(fault-test-unack, NULL, "<Company ID> <Test ID>", cmd_fault_test_unack, 3,
SHELL_CMD_ARG(fault-get, NULL, "<CID>", cmd_fault_get, 2, 0),
SHELL_CMD_ARG(fault-clear, NULL, "<CID>", cmd_fault_clear, 2, 0),
SHELL_CMD_ARG(fault-clear-unack, NULL, "<CID>", cmd_fault_clear_unack, 2, 0),
SHELL_CMD_ARG(fault-test, NULL, "<CID> <TestID>", cmd_fault_test, 3, 0),
SHELL_CMD_ARG(fault-test-unack, NULL, "<CID> <TestID>", cmd_fault_test_unack, 3,
0),
SHELL_CMD_ARG(period-get, NULL, NULL, cmd_period_get, 1, 0),
SHELL_CMD_ARG(period-set, NULL, "<divisor>", cmd_period_set, 2, 0),
SHELL_CMD_ARG(period-set-unack, NULL, "<divisor>", cmd_period_set_unack, 2, 0),
SHELL_CMD_ARG(period-set, NULL, "<Divisor>", cmd_period_set, 2, 0),
SHELL_CMD_ARG(period-set-unack, NULL, "<Divisor>", cmd_period_set_unack, 2, 0),
SHELL_CMD_ARG(attention-get, NULL, NULL, cmd_attention_get, 1, 0),
SHELL_CMD_ARG(attention-set, NULL, "<timer>", cmd_attention_set, 2, 0),
SHELL_CMD_ARG(attention-set-unack, NULL, "<timer>", cmd_attention_set_unack, 2, 0),
SHELL_CMD_ARG(attention-set, NULL, "<Time(s)>", cmd_attention_set, 2, 0),
SHELL_CMD_ARG(attention-set-unack, NULL, "<Time(s)>", cmd_attention_set_unack, 2, 0),
SHELL_CMD(instance, &instance_cmds, "Instance commands", bt_mesh_shell_mdl_cmds_help),
SHELL_SUBCMD_SET_END);

View file

@ -46,7 +46,7 @@ static int cmd_od_priv_gatt_proxy_set(const struct shell *sh, size_t argc,
SHELL_STATIC_SUBCMD_SET_CREATE(
od_priv_proxy_cmds,
SHELL_CMD_ARG(gatt-proxy, NULL, "[duration]", cmd_od_priv_gatt_proxy_set, 1, 1),
SHELL_CMD_ARG(gatt-proxy, NULL, "[Dur(s)]", cmd_od_priv_gatt_proxy_set, 1, 1),
SHELL_SUBCMD_SET_END);
SHELL_SUBCMD_ADD((mesh, models), od_priv_proxy, &od_priv_proxy_cmds,

View file

@ -56,7 +56,7 @@ static int cmd_seq_abort(const struct shell *sh, size_t argc, char *argv[])
SHELL_STATIC_SUBCMD_SET_CREATE(
op_agg_cmds,
SHELL_CMD_ARG(seq-start, NULL, "<elem_addr>", cmd_seq_start, 2, 0),
SHELL_CMD_ARG(seq-start, NULL, "<ElemAddr>", cmd_seq_start, 2, 0),
SHELL_CMD_ARG(seq-send, NULL, NULL, cmd_seq_send, 1, 0),
SHELL_CMD_ARG(seq-abort, NULL, NULL, cmd_seq_abort, 1, 0),
SHELL_SUBCMD_SET_END);

View file

@ -142,11 +142,14 @@ static int cmd_priv_node_id_set(const struct shell *sh, size_t argc, char *argv[
SHELL_STATIC_SUBCMD_SET_CREATE(
priv_beacons_cmds,
SHELL_CMD_ARG(priv-beacon-get, NULL, NULL, cmd_priv_beacon_get, 1, 0),
SHELL_CMD_ARG(priv-beacon-set, NULL, "<enable> <rand_interval>", cmd_priv_beacon_set, 3, 0),
SHELL_CMD_ARG(priv-beacon-set, NULL, "<Val(off, on)> <RandInt(10s steps)>",
cmd_priv_beacon_set, 3, 0),
SHELL_CMD_ARG(priv-gatt-proxy-get, NULL, NULL, cmd_priv_gatt_proxy_get, 1, 0),
SHELL_CMD_ARG(priv-gatt-proxy-set, NULL, "<state>", cmd_priv_gatt_proxy_set, 2, 0),
SHELL_CMD_ARG(priv-node-id-get, NULL, "<net_idx>", cmd_priv_node_id_get, 2, 0),
SHELL_CMD_ARG(priv-node-id-set, NULL, "<net_idx> <state>", cmd_priv_node_id_set, 3, 0),
SHELL_CMD_ARG(priv-gatt-proxy-set, NULL, "Val(off, on)> ", cmd_priv_gatt_proxy_set,
2, 0),
SHELL_CMD_ARG(priv-node-id-get, NULL, "<NetKeyIdx>", cmd_priv_node_id_get, 2, 0),
SHELL_CMD_ARG(priv-node-id-set, NULL, "<NetKeyIdx> <State>", cmd_priv_node_id_set, 3,
0),
SHELL_SUBCMD_SET_END);
SHELL_SUBCMD_ADD((mesh, models), prb, &priv_beacons_cmds, "Private Beacon Cli commands",

View file

@ -392,19 +392,19 @@ BT_MESH_SHELL_MDL_INSTANCE_CMDS(instance_cmds, BT_MESH_MODEL_ID_REMOTE_PROV_CLI,
SHELL_STATIC_SUBCMD_SET_CREATE(
rpr_cli_cmds,
SHELL_CMD_ARG(scan, NULL, "<timeout in seconds> [<UUID>]", cmd_scan, 2, 1),
SHELL_CMD_ARG(scan-ext, NULL, "<timeout in seconds> <UUID> [<AD-type> ... ]",
SHELL_CMD_ARG(scan, NULL, "<Timeout(s)> [<UUID(1-16 hex)>]", cmd_scan, 2, 1),
SHELL_CMD_ARG(scan-ext, NULL, "<Timeout(s)> <UUID(1-16 hex)> [<ADType> ... ]",
cmd_scan_ext, 3, CONFIG_BT_MESH_RPR_AD_TYPES_MAX),
SHELL_CMD_ARG(scan-srv, NULL, "[<AD-type> ... ]", cmd_scan_srv, 1,
SHELL_CMD_ARG(scan-srv, NULL, "[<ADType> ... ]", cmd_scan_srv, 1,
CONFIG_BT_MESH_RPR_AD_TYPES_MAX),
SHELL_CMD_ARG(scan-caps, NULL, NULL, cmd_scan_caps, 1, 0),
SHELL_CMD_ARG(scan-get, NULL, NULL, cmd_scan_get, 1, 0),
SHELL_CMD_ARG(scan-stop, NULL, NULL, cmd_scan_stop, 1, 0),
SHELL_CMD_ARG(link-get, NULL, NULL, cmd_link_get, 1, 0),
SHELL_CMD_ARG(link-close, NULL, NULL, cmd_link_close, 1, 0),
SHELL_CMD_ARG(provision-remote, NULL, "<UUID> <NetKeyIndex> <addr>",
SHELL_CMD_ARG(provision-remote, NULL, "<UUID(1-16 hex)> <NetKeyIdx> <Addr>",
cmd_provision_remote, 4, 0),
SHELL_CMD_ARG(reprovision-remote, NULL, "<addr> [<comp changed: false, true>]",
SHELL_CMD_ARG(reprovision-remote, NULL, "<Addr> [<CompChanged(false, true)>]",
cmd_reprovision_remote, 2, 1),
SHELL_CMD(instance, &instance_cmds, "Instance commands", bt_mesh_shell_mdl_cmds_help),
SHELL_SUBCMD_SET_END);

View file

@ -118,11 +118,17 @@ static int cmd_rx_set(const struct shell *sh, size_t argc, char *argv[])
}
SHELL_STATIC_SUBCMD_SET_CREATE(
sar_cfg_cli_cmds,
SHELL_CMD_ARG(tx-get, NULL, NULL, cmd_tx_get, 1, 0),
SHELL_CMD_ARG(tx-set, NULL, "<7 transmitter state values>", cmd_tx_set, 8, 0),
sar_cfg_cli_cmds, SHELL_CMD_ARG(tx-get, NULL, NULL, cmd_tx_get, 1, 0),
SHELL_CMD_ARG(tx-set, NULL,
"<SegIntStep> <UniRetransCnt> <UniRetransWithoutProgCnt> "
"<UniRetransIntStep> <UniRetransIntInc> <MultiRetransCnt> "
"<MultiRetransInt>",
cmd_tx_set, 8, 0),
SHELL_CMD_ARG(rx-get, NULL, NULL, cmd_rx_get, 1, 0),
SHELL_CMD_ARG(rx-set, NULL, "<5 receiver state values>", cmd_rx_set, 6, 0),
SHELL_CMD_ARG(rx-set, NULL,
"<SegThresh> <AckDelayInc> <DiscardTimeout> "
"<RxSegIntStep> <AckRetransCount>",
cmd_rx_set, 6, 0),
SHELL_SUBCMD_SET_END);
SHELL_SUBCMD_ADD((mesh, models), sar, &sar_cfg_cli_cmds, "Sar Cfg Cli commands",

View file

@ -1571,22 +1571,22 @@ static int cmd_appidx(const struct shell *sh, size_t argc, char *argv[])
}
#if defined(CONFIG_BT_MESH_SHELL_CDB)
SHELL_STATIC_SUBCMD_SET_CREATE(cdb_cmds,
SHELL_STATIC_SUBCMD_SET_CREATE(
cdb_cmds,
/* Mesh Configuration Database Operations */
SHELL_CMD_ARG(create, NULL, "[NetKey]", cmd_cdb_create, 1, 1),
SHELL_CMD_ARG(create, NULL, "[NetKey(1-16 hex)]", cmd_cdb_create, 1, 1),
SHELL_CMD_ARG(clear, NULL, NULL, cmd_cdb_clear, 1, 0),
SHELL_CMD_ARG(show, NULL, NULL, cmd_cdb_show, 1, 0),
SHELL_CMD_ARG(node-add, NULL, "<UUID> <Addr> <Num-elem> "
"<NetKeyIdx> [DevKey]", cmd_cdb_node_add, 5, 1),
SHELL_CMD_ARG(node-add, NULL,
"<UUID(1-16 hex)> <Addr> <ElemCnt> <NetKeyIdx> [DevKey(1-16 hex)]",
cmd_cdb_node_add, 5, 1),
SHELL_CMD_ARG(node-del, NULL, "<Addr>", cmd_cdb_node_del, 2, 0),
SHELL_CMD_ARG(subnet-add, NULL, "<NeyKeyIdx> [<NetKey>]",
cmd_cdb_subnet_add, 2, 1),
SHELL_CMD_ARG(subnet-del, NULL, "<NetKeyIdx>", cmd_cdb_subnet_del,
2, 0),
SHELL_CMD_ARG(app-key-add, NULL, "<NetKeyIdx> <AppKeyIdx> "
"[<AppKey>]", cmd_cdb_app_key_add, 3, 1),
SHELL_CMD_ARG(app-key-del, NULL, "<AppKeyIdx>", cmd_cdb_app_key_del,
2, 0),
SHELL_CMD_ARG(subnet-add, NULL, "<NetKeyIdx> [<NetKey(1-16 hex)>]", cmd_cdb_subnet_add, 2,
1),
SHELL_CMD_ARG(subnet-del, NULL, "<NetKeyIdx>", cmd_cdb_subnet_del, 2, 0),
SHELL_CMD_ARG(app-key-add, NULL, "<NetKeyIdx> <AppKeyIdx> [<AppKey(1-16 hex)>]",
cmd_cdb_app_key_add, 3, 1),
SHELL_CMD_ARG(app-key-del, NULL, "<AppKeyIdx>", cmd_cdb_app_key_del, 2, 0),
SHELL_SUBCMD_SET_END);
#endif
@ -1597,7 +1597,7 @@ SHELL_STATIC_SUBCMD_SET_CREATE(auth_cmds,
cmd_auth_method_set_input, 3, 0),
SHELL_CMD_ARG(output, NULL, "<Action> <Size>",
cmd_auth_method_set_output, 3, 0),
SHELL_CMD_ARG(static, NULL, "<Value>", cmd_auth_method_set_static, 2,
SHELL_CMD_ARG(static, NULL, "<Val(1-16 hex)>", cmd_auth_method_set_static, 2,
0),
SHELL_CMD_ARG(none, NULL, NULL, cmd_auth_method_set_none, 2, 0),
SHELL_SUBCMD_SET_END);
@ -1606,11 +1606,11 @@ SHELL_STATIC_SUBCMD_SET_CREATE(auth_cmds,
SHELL_STATIC_SUBCMD_SET_CREATE(
prov_cmds, SHELL_CMD_ARG(input-num, NULL, "<Number>", cmd_input_num, 2, 0),
SHELL_CMD_ARG(input-str, NULL, "<String>", cmd_input_str, 2, 0),
SHELL_CMD_ARG(local, NULL, "<NetKeyIndex> <Addr> [IVIndex]", cmd_provision_local, 3, 1),
SHELL_CMD_ARG(local, NULL, "<NetKeyIdx> <Addr> [IVI]", cmd_provision_local, 3, 1),
#if defined(CONFIG_BT_MESH_SHELL_PROV_CTX_INSTANCE)
SHELL_CMD_ARG(static-oob, NULL, "[Val: 1-16 hex values]", cmd_static_oob, 2, 1),
SHELL_CMD_ARG(uuid, NULL, "[UUID: 1-16 hex values]", cmd_uuid, 1, 1),
SHELL_CMD_ARG(beacon-listen, NULL, "<Val: off, on>", cmd_beacon_listen, 2, 0),
SHELL_CMD_ARG(static-oob, NULL, "[Val]", cmd_static_oob, 2, 1),
SHELL_CMD_ARG(uuid, NULL, "[UUID(1-16 hex)]", cmd_uuid, 1, 1),
SHELL_CMD_ARG(beacon-listen, NULL, "<Val(off, on)>", cmd_beacon_listen, 2, 0),
#endif
SHELL_CMD_ARG(comp-change, NULL, NULL, cmd_comp_change, 1, 0),
@ -1618,10 +1618,10 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
/* Provisioning operations */
#if defined(CONFIG_BT_MESH_PROV_DEVICE)
#if defined(CONFIG_BT_MESH_PB_GATT)
SHELL_CMD_ARG(pb-gatt, NULL, "<Val: off, on>", cmd_pb_gatt, 2, 0),
SHELL_CMD_ARG(pb-gatt, NULL, "<Val(off, on)>", cmd_pb_gatt, 2, 0),
#endif
#if defined(CONFIG_BT_MESH_PB_ADV)
SHELL_CMD_ARG(pb-adv, NULL, "<Val: off, on>", cmd_pb_adv, 2, 0),
SHELL_CMD_ARG(pb-adv, NULL, "<Val(off, on)>", cmd_pb_adv, 2, 0),
#endif
#endif /* CONFIG_BT_MESH_PROV_DEVICE */
@ -1629,15 +1629,15 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
SHELL_CMD(auth-method, &auth_cmds, "Authentication methods", bt_mesh_shell_mdl_cmds_help),
SHELL_CMD_ARG(remote-pub-key, NULL, "<PubKey>", cmd_remote_pub_key_set, 2, 0),
SHELL_CMD_ARG(remote-adv, NULL,
"<UUID> <NetKeyIndex> <Addr> "
"<AttentionDuration>",
"<UUID(1-16 hex)> <NetKeyIdx> <Addr> "
"<AttDur(s)>",
cmd_provision_adv, 5, 0),
#endif
#if defined(CONFIG_BT_MESH_PB_GATT_CLIENT)
SHELL_CMD_ARG(remote-gatt, NULL,
"<UUID> <NetKeyIndex> <Addr> "
"<AttentionDuration>",
"<UUID(1-16 hex)> <NetKeyIdx> <Addr> "
"<AttDur(s)>",
cmd_provision_gatt, 5, 0),
#endif
SHELL_SUBCMD_SET_END);
@ -1647,18 +1647,18 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
#if defined(CONFIG_BT_MESH_SHELL_HEALTH_SRV_INSTANCE)
SHELL_STATIC_SUBCMD_SET_CREATE(health_srv_cmds,
/* Health Server Model Operations */
SHELL_CMD_ARG(add-fault, NULL, "<Fault ID>", cmd_add_fault, 2, 0),
SHELL_CMD_ARG(del-fault, NULL, "[Fault ID]", cmd_del_fault, 1, 1),
SHELL_CMD_ARG(add-fault, NULL, "<FaultID>", cmd_add_fault, 2, 0),
SHELL_CMD_ARG(del-fault, NULL, "[FaultID]", cmd_del_fault, 1, 1),
SHELL_SUBCMD_SET_END);
#endif
SHELL_STATIC_SUBCMD_SET_CREATE(test_cmds,
/* Commands which access internal APIs, for testing only */
SHELL_CMD_ARG(net-send, NULL, "<Hex string>", cmd_net_send,
SHELL_CMD_ARG(net-send, NULL, "<HexString>", cmd_net_send,
2, 0),
#if defined(CONFIG_BT_MESH_IV_UPDATE_TEST)
SHELL_CMD_ARG(iv-update, NULL, NULL, cmd_iv_update, 1, 0),
SHELL_CMD_ARG(iv-update-test, NULL, "<Val: off, on>", cmd_iv_update_test, 2, 0),
SHELL_CMD_ARG(iv-update-test, NULL, "<Val(off, on)>", cmd_iv_update_test, 2, 0),
#endif
SHELL_CMD_ARG(rpl-clear, NULL, NULL, cmd_rpl_clear, 1, 0),
#if defined(CONFIG_BT_MESH_SHELL_HEALTH_SRV_INSTANCE)
@ -1674,11 +1674,11 @@ SHELL_STATIC_SUBCMD_SET_CREATE(proxy_cmds,
#endif
#if defined(CONFIG_BT_MESH_PROXY_CLIENT)
SHELL_CMD_ARG(connect, NULL, "<NetKeyIndex>", cmd_proxy_connect, 2, 0),
SHELL_CMD_ARG(disconnect, NULL, "<NetKeyIndex>", cmd_proxy_disconnect, 2, 0),
SHELL_CMD_ARG(connect, NULL, "<NetKeyIdx>", cmd_proxy_connect, 2, 0),
SHELL_CMD_ARG(disconnect, NULL, "<NetKeyIdx>", cmd_proxy_disconnect, 2, 0),
#if defined(CONFIG_BT_MESH_PROXY_SOLICITATION)
SHELL_CMD_ARG(solicit, NULL, "<NetKeyIndex>",
SHELL_CMD_ARG(solicit, NULL, "<NetKeyIdx>",
cmd_proxy_solicit, 2, 0),
#endif
#endif
@ -1687,15 +1687,15 @@ SHELL_STATIC_SUBCMD_SET_CREATE(proxy_cmds,
#if defined(CONFIG_BT_MESH_SHELL_LOW_POWER)
SHELL_STATIC_SUBCMD_SET_CREATE(low_pwr_cmds,
SHELL_CMD_ARG(set, NULL, "<Val: off, on>", cmd_lpn, 2, 0),
SHELL_CMD_ARG(set, NULL, "<Val(off, on)>", cmd_lpn, 2, 0),
SHELL_CMD_ARG(poll, NULL, NULL, cmd_poll, 1, 0),
SHELL_SUBCMD_SET_END);
#endif
SHELL_STATIC_SUBCMD_SET_CREATE(target_cmds,
SHELL_CMD_ARG(dst, NULL, "[dst_addr]", cmd_dst, 1, 1),
SHELL_CMD_ARG(net, NULL, "[net_idx]", cmd_netidx, 1, 1),
SHELL_CMD_ARG(app, NULL, "[app_idx]", cmd_appidx, 1, 1),
SHELL_CMD_ARG(dst, NULL, "[DstAddr]", cmd_dst, 1, 1),
SHELL_CMD_ARG(net, NULL, "[NetKeyIdx]", cmd_netidx, 1, 1),
SHELL_CMD_ARG(app, NULL, "[AppKeyIdx]", cmd_appidx, 1, 1),
SHELL_SUBCMD_SET_END);
/* Placeholder for model shell modules that is configured in the application */

View file

@ -61,7 +61,7 @@ static int cmd_srpl_clear(const struct shell *sh, size_t argc,
SHELL_STATIC_SUBCMD_SET_CREATE(
sol_pdu_rpl_cmds,
SHELL_CMD_ARG(clear, NULL, "<range_start> <acked> [range_len]",
SHELL_CMD_ARG(clear, NULL, "<RngStart> <Ackd> [RngLen]",
cmd_srpl_clear, 3, 1),
SHELL_SUBCMD_SET_END);

View file

@ -92,6 +92,11 @@ int bt_mesh_shell_mdl_print_all(const struct shell *sh, uint16_t mod_id)
int bt_mesh_shell_mdl_cmds_help(const struct shell *sh, size_t argc, char **argv)
{
shell_print(
sh,
"\nFor a detailed description of the commands and arguments in this shell module,\n"
"please refer to the Zephyr Project documentation online.\n");
if (argc == 1) {
shell_help(sh);
return 0;

View file

@ -28,7 +28,7 @@
} \
\
SHELL_STATIC_SUBCMD_SET_CREATE(cmd_set_name, \
SHELL_CMD_ARG(set, NULL, "<elem_idx>", cmd_##cmd_set_name##_set, 2,\
SHELL_CMD_ARG(set, NULL, "<ElemIdx>", cmd_##cmd_set_name##_set, 2,\
0), \
SHELL_CMD_ARG(get-all, NULL, NULL, cmd_##cmd_set_name##_get_all, 1,\
0), \