From 10304640405532ea475a73909baf43c8bca44176 Mon Sep 17 00:00:00 2001 From: Stefan Agner Date: Wed, 17 Jul 2024 21:20:52 +0100 Subject: [PATCH] [Python] Add missing attribute read parameters to docs (#34380) Add documentation for all parameters of the Read/ReadAttribute/ReadEvent functions in the Python controller. --- src/controller/python/chip/ChipDeviceCtrl.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/controller/python/chip/ChipDeviceCtrl.py b/src/controller/python/chip/ChipDeviceCtrl.py index 5023a1946e4b9d..4e1c5d6678ed3e 100644 --- a/src/controller/python/chip/ChipDeviceCtrl.py +++ b/src/controller/python/chip/ChipDeviceCtrl.py @@ -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. @@ -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 @@ -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