Standardize logging for stick

Author: brefra

plugwise/connections/connection.py

@@ -3,12 +3,16 @@
 
 Base for serial or socket connections
 """
-from plugwise.constants import SLEEP_TIME
-from plugwise.message import PlugwiseMessage
+import logging
 import queue
 import threading
 import time
 
+from plugwise.constants import SLEEP_TIME
+from plugwise.message import PlugwiseMessage
+
+_LOGGER = logging.getLogger(__name__)
+
 
 class StickConnection(object):
     """ Generic Plugwise stick connection"""
@@ -51,7 +55,7 @@ def _reader_deamon(self):
             if data:
                 self.stick.feed_parser(data)
             time.sleep(0.01)
-        self.stick.logger.debug("Reader deamon stopped")
+        _LOGGER.debug("Reader deamon stopped")
 
     def _read_data(self):
         """Placeholder to receive message from the connection"""
@@ -77,7 +81,7 @@ def _writer_deamon(self):
             except queue.Empty:
                 time.sleep(SLEEP_TIME)
             else:
-                self.stick.logger.debug(
+                _LOGGER.debug(
                     "Sending %s to plugwise stick (%s)",
                     message.__class__.__name__,
                     message.serialize(),
@@ -86,7 +90,7 @@ def _writer_deamon(self):
                 time.sleep(SLEEP_TIME)
                 if callback:
                     callback()
-        self.stick.logger.debug("Writer deamon stopped")
+        _LOGGER.debug("Writer deamon stopped")
 
     def _write_data(self, data):
         """Placeholder to write message to the connection"""

plugwise/connections/serial.py

@@ -3,7 +3,9 @@
 
 Serial connection
 """
+import logging
 import serial
