Lines Matching +full:polling +full:- +full:interval +full:- +full:ms
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
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
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
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 --------------------
180 -----------------------------
185 …* ``DstAddr``: If present, sets the new 16-bit mesh destination address. If omitted, the current d…
189 -------------------------------
200 -------------------------------
214 -------------------------------
217 start polling for friend nodes.
222 -----------------
230 ``mesh test net-send <HexString>``
231 -----------------------------------
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 -----------------------------------------------------------------------------------
321 …ioned device. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
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
337 …ioned device. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
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 --------------------------------
360 ``mesh prov input-str <String>``
361 --------------------------------
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 --------------------------------------------
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
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)]``
598 ``mesh models cfg relay [<Val(off, on)> [<Count> [Int(ms)]]]``
609 …`val`` is ``on``. Ignored if ``val`` is ``off``. Legal retransmit count is 0-7. Defaults to ``2`` …
610 …``Int``: Sets the new relay retransmit interval in milliseconds if ``val`` is ``on``. Legal inter…
612 ``mesh models cfg node-id <NetKeyIdx> [Identity]``
620 ``mesh models cfg polltimeout-get <LPNAddr>``
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]``
715 ``mesh models cfg model app-unbind <Addr> <AppKeyIdx> <MID> [CID]``
726 ``mesh models cfg model app-get <ElemAddr> <MID> [CID]``
736 …> <MID> [CID] [<PubAddr> <AppKeyIdx> <Cred(off, on)> <TTL> <PerRes> <PerSteps> <Count> <Int(ms)>]``
761 * ``Int`` The interval between each retransmission, in milliseconds. Must be a multiple of 50.
763 ``mesh models cfg model pub-va <Addr> <UUID(1-16 hex)> <AppKeyIdx> <Cred(off, on)> <TTL> <PerRes> <…
774 …o publish to. Providing a hex-string shorter than 16 bytes will populate the N most significant by…
786 * ``Int`` The interval between each retransmission, in milliseconds. Must be a multiple of 50.
789 ``mesh models cfg model sub-add <ElemAddr> <SubAddr> <MID> [CID]``
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]``
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]``
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]``
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]``
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]``
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]``
867 ``mesh models cfg model sub-get <ElemAddr> <MID> [CID]``
889 ``mesh models cfg hb-sub [<Src> <Dst> <Per>]``
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>]``
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``.
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>``
1019 Server will start publishing is fault status with a reduced interval. The reduced interval
1026 ``mesh models health period-set-unack <Divisor>``
1030 Server will start publishing is fault status with a reduced interval. The reduced interval
1037 ``mesh models health attention-get``
1043 ``mesh models health attention-set <Time(s)>``
1051 ``mesh models health attention-set-unack <Time(s)>``
1060 ------------------------------------------------
1080 * ``TimeoutBase``: Optional time to wait for responses from Target nodes, in 10-second increments.
1091 * ``Id``: 64-bit BLOB transfer ID.
1099 ``mesh models blob cli tx-cancel``
1104 ``mesh models blob cli tx-get [Group]``
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 ----------------------------
1242 ``mesh models dfu cli target-state``
1248 ``mesh models dfu cli target-imgs [<MaxCount>]``
1256 ``mesh models dfu cli target-check <SlotIdx> <TargetImgIdx>``
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.
1400 ``mesh models dfd receivers-delete-all``
1405 ``mesh models dfd receivers-get <First> <Count>``
1413 ``mesh models dfd capabilities-get``
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…
1578 * ``SegIntStep``: SAR Segment Interval Step state.
1581 * ``UniRetransIntStep``: SAR Unicast Retransmissions Interval Step state.
1582 * ``UniRetransIntInc``: SAR Unicast Retransmissions Interval Increment state.
1584 * ``MultiRetransInt``: SAR Multicast Retransmissions Interval state.
1586 ``mesh models sar rx-get``
1591 ``mesh models sar rx-set <SegThresh> <AckDelayInc> <DiscardTimeout> <RxSegIntStep> <AckRetransCount…
1599 * ``RxSegIntStep``: SAR Receiver Segment Interval Step state.
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>``
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…
1766 ``mesh models rpr reprovision-remote <Addr> [<CompChanged(false, true)>]``
1769 Reprovision a mesh node using the PB-Remote provisioning bearer.
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>``
1852 ``mesh models brg table-remove <NetIdx1> <NetIdx2> <Addr1> <Addr2>``
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 …
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 ----------------------------
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 ------------------------------------------------------------------------
2016 -----------------
2023 -------------------