Merge branch 'main' of https://github.com/SolderedElectronics/Soldered-Micropython-modules

Author: JosipKuci

HallEffect/HallEffect/Examples/HallEffect-analogNative.py

@@ -1,27 +1,27 @@
-# FILE: HallEffect-analogNative.py 
+# FILE: HallEffect-analogNative.py
 # AUTHOR: Josip Šimun Kuči @ Soldered
 # BRIEF:  An example of getting the magnetic field value from the Hall Effect sensor
 # WORKS WITH: Hall effect sensor breakout with analog output: www.solde.red/333079
-# LAST UPDATED: 2025-06-10 
+# LAST UPDATED: 2025-06-10
 
 from HallEffect import HallEffectAnalog
 from time import sleep
 
-#Initialize the sensor in native mode by giving it the board pin connected to OUT pin
-sensor=HallEffectAnalog(pin=34)
+# Initialize the sensor in native mode by giving it the board pin connected to OUT pin
+sensor = HallEffectAnalog(pin=34)
 
-#Infinite loop
+# Infinite loop
 while 1:
-    #Get raw voltage value on OUT pin
-    analog=sensor.getReading()
+    # Get raw voltage value on OUT pin
+    analog = sensor.getReading()
 
-    #Get the raw voltage value converted into milli Teslas
-    reading=sensor.getMilliTeslas()
+    # Get the raw voltage value converted into milli Teslas
+    reading = sensor.getMilliTeslas()
 
-    #Print out the readings
-    print("ADC reading:",analog)
-    print("Magnetic field= ",reading,"mT")
-    #Empty row
+    # Print out the readings
+    print("ADC reading:", analog)
+    print("Magnetic field= ", reading, "mT")
+    # Empty row
     print()
-    #Pause for 1 second
-    sleep(1.0)
+    # Pause for 1 second
+    sleep(1.0)

HallEffect/HallEffect/Examples/HallEffect-analogQwiic.py

@@ -1,8 +1,8 @@
-# FILE: HallEffect-analogQwiic.py 
+# FILE: HallEffect-analogQwiic.py
 # AUTHOR: Josip Šimun Kuči @ Soldered
 # BRIEF:  An example of getting the magnetic field value from the Hall Effect sensor
 # WORKS WITH: Hall effect sensor breakout with analog output & easyC: www.solde.red/333082
-# LAST UPDATED: 2025-06-10 
+# LAST UPDATED: 2025-06-10
 
 from HallEffect import HallEffectAnalog
 from time import sleep
@@ -11,26 +11,25 @@
 # i2c = I2C(0, scl=Pin(22), sda=Pin(21))
 # sensor = HallEffectAnalog(i2c)
 
-#Initialize sensor over Qwiic
-sensor=HallEffectAnalog()
-
-#You can also set a custom I2C address in the initialization:
-#sensor=HallEffectAnalog(address=0x31)
+# Initialize sensor over Qwiic
+sensor = HallEffectAnalog()
 
+# You can also set a custom I2C address in the initialization:
+# sensor=HallEffectAnalog(address=0x31)
 
 
 while 1:
-    #Get raw voltage value
-    analog=sensor.getReading()
+    # Get raw voltage value
+    analog = sensor.getReading()
+
+    # Get the raw voltage value converted into milli Teslas
+    reading = sensor.getMilliTeslas()
 
-    #Get the raw voltage value converted into milli Teslas
-    reading=sensor.getMilliTeslas()
-    
-    #Print out the readings
-    print("ADC reading:",analog)
-    print("Magnetic field= ",reading,"mT")
+    # Print out the readings
+    print("ADC reading:", analog)
+    print("Magnetic field= ", reading, "mT")
 
-    #Empty row
+    # Empty row
     print()
-    #Pause for 1 second
-    sleep(1.0)
+    # Pause for 1 second
+    sleep(1.0)

HallEffect/HallEffect/Examples/HallEffect-digitalNative.py