+
 from plugwise.constants import (
     BAUD_RATE,
     BYTE_SIZE,
@@ -15,6 +17,8 @@
 from plugwise.exceptions import PortError
 from plugwise.message import PlugwiseMessage
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class PlugwiseUSBConnection(StickConnection):
     """simple wrapper around serial module"""
@@ -28,7 +32,7 @@ def __init__(self, port, stick=None):
 
     def _open_connection(self):
         """Open serial port"""
-        self.stick.logger.debug("Open serial port %s", self.port)
+        _LOGGER.debug("Open serial port %s", self.port)
         try:
             self._serial = serial.Serial(
                 port=self.port,
@@ -39,7 +43,7 @@ def _open_connection(self):
                 timeout=1,
             )
         except serial.serialutil.SerialException as err:
-            self.stick.logger.debug(
+            _LOGGER.debug(
                 "Failed to connect to serial port %s, %s",
                 self.port,
                 err,
@@ -49,11 +53,9 @@ def _open_connection(self):
         if self._is_connected:
             self._reader_start("serial_reader_thread")
             self._writer_start("serial_writer_thread")
-            self.stick.logger.debug(
-                "Successfully connected to serial port %s", self.port
-            )
+            _LOGGER.debug("Successfully connected to serial port %s", self.port)
         else:
-            self.stick.logger.error(
+            _LOGGER.error(
                 "Failed to open serial port %s",
                 self.port,
             )
@@ -63,7 +65,7 @@ def _close_connection(self):
         try:
             self._serial.close()
         except serial.serialutil.SerialException as err:
-            self.stick.logger.debug(
+            _LOGGER.debug(
                 "Failed to close serial port %s, %s",
                 self.port,
                 err,
@@ -76,13 +78,11 @@ def _read_data(self):
             try:
                 serial_data = self._serial.read_all()
             except serial.serialutil.SerialException as err:
-                self.stick.logger.debug(
-                    "Error while reading data from serial port : %s", err
-                )
+                _LOGGER.debug("Error while reading data from serial port : %s", err)
                 self._is_connected = False
                 raise PortError(err)
             except Exception as e:
-                self.stick.logger.debug("Error _read_data : %s", err)
+                _LOGGER.debug("Error _read_data : %s", err)
             return serial_data
         return None
 
@@ -91,6 +91,6 @@ def _write_data(self, data):
         try:
             self._serial.write(data)
         except serial.serialutil.SerialException as err:
-            self.stick.logger.debug("Error while writing data to serial port : %s", err)
+            _LOGGER.debug("Error while writing data to serial port : %s", err)
             self._is_connected = False
             raise PortError(err)

plugwise/connections/socket.py

@@ -5,11 +5,14 @@
 """
 import logging
 import socket
+
 from plugwise.constants import SLEEP_TIME
 from plugwise.connections.connection import StickConnection
 from plugwise.exceptions import PortError
 from plugwise.message import PlugwiseMessage
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class SocketConnection(StickConnection):
     """
@@ -26,7 +29,7 @@ def __init__(self, port, stick=None):
 
     def _open_connection(self):
         """Open socket"""
-        self.stick.logger.debug(
+        _LOGGER.debug(
             "Open socket to host '%s' at port %s",
             self._socket_host,
             str(self._socket_port),
@@ -35,7 +38,7 @@ def _open_connection(self):
             self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             self._socket.connect(self._socket_address)
         except Exception as err:
-            self.stick.logger.debug(
+            _LOGGER.debug(
                 "Failed to connect to host %s at port %s, %s",
                 self._socket_host,
                 str(self._socket_port),
@@ -46,7 +49,7 @@ def _open_connection(self):
             self._reader_start("socket_reader_thread")
             self._writer_start("socket_writer_thread")
             self._is_connected = True
-            self.stick.logger.debug(
+            _LOGGER.debug(
                 "Successfully connected to host '%s' at port %s",
                 self._socket_host,
                 str(self._socket_port),
@@ -57,7 +60,7 @@ def _close_connection(self):
         try:
             self._socket.close()
         except Exception as err:
-            self.stick.logger.debug(
+            _LOGGER.debug(
                 "Failed to close socket to host %s at port %s, %s",
                 self._socket_host,
                 str(self._socket_port),
@@ -71,7 +74,7 @@ def _read_data(self):
             try:
                 socket_data = self._socket.recv(9999)
             except Exception as err:
-                self.stick.logger.debug(
+                _LOGGER.debug(
                     "Error while reading data from host %s at port %s : %s",
                     self._socket_host,
                     str(self._socket_port),
@@ -88,6 +91,6 @@ def _write_data(self, data):
         try:
             self._socket.send(data)
         except Exception as err:
-            self.stick.logger.debug("Error while writing data to socket port : %s", err)
+            _LOGGER.debug("Error while writing data to socket port : %s", err)
             self._is_connected = False
             raise PortError(err)

plugwise/node.py

@@ -3,7 +3,9 @@
 
 General node object to control associated plugwise nodes like: Circle+, Circle, Scan, Stealth
 """
+import logging
 from datetime import datetime
+
 from plugwise.constants import (
     HA_SWITCH,
     HW_MODELS,
@@ -27,14 +29,16 @@
 )
 from plugwise.util import validate_mac
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class PlugwiseNode(object):
     """ Base class for a Plugwise node """
 
     def __init__(self, mac, address, stick):
         mac = mac.upper()
         if validate_mac(mac) == False:
-            self.stick.logger.debug(
+            _LOGGER.debug(
                 "MAC address is in unexpected format: %s",
                 str(mac),
             )
@@ -103,7 +107,7 @@ def set_available(self, state, request_info=False):
         if state == True:
             if self._available == False:
                 self._available = True
-                self.stick.logger.debug(
+                _LOGGER.debug(
                     "Mark node %s available",
                     self.get_mac(),
                 )
@@ -113,7 +117,7 @@ def set_available(self, state, request_info=False):
         else:
             if self._available == True:
                 self._available = False
-                self.stick.logger.debug(
+                _LOGGER.debug(
                     "Mark node %s unavailable",
                     self.get_mac(),
                 )
@@ -189,7 +193,7 @@ def on_message(self, message):
         assert isinstance(message, PlugwiseMessage)
         if message.mac == self.mac:
             if message.timestamp != None:
-                self.stick.logger.debug(
+                _LOGGER.debug(
                     "Last update %s of node %s, last message %s",
                     str(self.last_update),
                     self.get_mac(),
@@ -206,7 +210,7 @@ def on_message(self, message):
                 self._on_message(message)
                 self.set_available(True)
         else:
-            self.stick.logger.debug(
+            _LOGGER.debug(
                 "Skip message, mac of node (%s) != mac at message (%s)",
                 message.mac.decode(UTF8_DECODE),
                 self.get_mac(),
@@ -236,7 +240,7 @@ def do_callback(self, sensor):
                 try:
                     callback(None)
                 except Exception as e:
-                    self.stick.logger.error(
+                    _LOGGER.error(
                         "Error while executing all callback : %s",
                         e,
                     )
@@ -256,7 +260,7 @@ def _process_ping_response(self, message):
 
     def _process_info_response(self, message):
         """ Process info response message"""
-        self.stick.logger.debug("Response info message for node %s", self.get_mac())
+        _LOGGER.debug("Response info message for node %s", self.get_mac())
         self.set_available(True)
         if message.relay_state.serialize() == b"01":
             if not self._relay_state:
@@ -273,15 +277,15 @@ def _process_info_response(self, message):
         if self._last_log_address != message.last_logaddr.value:
             self._last_log_address = message.last_logaddr.value
             self._last_log_collected = False
-        self.stick.logger.debug("Node type        = %s", self.get_node_type())
+        _LOGGER.debug("Node type        = %s", self.get_node_type())
         if not self.is_sed:
-            self.stick.logger.debug("Relay state      = %s", str(self._relay_state))
-        self.stick.logger.debug("Hardware version = %s", str(self._hardware_version))
-        self.stick.logger.debug("Firmware version = %s", str(self._firmware_version))
+            _LOGGER.debug("Relay state      = %s", str(self._relay_state))
+        _LOGGER.debug("Hardware version = %s", str(self._hardware_version))
+        _LOGGER.debug("Firmware version = %s", str(self._firmware_version))
 
     def _process_features_response(self, message):
         """ Process features message """
-        self.stick.logger.info(
+        _LOGGER.info(
             "Node %s supports features %s", self.get_mac(), str(message.features.value)
         )
         self._features = message.features.value