Lines Matching refs:model

75 This prints a list of the composition data of the node, including a list of its model IDs.
92 All multibyte fields model messages are in little endian, except the opcode.
108 Sending raw mesh packets is a good way to test model message handler implementations during
109 development, as it can be done without having to implement the sending model. By default, only the
110 reception of the model messages can be tested this way, as the Bluetooth Mesh shell only includes
111 the foundation models. To receive a packet in the mesh node, you have to add a model with a valid
494 The Configuration Client model is an optional mesh subsystem that can be enabled through the
497 any instance of the Configuration Client model if the mentioned shell configuration options is
498 enabled, and as long as the Configuration Client model is present in the model composition of the
505 provisioning context initialized, the Configuration Client model targets itself by default.
507 Client model targets the new node. In most common use-cases, the Configuration Client is depending
529 Get the target Configuration server for the Configuration Client model.
544 Get and set the Config Client model timeout used during message sending.
546 …* ``Timeout``: If present, set the Config Client model timeout in seconds. If omitted, the current…
703 ``mesh models cfg model app-bind <Addr> <AppKeyIdx> <MID> [CID]``
706 Bind an application key to a model. Models can only encrypt and decrypt messages sent with
709 * ``Addr``: Address of the element the model is on.
710 * ``AppKeyIdx``: The application key to bind to the model.
711 * ``MID``: The model ID of the model to bind the key to.
712 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
715 ``mesh models cfg model app-unbind <Addr> <AppKeyIdx> <MID> [CID]``
718 Unbind an application key from a model.
720 * ``Addr``: Address of the element the model is on.
721 * ``AppKeyIdx``: The application key to unbind from the model.
722 * ``MID``: The model ID of the model to unbind the key from.
723 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
726 ``mesh models cfg model app-get <ElemAddr> <MID> [CID]``
729 Get a list of application keys bound to a model.
731 * ``ElemAddr``: Address of the element the model is on.
732 * ``MID``: The model ID of the model to get the bound keys of.
733 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
736 ``mesh models cfg model pub <Addr> <MID> [CID] [<PubAddr> <AppKeyIdx> <Cred(off, on)> <TTL> <PerRes…
739 Get or set the publication parameters of a model. If all publication parameters are
740 included, they become the new publication parameters of the model. If all publication
741 parameters are omitted, print the current publication parameters of the model.
743 * ``Addr``: Address of the element the model is on.
744 * ``MID``: The model ID of the model to get the bound keys of.
745 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
763 ``mesh models cfg model pub-va <Addr> <UUID(1-16 hex)> <AppKeyIdx> <Cred(off, on)> <TTL> <PerRes> <…
766 Set the publication parameters of a model.
768 * ``Addr``: Address of the element the model is on.
769 * ``MID``: The model ID of the model to get the bound keys of.
770 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
789 ``mesh models cfg model sub-add <ElemAddr> <SubAddr> <MID> [CID]``
792 Subscription the model to a group address. Models only receive messages sent to their
796 * ``ElemAddr``: Address of the element the model is on.
797 * ``SubAddr``: 16-bit group address the model should subscribe to (``0xc000`` to ``0xFEFF``).
798 * ``MID``: The model ID of the model to add the subscription to.
799 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
802 ``mesh models cfg model sub-del <ElemAddr> <SubAddr> <MID> [CID]``
805 Unsubscribe a model from a group address.
807 * ``ElemAddr``: Address of the element the model is on.
808 …* ``SubAddr``: 16-bit group address the model should remove from its subscription list (``0xc000``…
809 * ``MID``: The model ID of the model to add the subscription to.
810 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
813 ``mesh models cfg model sub-add-va <ElemAddr> <LabelUUID(1-16 hex)> <MID> [CID]``
816 Subscribe the model to a virtual address. Models only receive messages sent to their unicast
820 * ``ElemAddr``: Address of the element the model is on.
822 * ``MID``: The model ID of the model to add the subscription to.
823 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
826 ``mesh models cfg model sub-del-va <ElemAddr> <LabelUUID(1-16 hex)> <MID> [CID]``
829 Unsubscribe a model from a virtual address.
831 * ``ElemAddr``: Address of the element the model is on.
833 * ``MID``: The model ID of the model to add the subscription to.
834 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
836 ``mesh models cfg model sub-ow <ElemAddr> <SubAddr> <MID> [CID]``
839 Overwrite all model subscriptions with a single new group address.
841 * ``ElemAddr``: Address of the element the model is on.
842 …* ``SubAddr``: 16-bit group address the model should added to the subscription list (``0xc000`` to…
843 * ``MID``: The model ID of the model to add the subscription to.
844 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
846 ``mesh models cfg model sub-ow-va <ElemAddr> <LabelUUID(1-16 hex)> <MID> [CID]``
849 Overwrite all model subscriptions with a single new virtual address. Models only receive
853 * ``ElemAddr``: Address of the element the model is on.
855 * ``MID``: The model ID of the model to add the subscription to.
856 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
858 ``mesh models cfg model sub-del-all <ElemAddr> <MID> [CID]``
861 Remove all group and virtual address subscriptions from of a model.
863 * ``ElemAddr``: Address of the element the model is on.
864 * ``MID``: The model ID of the model to Unsubscribe all.
865 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
867 ``mesh models cfg model sub-get <ElemAddr> <MID> [CID]``
870 Get a list of addresses the model subscribes to.
872 * ``ElemAddr``: Address of the element the model is on.
873 * ``MID``: The model ID of the model to get the subscription list of.
874 … If present, determines the Company ID of the model. If omitted, the model is a Bluetooth SIG defi…
938 The Health Client model is an optional mesh subsystem that can be enabled through the
941 any instance of the Health Client model if the mentioned shell configuration options is enabled, and
942 as long as one or more Health Client model(s) is present in the model composition of the
946 By default, the module will choose the first Health Client instance in the model composition when
958 Set the Health Client model instance to use.
960 * ``ElemIdx``: Element index of Health Client model.
965 Prints all available Health Client model instances on the device.
1059 Binary Large Object (BLOB) Transfer Client model
1071 * ``Addr``: Unicast address of the Target node's BLOB Transfer Server model.
1127 Use the BLOB Transfer Client model instance on the specified element when using the other
1128 BLOB Transfer Client model commands.
1130 * ``ElemIdx``: The element on which to find the BLOB Transfer Client model instance to use.
1135 Get a list of all BLOB Transfer Client model instances on the node.
1138 BLOB Transfer Server model
1142 :kconfig:option:`CONFIG_BT_MESH_BLOB_SRV` option. The BLOB Transfer Server model is capable of
1163 Use the BLOB Transfer Server model instance on the specified element when using the other argument
1164 BLOB Transfer Server model commands.
1166 * ``ElemIdx``: The element on which to find the BLOB Transfer Server model instance to use.
1171 Get a list of all BLOB Transfer Server model instances on the node. argument
1195 Firmware Update Client model
1198 The Firmware Update Client model can be added to the mesh shell by enabling configuration options
1280 a Target node address is provided, the Firmware Update Client model will try to cancel the argument
1281 DFU procedure on the provided Target node. Otherwise, the Firmware Update Client model will
1322 Use the Firmware Update Client model instance on the specified element when using the other argument
1323 Firmware Update Client model commands.
1325 * ``ElemIdx``: The element on which to find the Firmware Update Client model instance to use.
1330 Get a list of all Firmware Update Client model instances on the node. argument
1333 Firmware Update Server model
1336 The Firmware Update Server model can be added to the mesh shell by enabling configuration options
1367 Use the Firmware Update Server model instance on the specified element when using the other argument
1368 Firmware Update Server model commands.
1370 * ``ElemIdx``: The element on which to find the Firmware Update Server model instance to use.
1375 Get a list of all Firmware Update Server model instances on the node. argument
1380 Firmware Distribution Server model
1383 The Firmware Distribution Server model commands can be added to the mesh shell by enabling the
1384 :kconfig:option:`CONFIG_BT_MESH_DFD_SRV` configuration option. The shell commands for this model
1385 mirror the messages sent to the server by a Firmware Distribution Client model. To use these
1480 Use the Firmware Distribution Server model instance on the specified element when using the argument
1481 other Firmware Distribution Server model commands.
1483 * ``ElemIdx``: The element on which to find the Firmware Distribution Server model instance to use.
1488 Get a list of all Firmware Distribution Server model instances on the node. argument
1529 * ``VndCID``: Vendor model company identifier.
1530 * ``VndMID``: Vendor model identifier.
1562 The SAR Configuration client is an optional mesh model that can be enabled through the
1564 model is used to support the functionality of configuring the behavior of the lower transport layer
1565 of a node that supports the SAR Configuration Server model.
1606 The Private Beacon Client model is an optional mesh subsystem that can be enabled through the
1670 The Opcodes Aggregator client is an optional Bluetooth Mesh model that can be enabled through the
1672 model is used to support the functionality of dispatching a sequence of access layer messages to
1673 nodes supporting the Opcodes Aggregator Server model.
1700 The Remote Provisioning Client is an optional Bluetooth Mesh model enabled through the
1701 :kconfig:option:`CONFIG_BT_MESH_RPR_CLI` configuration option. The Remote Provisioning Client model
1703 Provisioning Server model.
1777 Use the Remote Provisioning Client model instance on the specified element when using the
1778 other Remote Provisioning Client model commands.
1780 * ``ElemIdx``: The element on which to find the Remote Provisioning Client model instance to use.
1785 Get a list of all Remote Provisioning Client model instances on the node.
1791 The Large Composition Data Client is an optional Bluetooth Mesh model enabled through the
1793 model is used to support the functionality of reading pages of Composition Data that do not fit in
1794 a Config Composition Data Status message, and reading the metadata of the model instances.
1816 The Bridge Configuration Client model is an optional Bluetooth Mesh model that can be enabled throu…
1817 :kconfig:option:`CONFIG_BT_MESH_BRG_CFG_CLI` configuration option. The model provides functionality
1983 The On-Demand Private GATT Proxy Client model is an optional mesh subsystem that can be enabled
1998 The Solicitation PDU RPL Client model is an optional mesh subsystem that can be enabled through the