Update to pythonic naming convention

Changed all function, variable, and object names from camel case to underscores

Author: makin-stuff

examples/qwiic_button_ex1_buttonPress.py

@@ -44,20 +44,20 @@
 import time
 import sys
 
-def runExample():
+def run_example():
 
     print("\nSparkFun Qwiic Button Example 1")
-    myButton = qwiic_button.QwiicButton()
+    my_button = qwiic_button.Qwiic_Button()
 
-    if myButton.begin() == False:
+    if my_button.begin() == False:
         print("\nThe Qwiic Button isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
     print("\nButton ready!")
 
     while True:   
 
-        if myButton.isButtonPressed() == True:
+        if my_button.is_button_pressed() == True:
             print("\nThe button is pressed!")
 
         else:    
@@ -67,7 +67,7 @@ def runExample():
 
 if __name__ == '__main__':
     try:
-        runExample()
+        run_example()
     except (KeyboardInterrupt, SystemExit) as exErr:
         print("\nEnding Example 1")
         sys.exit(0)

examples/qwiic_button_ex2_LEDon.py

@@ -46,12 +46,12 @@
 
 brightness = 100
 
-def runExample():
+def run_example():
 
     print("\nSparkFun Qwiic Button Example 2")
-    myButton = qwiic_button.QwiicButton()
+    my_button = qwiic_button.Qwiic_Button()
 
-    if myButton.begin() == False:
+    if my_button.begin() == False:
         print("\nThe Qwiic Button isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
@@ -60,19 +60,19 @@ def runExample():
 
     while True:
 
-        if myButton.isButtonPressed() == True:
+        if my_button.is_button_pressed() == True:
             print("\nThe button is pressed!")
-            myButton.LEDon(brightness)
+            my_button.LED_on(brightness)
 
         else:
             print("\nThe button is not pressed.")
-            myButton.LEDoff()
+            my_button.LED_off()
 
         time.sleep(0.02)
 
 if __name__ == '__main__':
     try:
-        runExample()
+        run_example()
     except (KeyboardInterrupt, SystemExit) as exErr:
         print("\nEnding Example 2")
         sys.exit(0)

examples/qwiic_button_ex3_LEDconfig.py

@@ -45,39 +45,39 @@
 import sys
 
 brightness = 250    # The maximum brightness of the pulsing LED. Can be between 0 and 255
-cycleTime = 1000    # The total time for the pulse to take. Set to a bigger number for a slower pulse or a smaller number for a faster pulse
-offTime = 200       # The total time to stay off between pulses. Set to 0 to be pulsing continuously.
+cycle_time = 1000    # The total time for the pulse to take. Set to a bigger number for a slower pulse or a smaller number for a faster pulse
+off_time = 200       # The total time to stay off between pulses. Set to 0 to be pulsing continuously.
 
-def runExample():
+def run_example():
 
     print("\nSparkFun Qwiic Button Example 3")
-    myButton = qwiic_button.QwiicButton()
+    my_button = qwiic_button.Qwiic_Button()
 
-    if myButton.begin() == False:
+    if my_button.begin() == False:
         print("\nThe Qwiic Button isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
 
     print("\nButton ready!")
 
-    myButton.LEDoff()
+    my_button.LED_off()
 
     while True:
 
-        if myButton.isButtonPressed() == True:
+        if my_button.is_button_pressed() == True:
 
             print("\nThe button is pressed!")
-            myButton.LEDconfig(brightness, cycleTime, offTime)
+            my_button.LED_config(brightness, cycle_time, off_time)
 
         else:
             print("\nThe button is not pressed.")
-            myButton.LEDoff()
+            my_button.LED_off()
 
         time.sleep(0.02)    # Let's not hammer too hard on the I2C bus
 
 if __name__ == '__main__':
     try:
-        runExample()
+        run_example()
     except (KeyboardInterrupt, SystemExit) as exErr:
         print("\nEnding Example 3")
         sys.exit(0)

examples/qwiic_button_ex4_queueUsage.py

@@ -43,12 +43,12 @@
 import time
 import sys
 
-def runExample():
+def run_example():
 
     print("\nSparkFun Qwiic Button Example 4")
-    myButton = qwiic_button.QwiicButton()
+    my_button = qwiic_button.Qwiic_Button()
 
-    if myButton.begin() == False:
+    if my_button.begin() == False:
         print("\nThe Qwiic Button isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
@@ -58,28 +58,28 @@ def runExample():
     while True:
 
         # If the queue of pressed events is not empty
-        if myButton.isPressedQueueEmpty() == False:
+        if my_button.is_pressed_queue_empty() == False:
             # Then print the time since the last and first button press
-            print("\n" + str(myButton.timeSinceLastPress() / 1000.0) + "s since he button was last pressed   ")
-            print(str(myButton.timeSinceFirstPress() / 1000.0) +"s since the button was first pressed ")
+            print("\n" + str(my_button.time_since_last_press() / 1000.0) + "s since he button was last pressed   ")
+            print(str(my_button.time_since_first_press() / 1000.0) +"s since the button was first pressed ")
         # If the queue is empty
         else: 
-            print("\nButtonPressed Queue is empty! ")
+            print("\nButton Pressed Queue is empty! ")
 
         # If the queue of clicked events is not empty
-        if myButton.isClickedQueueEmpty() == False:
+        if my_button.is_clicked_queue_empty() == False:
             # Then print the time since the last and first button click
-            print("\n" + str(myButton.timeSinceLastClick() / 1000.0) + "s since the button was last clicked  ")
-            print(str(myButton.timeSinceFirstClick() / 1000.0) + "s since the button was first clicked")
+            print("\n" + str(my_button.time_since_last_click() / 1000.0) + "s since the button was last clicked  ")
+            print(str(my_button.time_since_first_click() / 1000.0) + "s since the button was first clicked")
         # If the queue is empty
         else:
-            print("\nButtonClicked Queue is empty!")
+            print("\nButton Clicked Queue is empty!")
 
         time.sleep(0.02)    # Let's not hammer too hard on the I2C bus
 
 if __name__ == '__main__':
     try:
-        runExample()
+        run_example()
     except (KeyboardInterrupt, SystemExit) as exErr:
         print("\nEnding Example 4")
         sys.exit(0)

examples/qwiic_button_ex5_popQueue.py

@@ -43,12 +43,12 @@
 import time
 import sys
 
-def runExample():
+def run_example():
 
     print("\nSparkFun Qwiic Button Example 5")
-    myButton = qwiic_button.QwiicButton()
+    my_button = qwiic_button.Qwiic_Button()
 
-    if myButton.begin() == False:
+    if my_button.begin() == False:
         print("\nThe Qwiic Button isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
@@ -61,18 +61,18 @@ def runExample():
         val = raw_input("Type 'c' to pop a value from the clicked queue: ")
         # If the character is c or C, then pop a value off of the clicked queue
         if val == "c" or val == "C":
-            print("\nPopped ClickedQueue! The first value of clicked queue was: ")
-            print(str(myButton.popClickedQueue() / 1000.0))
+            print("\nPopped Clicked Queue! The first value of clicked queue was: ")
+            print(str(my_button.pop_clicked_queue() / 1000.0))
         # If the character is p or P, then pop a value off of the pressed queue
         if val == "p" or val == "P":
-            print("\nPopped PressedQueue!")
-            print(str(myButton.popClickedQueue() / 1000.0))
+            print("\nPopped Pressed Queue!")
+            print(str(my_button.pop_clicked_queue() / 1000.0))
 
         time.sleep(0.02)    # Let's not hammer too hard on the I2C bus
 
 if __name__ == '__main__':
     try:
-        runExample()
+        run_example()
     except (KeyboardInterrupt, SystemExit) as exErr:
         print("\nEnding Example 5")
         sys.exit(0)

examples/qwiic_button_ex6_changeI2CAddress.py

@@ -45,12 +45,12 @@
 import time
 import sys
 
-def runExample():
+def run_example():
 
     print("\nSparkFun Qwiic Button Example 6")
-    myButton = qwiic_button.QwiicButton()
+    my_button = qwiic_button.Qwiic_Button()
 
-    if myButton.begin() == False:
+    if my_button.begin() == False:
         print("\nThe Qwiic Button isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
@@ -61,19 +61,19 @@ def runExample():
     print("\nDon't use the 0x prefix. For instance, if you wanted to")
     print("\nchange the address to 0x5B, you would type 5B and hit enter.")
 
-    newAddress = raw_input("\nNew Address: ")
-    newAddress = int(newAddress, 16)
+    new_address = raw_input("\nNew Address: ")
+    new_address = int(new_address, 16)
 
     # Check if the user entered a valid address
-    if newAddress > 0x08 and newAddress < 0x77:
+    if new_address > 0x08 and new_address < 0x77:
         print("\nCharacters received and new address valid!")
         print("\nAttempting to set Qwiic Button address...")
 
-        myButton.setI2Caddress(newAddress)
+        my_button.set_I2C_address(new_address)
         print("\nAddress successfully changed!")
         # Check that the Qwiic Button acknowledges on the new address
         time.sleep(0.02)
-        if myButton.begin() == False:
+        if my_button.begin() == False:
             print("\nThe Qwiic Button isn't connected to the system. Please check your connection", \
                 file=sys.stderr)
 
@@ -85,7 +85,7 @@ def runExample():
 
 if __name__ == '__main__':
     try:
-        runExample()
+        run_example()
     except (KeyboardInterrupt, SystemExit) as exErr:
         print("\nEnding Example 6")
         sys.exit(0)

examples/qwiic_button_ex7_2Buttons.py

@@ -47,17 +47,17 @@
 import time
 import sys
 
-def runExample():
+def run_example():
 
     print("\nSparkFun Qwiic Button Example 7")
-    myButton1 = qwiic_button.QwiicButton()
-    myButton2 = qwiic_button.QwiicButton(0x5B)
+    my_button1 = qwiic_button.Qwiic_Button()
+    my_button2 = qwiic_button.Qwiic_Button(0x5B)
 
-    if myButton1.begin() == False:
+    if my_button1.begin() == False:
         print("\nThe Qwiic Button 1 isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
-    if myButton2.begin() == False:
+    if my_button2.begin() == False:
         print("\nThe Qwiic Button 2 isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
@@ -67,18 +67,18 @@ def runExample():
     while 1:
 
         # Check if button 1 is pressed
-        if myButton1.isButtonPressed() == True:
+        if my_button1.is_button_pressed() == True:
             print("\nButton 1 is pressed!")
 
         # Check if button2 is pressed
-        if myButton2.isButtonPressed() == True:
+        if my_button2.is_button_pressed() == True:
             print("\nButton 2 is pressed!")
 
         time.sleep(0.02)    # Don't hammer too hard on the I2C bus
 
 if __name__ == '__main__':
     try:
-        runExample()
+        run_example()
     except (KeyboardInterrupt, SystemExit) as exErr:
         print("\nEnding Example 7")
         sys.exit(0)