Lines Matching +full:ext +full:- +full:address +full:- +full:match
30 sub-commands. Every time the device boots up, make sure to call ``mesh init`` before any of the
43 The simplest way to provision the device is through self-provisioning. To do this the user must
44 provision the device with the default network key and address ``0x0001``, execute::
49 devices, as long as they're assigned non-overlapping unicast addresses. Alternatively, to provision
51 ``mesh prov pb-adv on`` or ``mesh prov pb-gatt on``. The beacons can be picked up by an external
57 * To set the destination address, call ``mesh target dst <Addr>``.
61 By default, the transmission parameters are set to send messages to the provisioned address and
67 By setting the destination address to the local unicast address (``0x0001`` in the
68 ``mesh prov local`` command above), we can perform self-configuration through any of the
73 uart:~$ mesh models cfg get-comp
89 uart:~$ mesh test net-send 82020100
94 The message will be sent to the current destination address, using the current network and
95 application key indexes. As the destination address points to the local unicast address by default,
96 the device will only send packets to itself. To change the destination address to the All Nodes
97 broadcast address, call::
101 With the destination address set to ``0xffff``, any other mesh nodes in the network with the
105 To change the configuration of the device, the destination address must be set back to the
106 local unicast address before issuing any configuration commands.
120 .. list-table:: Parameter formats
122 :header-rows: 1
124 * - Type
125 - Description
126 - Example
127 * - Integers
128 - The default format unless something else is specified. Can be either decimal or
130 - ``1234``, ``0xabcd01234``
131 * - Hexstrings
132 - For raw byte arrays, like UUIDs, key values and message payloads, the parameters should
134 - ``deadbeef01234``
135 * - Booleans
136 - Boolean values are denoted in the API documentation as ``<val(off, on)>``.
137 - ``on``, ``off``, ``enabled``, ``disabled``, ``1``, ``0``
162 -------------
166 ``mesh reset-local``
167 --------------------
175 The target commands enables the user to monitor and set the target destination address, network
180 -----------------------------
182 Get or set the message destination address. The destination address determines where mesh
185 …`DstAddr``: If present, sets the new 16-bit mesh destination address. If omitted, the current dest…
189 -------------------------------
200 -------------------------------
214 -------------------------------
222 -----------------
230 ``mesh test net-send <HexString>``
231 -----------------------------------
233 Send a raw mesh message with the current destination address, network and application index.
238 ``mesh test iv-update``
239 -----------------------
244 ``mesh test iv-update-test <Val(off, on)>``
245 -------------------------------------------
252 ``mesh test rpl-clear``
253 -----------------------
264 ------------------
266 ``mesh test health-srv add-fault <FaultID>``
274 ``mesh test health-srv del-fault [FaultID]``
288 ``mesh prov pb-gatt <Val(off, on)>``
289 ------------------------------------
301 ``mesh prov pb-adv <Val(off, on)>``
302 -----------------------------------
305 node to be discovered by nearby advertising-based provisioners, and provisioned through the
313 ``mesh prov remote-adv <UUID(1-16 hex)> <NetKeyIdx> <Addr> <AttDur(s)>``
314 -----------------------------------------------------------------------------------
318 network with the given unicast address, and given the network key indicated by
321 …ioned device. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
323 …* ``Addr``: First unicast address to assign to the unprovisioned device. The device will occupy as…
329 ``mesh prov remote-gatt <UUID(1-16 hex)> <NetKeyIdx> <Addr> <AttDur(s)>``
330 -------------------------------------------------------------------------
333 advertising for PB-GATT with the given UUID. Once found, the unprovisioned device will be
334 added to the mesh network with the given unicast address, and given the network key
337 …ioned device. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
339 …* ``Addr``: First unicast address to assign to the unprovisioned device. The device will occupy as…
342 ``mesh prov uuid [UUID(1-16 hex)]``
343 -----------------------------------
347 …sent, new 128-bit UUID value. Providing a hex-string shorter than 16 bytes will populate the N mos…
350 ``mesh prov input-num <Number>``
351 --------------------------------
354 provisioning. The input number must match the number presented by the other participant in
360 ``mesh prov input-str <String>``
361 --------------------------------
364 provisioning. The input string must match the string presented by the other participant in
370 ``mesh prov static-oob [Val(1-32 hex)]``
371 ----------------------------------------
378 …e static OOB. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
382 --------------------------------------------
388 …* ``Addr``: First unicast address to assign to the device. The device will occupy as many addresse…
392 ``mesh prov beacon-listen <Val(off, on)>``
393 ------------------------------------------
401 ``mesh prov remote-pub-key <PubKey>``
402 -------------------------------------
405 * ``PubKey`` - Device public key in big-endian.
407 ``mesh prov auth-method input <Action> <Size>``
408 -----------------------------------------------
412 * ``Action`` - Input action. Allowed values:
414 * ``0`` - No input action.
415 * ``1`` - Push action set.
416 * ``2`` - Twist action set.
417 * ``4`` - Enter number action set.
418 * ``8`` - Enter String action set.
419 * ``Size`` - Authentication size.
421 ``mesh prov auth-method output <Action> <Size>``
422 ------------------------------------------------
426 * ``Action`` - Output action. Allowed values:
428 * ``0`` - No output action.
429 * ``1`` - Blink action set.
430 * ``2`` - Vibrate action set.
431 * ``4`` - Display number action set.
432 * ``8`` - Display String action set.
433 * ``Size`` - Authentication size.
435 ``mesh prov auth-method static <Val(1-16 hex)>``
436 ------------------------------------------------
440 …* ``Val`` - Static OOB value. Providing a hex-string shorter than 32 bytes will populate the N mos…
442 ``mesh prov auth-method none``
443 ------------------------------
453 ``mesh proxy identity-enable``
454 ------------------------------
463 ----------------------------------
465 Auto-Connect a nearby proxy server into the mesh.
471 -------------------------------------
479 ----------------------------------
492 --------------------
507 Client model targets the new node. In most common use-cases, the Configuration Client is depending
509 Configuration Client always sends messages using the Device key bound to the destination address, so
517 * Monitor the composition data of the local node (``mesh models cfg get-comp``).
519 * Provision other devices (``mesh prov beacon-listen``) (``mesh prov remote-adv``)
520 (``mesh prov remote-gatt``).
523 * Monitor the composition data of the target device (``mesh models cfg get-comp``).
549 ``mesh models cfg get-comp [Page]``
571 …* ``TTL``: If present, sets the new default TTL value. Legal TTL values are 0x00 and 0x02-0x7f. If…
586 ``mesh models cfg gatt-proxy [Val(off, on)]``
609 …`val`` is ``on``. Ignored if ``val`` is ``off``. Legal retransmit count is 0-7. Defaults to ``2`` …
610 …t interval in milliseconds if ``val`` is ``on``. Legal interval range is 10-320 milliseconds. Ign…
612 ``mesh models cfg node-id <NetKeyIdx> [Identity]``
620 ``mesh models cfg polltimeout-get <LPNAddr>``
625 * ``LPNAddr`` Address of Low Power node.
627 ``mesh models cfg net-transmit-param [<Count> <Int(ms)>]``
632 …s the number of additional network transmits for every sent message. Legal retransmit count is 0-7.
633 …* ``Int``: Sets the new network retransmit interval in milliseconds. Legal interval range is 10-32…
636 ``mesh models cfg netkey add <NetKeyIdx> [Key(1-16 hex)]``
642 … as a 128-bit hexadecimal value. Providing a hex-string shorter than 16 bytes will populate the N …
645 ``mesh models cfg netkey upd <NetKeyIdx> [Key(1-16 hex)]``
651 … as a 128-bit hexadecimal value. Providing a hex-string shorter than 16 bytes will populate the N …
667 ``mesh models cfg appkey add <NetKeyIdx> <AppKeyIdx> [Key(1-16 hex)]``
675 … as a 128-bit hexadecimal value. Providing a hex-string shorter than 16 bytes will populate the N …
677 ``mesh models cfg appkey upd <NetKeyIdx> <AppKeyIdx> [Key(1-16 hex)]``
684 … as a 128-bit hexadecimal value. Providing a hex-string shorter than 16 bytes will populate the N …
703 ``mesh models cfg model app-bind <Addr> <AppKeyIdx> <MID> [CID]``
709 * ``Addr``: Address of the element the model is on.
715 ``mesh models cfg model app-unbind <Addr> <AppKeyIdx> <MID> [CID]``
720 * ``Addr``: Address of the element the model is on.
726 ``mesh models cfg model app-get <ElemAddr> <MID> [CID]``
731 * ``ElemAddr``: Address of the element the model is on.
743 * ``Addr``: Address of the element the model is on.
749 * ``PubAddr``: The destination address to publish to.
763 ``mesh models cfg model pub-va <Addr> <UUID(1-16 hex)> <AppKeyIdx> <Cred(off, on)> <TTL> <PerRes> <…
768 * ``Addr``: Address of the element the model is on.
774 …n virtual address to publish to. Providing a hex-string shorter than 16 bytes will populate the N …
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
793 unicast address or a group or virtual address they subscribe to. Models may subscribe to
796 * ``ElemAddr``: Address of the element the model is on.
797 * ``SubAddr``: 16-bit group address the model should subscribe to (``0xc000`` to ``0xFEFF``).
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``…
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
817 address or a group or virtual address they subscribe to. Models may subscribe to multiple
820 * ``ElemAddr``: Address of the element the model is on.
821 …-bit label UUID of the virtual address to subscribe to. Providing a hex-string shorter than 16 byt…
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.
832 …-bit label UUID of the virtual address to remove the subscription of. Providing a hex-string shor…
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…
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
850 messages sent to their unicast address or a group or virtual address they subscribe to.
853 * ``ElemAddr``: Address of the element the model is on.
854 …-bit label UUID of the virtual address as the new Address to be added to the subscription list. Pr…
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.
867 ``mesh models cfg model sub-get <ElemAddr> <MID> [CID]``
872 * ``ElemAddr``: Address of the element the model is on.
889 ``mesh models cfg hb-sub [<Src> <Dst> <Per>]``
897 * ``Src``: Unicast source address to receive Heartbeat messages from.
898 * ``Dst``: Destination address to receive Heartbeat messages on.
902 …* ``1`` to ``17``: The node will subscribe to Heartbeat messages for 2\ :sup:`(period - 1)` second…
905 ``mesh models cfg hb-pub [<Dst> <Count> <Per> <TTL> <Features> <NetKeyIdx>]``
912 * ``Dst``: Destination address to publish Heartbeat messages to.
916 * ``1`` to ``17``: The node will periodically publish 2\ :sup:`(count - 1)` Heartbeat messages.
922 * ``1`` to ``17``: The node will publish Heartbeat messages every 2\ :sup:`(period - 1)` seconds.
936 -------------
948 the commands ``mesh models health instance set`` and ``mesh models health instance get-all``.
952 destination address is set to zero, the targeted Health Client will attempt to publish messages
962 ``mesh models health instance get-all``
967 ``mesh models health fault-get <CID>``
975 ``mesh models health fault-clear <CID>``
983 ``mesh models health fault-clear-unack <CID>``
991 ``mesh models health fault-test <CID> <TestID>``
994 Invoke a self-test procedure, and show a list of triggered faults.
996 * ``CID``: Company ID to perform self-tests for.
1000 ``mesh models health fault-test-unack <CID> <TestID>``
1003 Invoke a self-test procedure without requesting a response.
1005 * ``CID``: Company ID to perform self-tests for.
1009 ``mesh models health period-get``
1015 ``mesh models health period-set <Divisor>``
1026 ``mesh models health period-set-unack <Divisor>``
1037 ``mesh models health attention-get``
1043 ``mesh models health attention-set <Time(s)>``
1051 ``mesh models health attention-set-unack <Time(s)>``
1060 ------------------------------------------------
1071 * ``Addr``: Unicast address of the Target node's BLOB Transfer Server model.
1079 …`Group``: Optional group address to use when communicating with Target nodes. If omitted, the BLOB…
1080 * ``TimeoutBase``: Optional time to wait for responses from Target nodes, in 10-second increments.
1091 * ``Id``: 64-bit BLOB transfer ID.
1095 …``: Optional group address to use when communicating with Target nodes. If omitted or set to 0, th…
1099 ``mesh models blob cli tx-cancel``
1104 ``mesh models blob cli tx-get [Group]``
1110 …``: Optional group address to use when communicating with Target nodes. If omitted or set to 0, th…
1113 ``mesh models blob cli tx-suspend``
1119 ``mesh models blob cli tx-resume``
1124 ``mesh models blob cli instance-set <ElemIdx>``
1132 ``mesh models blob cli instance-get-all``
1139 --------------------------
1151 * ``ID``: 64-bit BLOB transfer ID to receive.
1152 * ``TimeoutBase``: Optional additional time to wait for client messages, in 10-second increments.
1155 ``mesh models blob srv rx-cancel``
1160 ``mesh models blob srv instance-set <ElemIdx>``
1168 ``mesh models blob srv instance-get-all``
1175 ------------------------------------------------
1181 ``mesh models blob flash-stream-set <AreaID> [<Offset>]``
1189 ``mesh models blob flash-stream-unset``
1196 ----------------------------
1238 * ``Addr``: Unicast address of the Target node.
1239 * ``ImgIdx``: Image index to address on the Target node.
1242 ``mesh models dfu cli target-state``
1245 Check the DFU Target state of the device at the configured destination address.
1248 ``mesh models dfu cli target-imgs [<MaxCount>]``
1251 Get a list of DFU images on the device at the configured destination address.
1256 ``mesh models dfu cli target-check <SlotIdx> <TargetImgIdx>``
1259 Check whether the device at the configured destination address will accept a DFU transfer
1273 …oup``: Optional group address to use when communicating with the Target nodes. If omitted, the Fir…
1280 a Target node address is provided, the Firmware Update Client model will try to cancel the
1284 * ``Addr``: Optional unicast address of a Target node on which to cancel the DFU procedure.
1319 ``mesh models dfu cli instance-set <ElemIdx>``
1327 ``mesh models dfu cli instance-get-all``
1334 ----------------------------
1359 ``mesh models dfu srv rx-cancel``
1364 ``mesh models dfu srv instance-set <ElemIdx>``
1372 ``mesh models dfu srv instance-get-all``
1381 ----------------------------------
1388 ``mesh models dfd receivers-add <Addr>,<FwIdx>[;<Addr>,<FwIdx>]...``
1392 comma-separated addr,fw_idx pairs, separated by semicolons, for example,
1395 ``mesh models dfd receivers-delete-all`` is called.
1397 * ``Addr``: Address of the receiving node(s).
1400 ``mesh models dfd receivers-delete-all``
1405 ``mesh models dfd receivers-get <First> <Count>``
1413 ``mesh models dfd capabilities-get``
1430 …``: Optional group address to use when communicating with the Target nodes. If omitted, the Firmwa…
1433 …used to calculate timeout values in the firmware distribution process, in 10-second increments.. S…
1451 ``mesh models dfd fw-get <FwID>``
1458 ``mesh models dfd fw-get-by-idx <Idx>``
1465 ``mesh models dfd fw-delete <FwID>``
1472 ``mesh models dfd fw-delete-all``
1477 ``mesh models dfd instance-set <ElemIdx>``
1485 ``mesh models dfd instance-get-all``
1494 ------------
1500 ``mesh models dfu metadata comp-clear``
1505 ``mesh models dfu metadata comp-add <CID> <ProductID> <VendorID> <Crpl> <Features>``
1511 * ``ProductID``: Vendor-assigned product identifier.
1512 * ``VendorID``: Vendor-assigned version identifier.
1521 ``mesh models dfu metadata comp-elem-add <Loc> <NumS> <NumV> {<SigMID>|<VndCID> <VndMID>}...``
1532 ``mesh models dfu metadata comp-hash-get [<Key(16 hex)>]``
1537 …-bit key to be used to generate the hash. Providing a hex-string shorter than 16 bytes will popula…
1554 …* ``Hash``: Hash of the composition data generated using ``mesh models dfu metadata comp-hash-get`…
1560 ------------------------------------------------------
1568 ``mesh models sar tx-get``
1573 ``mesh models sar tx-set <SegIntStep> <UniRetransCnt> <UniRetransWithoutProgCnt> <UniRetransIntStep…
1586 ``mesh models sar rx-get``
1591 ``mesh models sar rx-set <SegThresh> <AckDelayInc> <DiscardTimeout> <RxSegIntStep> <AckRetransCount…
1604 ---------------------
1609 ``mesh models prb priv-beacon-get``
1617 ``mesh models prb priv-beacon-set <Val(off, on)> <RandInt(10s steps)>``
1623 * ``RandInt``: Random refresh interval (in 10-second steps), or 0 to keep current value.
1625 ``mesh models prb priv-gatt-proxy-get``
1634 ``mesh models prb priv-gatt-proxy-set <Val(off, on)>``
1644 ``mesh models prb priv-node-id-get <NetKeyIdx>``
1655 ``mesh models prb priv-node-id-set <NetKeyIdx> <State>``
1668 -------------------------
1675 ``mesh models opagg seq-start <ElemAddr>``
1679 aggregating messages and sets the destination address for next shell commands to
1682 * ``ElemAddr``: Element address that will process the aggregated opcodes.
1684 ``mesh models opagg seq-send``
1690 ``mesh models opagg seq-abort``
1698 --------------------------
1708 ``mesh models rpr scan <Timeout(s)> [<UUID(1-16 hex)>]``
1714 … to scan for. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
1716 ``mesh models rpr scan-ext <Timeout(s)> <UUID(1-16 hex)> [<ADType> ... ]``
1722 …scanning for. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
1725 ``mesh models rpr scan-srv [<ADType> ... ]``
1732 ``mesh models rpr scan-caps``
1737 ``mesh models rpr scan-get``
1742 ``mesh models rpr scan-stop``
1747 ``mesh models rpr link-get``
1752 ``mesh models rpr link-close``
1757 ``mesh models rpr provision-remote <UUID(1-16 hex)> <NetKeyIdx> <Addr>``
1760 Provision a mesh node using the PB-Remote provisioning bearer.
1762 …isioned node. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
1764 …* ``Addr``: Address to assign to remote device. If ``addr`` is 0, the lowest available address wil…
1766 ``mesh models rpr reprovision-remote <Addr> [<CompChanged(false, true)>]``
1769 Reprovision a mesh node using the PB-Remote provisioning bearer.
1771 …* ``Addr``: Address to assign to remote device. If ``addr`` is 0, the lowest available address wil…
1774 ``mesh models rpr instance-set <ElemIdx>``
1782 ``mesh models rpr instance-get-all``
1789 -----------------------------
1796 ``mesh models lcd large-comp-data-get <Page> <Offset>``
1804 ``mesh models lcd models-metadata-get <Page> <Offset>``
1814 ---------------------------
1832 ``mesh models brg table-size-get``
1837 ``mesh models brg table-add <Directions> <NetIdx1> <NetIdx2> <Addr1> <Addr2>``
1844 …owed only for messages with ``Addr1`` as the source address and ``Addr2`` as the destination addre…
1849 * ``Addr1``: Address of the node in the first subnet.
1850 * ``Addr2``: Address of the node in the second subnet.
1852 ``mesh models brg table-remove <NetIdx1> <NetIdx2> <Addr1> <Addr2>``
1859 * ``Addr1``: Address of the node in the first subnet.
1860 * ``Addr2``: Address of the node in the second subnet.
1862 ``mesh models brg subnets-get <Filter> <NetIdx> <StartIdx>``
1877 ``mesh models brg table-get <NetIdx1> <NetIdx2> <StartIdx>``
1897 ``mesh cdb create [NetKey(1-16 hex)]``
1898 --------------------------------------
1902 …KeyIndex=0). Providing a hex-string shorter than 16 bytes will populate the N most significant by…
1906 ------------------
1912 -----------------
1917 ``mesh cdb node-add <UUID(1-16 hex)> <Addr> <ElemCnt> <NetKeyIdx> [DevKey(1-16 hex)]``
1918 --------------------------------------------------------------------------------------
1921 ``mesh provision`` and ``mesh provision-adv`` will be added automatically if the
1924 … 128-bit hexadecimal UUID of the node. Providing a hex-string shorter than 16 bytes will populate …
1925 * ``Addr``: Unicast address of the node, or 0 to automatically choose the lowest available address.
1928 …28-bit device key value for the device. Providing a hex-string shorter than 16 bytes will populate…
1931 ``mesh cdb node-del <Addr>``
1932 ----------------------------
1938 * ``Addr`` Address of the node to delete.
1941 ``mesh cdb subnet-add <NetKeyIdx> [<NetKey(1-16 hex)>]``
1942 --------------------------------------------------------
1949 …ional 128-bit network key value. Providing a hex-string shorter than 16 bytes will populate the N …
1952 ``mesh cdb subnet-del <NetKeyIdx>``
1953 -----------------------------------
1960 ``mesh cdb app-key-add <NetKeyIdx> <AppKeyIdx> [<AppKey(1-16 hex)>]``
1961 ---------------------------------------------------------------------
1969 …nal 128-bit application key value. Providing a hex-string shorter than 16 bytes will populate the …
1972 ``mesh cdb app-key-del <AppKeyIdx>``
1973 ------------------------------------
1980 On-Demand Private GATT Proxy Client
1981 -----------------------------------
1983 The On-Demand Private GATT Proxy Client model is an optional mesh subsystem that can be enabled
1986 ``mesh models od_priv_proxy od-priv-gatt-proxy [Dur(s)]``
1987 ---------------------------------------------------------
1989 Set the On-Demand Private GATT Proxy state on active target, or fetch the value of this
1992 …* ``Dur``: If given, set the state of On-Demand Private GATT Proxy to this value in seconds. Fetc…
1996 ---------------------------
2001 ``mesh models sol_pdu_rpl sol-pdu-rpl-clear <RngStart> <Ackd> [RngLen]``
2002 ------------------------------------------------------------------------
2007 * ``RngStart``: Start address of the SSRC range.
2009 …iation RPL list. This parameter is optional; if absent, only a single SSRC address will be cleared.
2016 -----------------
2023 -------------------