projects:Updated link to documentation

Migrated all the reference links from wiki page to point to github IO docs Updated the 'wiki' references across all files Signed-off-by: Janani Sunil <[email protected]>
analogdevicesinc · Jan 24, 2025 · b751235 · b751235
1 parent 88be7ee
commit b751235
Show file tree

Hide file tree

Showing 21 changed files with 48 additions and 54 deletions.
diff --git a/projects/ad4130_iio/README.rst b/projects/ad4130_iio/README.rst
@@ -103,7 +103,7 @@ Software Downloads
 Below section provides an overview about the pre-requisites needed to build and run the project:
 
 * Source code is hosted on `precision-converters-firmware <https://studio.keil.arm.com/auth/login/>`_ repo
-* `Build Guide for projects <https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide>`_
+* `Build Guide for projects <https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html>`_
 * `Libiio: IIO Library <https://github.com/analogdevicesinc/libiio/releases>`_ 
 This library provides an abstracted interface to communicate with IIO device 
 and IIO client application (IIO Oscilloscope) without worrying about the low 

diff --git a/projects/ad469x_iio/README.txt b/projects/ad469x_iio/README.txt
@@ -14,16 +14,16 @@ The EVAL-AD4696FMCZ board is interfaced with SDP-K1 (or any Arduino compatible b
 
 Hardware Setup
 --------------
-Refer "Hardware Connections" section from below wiki page link:
-https://wiki.analog.com/resources/tools-software/product-support-software/ad4696_mbed_iio_application
+Refer "Hardware Connections" section from below page:
+https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad4696_iio/ad4696_iio.html
 
 
 How to Get Started
 ------------------
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad559xr_console/README.txt b/projects/ad559xr_console/README.txt
@@ -12,15 +12,15 @@ Use of Mbed platform allows code to port on other Mbed supported target boards w
 
 Product details: https://www.analog.com/en/products/ad5592r.html
 Product Evaluation board details: https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-ADA4250.html
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad5592r_mbed_example
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad559xr_console/ad559xr_console.html
 Communication Protocol: SPI/I2C
 
 
 Hardware Setup
 --------------
 Required: SDP-K1 (or alternative Mbed enabled controller board), EVAL-ADA4250-ARDZ board and USB cable.
 Plug in the EVAL-AD5592R board on SDP-K1 board (or any other Mbed enabled controller board) 
-using the SDP-120 (refer software wiki page to identify suitable interface).
+using the SDP-120 (refer software documentation page to identify suitable interface).
 Connect SDP-K1 board to the PC using the USB cable.
 
 
@@ -29,7 +29,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad559xr_console/tests/readme.txt b/projects/ad559xr_console/tests/readme.txt
@@ -23,8 +23,8 @@ Links:
 LK11: C/B	
 LK1: B	
 
-For more details and photos for connecting power on the AD5592R/93R the wiki page:	
-https://wiki.analog.com/resources/tools-software/product-support-software/ad5592r_mbed_example	
+For more details and photos for connecting power on the AD5592R/93R:	
+https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad559xr_console/ad559xr_console.html
 
 
 

diff --git a/projects/ad5770r_console/README.txt b/projects/ad5770r_console/README.txt
@@ -28,7 +28,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad590_console/README.txt b/projects/ad590_console/README.txt
@@ -10,15 +10,15 @@ Use of Mbed platform allows code to port on other Mbed supported target boards w
 
 Product details: https://www.analog.com/en/products/ad590.html
 Product Evaluation board details: https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-AD590.html
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/eval-ad590ardz
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad590_console/ad590_console.html
 Communication Protocol: SPI
 
 
 Hardware Setup
 --------------
 Required: SDP-K1 (or alternative Mbed enabled controller board), EVAL-AD590-ARDZ board and USB cable.
 Plug in the EVAL-AD590-ARDZ board on SDP-K1 board (or any other Mbed enabled controller board) 
-using the Arduino connector (refer software wiki page to identify suitable interface).
+using the Arduino connector (refer software documentation page to identify suitable interface).
 Connect SDP-K1 board to the PC using the USB cable.
 
 
@@ -27,7 +27,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad5933_console/README.txt b/projects/ad5933_console/README.txt
@@ -14,15 +14,15 @@ Use of Mbed platform allows code to port on other Mbed supported target boards w
 
 Product details: https://www.analog.com/en/products/ad5933.html
 Eval board details: https://digilent.com/reference/pmod/pmodia/start
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad5933-mbed
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad5933_console/ad5933_console.html
 Communication Protocol: I2C
 
 
 Hardware Setup
 --------------
 Required: SDP-K1 (or alternative MBED enabled controller board), recommend Digilent PMOD IA, USB cable.
 Connect the DIGILENT PMOD IA board to SDP-K1 board (or any other Mbed enabled controller board) 
-using the SDP-120 or Arduino on-board connector (refer software wiki page to identify suitable interface) and short jumper-wires.
+using the SDP-120 or Arduino on-board connector (refer software documentation page to identify suitable interface) and short jumper-wires.
 Connect SDP-K1 board to the PC using the USB cable.
 
 
@@ -31,7 +31,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad7124_console/README.txt b/projects/ad7124_console/README.txt
@@ -12,7 +12,7 @@ controller board: https://os.mbed.com/platforms/SDP_K1/
 
 Product details: https://www.analog.com/en/products/ad7124-8.html
 Eval board details: https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-AD7124-8.html
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad7124_mbed_support
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad7124_console/ad7124_console.html
 Communication Protocol: SPI
 
 
@@ -29,7 +29,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad7124_temperature-measure/README.txt b/projects/ad7124_temperature-measure/README.txt
@@ -12,7 +12,7 @@ controller board: https://os.mbed.com/platforms/SDP_K1/
 Product details: https://www.analog.com/en/products/ad7124-8.html, https://www.analog.com/en/products/ad7124-4.html
 Product Evaluation board details: https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-AD7124-8.html
                                   https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-AD7124-4.html
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad7124_temperature_measurement_demo
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad7124_temperature-measure/ad7124_temperature-measure.html
 Communication Protocol: SPI
 
 
@@ -29,7 +29,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad7134_iio/README.txt b/projects/ad7134_iio/README.txt
@@ -18,18 +18,15 @@ Hardware Setup
 --------------
 Required: SDP-K1 (or alternative Mbed/STM32 enabled controller board), EVAL-AD7134 board and USB cable.
 Find further instructions on the hardware connections here:
-https://wiki.analog.com/resources/tools-software/product-support-software/ad7134_iio_support#hardware_connections
+https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad7134_iio/ad7134_iio.html
 
 
 How to Get Started
 ------------------
 The Firmware supports MBED and STM32 platforms. Import code into the respective platform and compile it to generate the executable binary.
 
-Find detailed instructions for MBED platform here: 
-https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
-
-Find detailed instructions for STM32 platform here: 
-https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-stm32-build-guide
+Find detailed instructions here: 
+https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad7134_iio/app/app_config.h b/projects/ad7134_iio/app/app_config.h
@@ -182,7 +182,7 @@
  * and not in case of SAI-TDM method. For TDM, AD7134 can operate only as
  * a controller)
  * Note: The mode configuration must be modified in the hardware to match the one set
