Merge branch 'feature/change_address'

Author: malcolm-sparkfun

.github/workflows/build-deploy-ghpages.yml

@@ -0,0 +1,65 @@
+name: Build Documentation and Deploy
+
+on:
+  push:
+    branches:
+      - main
+      - feature/change_address
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+  pages: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: "true"
+
+      - name: Set Version
+        run: echo "PROJECT_NUMBER = `git describe --tags`" >> ./docs/doxygen/doxygen-config
+
+      - name: Build Documentation
+        uses: mattnotmitt/doxygen-action@v1.9.5
+        with:
+          doxyfile-path: "./docs/doxygen/doxygen-config"
+
+      # Upload the documentation as an artifact
+      - name: Upload documentation
+        uses: actions/upload-pages-artifact@v3.0.1
+        with:
+          path: ./docs/html
+
+  # Deploy job
+  deploy:
+    # Add a dependency to the build job
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

README.md

@@ -1,142 +1,145 @@
-Qwiic_Relay_Py
-==================
-<p align="center">
-   <img src="https://cdn.sparkfun.com/assets/custom_pages/2/7/2/qwiic-logo-registered.jpg"  width=200>  
-   <img src="https://www.python.org/static/community_logos/python-logo-master-v3-TM.png"  width=240>   
-</p>
-<p align="center">
-	<a href="https://pypi.org/project/sparkfun-qwiic-relay/" alt="Package">
-		<img src="https://img.shields.io/pypi/pyversions/sparkfun-qwiic-relay.svg" /></a>
-	<a href="https://github.com/sparkfun/Qwiic_Relay_Py/issues" alt="Issues">
-		<img src="https://img.shields.io/github/issues/sparkfun/Qwiic_Relay_Py.svg" /></a>
-	<a href="https://sparkfun-qwiic-relay.readthedocs.io/en/latest/?" alt="Documentation">
-		<img src="https://readthedocs.org/projects/sparkfun-qwiic-relay/badge/?version=latest&style=flat" /></a>
-	<a href="https://github.com/sparkfun/Qwiic_Relay_Py/blob/master/LICENSE" alt="License">
-		<img src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
-	<a href="https://twitter.com/intent/follow?screen_name=sparkfun">
-        	<img src="https://img.shields.io/twitter/follow/sparkfun.svg?style=social&logo=twitter"
-           	 alt="follow on Twitter"></a>
-	
-</p>
+![Qwiic RELAY - Python Package](docs/images/gh-banner.png "qwiic RELAY Python Package")
 
-<img src="https://cdn.sparkfun.com/assets/parts/1/5/7/5/4/16833-SparkFun_Qwiic_Quad_Solid_State_Relay_Kit-01.jpg"  align="right" width=300 alt="SparkFun Qwiic Solid State Relay">
+# SparkFun Qwiic RELAY - Python Package
 
