Skip to content

Commit

Permalink
ChipDeviceCtrl: Fix type & doc for WriteAttribute (#30824)
Browse files Browse the repository at this point in the history
I went one layer too low when I wrote the documentation for the
return type. Also, the type hint for attributes is wrong - I think
this was copied from events, which include urgency. But write does
not have or need that. Documentation and normal useage match the
new type hint.
  • Loading branch information
cecille authored Dec 5, 2023
1 parent 406ed8d commit 8677d1a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/controller/python/chip/ChipDeviceCtrl.py
Original file line number Diff line number Diff line change
Expand Up @@ -880,7 +880,7 @@ def SendGroupCommand(self, groupid: int, payload: ClusterObjects.ClusterCommand,
return None

async def WriteAttribute(self, nodeid: int,
attributes: typing.List[typing.Tuple[int, ClusterObjects.ClusterAttributeDescriptor, int]],
attributes: typing.List[typing.Tuple[int, ClusterObjects.ClusterAttributeDescriptor]],
timedRequestTimeoutMs: typing.Union[None, int] = None,
interactionTimeoutMs: typing.Union[None, int] = None, busyWaitMs: typing.Union[None, int] = None):
'''
Expand All @@ -897,7 +897,7 @@ async def WriteAttribute(self, nodeid: int,
to the XYZ attribute on the test cluster to endpoint 1
Returns:
- [PyChipError] (list - one for each pth)
- [AttributeStatus] (list - one for each pth)
'''
self.CheckIsActive()

Expand Down

0 comments on commit 8677d1a

Please sign in to comment.