Fix spelling, add words to wordlist

cecille · cecille · commit 0dc16a6e3e96 · 2024-02-28T10:04:40.000-05:00
diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt
@@ -465,6 +465,7 @@ EchoMessage
 EchoRequests
 EchoResponse
 EchoService
+ECW
 edaf
 edc
 EDR
@@ -738,6 +739,7 @@ kCase
 Kconfig
 kDacPublicKey
 KeypadInput
+keypair
 keyset
 kGroup
 kInvalidCommandId
@@ -884,6 +886,7 @@ mlan
 MLD
 mmevk
 moal
+Mobly
 ModeSelect
 modprobe
 Modustoolbox
@@ -948,6 +951,7 @@ nrfdks
 nrfutil
 nrfxlib
 NTAG
+NTP
 nullable
 nullptr
 NUM
@@ -1013,6 +1017,7 @@ OTBR
 otcli
 outform
 outgoingCommands
+overridable
 OxygenConcentrationMeasurement
 OzoneConcentrationMeasurement
 PAA
@@ -1051,6 +1056,7 @@ perfetto
 periodicQueryTimeout
 pexpect
 pickString
+PICSCODE
 PID
 Pigweed
 PinCode
@@ -1366,6 +1372,7 @@ TestGenExample
 TestGroupDemoConfig
 TestMultiRead
 TestName
+TestOnlySendCommandTimedRequestFlagWithNoTimedInvoke
 TESTPASSWD
 TestPICS
 TESTSSID
diff --git a/docs/testing/ChipDeviceCtrlAPI.md b/docs/testing/ChipDeviceCtrlAPI.md
@@ -1,61 +1,62 @@
 # Table of Contents
 
