Main docs update

This commit includes updated docs content, GH pages build files and other review updates.

Author: SFEMark

.github/README.md

@@ -0,0 +1,39 @@
+SparkFun Pro Micro - RP2350
+========================================
+
+[![SparkFun Pro Micro - RP2350](https://cdn.sparkfun.com/r/600-600/assets/parts/2/5/1/6/2/DEV-24870-Pro-Micro-RP2350-Feature.jpg)](https://www.sparkfun.com/products/24870)
+
+[*SparkFun Pro Micro - RP2350 (DEV-28470)*](https://www.sparkfun.com/products/24870)
+
+The SparkFun Pro Micro - RP2350 provides a powerful development platform in SparkFun's compact Pro Micro form factor built around the RP2350 from the Raspberry Pi Foundation. This board uses the updated Pro Micro form factor and includes a USB-C connector, Qwiic connector, WS2812B addressable RGB LED, Boot and Reset buttons, resettable PTC fuse as well as PTH and castellated solder pads. The board includes two expanded memory options with 16MB of external Flash and 8MB PSRAM connected to the RP2350's QSPI controller. The RP2350 also features 520kB SRAM in ten banks, a host of peripherals including 2 UARTs, 2 SPI and 2 I<sup>2</sup>C controllers, as well as a USB 1.1 controller that allows for both host and device support. The Pro Micro - RP2350 works with C/C++ using the Pico SDK along with MicroPython development environments. 
+
+Repository Contents
+-------------------
+
+* **/Documents** - Data sheets, additional product information 
+* **/Examples** - Example code 
+* **/Hardware** - Eagle design files (.brd, .sch)
+* **/Production** - Production panel files (.brd)
+* **/docs** - GitHub Pages documentation files
+
+Documentation
+--------------
+* **[Hookup Guide](https://sparkfun.github.io/SparkFun_Pro_Micro_RP2350)** - Basic hookup guide for the Pro Micro - RP2350.
+* [PSRAM Library and Examples](https://github.com/sparkfun/sparkfun-pico) - A cmake library and examples to use the on-board PSRAM when developing in the Raspberry Pi [pico-sdk](https://github.com/raspberrypi/pico-sdk).
+
+Product Versions
+----------------
+* [DEV-28470](https://www.sparkfun.com/products/24870) - SparkFun Pro Micro - RP2350 development board.
+
+License Information
+-------------------
+
+This product is _**open source**_! 
+
+Please review the LICENSE.md file for license information. 
+
+If you have any questions or concerns on licensing, please contact technical support on our [SparkFun forums](https://forum.sparkfun.com/viewforum.php?f=152).
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.

.github/workflows/mkdocs.yml

@@ -0,0 +1,40 @@
+name: Run mkdocs
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python runtime
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Install Python dependencies
+        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 setuptools
+
+      # - name: Install Chrome
+      #   run: sudo apt install google-chrome-stable
+
+      # - run: pip uninstall -y beautifulsoup4
+      # - run: pip install beautifulsoup4==4.9.3
+
+      - name: Set up build cache
+        uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+
+      - name: Install Insiders build
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }} 
+        run: pip install --upgrade mkdocs-material
+      - run: mkdocs gh-deploy --force

Hardware/Qwiic_ADC_ADS1219.kicad_prl

@@ -86,16 +86,16 @@
       9
     ],
     "col_widths": [
-      0,
-      0,
-      0,
-      0,
-      0,
-      0,
-      0,
-      0,
-      0,
-      0
+      13,
+      13,
+      13,
+      13,
+      13,
+      13,
+      13,
+      13,
+      13,
+      20
     ],
     "custom_group_rules": [],
     "expanded_rows": [],

Hardware/Qwiic_ADC_ADS1219.kicad_pro

@@ -628,7 +628,7 @@
     },
     "net_format_name": "",
     "page_layout_descr_file": "",
-    "plot_directory": "",
+    "plot_directory": "./",
     "space_save_all_events": true,
     "spice_current_sheet_as_root": false,
     "spice_external_command": "spice \"%I\"",

README.md

@@ -1,24 +1,29 @@
-SparkX Qwiic ADC ADS1219 - 24-Bit 4-Channel
-========================================
+[![SparkFun Qwiic 24 Bit ADC - 4 Channel (ADS1219)](./docs/assets/img/Qwiic_ADC-RepoBanner.png)](https://www.sparkfun.com/sparkfun-qwiic-24-bit-adc-4-channel-ads1219.html)
 
-[![Qwiic ADC ADS1219](URL for picture of part)](URL for product on Sparkfun.com)
+[*SparkFun Qwiic 24 Bit ADC - 4 Channel (ADS1219) (SEN-27544)*](https://www.sparkfun.com/sparkfun-qwiic-24-bit-adc-4-channel-ads1219.html)
 
-[*Qwiic ADC ADS1219 (SKU)*](URL for product on Sparkfun.com)
-
-A lot of the time you just need to add more analog inputs to solve a problem. It happens. The SparkX Qwiic 24-Bit ADC can provide four channels of I2C controlled ADC input to your Qwiic enabled project. These channels can be used as single-ended inputs, or in pairs for differential inputs, running at sample rates of up to 1kHz. What makes this ADC even more powerful is that it has a programmable x1 or x4 gain amplifier that lets you "zoom in" on a very small change in analog voltage (but will still effect your input range and resolution). Utilizing our handy Qwiic system, it is easy to connect it to the rest of your system. However, we have broken out 0.1"-spaced pads too in case you prefer to use a breadboard. The analog inputs and reference pins are all broken out on 0.1"-spaced pads too. This board does not have screw terminals - there was not enough room!
+A lot of the time you just need to add more analog inputs to solve a problem. It happens. The SparkFun Qwiic 24-Bit ADC can provide four channels of I2C controlled ADC input to your Qwiic enabled project. These channels can be used as single-ended inputs, or in pairs for differential inputs, running at sample rates of up to 1kHz. What makes this ADC even more powerful is that it has a programmable x1 or x4 gain amplifier that lets you "zoom in" on a very small change in analog voltage (but will still effect your input range and resolution). Utilizing our handy Qwiic system, it is easy to connect it to the rest of your system. However, we have broken out 0.1"-spaced pads too in case you prefer to use a breadboard. The analog inputs and reference pins are all broken out on 0.1"-spaced pads too. This board does not have screw terminals - there was not enough room!
 
 The ADS1219 can use its own internal 2.048V voltage reference for measurements, or you can provide your own reference via the REFP and REFN breakout pads. You can also provide your own VDDA (AVDD) by opening the jumper and connecting a voltage to the VDDA pad. This ADC board has eight address jumpers that let you choose one of sixteen unique addresses (0x40 to 0x4F). With these, you can connect up to sixteen of these on the same I2C bus and have 64 channels of ADC. The maximum resolution of the converter is 24-bits, corresponding to 244.14nV per count at a gain of x1. At a gain of x4, the resolution is 61.04nV per count. Note: the effective resolution is limited to 20-bits.
 
 Repository Contents
 -------------------
 
+* **/docs** - GitHub pages documentation files
 * **/Documentation** - TI datasheet 
 * **/Hardware** - KiCad design files (_pcb, _sch), Schematic (PDF)
 * **/Production** - Production panel files (_pcb, gerbers)
 
 Documentation
 --------------
 * [**Arduino Library**](https://github.com/sparkfun/SparkFun_ADS1219_Arduino_Library) - Arduino library for the ADS1219.
+* [**Hookup Guide**](https://docs.sparkfun.com/SparkFun_Qwiic_ADC_ADS1219/)
+
+Product Versions
+-----------------
+
+* [SPX-23455](https://www.sparkfun.com/sparkx-qwiic-24-bit-adc-4-channel-ads1219.html) - Original SparkX release.
+* [SEN-27544](https://www.sparkfun.com/sparkfun-qwiic-24-bit-adc-4-channel-ads1219.html) - Initial SparkFun release.
 
 License Information
 -------------------

docs/arduino_examples.md

@@ -0,0 +1,42 @@
+Let's take a look at a few of the examples included in the SparkFun ADS1219 Arduino Library.
+
+## Example 01 - Single Shot
+
+The first example shows how to take single-shot measurements of a differential input on channels A0 and A1. Open the example by navigating to **File** > **Examples** > **SparkFun ADS1219 Arduino Library** > **Example01_SingleShot**. Select your Board and Port and click the Upload button. After the code finishes uploading, open the [serial monitor](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-serial-monitor/) with the baud set to **115200** and you should see some setup messages print out followed by readings in millivolts.
+
+The example initializes the ADS1219 on the I<sup>2</sup>C bus with default settings and then attempts to take single-shot readings from the ADC. 
+
+## Example 02 - Continuous
+
+The second example shows how to take continuous measurements of a differential input on channels A0 and A1. This example is very similar to the previous one but instead of requesting for a single-shot synched readings, requests continuous readings every 10ms. Open the example from the SparkFun ADS1219 Arduino Library and upload it.
+
+With the serial monitor open and set to **115200**, you should see an initialization message print followed by differential voltage readings from A0 and A1 in millivolts.
+
+## Example 03 - Input Multiplexer
+
+The third example shows how to configure the ADS1219's input multiplexer feature. This adjustable setting lets users set the ADS1219's input multiplexer to one of eight options using the `myADC.setInputMultiplexer();` function. Available settings are:
+
+``` c++
+  ADS1219_CONFIG_MUX_DIFF_P0_N1 //(Default)
+  ADS1219_CONFIG_MUX_DIFF_P2_N3
+  ADS1219_CONFIG_MUX_DIFF_P1_N2
+  ADS1219_CONFIG_MUX_SINGLE_0
+  ADS1219_CONFIG_MUX_SINGLE_1
+  ADS1219_CONFIG_MUX_SINGLE_2
+  ADS1219_CONFIG_MUX_SINGLE_3
+  ADS1219_CONFIG_MUX_SHORTED
+```
+
+## Example 04 - Data Ready Interrupt
+
+The fourth example demonstrates how to use the ADS1219's data ready pin to trigger an interrupt on a connected microcontroller. For this example, you'll need to connect the Data Ready (DRDY) pin to an [interrupt-capable I/O pin](https://docs.arduino.cc/language-reference/en/functions/external-interrupts/attachInterrupt/) on your development board. 
+
+The code defaults to use D4 for the interrupt pin so if you need to switch to another pin, adjust this line:
+
+``` c++
+const int interruptPin = 4;
+```
+
+The example's setup sets the I<sup>2</sup>C clock speed to 400kHz for better performance and initializes the ADS1219 to read the voltage between AIN0 and Ground, adjusts the gain to x4 and configure the data rate to 1000 samples per second. Lastly, it configures the interrupt to go LOW when data is ready. The main loop just checks to see if the interrupt is seen, clears the flag and then prints readings in millivolts.
+
+

docs/arduino_setup.md

@@ -0,0 +1,16 @@
+!!! arduino
+    This example assumes you are using the latest version of the Arduino IDE on your desktop. If this is your first time using Arduino IDE, library, or board add-on, please review the following tutorials.
+
+    - [Installing the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-arduino-ide)
+    - [Installing an Arduino Library](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)
+    - [Installing Board Definitions in the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-board-definitions-in-the-arduino-ide)
+
+    ## Installing the SparkFun ADS1219 Arduino Library
+
+!!! note "SparkFun Toolkit"
+
+    This library is built using the [SparkFun Toolkit](https://github.com/sparkfun/SparkFun_Toolkit) so you'll need to make sure that is installed before using this library. Install the SparkFun Toolkit with the Arduino Library manager by searching "SparkFun Toolkit" and installing the latest version. Users who prefer manually installing Arduino Libraries can download it from the [GitHub Repository](https://github.com/sparkfun/SparkFun_Toolkit).
+
+## SparkFun ADS1219 Arduino Library
+
+The SparkFun ADS1219 Arduino Library lets users easily get started with the ADS1219 with basic commands and six examples. Install the library using the Arduino Library Manager tool by searching for "SparkFun ADS1219" and install the latest version. If you'd prefer to manually install the library, you can download it from the [GitHub Repository](https://github.com/sparkfun/SparkFun_ADS1219_Arduino_Library) or you can download a ZIP of the repository [here](https://github.com/sparkfun/SparkFun_ADS1219_Arduino_Library/archive/refs/heads/main.zip).