minor

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Tomas Fryza
+Copyright (c) 2023-2024 Tomas Fryza
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

modules/dht12.py

@@ -112,7 +112,6 @@ def humidity(self):
         `measure` method. 
 
         :returns: The current humidity as a percentage.
-        :rtype: float
 
         :Example:
 
@@ -133,7 +132,6 @@ def temperature(self):
         temperatures.
 
         :returns: The current temperature in degrees Celsius.
-        :rtype: float
 
         :Example:
 
@@ -155,7 +153,6 @@ def read_values(self):
 
         :returns: A tuple containing the temperature (float)
                   and humidity (float) values.
-        :rtype: tuple
         """
         self.measure()
         return self.temperature(), self.humidity()

modules/hw_config.py

@@ -50,7 +50,6 @@ def __init__(self, pin_number):
         Initialize the button on a specific GPIO pin with a pull-up resistor.
 
         :param pin_number: GPIO pin number where the button is connected.
-        :type pin_number: int
         """
         self.button = Pin(pin_number, Pin.IN, Pin.PULL_UP)
 
@@ -59,7 +58,6 @@ def is_pressed(self):
         Check if the button is currently pressed using active-low logic.
 
         :return: `True` if the button is pressed; `False` otherwise.
-        :rtype: bool
         """
         if self.button.value() == 0:  # Pressed button returns 0
             return True
@@ -76,7 +74,6 @@ def __init__(self, pin_number):
         Initialize the LED on a specific GPIO pin.
 
         :param pin_number: GPIO pin number where the LED is connected.
-        :type pin_number: int
         """
         # Calls Parent's __init__ without needing `self`
         super().__init__(pin_number, Pin.OUT)
@@ -93,9 +90,7 @@ def blink(self, duration=0.5, times=5):
 
         :param duration: Duration in seconds for each on/off cycle.
                          Default is 0.5 seconds.
-        :type duration: float
         :param times: Number of times the LED should blink. Default is 5.
-        :type times: int
         """
         for _ in range(times):
             self.on()
@@ -116,9 +111,7 @@ def __init__(self, pin_number, frequency=1000):
         starting with LED off.
 
         :param pin_number: GPIO pin number where the LED is connected.
-        :type pin_number: int
         :param frequency: PWM frequency for LED control. Default is 1000 Hz.
-        :type frequency: int
         """
         pin = Pin(pin_number, Pin.OUT)
         super().__init__(pin)
@@ -130,7 +123,6 @@ def set_brightness(self, brightness):
         Set the LED brightness using PWM.
 
         :param brightness: Brightness level as a percentage (0 to 100).
-        :type brightness: int
         """
         duty_cycle = int(brightness / 100 * 1023)  # Duty cycle 0 to 1023
         self.duty(duty_cycle)
@@ -141,7 +133,6 @@ def on(self, brightness=100):
 
         :param brightness: Brightness level as a percentage (0 to 100).
                            Default is 100%.
-        :type brightness: int
         """
         self.set_brightness(brightness)
 
@@ -157,7 +148,6 @@ def fade_in(self, duration=1):
 
         :param duration: Total duration of the fade-in effect, in seconds.
                          Default is 1 second.
-        :type duration: float
         """
         step_duration = duration / 100
         for i in range(100):
@@ -170,7 +160,6 @@ def fade_out(self, duration=1):
 
         :param duration: Total duration of the fade-out effect, in seconds.
                          Default is 1 second.
-        :type duration: float
         """
         step_duration = duration / 100
         for i in range(100, -1, -1):  # -1 to reach fully off

modules/wifi_module.py

@@ -47,14 +47,12 @@ def connect(wifi, ssid, password, timeout=10):
     specified timeout, it will terminate and return `False`.
     
     :param wifi: The Wi-Fi interface object to use for the connection.
-    :type wifi: network.WLAN
     :param str ssid: The SSID of the Wi-Fi network to connect to.
     :param str password: The password for the Wi-Fi network.
     :param int timeout: The maximum time in seconds to wait
                         for the connection attempt.
     :returns: `True` if connected successfully, `False` if
               the connection attempt timed out.
-    :rtype: bool
     """
     import time
 
@@ -90,7 +88,6 @@ def disconnect(wifi):
     the device is not connected to any Wi-Fi network.
 
     :param wifi: The Wi-Fi interface object to disconnect.
-    :type wifi: network.WLAN
     """
     if wifi.active():
         wifi.active(False)
@@ -109,7 +106,6 @@ def print_status(wifi):
 
     :param wifi: The Wi-Fi interface object whose status is to
                  be printed.
-    :type wifi: network.WLAN
     """
     status = wifi.status()
     print(f"[WIFI] {status_messages.get(status)}")