--   [chip.ChipDeviceCtrl](#chip.ChipDeviceCtrl)
-    -   [CommissionableNode](#chip.ChipDeviceCtrl.CommissionableNode)
-        -   [Commission](#chip.ChipDeviceCtrl.CommissionableNode.Commission)
-    -   [DeviceProxyWrapper](#chip.ChipDeviceCtrl.DeviceProxyWrapper)
-    -   [ChipDeviceControllerBase](#chip.ChipDeviceCtrl.ChipDeviceControllerBase)
-        -   [Shutdown](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.Shutdown)
-        -   [ShutdownAll](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ShutdownAll)
-        -   [ExpireSessions](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ExpireSessions)
-        -   [DiscoverCommissionableNodes](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodes)
-        -   [DiscoverCommissionableNodesLongDiscriminator](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesLongDiscriminator)
-        -   [DiscoverCommissionableNodesShortDiscriminator](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesShortDiscriminator)
-        -   [DiscoverCommissionableNodesVendor](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesVendor)
-        -   [DiscoverCommissionableNodesDeviceType](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesDeviceType)
-        -   [DiscoverCommissionableNodesCommissioningEnabled](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesCommissioningEnabled)
-        -   [PrintDiscoveredDevices](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.PrintDiscoveredDevices)
-        -   [DiscoverAllCommissioning](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverAllCommissioning)
-        -   [OpenCommissioningWindow](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.OpenCommissioningWindow)
-        -   [GetFabricIdInternal](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.GetFabricIdInternal)
-        -   [GetNodeIdInternal](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.GetNodeIdInternal)
-        -   [GetConnectedDeviceSync](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.GetConnectedDeviceSync)
-        -   [ComputeRoundTripTimeout](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ComputeRoundTripTimeout)
-        -   [GetRemoteSessionParameters](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.GetRemoteSessionParameters)
-        -   [TestOnlySendBatchCommands](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.TestOnlySendBatchCommands)
-        -   [TestOnlySendCommandTimedRequestFlagWithNoTimedInvoke](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.TestOnlySendCommandTimedRequestFlagWithNoTimedInvoke)
-        -   [SendCommand](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.SendCommand)
-        -   [SendBatchCommands](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.SendBatchCommands)
-        -   [SendGroupCommand](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.SendGroupCommand)
-        -   [WriteAttribute](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.WriteAttribute)
-        -   [WriteGroupAttribute](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.WriteGroupAttribute)
-        -   [Read](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.Read)
-        -   [ReadAttribute](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ReadAttribute)
-        -   [ReadEvent](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ReadEvent)
-        -   [ZCLSend](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ZCLSend)
-        -   [ZCLReadAttribute](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ZCLReadAttribute)
-        -   [ZCLWriteAttribute](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ZCLWriteAttribute)
-        -   [ZCLSubscribeAttribute](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.ZCLSubscribeAttribute)
-        -   [InitGroupTestingData](#chip.ChipDeviceCtrl.ChipDeviceControllerBase.InitGroupTestingData)
-    -   [ChipDeviceController](#chip.ChipDeviceCtrl.ChipDeviceController)
-        -   [Commission](#chip.ChipDeviceCtrl.ChipDeviceController.Commission)
-        -   [CommissionThread](#chip.ChipDeviceCtrl.ChipDeviceController.CommissionThread)
-        -   [CommissionWiFi](#chip.ChipDeviceCtrl.ChipDeviceController.CommissionWiFi)
-        -   [SetWiFiCredentials](#chip.ChipDeviceCtrl.ChipDeviceController.SetWiFiCredentials)
-        -   [SetThreadOperationalDataset](#chip.ChipDeviceCtrl.ChipDeviceController.SetThreadOperationalDataset)
-        -   [ResetCommissioningParameters](#chip.ChipDeviceCtrl.ChipDeviceController.ResetCommissioningParameters)
-        -   [SetTimeZone](#chip.ChipDeviceCtrl.ChipDeviceController.SetTimeZone)
-        -   [SetDSTOffset](#chip.ChipDeviceCtrl.ChipDeviceController.SetDSTOffset)
-        -   [SetDefaultNTP](#chip.ChipDeviceCtrl.ChipDeviceController.SetDefaultNTP)
-        -   [SetTrustedTimeSource](#chip.ChipDeviceCtrl.ChipDeviceController.SetTrustedTimeSource)
-        -   [SetCheckMatchingFabric](#chip.ChipDeviceCtrl.ChipDeviceController.SetCheckMatchingFabric)
-        -   [GetFabricCheckResult](#chip.ChipDeviceCtrl.ChipDeviceController.GetFabricCheckResult)
-        -   [CommissionOnNetwork](#chip.ChipDeviceCtrl.ChipDeviceController.CommissionOnNetwork)
-        -   [CommissionWithCode](#chip.ChipDeviceCtrl.ChipDeviceController.CommissionWithCode)
-        -   [CommissionIP](#chip.ChipDeviceCtrl.ChipDeviceController.CommissionIP)
-        -   [IssueNOCChain](#chip.ChipDeviceCtrl.ChipDeviceController.IssueNOCChain)
-    -   [BareChipDeviceController](#chip.ChipDeviceCtrl.BareChipDeviceController)
-        -   [\_\_init\_\_](#chip.ChipDeviceCtrl.BareChipDeviceController.__init__)
+-   [Table of Contents](#table-of-contents)
+-   [chip.ChipDeviceCtrl](#chipchipdevicectrl)
+    -   [CommissionableNode](#commissionablenode)
+        -   [Commission](#commission)
+    -   [DeviceProxyWrapper](#deviceproxywrapper)
+    -   [ChipDeviceControllerBase](#chipdevicecontrollerbase)
+        -   [Shutdown](#shutdown)
+        -   [ShutdownAll](#shutdownall)
+        -   [ExpireSessions](#expiresessions)
+        -   [DiscoverCommissionableNodes](#discovercommissionablenodes)
+        -   [DiscoverCommissionableNodesLongDiscriminator](#discovercommissionablenodeslongdiscriminator)
+        -   [DiscoverCommissionableNodesShortDiscriminator](#discovercommissionablenodesshortdiscriminator)
+        -   [DiscoverCommissionableNodesVendor](#discovercommissionablenodesvendor)
+        -   [DiscoverCommissionableNodesDeviceType](#discovercommissionablenodesdevicetype)
+        -   [DiscoverCommissionableNodesCommissioningEnabled](#discovercommissionablenodescommissioningenabled)
+        -   [PrintDiscoveredDevices](#printdiscovereddevices)
+        -   [DiscoverAllCommissioning](#discoverallcommissioning)
+        -   [OpenCommissioningWindow](#opencommissioningwindow)
+        -   [GetFabricIdInternal](#getfabricidinternal)
+        -   [GetNodeIdInternal](#getnodeidinternal)
+        -   [GetConnectedDeviceSync](#getconnecteddevicesync)
+        -   [ComputeRoundTripTimeout](#computeroundtriptimeout)
+        -   [GetRemoteSessionParameters](#getremotesessionparameters)
+        -   [TestOnlySendBatchCommands](#testonlysendbatchcommands)
+        -   [TestOnlySendCommandTimedRequestFlagWithNoTimedInvoke](#testonlysendcommandtimedrequestflagwithnotimedinvoke)
+        -   [SendCommand](#sendcommand)
+        -   [SendBatchCommands](#sendbatchcommands)
+        -   [SendGroupCommand](#sendgroupcommand)
+        -   [WriteAttribute](#writeattribute)
+        -   [WriteGroupAttribute](#writegroupattribute)
+        -   [Read](#read)
+        -   [ReadAttribute](#readattribute)
+        -   [ReadEvent](#readevent)
+        -   [ZCLSend](#zclsend)
+        -   [ZCLReadAttribute](#zclreadattribute)
+        -   [ZCLWriteAttribute](#zclwriteattribute)
+        -   [ZCLSubscribeAttribute](#zclsubscribeattribute)
+        -   [InitGroupTestingData](#initgrouptestingdata)
+    -   [ChipDeviceController](#chipdevicecontroller)
+        -   [Commission](#commission-1)
+        -   [CommissionThread](#commissionthread)
+        -   [CommissionWiFi](#commissionwifi)
+        -   [SetWiFiCredentials](#setwificredentials)
+        -   [SetThreadOperationalDataset](#setthreadoperationaldataset)
+        -   [ResetCommissioningParameters](#resetcommissioningparameters)
+        -   [SetTimeZone](#settimezone)
+        -   [SetDSTOffset](#setdstoffset)
+        -   [SetDefaultNTP](#setdefaultntp)
+        -   [SetTrustedTimeSource](#settrustedtimesource)
+        -   [SetCheckMatchingFabric](#setcheckmatchingfabric)
+        -   [GetFabricCheckResult](#getfabriccheckresult)
+        -   [CommissionOnNetwork](#commissiononnetwork)
+        -   [CommissionWithCode](#commissionwithcode)
+        -   [CommissionIP](#commissionip)
+        -   [IssueNOCChain](#issuenocchain)
+    -   [BareChipDeviceController](#barechipdevicecontroller)
+        -   [\_\_init\_\_](#__init__)
 
 <a id="chip.ChipDeviceCtrl"></a>
 
@@ -94,7 +95,7 @@ class DeviceProxyWrapper()
 
 Encapsulates a pointer to OperationalDeviceProxy on the c++ side that needs to
 be freed when DeviceProxyWrapper goes out of scope. There is a potential issue
-where if this is copied around that a double free will occure, but how this is
+where if this is copied around that a double free will occur, but how this is
 used today that is not an issue that needs to be accounted for and it will
 become very apparent if that happens.
 
@@ -379,8 +380,8 @@ async def SendCommand(nodeid: int,
 
 Send a cluster-object encapsulated command to a node and get returned a future
 that can be awaited upon to receive the response. If a valid responseType is
-passed in, that will be used to deserialize the object. If not, the type will be
-automatically deduced from the metadata received over the wire.
+passed in, that will be used to de-serialize the object. If not, the type will
+be automatically deduced from the metadata received over the wire.
 
 timedWriteTimeoutMs: Timeout for a timed invoke request. Omit or set to 'None'
 to indicate a non-timed request. interactionTimeoutMs: Overall timeout for the
@@ -488,7 +489,7 @@ to the XYZ attribute on the test cluster to endpoint 1
 
 **Returns**:
 
--   [AttributeStatus] (list - one for each pth)
+-   [AttributeStatus] (list - one for each path)
 
 <a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.WriteGroupAttribute"></a>
 
@@ -663,15 +664,16 @@ sent.
     SubscriptionTransaction. This is used to set a callback function, which is a
     callable of type Callable[[TypedAttributePath, SubscriptionTransaction],
     None] Get the attribute value from the change path using GetAttribute on the
-    SubscriptionTransasction You can await changes in the main loop using a
+    SubscriptionTransaction You can await changes in the main loop using a
     trigger mechanism from the callback. ex. queue.SimpleQueue
 
--   read request: AsyncReadTransation.ReadResponse.attributes. This is of type
+-   read request: AsyncReadTransaction.ReadResponse.attributes. This is of type
     AttributeCache.attributeCache (Attribute.py), which is a dict mapping
     endpoints to a list of Cluster (ClusterObjects.py) classes (dict[int,
-    List[Cluster]]) Access as ret[endpoint_id][<cluster class>][<Attribute
-    class>] Ex. To access the OnTime attribute from the OnOff cluster on EP 1
-    ret[1][clusters.onoff][Clusters.OnOff.Attributes.OnTime]
+    List[Cluster]]) Access as
+    returned_object[endpoint_id][<Cluster class>][<Attribute class>] Ex. To
+    access the OnTime attribute from the OnOff cluster on endpoint 1
+    ret[1][Clusters.OnOff][Clusters.OnOff.Attributes.OnTime]
 
 **Raises**:
 
@@ -940,7 +942,7 @@ Set the DefaultNTP to set during commissioning
 def SetTrustedTimeSource(nodeId: int, endpoint: int)
 ```
 
-Set the trusetd time source nodeId to set during commissioning. This must be a
+Set the trusted time source nodeId to set during commissioning. This must be a
 node on the commissioner fabric.
 
 <a id="chip.ChipDeviceCtrl.ChipDeviceController.SetCheckMatchingFabric"></a>
@@ -1052,7 +1054,7 @@ def __init__(operationalKey: p256keypair.P256Keypair,
              name: str = None)
 ```
 
-Creates a controller without autocommissioner.
+Creates a controller without AutoCommissioner.
 
 The allocated controller uses the noc, icac, rcac and ipk instead of the
 default, random generated certificates / keys. Which is suitable for creating a
diff --git a/docs/testing/python.md b/docs/testing/python.md
@@ -1,7 +1,7 @@
 # Python framework tests
 
 The python test framework is built on top of the ChipDeviceCtrl.py python
-controller API and the mobly test framework. Python tests are interaction tests,
+controller API and the Mobly test framework. Python tests are interaction tests,
 and can be used for certification testing, and / or integration testing in the
 CI.
 
@@ -33,7 +33,7 @@ Python tests located in src/python_testing
 -   Use ChipDeviceCtrl to interact with the DUT
     -   Controller API is in ChipDeviceCtrl.py (see API doc in file)
     -   some support functions in matter_testing_support.py
--   Use mobly assertions for failing tests
+-   Use Mobly assertions for failing tests
 -   self.step() along with a steps\_ function to mark test plan steps for cert
     tests
 -
@@ -198,7 +198,7 @@ Example
 ## Accessing Clusters and Cluster Elements by ID
 
 [ClusterObjects.py](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/chip/clusters/ClusterObjects.py)
-has a set of objects that map ID to the codegen'd object.
+has a set of objects that map ID to the code generated object.
 
 `chip.clusters.ClusterObjects.ALL_CLUSTERS`
 
@@ -253,7 +253,7 @@ Single attribute
 
 `await dev_ctrl.ReadAttribute(node_id, [(1, Clusters.OnOff.Attributes.OnTime)])`
 
-Multipath
+Multi-path
 
 `await dev_ctrl.ReadAttribute(node_id, [(1, Clusters.OnOff.Attributes.OnTime),(1, Clusters.OnOff.Attributes.OnOff)])`
 
@@ -343,15 +343,15 @@ pai = await dev_ctrl.SendCommand(nodeid, 0, Clusters.OperationalCredentials.Comm
     -   read_single_attribute_expect_error
     -   send_single_cmd
 -   step() function to mark step progress for the test harness
--   skip / skip_step / skip_remaning_steps functions for test harness
+-   skip / skip_step / skip_remaining_steps functions for test harness
     integration
 -   check_pics / pics_guard to handle pics
 
 ## Mobly helpers
 
-The test system is based on mobly, and the
+The test system is based on Mobly, and the
 [matter_testing_support.py](https://github.com/project-chip/connectedhomeip/blob/master/src/python_testing/matter_testing_support.py)
-class provides some helpers for mobly integration
+class provides some helpers for Mobly integration
 
 -   default_matter_test_main
     -   Sets up commissioning and finds all tests, parses command arguments
@@ -425,7 +425,7 @@ See
 -   --tests to select tests
 -   --PICS
 -   --int-arg, --bool-arg, --float-arg, --string-arg, --json-arg, --hex-arg
-    -   specify as key:value ex --bool-arg mybool:False
+    -   specify as key:value ex --bool-arg pixit_name:False
     -   used for custom arguments to scripts (PIXITs)
 
 ## PICS and PIXITS
@@ -438,7 +438,7 @@ See
     -   use --int-arg, --bool-arg etc on the command line to specify PIXITs
     -   Warn users if they don’t set required values, add instructions in the
         comments
--   ret = self.user_params.get("pixit_name", default)
+-   pixit_value = self.user_params.get("pixit_name", default)
 
 ## Support functions
 
@@ -474,7 +474,7 @@ second_ctrl = fa.new_fabric_admin.NewController(nodeId=node_id)
 -   basic_composition_support
     -   wildcard read, whole device analysis
 -   CommissioningFlowBlocks
-    -   various commissining support for core tests
+    -   various commissioning support for core tests
 -   spec_parsing_support
     -   parsing data model XML into python readable format
 
diff --git a/src/controller/python/chip/ChipDeviceCtrl.py b/src/controller/python/chip/ChipDeviceCtrl.py
