Skip to content

Commit fbf249d

Browse files
committed
docs: clarify internal usage of V1TraitDataConverter and V1TraitMixin attributes.
1 parent cc755d1 commit fbf249d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

roborock/devices/traits/v1/common.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@
1414

1515
_LOGGER = logging.getLogger(__name__)
1616

17+
1718
V1ResponseData = dict | list | int | str
1819

1920

2021
class V1TraitDataConverter:
2122
"""Converts responses to RoborockBase objects.
2223
24+
This is an internal class and should not be used directly by consumers.
2325
"""
2426

2527
@abstractmethod
@@ -54,7 +56,10 @@ class V1TraitMixin(ABC):
5456
"""
5557

5658
command: ClassVar[RoborockCommand]
59+
"""The RoborockCommand used to fetch the trait data from the device (internal only)."""
60+
5761
converter: V1TraitDataConverter
62+
"""The converter used to parse the response from the device (internal only)."""
5863

5964
def __init__(self) -> None:
6065
"""Initialize the V1TraitMixin."""

0 commit comments

Comments
 (0)