Skip to content

Commit a338292

Browse files
committed
more spelling
1 parent 0dc16a6 commit a338292

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

docs/testing/ChipDeviceCtrlAPI.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,10 @@ sent to remote node. suppressTimedRequestMessage: When set to true, we suppress
349349
sending Timed Request Message. commandRefsOverride: List of commandRefs to use
350350
for each command with the same index in `commands`.
351351

352+
**Returns**:
353+
354+
- TestOnlyBatchCommandResponse
355+
352356
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.TestOnlySendCommandTimedRequestFlagWithNoTimedInvoke"></a>
353357

354358
#### TestOnlySendCommandTimedRequestFlagWithNoTimedInvoke
@@ -413,7 +417,7 @@ async def SendBatchCommands(
413417

414418
Send a batch of cluster-object encapsulated commands to a node and get returned
415419
a future that can be awaited upon to receive the responses. If a valid
416-
responseType is passed in, that will be used to deserialize the object. If not,
420+
responseType is passed in, that will be used to de-serialize the object. If not,
417421
the type will be automatically deduced from the metadata received over the wire.
418422

419423
nodeId: Target's Node ID commands: A list of InvokeRequestInfo containing the
@@ -673,7 +677,7 @@ sent.
673677
List[Cluster]]) Access as
674678
returned_object[endpoint_id][<Cluster class>][<Attribute class>] Ex. To
675679
access the OnTime attribute from the OnOff cluster on endpoint 1
676-
ret[1][Clusters.OnOff][Clusters.OnOff.Attributes.OnTime]
680+
returned_object[1][Clusters.OnOff][Clusters.OnOff.Attributes.OnTime]
677681

678682
**Raises**:
679683

@@ -737,7 +741,7 @@ subscriptions. When not provided, a read request will be sent.
737741
Callable[[EventReadResult, SubscriptionTransaction], None] You can await
738742
events using a trigger mechanism in the callback. ex. queue.SimpleQueue
739743

740-
- read request: AsyncReadTransation.ReadResponse.events. This is a
744+
- read request: AsyncReadTransaction.ReadResponse.events. This is a
741745
List[ClusterEvent].
742746

743747
**Raises**:
@@ -1000,9 +1004,11 @@ selected filter.
10001004
#### CommissionWithCode
10011005

10021006
```python
1003-
def CommissionWithCode(setupPayload: str,
1004-
nodeid: int,
1005-
networkOnly: bool = False) -> PyChipError
1007+
def CommissionWithCode(
1008+
setupPayload: str,
1009+
nodeid: int,
1010+
discoveryType: DiscoveryType = DiscoveryType.DISCOVERY_ALL
1011+
) -> PyChipError
10061012
```
10071013

10081014
Commission with the given nodeid from the setupPayload. setupPayload may be a QR

src/controller/python/chip/ChipDeviceCtrl.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -955,7 +955,7 @@ async def SendBatchCommands(self, nodeid: int, commands: typing.List[ClusterComm
955955
suppressResponse: typing.Optional[bool] = None):
956956
'''
957957
Send a batch of cluster-object encapsulated commands to a node and get returned a future that can be awaited upon to receive
958-
the responses. If a valid responseType is passed in, that will be used to deserialize the object. If not,
958+
the responses. If a valid responseType is passed in, that will be used to de-serialize the object. If not,
959959
the type will be automatically deduced from the metadata received over the wire.
960960
961961
nodeId: Target's Node ID
@@ -1330,7 +1330,7 @@ async def ReadAttribute(self, nodeid: int, attributes: typing.List[typing.Union[
13301330
(dict[int, List[Cluster]])
13311331
Access as returned_object[endpoint_id][<Cluster class>][<Attribute class>]
13321332
Ex. To access the OnTime attribute from the OnOff cluster on endpoint 1
1333-
ret[1][Clusters.OnOff][Clusters.OnOff.Attributes.OnTime]
1333+
returned_object[1][Clusters.OnOff][Clusters.OnOff.Attributes.OnTime]
13341334
13351335
Raises:
13361336
- InteractionModelError (chip.interaction_model) on error
@@ -1398,7 +1398,7 @@ async def ReadEvent(self, nodeid: int, events: typing.List[typing.Union[
13981398
Callable[[EventReadResult, SubscriptionTransaction], None]
13991399
You can await events using a trigger mechanism in the callback. ex. queue.SimpleQueue
14001400
1401-
- read request: AsyncReadTransation.ReadResponse.events.
1401+
- read request: AsyncReadTransaction.ReadResponse.events.
14021402
This is a List[ClusterEvent].
14031403
14041404
Raises:

0 commit comments

Comments
 (0)