- * in software. Refer project wiki document for required h/w changes */
+ * in software. Refer project documentation for required h/w changes */
 #define AD7134_ASRC_MODE	CONTROLLER_MODE
 
 /* Enable/Disable the use of SDRAM for ADC data capture buffer */

diff --git a/projects/ad717x_console/README.txt b/projects/ad717x_console/README.txt
@@ -26,7 +26,7 @@ Product details: https://www.analog.com/en/products/ad4111.html
                  https://www.analog.com/en/products/landing-pages/001/ad717x-family.html
 Eval board details: https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-AD4111.html
                     (*Refer device datasheet page for the respective EVAL boards manual)
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad717x_ad411x_mbed_example
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad717x_console/ad717x_console.html
 Communication Protocol: SPI
 
 
@@ -44,7 +44,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad717x_iio/README.txt b/projects/ad717x_iio/README.txt
@@ -26,7 +26,7 @@ Product details: https://www.analog.com/en/products/ad4111.html
                  https://www.analog.com/en/products/landing-pages/001/ad717x-family.html
 Eval board details: https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-AD4111.html
                     (*Refer device datasheet page for the respective EVAL boards manual)
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad717x_mbed_iio_support
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad717x_iio/ad717x_iio.html
 Communication Protocol: SPI
 
 
