updated readme

Protocentral · Dec 24, 2024 · a39085f · a39085f
1 parent e4e8d37
commit a39085f
Show file tree

Hide file tree

Showing 10 changed files with 59 additions and 22 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.md b/README.md
@@ -1,17 +1,66 @@
-ProtoCentral ADS1292R ECG/respiration Arduino Library
-================================
+# Protocentral ADS1292R ECG/respiration Arduino Library
+
 [![Compile Examples](https://github.com/Protocentral/protocentral-ads1292r-arduino/workflows/Compile%20Examples/badge.svg)](https://github.com/Protocentral/protocentral-ads1292r-arduino/actions?workflow=Compile+Examples)
 
-[Don't have it yet? Buy one here: ADS1292R ECG/Respiration Shield for Arduino- v2 (PC-4128)](https://protocentral.com/product/ads1292r-ecg-respiration-shield-for-arduino-v2/)
+## Don't have one? [Buy shield here](https://protocentral.com/product/ads1292r-ecg-respiration-shield-for-arduino-v2/)
+
+<center>
+
+![ADS1292R breakout](./assets/ads1292r_shield.jpg)
+
+</center>
+
+
+## Don't have one? [Buy breakout here](https://protocentral.com/product/ads1292r-ecg-respiration-breakout-kit/)
+
+<center>
+
+![ADS1292R shield](./assets/ads1292r_breakout.jpg)
+
+</center>
+
+Easily monitor ECG and respiration using your Arduino with this plug-in shield. The version 2 of this product adds a new SPI pin header making it compatible with newer Arduino devices including the Arduino Yun and 3.5mm connector for the electrodes. We now include the electrodes and cable also with the shield
+
+Just plug it into an Arduino and you're ready to go. The 3.5 mm circular connector provides an easy way to connect electodes to the shield. The other end of this cable has snaps for standard ECG electrodes. We also include a pakc of 10 disposable EG electrodes. It accepts two ECG electrodes and one Driven Right Leg (DRL) electrode for common mode noise reduction.
+
+Another interesting feature of this shield is that you can also measure the respiratory activity using the same two electrodes connected to the shield. The ADS1292R uses a method known as impedance pneumography to measure respiration using the changes in chest impedance caused during respiration.
+
+## Features
+
+* ADS1292R Analog Front End IC
+* Onboard 3.3V voltage regulator for low noise
+* Onboard logic level transalators for Arduino interface
+* Prototyping area for adding addtional components
+
+
+## Hardware Setup
+
+Connection with the Arduino board is as follows:
+
+
+|ADS1292R pin label| Arduino Connection   |Pin Function      |
+|----------------- |:--------------------:|-----------------:|
+| MISO             | D12                  |  Slave out   |             
+| MOSI             | D11                  |  Slave in         |
+| SCK              | D13                  |  Serial clock     |
+| CS               | D7                   |  chip select      |
+| DRDY             | D6                   |  Data Ready Output|
+| START            | D5                   |  Start Input      |
+| PWDN/RESET       | D4                   |  Reset            |
+| VDD              | +5V                   | Power Supply      |
+| GND              | GND                  | GND               |
+
 
-[![bob](docs/img/ads1292r_breakout.jpg)  
-Dont have it yet? But one here: ADS1292R ECG/Respiration Breakout for Arduino- v3 (PC-4116)](https://protocentral.com/product/ads1292r-ecg-respiration-breakout-kit/)
+# Visualizing Output
 
+![Streaming output](./assets/output.png)
 
-This is the Arduino library for the ProtoCentral ADS1292R-based ECG/Respiration monitoring shield and breakout boards.
+For further details of the board, refer the documentation
+<center>
 
-## For the main documentation site, GUI and more resources, please check out our main [GitHub Repo](https://github.com/Protocentral/ADS1292rShield_Breakout)
+[ ADS1292R breakout board Documentation](https://docs.protocentral.com/getting-started-with-ADS1292R/)
 
+</center>
 
 License Information
 ===================

diff --git a/docs/img/ads1292r_breakout.jpg → assets/ads1292r_breakout.jpg b/docs/img/ads1292r_breakout.jpg → assets/ads1292r_breakout.jpg
diff --git a/assets/ads1292r_shield.jpg b/assets/ads1292r_shield.jpg
diff --git a/assets/output.png b/assets/output.png
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/img/.DS_Store b/docs/img/.DS_Store
diff --git a/examples/Example-1-ECG-Respiration-Plot-Openview/Example-1-ECG-Respiration-Plot-Openview.ino b/examples/Example-1-ECG-Respiration-Plot-Openview/Example-1-ECG-Respiration-Plot-Openview.ino
@@ -102,11 +102,7 @@ void setup()
   delay(2000);
 
   SPI.begin();
-  SPI.setBitOrder(MSBFIRST);
-  //CPOL = 0, CPHA = 1
-  SPI.setDataMode(SPI_MODE1);
-  // Selecting 1Mhz clock for SPI
-  SPI.setClockDivider(SPI_CLOCK_DIV16);
+  SPI.beginTransaction(SPISettings(1000000, MSBFIRST, SPI_MODE1));
 
   pinMode(ADS1292_DRDY_PIN, INPUT);
   pinMode(ADS1292_CS_PIN, OUTPUT);

diff --git a/examples/Example-2-Computation-only/Example-2-Computation-only.ino b/examples/Example-2-Computation-only/Example-2-Computation-only.ino
@@ -57,11 +57,7 @@ void setup()
   delay(2000);
 
   SPI.begin();
-  SPI.setBitOrder(MSBFIRST);
-  //CPOL = 0, CPHA = 1
-  SPI.setDataMode(SPI_MODE1);
-  // Selecting 1Mhz clock for SPI
-  SPI.setClockDivider(SPI_CLOCK_DIV16);
+  SPI.beginTransaction(SPISettings(1000000, MSBFIRST, SPI_MODE1));
 
   pinMode(ADS1292_DRDY_PIN, INPUT);
   pinMode(ADS1292_CS_PIN, OUTPUT);

diff --git a/...s/Example-3-ECG-Respiration-Arduino-Plotter/Example-3-ECG-Respiration-Arduino-Plotter.ino b/...s/Example-3-ECG-Respiration-Arduino-Plotter/Example-3-ECG-Respiration-Arduino-Plotter.ino
@@ -57,11 +57,7 @@ void setup()
   delay(2000);
 
   SPI.begin();
-  SPI.setBitOrder(MSBFIRST);
-  //CPOL = 0, CPHA = 1
-  SPI.setDataMode(SPI_MODE1);
-  // Selecting 1Mhz clock for SPI
-  SPI.setClockDivider(SPI_CLOCK_DIV16);
+ SPI.beginTransaction(SPISettings(1000000, MSBFIRST, SPI_MODE1));
 
   pinMode(ADS1292_DRDY_PIN, INPUT);
   pinMode(ADS1292_CS_PIN, OUTPUT);