@@ -1,21 +1,21 @@
-# FILE: HallEffect-digitalNative.py 
+# FILE: HallEffect-digitalNative.py
 # AUTHOR: Josip Šimun Kuči @ Soldered
 # BRIEF:  An example of detecting a magnetic field with the Hall Effect sensor
 # WORKS WITH: Hall effect sensor breakout with digital output: www.solde.red/333080
-# LAST UPDATED: 2025-06-10 
+# LAST UPDATED: 2025-06-10
 
 from HallEffect import HallEffectDigital
 from time import sleep
 
-#Initialize the sensor in native mode by giving it the board pin connected to OUT pin
-sensor=HallEffectDigital(pin=34)
+# Initialize the sensor in native mode by giving it the board pin connected to OUT pin
+sensor = HallEffectDigital(pin=34)
 
-#Infinite loop
+# Infinite loop
 while 1:
-    #Check if magnetic field is present
-    reading=sensor.getReading()
-    #If it is, print it out to inform the user
-    if(reading):
+    # Check if magnetic field is present
+    reading = sensor.getReading()
+    # If it is, print it out to inform the user
+    if reading:
         print("Magnet detected!")
-    #Pause for 1 second
-    sleep(1.0)
+    # Pause for 1 second
+    sleep(1.0)

HallEffect/HallEffect/Examples/HallEffect-digitalQwiic.py

@@ -1,28 +1,27 @@
-# FILE: HallEffect-digitalQwiic.py 
+# FILE: HallEffect-digitalQwiic.py
 # AUTHOR: Josip Šimun Kuči @ Soldered
 # BRIEF:  An example of detecting a magnetic field with the Hall Effect sensor
 # WORKS WITH: Hall effect sensor breakout with digital output & easyC: www.solde.red/333081
-# LAST UPDATED: 2025-06-10 
+# LAST UPDATED: 2025-06-10
 
 from HallEffect import HallEffectDigital
 from time import sleep
 # If you aren't using the Qwiic connector, manually enter your I2C pins
 # i2c = I2C(0, scl=Pin(22), sda=Pin(21))
 # sensor = HallEffectDigital(i2c)
 
-#Initialize sensor over I2C
-sensor=HallEffectDigital()
+# Initialize sensor over I2C
+sensor = HallEffectDigital()
 
-#You can also set a custom I2C address in the initialization:
-#sensor=HallEffectDigital(address=0x31)
+# You can also set a custom I2C address in the initialization:
+# sensor=HallEffectDigital(address=0x31)
 
-#Infinite loop
+# Infinite loop
 while 1:
-
-    #Check if magnetic field is present
-    reading=sensor.getReading()
-    #If it is, print it out to inform the user
-    if(reading):
+    # Check if magnetic field is present
+    reading = sensor.getReading()
+    # If it is, print it out to inform the user
+    if reading:
         print("Magnet detected!")
-    #Pause for 1 second
-    sleep(1.0)
+    # Pause for 1 second
+    sleep(1.0)

HallEffect/HallEffect/HallEffect.py

@@ -1,19 +1,19 @@
-# FILE: HallEffect.py 
+# FILE: HallEffect.py
 # AUTHOR: Josip Šimun Kuči @ Soldered
-# BRIEF: A Micropython module used for the Hall Effect sensor family of products, supports both 
+# BRIEF: A Micropython module used for the Hall Effect sensor family of products, supports both
 #        Digital and Analog versions as well as the native and Qwiic variants
-# LAST UPDATED: 2025-06-10 
+# LAST UPDATED: 2025-06-10
 
 from os import uname
 from Qwiic import Qwiic
-from machine import Pin,I2C,ADC
+from machine import Pin, I2C, ADC
 
 
-ANALOG_READ_REG=0
+ANALOG_READ_REG = 0
 
 
 class HallEffectAnalog(Qwiic):
