Skip to content

Commit 6658825

Browse files
committed
Update docstrings file heders
1 parent 1f7238f commit 6658825

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

plugwise/controller.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
"""Base for Plugwise messages."""
1+
"""
2+
Message controller for USB-Stick
3+
4+
The controller will:
5+
- handle the connection (connect/disconnect) to the USB-Stick
6+
- take care for message acknowledgements based on sequence id's
7+
- resend message requests when timeouts occurs
8+
- holds a sending queue (fifo)
9+
- passes received messages back to message processor (stick.py)
10+
- execution of callbacks after processing the response message
11+
12+
"""
213

314
from datetime import datetime, timedelta
415
import logging

plugwise/parser.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
"""Transform Plugwise message from wire format to response message object."""
1+
"""
2+
Data parser for USB-Stick
3+
4+
The parser will:
5+
- buffer receiving data
6+
- filter out received zigbee routing data
7+
- collect message data by detecting header and footer
8+
- detect message type based on message ID or fixed sequence ID
9+
- validate received data on checksum
10+
- decode collected data into a response message instance
11+
- pass over received messages to message_processor (controller.py)
12+
13+
"""
214

315
import logging
416

0 commit comments

Comments
 (0)