Skip to content

Commit

Permalink
[Python] Add missing attribute read parameters to docs (#34380)
Browse files Browse the repository at this point in the history
Add documentation for all parameters of the Read/ReadAttribute/ReadEvent
functions in the Python controller.
  • Loading branch information
agners authored and pull[bot] committed Sep 9, 2024
1 parent 8b1ee7d commit 1030464
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/controller/python/chip/ChipDeviceCtrl.py
Original file line number Diff line number Diff line change
Expand Up @@ -1436,6 +1436,13 @@ async def Read(self, nodeid: int, attributes: typing.List[typing.Union[
reportInterval: A tuple of two int-s for (MinIntervalFloor, MaxIntervalCeiling). Used by establishing subscriptions.
When not provided, a read request will be sent.
fabricFiltered: If True (default), the read/subscribe is fabric-filtered and will only see things associated with the fabric
of the reader/subscriber. Relevant for attributes with fabric-scoped data.
keepSubscriptions: Keep existing subscriptions. If set to False, existing subscriptions with this node will get cancelled
and a new one gets setup.
autoResubscribe: Automatically resubscribe to the subscription if subscription is lost. The automatic re-subscription only
applies if the subscription establishes on first try. If the first subscription establishment attempt fails the function
returns right away.
Returns:
- AsyncReadTransaction.ReadResponse. Please see ReadAttribute and ReadEvent for examples of how to access data.
Expand Down Expand Up @@ -1505,6 +1512,13 @@ async def ReadAttribute(self, nodeid: int, attributes: typing.List[typing.Union[
reportInterval: A tuple of two int-s for (MinIntervalFloor, MaxIntervalCeiling). Used by establishing subscriptions.
When not provided, a read request will be sent.
fabricFiltered: If True (default), the read/subscribe is fabric-filtered and will only see things associated with the fabric
of the reader/subscriber. Relevant for attributes with fabric-scoped data.
keepSubscriptions: Keep existing subscriptions. If set to False, existing subscriptions with this node will get cancelled
and a new one gets setup.
autoResubscribe: Automatically resubscribe to the subscription if subscription is lost. The automatic re-subscription only
applies if the subscription establishes on first try. If the first subscription establishment attempt fails the function
returns right away.
Returns:
- subscription request: ClusterAttribute.SubscriptionTransaction
Expand Down Expand Up @@ -1581,6 +1595,11 @@ async def ReadEvent(self, nodeid: int, events: typing.List[typing.Union[
eventNumberFilter: Optional minimum event number filter.
reportInterval: A tuple of two int-s for (MinIntervalFloor, MaxIntervalCeiling). Used by establishing subscriptions.
When not provided, a read request will be sent.
keepSubscriptions: Keep existing subscriptions. If set to False, existing subscriptions with this node will get cancelled
and a new one gets setup.
autoResubscribe: Automatically resubscribe to the subscription if subscription is lost. The automatic re-subscription only
applies if the subscription establishes on first try. If the first subscription establishment attempt fails the function
returns right away.
Returns:
- subscription request: ClusterAttribute.SubscriptionTransaction
Expand Down

0 comments on commit 1030464

Please sign in to comment.