-    def __init__(self,i2c=None,address=0x30,pin=None):
+    def __init__(self, i2c=None, address=0x30, pin=None):
         """
         Initializes the Hall Effect Sensor.
 
@@ -22,23 +22,23 @@ def __init__(self,i2c=None,address=0x30,pin=None):
         :param pin: GPIO pin number for native mode. If provided, native mode is used.
         """
         if uname().sysname == "esp32":
-            self.VOLTAGE_RES=3.3
-            self.ADC_MAX=4096
-            self.NUM_BITS=12
+            self.VOLTAGE_RES = 3.3
+            self.ADC_MAX = 4096
+            self.NUM_BITS = 12
         elif uname().sysname == "esp8266":
-            self.VOLTAGE_RES=3.3
-            self.ADC_MAX=1024
-            self.NUM_BITS=10
+            self.VOLTAGE_RES = 3.3
+            self.ADC_MAX = 1024
+            self.NUM_BITS = 10
         else:
-            self.VOLTAGE_RES=5
-            self.ADC_MAX=1024
-            self.NUM_BITS=10
-        
+            self.VOLTAGE_RES = 5
+            self.ADC_MAX = 1024
+            self.NUM_BITS = 10
+
         if pin is not None:
             # Native mode
             super().__init__(i2c=None, native=True)
             self.pin = ADC(pin)
-            self.native=True
+            self.native = True
             self.pin.atten(ADC.ATTN_11DB)
         else:
             if i2c != None:
@@ -49,39 +49,40 @@ def __init__(self,i2c=None,address=0x30,pin=None):
                 else:
                     raise Exception("Board not recognized, enter I2C pins manually")
             super().__init__(i2c=i2c, address=address, native=False)
-        
+
     def initialize_native(self):
         """
         Setup for native GPIO input.
         """
         # Already initialized in __init__
         pass
-    
+
     def getReading(self) -> int:
         if self.native:
             return self.pin.read()
         else:
-            data = self.read_register(ANALOG_READ_REG,2)
-            value=data[1]<<8|data[0]
+            data = self.read_register(ANALOG_READ_REG, 2)
+            value = data[1] << 8 | data[0]
             return value
-    
+
     def getMilliTeslas(self) -> float:
-        value=self.getReading()
+        value = self.getReading()
         if self.native:
             if uname().sysname == "esp32":
-                if (value >= 2710):
+                if value >= 2710:
                     return (value - 2710.0) * (20.47 - 0.0) / (4095.0 - 2710.0) + 0.0
                 else:
                     return (value) * (20.47) / (2710.0) - 20.47
             else:
-                return 20.47 * (self.NUM_BITS * (value / (self.ADC_MAX - 1)) / self.VOLTAGE_RES - 1)
+                return 20.47 * (
+                    self.NUM_BITS * (value / (self.ADC_MAX - 1)) / self.VOLTAGE_RES - 1
+                )
         else:
             return 20.47 * (10 * (value / 1023.0) / 5.0 - 1)
-        
-        
-        
+
+
 class HallEffectDigital(Qwiic):
-    def __init__(self,i2c=None,address=0x30,pin=None):
+    def __init__(self, i2c=None, address=0x30, pin=None):
         """
         Initializes the Hall Effect Sensor.
 
@@ -94,7 +95,7 @@ def __init__(self,i2c=None,address=0x30,pin=None):
             # Native mode
             super().__init__(i2c=None, native=True)
             self.pin = Pin(pin, Pin.IN)
-            self.native=True
+            self.native = True
         else:
             if i2c != None:
                 i2c = i2c
@@ -104,18 +105,17 @@ def __init__(self,i2c=None,address=0x30,pin=None):
                 else:
                     raise Exception("Board not recognized, enter I2C pins manually")
             super().__init__(i2c=i2c, address=address, native=False)
-        
+
     def initialize_native(self):
         """
         Setup for native GPIO input.
         """
         # Already initialized in __init__
         pass
-    
+
     def getReading(self) -> int:
         if self.native:
             return not (self.pin.value())
         else:
-            data = self.read_register(0,2)
+            data = self.read_register(0, 2)
             return not (data[1])
-