@@ -44,7 +44,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad738x_iio/README.txt b/projects/ad738x_iio/README.txt
@@ -19,7 +19,7 @@ Hardware Setup
 --------------
 Required: SDP-K1 (or alternative Mbed enabled controller board), EVAL-AD7380 board, 9V adapter and USB cable.
 Connect the EVAL-AD7380 board to SDP-K1 board (or any other Mbed enabled controller board) using jumper wires
-(refer software wiki page for connection setup).
+(refer software documentation page for connection setup).
 Connect SDP-K1 board to the PC using the USB cable. AD7380 EVB is powered through external 9-12V DC adapter.
 
 
@@ -28,7 +28,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad7606_iio/README.txt b/projects/ad7606_iio/README.txt
@@ -14,16 +14,16 @@ The AD7606-Eval board is interfaced with SDP-K1 (or any Arduino compatible board
 
 Hardware Setup
 --------------
-Refer "Hardware Connections" section from below wiki page link:
-https://wiki.analog.com/resources/tools-software/product-support-software/ad7606_mbed_iio_application
+Refer "Hardware Connections" section from below page link:
+https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad7606_iio/ad7606_iio.html
 
 
 How to Get Started
 ------------------
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad7689_iio/README.txt b/projects/ad7689_iio/README.txt
@@ -11,15 +11,15 @@ Use of Mbed platform allows code to port on other Mbed supported target boards w
 
 Product details: AD7689, AD7682, AD7949, AD7699
 Product Evaluation board details: EVAL-AD7689-ARDZ
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad7689_mbed_iio_support
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad7606_iio/ad7606_iio.html
 Communication Protocol: SPI
 
 
 Hardware Setup
 --------------
 Required: SDP-K1 (or alternative Mbed enabled controller board), EVAL-AD7689 board and USB cable.
 Plug in the EVAL-AD7689 board on SDP-K1 board (or any other Mbed enabled controller board) using the Arduino connector 
-(refer software wiki page for connection setup).
+(refer software documentation page for connection setup).
 Connect SDP-K1 board to the PC using the USB cable. AD7689 EVB is powered through USB supply coming from SDP-K1.
 
 
@@ -28,7 +28,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad77681_iio/README.txt b/projects/ad77681_iio/README.txt
@@ -11,7 +11,7 @@ Use of Mbed platform allows code to port on other Mbed supported target boards w
 
 Product details: https://www.analog.com/en/products/ad7768-1.html
 Product Evaluation board details: https://www.analog.com/en/design-center/reference-designs/circuits-from-the-lab/cn0540.html
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad77681_mbed_iio_application
+User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad77681_iio/ad77681_iio.html
 Communication Protocol: SPI
 
 
@@ -27,7 +27,7 @@ How to Get Started
 Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
 Import code into compiler and compile it to generate executable binary file. 
 Drag and drop binary file into USB drive hosted by SDP-K1 controller board. 
-Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
+Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes

diff --git a/projects/ad777x_iio/README.txt b/projects/ad777x_iio/README.txt
@@ -20,18 +20,15 @@ Hardware Setup
 Required: SDP-K1 (or alternative Mbed/STM32 enabled controller board), EVAL-AD777x board and USB cable.
 
 Find further instructions on the hardware connections here:
-https://wiki.analog.com/resources/tools-software/product-support-software/ad777x_iio_support#hardware_connections
+https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad777x_iio/ad777x_iio.html
 
 
 How to Get Started
 ------------------
 The Firmware supports MBED and STM32 platforms. Import code into the respective platform and compile it to generate the executable binary.
 
-Find detailed instructions for MBED platform here: 
-https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
-
-Find detailed instructions for STM32 platform here: 
-https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-stm32-build-guide
+Find detailed instructions here: 
+https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html
 
 
 Notes