Cleaning the code

Author: javanese-programmer

hardware/plc.py

@@ -1,24 +1,27 @@
-"""Module for Modbus Communication with PLC"""
+"""Module for Modbus Communication with PLC."""
 
 from pymodbus.client.sync import ModbusTcpClient
 from pyModbusTCP.server import DataBank, DeviceIdentification
 
+
 def prepare_server():
-    """Prepare server properties"""
+    """Prepare server properties."""
     identity = DeviceIdentification(
         vendor_name=b"Lab. Schneider DTETI UGM",
         product_code=b"MCD",
         major_minor_revision=b"1.0",
         vendor_url=b"https://github.com/javanese-programmer/conveyor-object-detection",
         product_name=b"McDetector",
         model_name=b"McDetector-1",
-        user_application_name=b"Conveyor Object Detection"
+        user_application_name=b"Conveyor Object Detection",
     )
     databank = DataBank()
     return databank, identity
 
+
 def server_set_di(databank: DataBank, bit_value: str):
-    """Set a value to Discretes Input of a server
+    """Set values to Discrete Inputs of a server.
+
     Args:
         databank: a DataBank object that store data
         bit_value: binary value in string format
@@ -28,10 +31,11 @@ def server_set_di(databank: DataBank, bit_value: str):
     for addr, bit in enumerate(bit_value):
         databank.set_discrete_inputs(addr, [int(bit)])
     print("Discretes Inputs updated!")
-    
+
 
 def server_set_ir(databank: DataBank, values: tuple):
-    """Set a value to Input Registers of a server
+    """Set values to Input Registers of a server.
+
     Args:
         databank: a DataBank object that store data
         values: tuple of values to be written to register
@@ -43,49 +47,52 @@ def server_set_ir(databank: DataBank, values: tuple):
     print("Input registers updated!")
 
 
-class PLC():
-    """PLC Client Class"""
-    
+class PLC:
+    """PLC Client Class."""
+
     def __init__(self, ip_address: str):
-        """Constructor method
+        """Init object instance of the class.
+
         Args:
             ip_address: IP address of PLC to be connected
         """
         # Define attribute for PLC IP Address
         self.plc_ip = ip_address
-        
+
     def write_words(self, values: tuple):
-        """Write PLC Registers through Modbus TCP Communication
+        """Write PLC Registers through Modbus TCP Communication.
+
         Args:
             values: tuple of values to be written to register
         """
         # Define Modbus TCP Client and connect to it
         client = ModbusTcpClient(self.plc_ip)
         client.connect()
-        
+
         # Write value to registers: %MW0, %MW1, and so on
         print("Writing value to PLC registers...")
         for reg, val in enumerate(values):
             client.write_registers(reg, int(val))
         print("Writing operation done!")
-        
+
         # Close connection
         client.close()
-        
+
     def write_bits(self, bit_value: str):
-        """Write PLC Coils through Modbus TCP Communication
+        """Write PLC Coils through Modbus TCP Communication.
+
         Args:
             bit_value: binary value in string format
         """
         # Define Modbus TCP Client and connect to it
         client = ModbusTcpClient(self.plc_ip)
         client.connect()
-        
+
         # Write value to coils: %M0, %M1, and so on
         print("Writing value to PLC coils...")
         for coil, bit in enumerate(bit_value):
             client.write_coils(coil, [int(bit)])
         print("Writing operation done!")
-            
+
         # Close connection
-        client.close()
+        client.close()

hardware/sensor.py

@@ -1,44 +1,48 @@
-""" Script to define GPIO, sensor, and actuator """
+"""Script to initiate GPIO, sensor, and actuator."""
 
 from RPi import GPIO
-from time import sleep
+
 
 def prepare_gpio():
-    """Function to prepare GPIO"""
+    """Prepare GPIO before being used."""
     GPIO.setmode(GPIO.BOARD)
     GPIO.setwarnings(False)
-    
+
+
 def clean_gpio():
-    """Function to clean GPIO port"""
+    """Clean GPIO port after being used."""
     GPIO.cleanup()
 
-class Infrared():
-    """ IR Sensor Class """
-    
+
+class Infrared:
+    """IR Sensor Class."""
+
     def __init__(self, right_ir: int, left_ir: int):
-        """ Contructor method
+        """Init object instance of the class.
+
         Args:
             right_ir (int): Right IR Sensor Pin
             left_ir (int): Left IR Sensor pin
         """
         self.right_ir = right_ir
         self.left_ir = left_ir
-        
+
         GPIO.setup(self.right_ir, GPIO.IN)
         GPIO.setup(self.left_ir, GPIO.IN)
-        
+
     def read_sensor(self):
-        """Method to detect object presence using IR"""
+        """Detect object's presence using IR."""
         right_read = GPIO.input(self.right_ir)
         left_read = GPIO.input(self.left_ir)
         return right_read, left_read
 
 
-class Led():
-    """ LED Class """
-    
+class Led:
+    """LED Class."""
+
     def __init__(self, yellow, red, blue):
-        """ Contructor method
+        """Init object instance of the class.
+
         Args:
             yellow (int): Yellow LED Pin
             red (int): Red LED pin
@@ -47,15 +51,16 @@ def __init__(self, yellow, red, blue):
         self.yellow = yellow
         self.red = red
         self.blue = blue
-        
+
         GPIO.setup(self.yellow, GPIO.OUT)
         GPIO.setup(self.red, GPIO.OUT)
         GPIO.setup(self.blue, GPIO.OUT)
-        
+
     def turn_on(self, index: int):
-        """Method to turn-on an LED according to detected object
+        """Turn-on an LED according to detected object.
+        
         Args:
-            index: Index of detected object class 
+            index: Index of detected object class
         """
         if index == 0:
             GPIO.output(self.yellow, True)
@@ -73,9 +78,9 @@ def turn_on(self, index: int):
             GPIO.output(self.yellow, False)
             GPIO.output(self.red, False)
             GPIO.output(self.blue, False)
-        
+
     def turn_off(self):
-        """Method to turn-off all LED"""
+        """Turn-off all LED."""
         GPIO.output(self.yellow, False)
         GPIO.output(self.red, False)
-        GPIO.output(self.blue, False)
+        GPIO.output(self.blue, False)