Skip to content

Commit 4effe4b

Browse files
agnersj-ororke
authored andcommitted
[Python] Add missing attribute read parameters to docs (project-chip#34380)
Add documentation for all parameters of the Read/ReadAttribute/ReadEvent functions in the Python controller.
1 parent 2320111 commit 4effe4b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/controller/python/chip/ChipDeviceCtrl.py

+19
Original file line numberDiff line numberDiff line change
@@ -1436,6 +1436,13 @@ async def Read(self, nodeid: int, attributes: typing.List[typing.Union[
14361436
14371437
reportInterval: A tuple of two int-s for (MinIntervalFloor, MaxIntervalCeiling). Used by establishing subscriptions.
14381438
When not provided, a read request will be sent.
1439+
fabricFiltered: If True (default), the read/subscribe is fabric-filtered and will only see things associated with the fabric
1440+
of the reader/subscriber. Relevant for attributes with fabric-scoped data.
1441+
keepSubscriptions: Keep existing subscriptions. If set to False, existing subscriptions with this node will get cancelled
1442+
and a new one gets setup.
1443+
autoResubscribe: Automatically resubscribe to the subscription if subscription is lost. The automatic re-subscription only
1444+
applies if the subscription establishes on first try. If the first subscription establishment attempt fails the function
1445+
returns right away.
14391446
14401447
Returns:
14411448
- AsyncReadTransaction.ReadResponse. Please see ReadAttribute and ReadEvent for examples of how to access data.
@@ -1505,6 +1512,13 @@ async def ReadAttribute(self, nodeid: int, attributes: typing.List[typing.Union[
15051512
15061513
reportInterval: A tuple of two int-s for (MinIntervalFloor, MaxIntervalCeiling). Used by establishing subscriptions.
15071514
When not provided, a read request will be sent.
1515+
fabricFiltered: If True (default), the read/subscribe is fabric-filtered and will only see things associated with the fabric
1516+
of the reader/subscriber. Relevant for attributes with fabric-scoped data.
1517+
keepSubscriptions: Keep existing subscriptions. If set to False, existing subscriptions with this node will get cancelled
1518+
and a new one gets setup.
1519+
autoResubscribe: Automatically resubscribe to the subscription if subscription is lost. The automatic re-subscription only
1520+
applies if the subscription establishes on first try. If the first subscription establishment attempt fails the function
1521+
returns right away.
15081522
15091523
Returns:
15101524
- subscription request: ClusterAttribute.SubscriptionTransaction
@@ -1581,6 +1595,11 @@ async def ReadEvent(self, nodeid: int, events: typing.List[typing.Union[
15811595
eventNumberFilter: Optional minimum event number filter.
15821596
reportInterval: A tuple of two int-s for (MinIntervalFloor, MaxIntervalCeiling). Used by establishing subscriptions.
15831597
When not provided, a read request will be sent.
1598+
keepSubscriptions: Keep existing subscriptions. If set to False, existing subscriptions with this node will get cancelled
1599+
and a new one gets setup.
1600+
autoResubscribe: Automatically resubscribe to the subscription if subscription is lost. The automatic re-subscription only
1601+
applies if the subscription establishes on first try. If the first subscription establishment attempt fails the function
1602+
returns right away.
15841603
15851604
Returns:
15861605
- subscription request: ClusterAttribute.SubscriptionTransaction

0 commit comments

Comments
 (0)