-Python module for the Qwiic Relays, Listed below
-* [SparkFun Qwiic Single Relay](https://www.sparkfun.com/products/15093)
-* [SparkFun Qwiic Quad Relay](https://www.sparkfun.com/products/15102)
-* [SparkFun Qwiic Quad Solid State Relay](https://www.sparkfun.com/products/16833)
-* [SparkFun Qwiic Dual Solid State Relay](https://www.sparkfun.com/products/16810)
+![PyPi Version](https://img.shields.io/pypi/v/sparkfun_qwiic_relay)
+![GitHub issues](https://img.shields.io/github/issues/sparkfun/qwiic_relay_py)
+![License](https://img.shields.io/github/license/sparkfun/qwiic_relay_py)
+![X](https://img.shields.io/twitter/follow/sparkfun)
+[![API](https://img.shields.io/badge/API%20Reference-blue)](https://docs.sparkfun.com/qwiic_relay_py/classqwiic__relay_1_1_qwiic_relay.html)
 
-This package can be used in conjunction with the overall [SparkFun qwiic Python Package](https://github.com/sparkfun/Qwiic_Py)
+The SparkFun Qwiic Relay RELAY Module provides a simple and cost effective solution for adding Relay capabilities to your project. Implementing a SparkFun Qwiic I2C interface, these sensors can be rapidly added to any project with boards that are part of the SparkFun Qwiic ecosystem.
 
-New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
+This repository implements a Python package for the SparkFun Qwiic RELAY. This package works with Python, MicroPython and CircuitPython.
 
-## Contents
+### Contents
 
-* [Supported Platforms](#supported-platforms)
-* [Dependencies](#dependencies)
+* [About](#about-the-package)
+* [Getting Started](#getting-started)
 * [Installation](#installation)
-* [Documentation](#documentation)
-* [Example Use](#example-use)
+* [Supported Platforms](#supported-platforms)
+* [Documentation](https://docs.sparkfun.com/qwiic_relay_py/classqwiic__relay_1_1_qwiic_relay.html)
+* [Examples](#examples)
+
+## About the Package
+
+This python package enables the user to access the features of the RELAY via a single Qwiic cable. This includes setting relay state, reading relay state, set slow PWM value and more. The capabilities of the RELAY are each demonstrated in the included examples.
+
+New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
 
-Supported Platforms
---------------------
-The Qwiic Relay Python package current supports the following platforms:
-* [Raspberry Pi](https://www.sparkfun.com/search/results?term=raspberry+pi)
+### Supported SparkFun Products
 
-Dependencies 
----------------
-This driver package depends on the qwiic I2C driver: 
-[Qwiic_I2C_Py](https://github.com/sparkfun/Qwiic_I2C_Py)
+This Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python. 
 
-Documentation
--------------
-The SparkFun Qwiic Relay module documentation is hosted at [ReadTheDocs](https://sparkfun-qwiic-relay.readthedocs.io/en/latest/?)
+* [SparkFun Relay Sensor - RELAY](http://www.sparkfun.com/qwiic)
 
-Installation
--------------
+### Supported Platforms
 
-### PyPi Installation
-This repository is hosted on PyPi as the [sparkfun-qwiic-relay](https://pypi.org/project/sparkfun-qwiic-relay/) package. On systems that support PyPi installation via pip, this library is installed using the following commands
+| Python | Platform | Boards |
+|--|--|--|
+| Python | Linux | [Raspberry Pi](https://www.sparkfun.com/raspberry-pi-5-8gb.html) , [NVIDIA Jetson Orin Nano](https://www.sparkfun.com/nvidia-jetson-orin-nano-developer-kit.html) via the [SparkFun Qwiic SHIM](https://www.sparkfun.com/sparkfun-qwiic-shim-for-raspberry-pi.html) |
+| MicroPython | Raspberry Pi - RP2, ESP32 | [SparkFun RP2040 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2040.html), [SparkFun RP2350 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2350.html), [SparkFun ESP32 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-esp32-wroom-usb-c.html)
+|CircuitPython | Raspberry Pi - RP2, ESP32 | [SparkFun RP2040 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2040.html), [SparkFun RP2350 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2350.html), [SparkFun ESP32 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-esp32-wroom-usb-c.html)
 
-For all users (note: the user must have sudo privileges):
+> [!NOTE]
+> The listed supported platforms and boards are the primary platform targets tested. It is fully expected that this package will work across a wide variety of Python enabled systems. 
+
+## Installation 
+
+The first step to using this package is installing it on your system. The install method depends on the python platform. The following sections outline installation on Python, MicroPython and CircuitPython.
+
+### Python 
+
+#### PyPi Installation
+
+The package is primarily installed using the `pip3` command, downloading the package from the Python Index - "PyPi". 
+
+Note - the below instructions outline installation on a Linux-based (Raspberry Pi) system.
+
+First, setup a virtual environment from a specific directory using venv:
 ```sh
-sudo pip install sparkfun-qwiic-relay
+python3 -m venv path/to/venv
 ```
-For the current user:
+You can pass any path as path/to/venv, just make sure you use the same one for all future steps. For more information on venv [click here](https://docs.python.org/3/library/venv.html).
 
+Next, install the qwiic package with:
 ```sh
-pip install sparkfun-qwiic-relay
+path/to/venv/bin/pip3 install sparkfun-qwiic-relay
+```
+Now you should be able to run any example or custom python scripts that have `import qwiic_relay` by running e.g.:
+```sh
+path/to/venv/bin/python3 example_script.py
 ```
 
-### Local Installation
-To install, make sure the `setuptools` package is installed on the system.
+### MicroPython Installation
+If not already installed, follow the [instructions here](https://docs.micropython.org/en/latest/reference/mpremote.html) to install mpremote on your computer.
 
-Direct installation at the command line:
+Connect a device with MicroPython installed to your computer and then install the package directly to your device with mpremote mip.
 ```sh
-python setup.py install
+mpremote mip install github:sparkfun/qwiic_relay_py
 ```
 
-To build a package for use with pip:
+If you would also like to install the examples for this repository, issue the following mip command as well:
 ```sh
-python setup.py sdist
- ```
-A package file is built and placed in a subdirectory called dist. This package file can be installed using pip.
+mpremote mip install --target "" github:sparkfun/qwiic_relay_py@examples
+```
+
+### CircuitPython Installation
+If not already installed, follow the [instructions here](https://docs.circuitpython.org/projects/circup/en/latest/#installation) to install CircUp on your computer.
+
+Ensure that you have the latest version of the SparkFun Qwiic CircuitPython bundle. 
+```sh
+circup bundle-add sparkfun/Qwiic_Py
+```
+
+Finally, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.
 ```sh
-cd dist
-pip install sparkfun_qwiic_relay-<version>.tar.gz
-  
+circup install --py qwiic_relay
 ```
+
+If you would like to install any of the examples from this repository, issue the corresponding circup command from below. (NOTE: The below syntax assumes you are using CircUp on Windows. Linux and Mac will have different path seperators. See the [CircUp "example" command documentation](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/example-command) for more information)
+
+```sh
+circup example qwiic_relay\qwiic_relay_ex1_single
+circup example qwiic_relay\qwiic_relay_ex2_dual
+circup example qwiic_relay\qwiic_relay_ex3_quad
+circup example qwiic_relay\qwiic_relay_ex4_pwm
+```
+
 Example Use
  ---------------
-See the examples directory for more detailed use examples.
+Below is a quickstart program to print readings from the RELAY.
+
+See the examples directory for more detailed use examples and [examples/README.md](https://github.com/sparkfun/qwiic_relay_py/blob/main/examples/README.md) for a summary of the available examples.
 
 ```python
-from __future__ import print_function
+
 import qwiic_relay
 import time
 import sys
 
-myRelays = qwiic_relay.QwiicRelay()
+myRelay = qwiic_relay.QwiicRelay(qwiic_relay.SINGLE_RELAY_DEFUALT_ADDR)
 
 def runExample():
+    print("\nSparkFun Qwiic Relay Example 1 - Single\n")
 
-    print("\nSparkFun Qwiic Relay Example 1\n")
-
-    if myRelays.begin() == False:
+    if myRelay.begin() == False:
         print("The Qwiic Relay isn't connected to the system. Please check your connection", \
             file=sys.stderr)
         return
 
-    #Turn on relays one and three
-    myRelays.set_relay_on(1)
-    myRelays.set_relay_on(3)
-    time.sleep(1)
-    
-    #Print the status of all relays
-    for relayNum in range(4):
-        current_status = None
-        if myRelays.get_relay_state(relayNum) is True:
-            current_status = "On"
-        else:
-            current_status = "Off"
-        print("Status 1: " + current_status + "\n")
-    
-    #Turn off 1 and 3, turn on 2 and 4
-    myRelays.set_relay_off(1)
-    myRelays.set_relay_on(2)
-    myRelays.set_relay_off(3)
-    myRelays.set_relay_on(4)
-    time.sleep(1)
-    
+    for i in range(2):
+        myRelay.set_relay_on()
 
-    #Turn all relays on, then turn them all off
-    myRelays.set_all_relays_on()
-    time.sleep(1)
-    
-    myRelays.set_all_relays_off()
-    
+        print("Relay state: " + str(myRelay.get_relay_state()))
+
+        time.sleep(1)
+        
+        myRelay.set_relay_off()
+
+        print("Relay state: " + str(myRelay.get_relay_state()))
 
+        time.sleep(1)
 
 if __name__ == '__main__':
     try: