added set relay status property

Author: fourstix

docs/examples.rst

@@ -16,7 +16,7 @@ Ecamples
     :caption: examples/example1_basic_control.py
     :linenos:
 
-2. Change I2C Addres - Change the device I2C address.
+2. Change I2C Address - Change the device I2C address.
 
 .. literalinclude:: ../examples/example2_change_i2c_address.py
     :caption: example2_change_i2c_address.py
@@ -34,8 +34,15 @@ Ecamples
     :caption: examples/example4_get_relay_status.py
     :linenos:
 
-1. Firmware Version - Display the firmware version string.
+5. Firmware Version - Display the firmware version string.
 
 .. literalinclude:: ../examples/example5_get_firmware_version.py
     :caption: examples/example5_get_firmware_version.py
     :linenos:
+
+6. Set Relay Status - Set relay status to turn relay on and off.
+
+.. literalinclude:: ../examples/example6_set_relay_status.py
+    :caption: examples/example6_set_relay_status.py
+    :linenos:
+

examples/example6_set_relay_status.py

@@ -0,0 +1,54 @@
+#  This is example is for the SparkFun Qwiic Single Relay.
+#  SparkFun sells these at its website: www.sparkfun.com
+#  Do you like this library? Help support SparkFun. Buy a board!
+#  https://www.sparkfun.com/products/15093
+
+"""
+ Qwiic Relay Example 6 - example6_set_relay_status.py
+ Written by Gaston Williams, June 21st, 2019
+ The Qwiic Single Relay is an I2C controlled relay produced by sparkfun
+
+ Example 6 - Set Relay Status:
+ This program uses the Qwiic Relay CircuitPython Library to
+ set the relay status property to turn the relay on and off.
+
+
+ Default Qwiic relay address is 0x18.
+"""
+
+from time import sleep
+import board
+import busio
+import sparkfun_qwiicrelay
+
+# Create bus object using our board's I2C port
+i2c = busio.I2C(board.SCL, board.SDA)
+
+# Create relay object
+relay = sparkfun_qwiicrelay.Sparkfun_QwiicRelay(i2c)
+
+print('Qwiic Relay Example 6 Set Relay Status')
+
+# Check if connected
+if relay.connected:
+    print('Relay connected.')
+else:
+    print('Relay does not appear to be connected. Please check wiring.')
+    exit()
+
+print('Type Ctrl-C to exit program.')
+
+try:
+    while True:
+        # Set status = 1/True is the same as relay.relay_on()
+        relay.status = True
+        print('The relay status is', bool(relay.status))
+        sleep(2)
+        # Set status = 0/False is the same as relay.relay_off()
+        relay.status = False
+        print('The relay status is', bool(relay.status))
+
+        sleep(2)
+
+except KeyboardInterrupt:
+    pass

sparkfun_qwiicrelay.py

@@ -109,6 +109,13 @@ def status(self):
 
         return status[0] & 0xFF
 
+    @status.setter
+    def status(self, value):
+        """Setting the status True turns relay on, False turns relay off."""
+        if bool(value):
+            self._write_command(_RELAY_ON)
+        else:
+            self._write_command(_RELAY_OFF)
 
 # public functions