Differences

This shows you the differences between two versions of the page.

--- resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x [31 Jan 2022 17:39] – Angelo Nikko Catapang
+++ resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x [03 Mar 2023 07:42] (current) – Joyce Velasco
@@ Line 1: / Line 1: @@
-====== EVAL-ADPD410X-ARDZ User Guide ======
+====== EVAL-ADPD410x-ARDZ User Guide ======
-**[[ADI>EVAL-ADPD4100-ARDZ]]** and **[[ADI>EVAL-ADPD4101-ARDZ]]** are simple, Arduino form-factor breakout board for developing **[[ADI>ADPD4100]]** and **[[ADI>ADPD4101]]** applications, respectively. The **[[ADI>ADPD4101]]**, interfaced through I2C, and the **[[ADI>ADPD4100]]**, interfaced through SPI, are highly versatile, multimodal sensor front ends, stimulating up to eight light emitting diodes (LEDs) and measuring the return signal on up to eight separate current inputs. There are a number of other evaluation platforms for these devices, including the **[[ADI>EVAL-ADPD4100Z-PPG]]**, optimized for photoplethysmograph applications, and the reference design **[[ADI>CN0503]]**, optimized for optical liquid analysis applications (colorimetry, turbidity, fluorescence). The EVAL-ADPD410X-ARDZ boards come in handy for adapting these evaluation boards to meet specific application requirements, as well as for "ground up" development of new applications.
+The [[ADI>EVAL-ADPD410x-ARDZ]] is a simple, Arduino form-factor breakout board for developing [[ADI>ADPD4100]] and [[ADI>ADPD4101]] applications. The [[ADI>ADPD4101]], interfaced through I2C, and the [[ADI>ADPD4100]], interfaced through SPI, are highly versatile, multimodal sensor front ends, stimulating up to eight light emitting diodes (LEDs) and measuring the return signal on up to eight separate current inputs. There are a number of other evaluation platforms for these devices, including the [[ADI>EVAL-ADPD4100Z-PPG]], optimized for photoplethysmograph applications, and the reference design [[ADI>CN0503]], optimized for optical liquid analysis applications such as colorimetry, turbidity, and fluorescence. The [[ADI>EVAL-ADPD410x-ARDZ]] board come in handy for adapting these evaluation boards to meet specific application requirements, as well as for "ground up" development of new applications.
 {{ :resources:eval:user-guides:circuits-from-the-lab:adpd410x:20220105_094532.jpg?nolink&600 |}}
@@ Line 8: / Line 8: @@
 ===== Device Driver and Support =====
-A no-OS device driver and example program is provided, targeting the EVAL-ADICUP3029 platform. The ADICUP3029 example application uses the ADPD410x no-OS driver, and emulates the Linux IIO framework through the tinyiiod daemon library. The application communicates with the host computer via the serial backend, over a USB-UART physical connection. This facilitates rapid application development on a host computer, independent from embedded code development.
+A no-OS device driver and an example program are provided, targeting the [[ADI>EVAL-ADICUP3029]] platform. The ADICUP3029 example application uses the ADPD410x no-OS driver and emulates the Linux IIO framework through the tinyiiod daemon library. The application communicates with the host computer via the serial backend over a USB-UART physical connection. This facilitates rapid application development on a host computer, independent from embedded code development.
-Similarly, utility software (iio_info, IIO Oscilloscope, PyADI-IIO, etc.) that are typically associated with Linux systems can be used with this no-OS implementation.
+Similarly, utility software (such as iio_info, IIO Oscilloscope, PyADI-IIO, etc.) typically associated with Linux systems can be used with this no-OS implementation.
 ===== Materials Needed =====
   * [[ADI>EVAL-ADICUP3029]]
-  * [[ADI>EVAL-ADPD4100-ARDZ]] or [[ADI>EVAL-ADPD4101-ARDZ]]
+  * [[ADI>EVAL-ADPD410x-ARDZ]]
   * Micro USB to USB cable
   * PC or laptop with a USB port
@@ Line 20: / Line 21: @@
 ==== Jumper Configuration ====
-There are two shunt-configurable jumpers and 3 types of solder jumpers on both **[[ADI>EVAL-ADPD4100-ARDZ]]** and **[[ADI>EVAL-ADPD4101-ARDZ]]** boards.
+There are two shunt-configurable jumpers and three types of solder jumpers on the [[ADI>EVAL-ADPD410x-ARDZ]] board.
 === I/O Logic Voltage (IOSEL) Shunt Positions ===
@@ Line 27: / Line 28: @@
 === Onboard LED and Photodiode (P10) Shunt Positions ===
-An onboard LED and photodiode is by default connected to LED1A and PD1A, respectively. **When using external LEDs and sensors on this channel, make sure to remove this connection using jumper header P10**
+The onboard LED and photodiode are by default connected to LED1A and PD1A, respectively. **When using external LEDs and sensors on this channel, make sure to remove this connection using jumper header P10.**
 ^ Correct Shunt Position                                        ^ Layout Picture ^
 | Shorted Pin 1 and 2, Shorted Pin 3 and 4, Shorted Pin 5 and 6 | {{ :resources:eval:user-guides:circuits-from-the-lab:adpd410x:p10_shunt.png?nolink&100 |}}                                        |
@@ Line 33: / Line 34: @@
 === LED Supply Voltage (JP1) Solder Positions ===
 ^ Correct Shunt Position ^ Layout Picture                                                                       ^
-| Shorted Pin 1 and 2    | {{ :resources:eval:user-guides:circuits-from-the-lab:jp1_5v.png?nolink&100 |}} |
+| Shorted Pin 2 and 3    | {{ :resources:eval:user-guides:circuits-from-the-lab:jp1_5v.png?nolink&100 |}} |
 === LED Driver Connection P9, P11, P13, P15, P17, P19, P22, P24 ===
@@ Line 41: / Line 42: @@
 === SPI or I2C Interface ===
 ^ Board                    ^ Shorted Resistors                 ^ Layout Picture ^
-| EVAL-ADPD4100-ARDZ (SPI) | Shorted R8 and R9, Open R6 and R7 | {{ :resources:eval:user-guides:circuits-from-the-lab:adpd410x:adpd4100_r8_r9.png?nolink&100 |}}                                  |
+| EVAL-ADPD410x-ARDZ (SPI) | Shorted R8 and R9, Open R6 and R7 | {{ :resources:eval:user-guides:circuits-from-the-lab:adpd410x:adpd4100_r8_r9.png?nolink&100 |}}                                  |
-Below is a photo of the EVAL-ADPD4100-ARDZ (SPI) board with all the correct shunt and solder jumper connections.
+Below is a photo of the [[ADI>ADPD4100]] (SPI) board with all the correct shunt and solder jumper connections.
 {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:spi.jpg?nolink&600|}}
 ^ Board                    ^ Shorted Resistors                 ^ Layout Picture ^
-| EVAL-ADPD4101-ARDZ (I2C) | Shorted R6 and R7, Open R8 and R9 | {{ :resources:eval:user-guides:circuits-from-the-lab:adpd410x:adpd4101_r6_r7.png?nolink&100 |}}                                  |
+| [[ADI>ADPD4101]] (I2C) | Shorted R6 and R7, Open R8 and R9 | {{ :resources:eval:user-guides:circuits-from-the-lab:adpd410x:adpd4101_r6_r7.png?nolink&100 |}}                                  |
 Below is a photo of the EVAL-ADPD4101-ARDZ (I2C) board with all the correct shunt and solder jumper connections.
 {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:i2c.jpg?nolink&600|}}
 ==== Prototyping Connectors ====
-The board has 2 parallel 18-pin 100-mil pitch male connectors which give access to the LED driver channels, the photodiode inputs, custom I/O pins from the AFE, and supply voltage for the LED. The user can use this along with the break-away protoboard to implement a custom circuit for test. The pin assignment and functions are shown below.
+The board has two parallel 18-pin, 100-mil pitch male connectors, which give access to the LED driver channels, the photodiode inputs, custom I/O pins from the AFE, and supply voltage for the LED. The user can use this along with the break-away protoboard to implement a custom circuit for testing. The pin assignment and functions are shown below.
 {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pinassignment.jpg?nolink&400|}}{{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pinassignmentdiagram.png?nolink&400|}}
-Pins labeled **XYC** (where X refers to LED 1, 2, 3, or 4 and Y refers to channel A or B) denote connections to the LED cathode which are voltage protected via transistors to the ADPD4100/1 LED inputs (denoted by **LXY**). It is recommended to connect LED cathodes to this pins instead of connecting directly to **LXY** pins. **PDXY** (X refers to photodiode 1, 2, 3, or 4 and Y refers to channel A or B) pins denote photodiode signal inputs to the AFE. **ACOM** and **BCOM** pins refer to the common cathode bias output for photodiode sensors. These should be connected to the cathodes of photodiodes in the matching channel (i.e. photodiodes connected to PD1A, PD2A, PD3A, and PD4A should have their cathodes connected to ACOM).
-A simple circuit for testing LED driver outputs and photodiode current sensing using the break-away prototype board can easily be set-up using optocouplers as shown below.
+Pins labeled **XYC** (where X refers to LED 1, 2, 3, or 4, and Y refers to channel A or B) denote connections to the LED cathode which are voltage protected via transistors to the ADPD4100/1 LED inputs (denoted by **LXY**). It is recommended to connect LED cathodes to these pins instead of connecting directly to **LXY** pins. **PDXY** (X refers to photodiode 1, 2, 3, or 4 and Y refers to channel A or B) pins denote photodiode signal inputs to the AFE. **ACOM** and **BCOM** pins refer to the common cathode bias output for photodiode sensors. These should be connected to the cathodes of photodiodes in the matching channel (for example, photodiodes connected to PD1A, PD2A, PD3A, and PD4A should have their cathodes connected to ACOM).
+A simple circuit for testing LED driver outputs and photodiode current sensing using the break-away prototype board can easily be set up using optocouplers, as shown below.
 {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:testschematic.png?nolink&600|}}
 ==== General Connection ====
-  * Set the following EVAL-ADICUP3029 switches according to their configuration on the table
+  * Set the following EVAL-ADICUP3029 switches according to their configuration on the table.
 ^ Switch     ^ Configuration ^
@@ Line 67: / Line 69: @@
 | POWER (S5) | WALL/USB      |
-  * Connect the EVAL-ADPD4100-ARDZ or EVAL-ADPD4101-ARDZ, both with the correct jumper configuration in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#jumper_configuration|Jumper Configuration]], to the EVAL-ADICUP3029 using the headers shown.
+  * Connect the [[ADI>EVAL-ADPD410x-ARDZ]] to the [[ADI>EVAL-ADICUP3029]] using the headers shown. See correct Jumper Configuration for both evaluation boards [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#jumper_configuration|here]].
 {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:arduinoconnection.jpg?nolink&400|}}
 ===== Driver / Firmware Setup =====
-There are two basic ways to program the [[EVAL-ADICUP3029]] with the software for both boards.
+There are two basic ways to program the [[ADI>EVAL-ADICUP3029]] with the software for both boards.
 ==== Dragging and Dropping the Hex File to the Daplink Drive ====
-  - Ensure that the [[ADI>EVAL-ADICUP3029]] board switches are set to the correct configuration as detailed in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#general_connection|General Connection]]
+  - Ensure that the [[ADI>EVAL-ADICUP3029]] board switches are set to the correct configuration, as detailed in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#general_connection|General Connection]].
   - Connect the [[ADI>EVAL-ADICUP3029]] board to the PC or laptop using the Micro USB to USB cable.
-  - Drag and Drop the appropriate .hex file from the list below to the the Daplink Drive {{:resources:eval:user-guides:eval-adicup3029:tools:daplink_windows_explorer.png?550|}}
+  - Drag and Drop the appropriate .hex file from the list below to the Daplink Drive. {{:resources:eval:user-guides:eval-adicup3029:tools:daplink_windows_explorer.png?550|}}
-  - The drive will unmount once the .hex file is dropped and wait for it to reappear. Once it does, press the reset button of the **[[ADI>EVAL-ADICUP3029]]** to ensure that the microcontroller is updated.
+  - The drive will unmount once the .hex file is dropped and wait for it to reappear. Once it does, press the reset button of the [[ADI>EVAL-ADICUP3029]] to ensure that the microcontroller is updated.
+<WRAP center round download 80%>
+Pre-built hex files can be found here:
+  * [[repo>EVAL-ADICUP3029/releases/download/Latest/ADuCM3029_demo_adpd410x_spi.hex|EVAL-ADPD4100-ARDZ .Hex File (ADuCM3029_demo_adpd410x_spi.hex)]]
+  * [[repo>EVAL-ADICUP3029/releases/download/Latest/ADuCM3029_demo_adpd410x_i2c.hex|EVAL-ADPD4101-ARDZ .Hex File (ADuCM3029_demo_adpd410x_i2c.hex)]]
+The latest source code can be found here:
+  * [[repo>EVAL-ADICUP3029/tree/master/projects/ADuCM3029_demo_adpd410x]].
-<WRAP todo>
-Prerelease hex files can be found inside this zip archive: {{ :resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x-ardz_pre-release_hex_files.zip |}}. For the latest build, see [[repo>EVAL-ADICUP3029/releases/tag/Latest]]
-  * For EVAL-ADPD4100: EVAL-ADPD4100-ARDZ.hex
-  * For EVAL-ADPD4101: EVAL-ADPD4101-ARDZ.hex
 </WRAP>
 ==== Using CrossCore Embedded Studio ====
-  - You will have to acquire a copy of the project source files of the EVAL-ADPD410X-ARDZ. You can download the source files directly from the repository at [[repo>EVAL-ADICUP3029/tree/dev/cn0567/projects/ADuCM3029_demo_cn0567]] or you can clone the entire [[https://github.com/analogdevicesinc/EVAL-ADICUP3029 | EVAL-ADICUP3029 repository]] and check the projects folder for ADuCM3029_demo_cn0567
+  - Acquire a copy of the project source files of the [[adi>EVAL-ADPD410x-ARDZ]] by downloading the source files directly from the repository at [[repo>EVAL-ADICUP3029/tree/master/projects/ADuCM3029_demo_adpd410x]] or you can clone the entire [[https://github.com/analogdevicesinc/EVAL-ADICUP3029 | EVAL-ADICUP3029 repository]] and check the projects folder for ADuCM3029_demo_adpd410x.
-  - Open CrossCore Embedded Studio and import the project into your workspace as detailed in [[:resources:eval:user-guides:eval-adicup3029:tools:cces_user_guide]]. This allows you to edit the software to fit your requirements. <WRAP important>If this is your first time using CrossCore Embedded Studio, check the [[:resources:eval:user-guides:eval-adicup3029:tools:cces_user_guide | user guide]] to get you started</WRAP>
+  - Open CrossCore Embedded Studio and import the project into your workspace, as detailed in the [[:resources:eval:user-guides:eval-adicup3029:tools:cces_user_guide]]. This allows you to edit the software to fit your requirements. <WRAP important>If this is your first time using CrossCore Embedded Studio, check the [[:resources:eval:user-guides:eval-adicup3029:tools:cces_user_guide | user guide]] to get started.</WRAP>
-  - Once ready, you can opt to generate your own .hex file and use the first method to program the **[[EVAL-ADICUP3029]]** or you can use a debug session by following the quickstart guide.
+  - Once ready, you can opt to generate your own .hex file and use the first method to program the [[ADI>EVAL-ADICUP3029]] or you can use a debug session by following the quickstart guide.
 === CrossCore Project Header File Configuration ===
-  * You can select for which board the project will support when built using [[https://github.com/analogdevicesinc/EVAL-ADICUP3029/blob/master/projects/ADuCM3029_demo_cn0567/src/app_config.h|app_config.h]]
+  * Select which board the project will support when built using [[https://github.com/analogdevicesinc/EVAL-ADICUP3029/blob/master/projects/ADuCM3029_demo_adpd410x/src/app_config.h|app_config.h]].
     * For EVAL-ADPD4100-ARDZ\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd4100_support.png?nolink&400|}}
     * For EVAL-ADPD4101-ARDZ\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd4101_support.png?nolink&400|}}
-You can configure the default timeslots and other settings of the [[ADI>ADPD4100]] or [[ADI>ADPD4101]] using [[https://github.com/analogdevicesinc/EVAL-ADICUP3029/blob/master/projects/ADuCM3029_demo_cn0567/src/cn0567_config.h|cn0567_config.h]].
+You can configure the default timeslots and other settings of the [[ADI>ADPD4100]] or [[ADI>ADPD4101]] using [[https://github.com/analogdevicesinc/EVAL-ADICUP3029/blob/master/projects/ADuCM3029_demo_adpd410x/src/adpd410x_app_config.h|adpd410x_app_config.h]].
   * You can set the default number of active timeslots and output data rate.\\ {{:resources:eval:user-guides:circuits-from-the-lab:activetimeslots_odr.png?nolink&400|}}
-  * Initial timeslot settings are configured using the **adpd410x_timeslot_init** data structure as shown below:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_datastructure.png?nolink&400|}}
+  * Initial timeslot settings are configured using the **adpd410x_timeslot_init** data structure, as shown below:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_datastructure.png?nolink&400|}}
-    * **Enabling ADC channel 2**\\ Each timeslot can use the two ADC input channels of the ADPD4100/1. By default, the timeslot only uses channel 1. Setting this to true will enable the channel 2.
+    * **Enabling ADC channel 2**\\ Each timeslot can use the two ADC input channels of the ADPD4100/1. By default, the timeslot only uses channel 1. Setting this to true will enable channel 2.
-    * **Timeslot Inputs**\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_inputs.png?nolink&400|}}\\ Each timeslot input can be set to use a pair of input pins of the ADPD4100/1. Below are possible pair options\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_pairoptions.png?nolink&400|}}\\ Each of the input pins can be disabled or routed to any or both of the channels. Below are the possible configurations of the input pins.\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_inputoptions.png?nolink&400|}}
+    * **Timeslot Inputs**\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_inputs.png?nolink&400|}}\\ Each timeslot input can be set to use a pair of input pins of the ADPD4100/1. Below are possible pair options:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_pairoptions.png?nolink&400|}}\\
-    * **Timeslot Input Preconditioning**\\ Timeslot inputs have programmable connections which precondition the sensor to set operating condition before sampling. Below are the possible options:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_precond.png?nolink&400|}}
+    * Each of the input pins can be disabled or routed to any or both of the channels. Below are the possible configurations of the input pins.\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_inputoptions.png?nolink&400|}}\\
-    * **TIA Reference Voltage**\\ The reference voltage of the TIA (Trans-Impedance Amplifier) is configurable. Below are the possible values:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_tiavref.png?nolink&400|}}
-    * **TIA Gain Resistor**\\ The gain resistor used by the TIA (Trans-Impedance Amplifier) is configurable for each input channel. Below are the possible values:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_tiares.png?nolink&400|}}
+    * **Timeslot Input Preconditioning**\\ Timeslot inputs have programmable connections, which precondition the sensor to set operating conditions before sampling. Below are the possible options:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_precond.png?nolink&400|}}
-    * **Multiple Pulses and Integrator Chopping** The ADPD4100/1 is capable of improving SNR using multiple pulses per sample and integrator chopping which have configurable settings.
+    * **TIA Reference Voltage**\\ The reference voltage of the Trans-Impedance Amplifier (TIA) is configurable. Below are the possible values:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_tiavref.png?nolink&400|}}
+    * **TIA Gain Resistor**\\ The gain resistor used by the TIA is configurable for each input channel. Below are the possible values:\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_tiares.png?nolink&400|}}
+    * **Multiple Pulses and Integrator Chopping** The ADPD4100/1 is capable of improving SNR using multiple pulses per sample and integrator chopping, which have configurable settings.
       * **4-Pulse Reverse Pattern**\\ Each pulse from the LED in a set of 4 can be configured to either have an on-off or off-on integrator chopping sequence. This is a 4-bit value, 1 bit for each pulse. Setting a bit reverses the integrator chopping sequence for that pulse.
       * **4-Pulse Subtract Pattern**\\ The mathematical operation performed on a digitized ADC sample can be set to addition or subtraction for each pulse in a set of 4. This is a 4-bit value, 1 bit for each pulse. Setting a bit negates the operation for that pulse.
-    * **Byte Number**\\ This sets the number of data bytes used in the timeslot
+    * **Byte Number**\\ This sets the number of data bytes used in the timeslot.
     * **Decimation Factor**\\ The decimation factor sets the number of time slot values used in the final sample.\\ <code>
 output data rate = sample rate / (decimation factor - 1)
 </code>
-    * **LED Output**\\ The 4 LED outputs have configurable output current and can be set to either channel A or channel B only. You can define the LED value directly or through fields. The first 7 bits are for the output current which scale from 1.5mA to 200mA for 0x01 to 0x7F. The last bit is for the output channel. Setting this bit selects channel B while clearing selects channel A.\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_led.png?nolink&400|}}
+    * **LED Output**\\ The 4 LED outputs have configurable output current and can be set to either channel A or channel B only. You can define the LED value directly or through fields. The first 7 bits are for the output current, which scale from 1.5 mA to 200 mA for 0x01 to 0x7F. The last bit is for the output channel. Setting this bit selects channel B while clearing selects channel A.\\ {{:resources:eval:user-guides:circuits-from-the-lab:timeslot_led.png?nolink&400|}}
     * **ADC Cycles**\\ This sets the number of integration cycles per ADC conversion. This value can range from 0x01 to 0xFF.\\
-    * **Number of Repeats**\\ This sets the number of repeat ADC conversions.\\ This value can range from 0x01 to 0xFF\\ <code>
+    * **Number of Repeats**\\ This sets the number of repeat ADC conversions\\. This value can range from 0x01 to 0xFF\\. <code>
 total number of pulses = ADC cycles X Number of Repeats
 </code>
@@ Line 124: / Line 133: @@
 ==== Connection ====
-The device must be able to create a context. Context creation in the software depends on the backend used to connect the device. This guide will cover the device communication using the currently supported platform, a serial backend through a USB-UART connection. A simple way of checking, if the device is connected, is through the **[[:resources:tools-software:linux-software:libiio:iio_info | iio_info]]** command. It reports all IIO attributes of a detected device and context. Simple enter the command shown below to a terminal / command line.
+The device must be able to create a context. Context creation in the software depends on the backend used to connect the device. This guide covers the device communication using the currently supported platform, a serial backend through a USB-UART connection. A simple way of checking, if the device is connected, is through the **[[:resources:tools-software:linux-software:libiio:iio_info | iio_info]]** command. Specifically, it reports all IIO attributes of a detected device and context. To do this, simply enter the below command to a terminal or command line.
 <code>
 iio_info -u serial:<serial port>
 </code>
 Examples:
-  * In a Windows machine, you can check the port of your ADICUP3029 via Device Manager in the Ports (COM & LPT) section. If your device is in COM4, you have to use **serial:COM4** as your URI. (E.G. //iio_info -u serial:COM4//)
+  * In a Windows machine, you can check the port of your ADICUP3029 via Device Manager in the Ports (COM & LPT) section. If your device is in COM4, use **serial:COM4** as your URI (e.g., //iio_info -u serial:COM4//).
-  * In a Unix-based machine, you will see it under the /dev/ directory in this format “ttyUSBn”, where n is a number depending on how many serial USB devices attached. If you see that your device is ttyUSB0, you have to use **serial:/dev/ttyUSB0** as your URI. (E.G. //iio_info -u serial:/dev/ttyUSB0//)
+  * In a Unix-based machine, you will see it under the /dev/ directory in this format “ttyUSBn”, where n is a number depending on how many serial USB devices are attached. If you see that your device is ttyUSB0, use **serial:/dev/ttyUSB0** as your URI. (e.g., //iio_info -u serial:/dev/ttyUSB0//).
 An example output of this command should look like the one below:
 {{:resources:eval:user-guides:circuits-from-the-lab:iio_info_-_output.png?nolink&600|}}
@@ Line 141: / Line 150: @@
 <code>
 iio_attr -u <URI> -c <DEVICENAME> <CHANNELNAME> <ATTRIBUTE>
-E.g. for a Windows Machine
+E.g., for a Windows Machine
 iio_attr -u serial:COM4  -c adpd410x voltage0 raw
 </code>
-  * <URI> specifies the URI similar to the one used in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]]
+  * <URI> specifies the URI similar to the one used in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]].
-  * <DEVICENAME> specifies the device name which is **adpd410x**
+  * <DEVICENAME> specifies the device name, which is **adpd410x**.
-  * <CHANNELNAME> specifies the channel name which are formatted as voltageX where X can be from 0 to 7
+  * <CHANNELNAME> specifies the channel name, which are formatted as voltageX where X can be from 0 to 7.
-  * <ATTRIBUTE> specifies the name of the channel attribute which is raw. This is a read-only attribute
+  * <ATTRIBUTE> specifies the name of the channel attribute, which is raw. This is a read-only attribute.
 An example output of this command should look like the one below:
 {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:rawchanneliio.png?nolink&600|}}
@@ Line 154: / Line 163: @@
 The -d option of the **[[:resources:tools-software:linux-software:libiio:iio_attr | iio_attr]]** command allows reading or writing (only for specific items) of device attributes. For example, the //sampling_frequency// attribute is readable and writeable. The command to read and write to this attribute is shown below:
 <code>
-For reading: iio_attr -u <URI> -d <DEVICENAME> <ATTRIBUTE>
+For reading, use iio_attr -u <URI> -d <DEVICENAME> <ATTRIBUTE>
-For writing: iio_attr -u <URI> -d <DEVICENAME> <ATTRIBUTE> <VALUE>
+For writing, use iio_attr -u <URI> -d <DEVICENAME> <ATTRIBUTE> <VALUE>
-E.g. for a Windows Machine
+e.g., for a Windows Machine
 iio_attr -u serial:COM4 -d adpd410x sampling_frequency 40
 </code>
-  * <URI> specifies the URI similar to the one used in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]]
+  * <URI> specifies the URI similar to the one used in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]].
-  * <DEVICENAME> specifies the device name which is **adpd410x**
+  * <DEVICENAME> specifies the device name which is **adpd410x**.
   * <ATTRIBUTE> specifies the name of the device attribute which is **sampling_frequency**.
 An example output of this command should look like the one below:
@@ Line 166: / Line 175: @@
 ==== IIO Oscilloscope ====
-<note important>Make sure to download/update to the latest version of IIO-Oscilloscope found on this link[[https://github.com/analogdevicesinc/iio-oscilloscope/releases]]</note>
+<note important>Make sure to download/update to the latest version of IIO-Oscilloscope found on this link[[https://github.com/analogdevicesinc/iio-oscilloscope/releases]].</note>
-  - Install and Start IIO-Oscilloscope. There are two options you can use to select IIO contexts. First, you can use the Serial option and input the correct port settings of the board from the Device Manager. Another way is to manually enter the URI used in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]]\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:iio-oscilloscopeserialcontext.png?nolink&400|}}{{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:iio-oscilloscopemanualcontext.png?nolink&400|}}
+  - Install and start IIO-Oscilloscope. There are two options you can use to select IIO contexts. First, you can use the Serial option and input the correct port settings of the board from the Device Manager. Another way is by manually entering the URI used in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]]. \\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:iio-oscilloscopeserialcontext.png?nolink&400|}}{{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:iio-oscilloscopemanualcontext.png?nolink&400|}}
-  - Press Refresh to display available IIO Devices and, once adpd410x is detected, press Connect. It may take several presses to Connect before the software proceeds and opens the Debug Panel and Waveform Panel\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:iio-oscilloscopedetecteddevice.png?nolink&400|}}
+  - Press Refresh to display available IIO Devices, and once adpd410x is detected, press Connect. It may take several presses to Connect before the software proceeds and opens the Debug Panel and Waveform Panel\\. {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:iio-oscilloscopedetecteddevice.png?nolink&400|}}
 === Debug Panel ===
@@ Line 175: / Line 184: @@
 === Waveform Panel ===
-The Waveform panel, also known as the Capture window, displays the real-time waveform of selected photodiode channels of the ADPD410x. Select the desired channels to display at the upper left section. You can also edit the plot settings at the left section\\
+The Waveform panel, also known as the Capture window, displays the real-time waveform of selected photodiode channels of the ADPD410x. Select the desired channels to display in the upper left section. You can also edit the plot settings in the left section.\\
-<WRAP important>You cannot use the Debug Panel and the Waveform Panel simultaneously. Using the Waveform Panel will freeze the Debug Panel</WRAP>
+<WRAP important>You cannot use the Debug Panel and the Waveform Panel simultaneously. Using the Waveform Panel will freeze the Debug Panel.</WRAP>
 {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:iio-oscilloscopeplotinstructions.png?nolink&400|}}{{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:iio-oscilloscopeplot.png?nolink&400|}}
-<note important>For best device operation and waveform captured, it is recommended to use a time domain plot with 20 samples</note>
+<note important>For best device operation and waveform captured, it is recommended to use a time domain plot with 20 samples.</note>
 ==== Python and PyADI-IIO ====
@@ Line 184: / Line 193: @@
 === Installing the Packages ===
-<note important>PyADI-IIO requires a Python installed in your computer. It is recommended to install Python 3.7 or higher</note>
+<note important>PyADI-IIO requires a Python installed on your computer. It is recommended to install Python 3.7 or higher.</note>
-Install PyADI-IIO using one of the methods in [[/resources/tools-software/linux-software/pyadi-iio|PyADI-IIO]].\\
+Install PyADI-IIO using one of the methods in [[/resources/tools-software/linux-software/pyadi-iio|PyADI-IIO]]\\.
-There are two example scripts found in the examples folder in [[/resources/tools-software/linux-software/pyadi-iio|PyADI-IIO]]. To run both examples the following packages are required: [[https://www.pyqtgraph.org | pyqtgraph]], [[https://scipy.org | scipy]], [[https://www.riverbankcomputing.com/software/pyqt | PyQt5]], [[https://matplotlib.org | matplotlib]].\\
+There are two example scripts found in the examples folder in [[/resources/tools-software/linux-software/pyadi-iio|PyADI-IIO]]. To run both examples, the following packages are required: [[https://www.pyqtgraph.org | pyqtgraph]], [[https://scipy.org | scipy]], [[https://www.riverbankcomputing.com/software/pyqt | PyQt5]], [[https://matplotlib.org | matplotlib]].\\
-If you are using [[https://pip.pypa.io/en/stable | pip]], you can install all of the PyADI-IIO as well as the example script dependencies by following these steps:
+If you are using [[https://pip.pypa.io/en/stable | pip]], you can install all of the PyADI-IIO, as well as the example script dependencies, by following these steps:
   - Clone or download the pyadi-iio repository [[repo>pyadi-iio/]]
   - Open command prompt or terminal and navigate to the //pyadi-iio// directory.
@@ Line 197: / Line 206: @@
 ...\pyadi-iio\>python setup.py install
 </code>
-<note important> One of the packages in //requirements_adiplot.txt// is the PyQt5. If you already have a pre-installed PyQt5 prior to the installation of the packages, we suggest that you uninstall the said package in the virtual environment. Duplicate installations may sometimes cause errors that inhibit the system from displaying the real-time plot. This can easily be done by inputting the command: //pip uninstall PyQt5// while the virtual environment is active. </note>
+<note important> One of the packages in //requirements_adiplot.txt// is the PyQt5. If you already have a pre-installed PyQt5 prior to the installation of the packages, it is suggested that you uninstall the said package in the virtual environment. Duplicate installations may sometimes cause errors that inhibit the system from displaying the real-time plot. This can easily be done by inputting the command: //pip uninstall PyQt5// while the virtual environment is active. </note>
 === Running the Examples ===
-There are three example scripts for the ADPD410x found in [[repo>pyadi-iio/]]. The first simply reads from the photodiode channels, the second plots specified photodiode channels and the third tests the board separately, with its onboard LED and photodiode and with a test setup built from the simple example circuit from [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#prototyping_connectors | Prototyping Connectors]].\\
+There are three example scripts for the ADPD410x found in [[repo>pyadi-iio/]]. The first simply reads from the photodiode channels, the second plots specified photodiode channels, and the third tests the board separately, with its onboard LED and photodiode and with a test setup built from the simple example circuit from [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#prototyping_connectors | Prototyping Connectors]].\\
 For example 1, follow these steps:
-  - Connect the EVAL-ADPD4100-ARDZ or EVAL-ADPD4101-ARDZ to the EVAL-ADICUP3029
+  - Connect the [[ADI>EVAL-ADPD410x-ARDZ]] to the [[ADI>EVAL-ADICUP3029]].
-  - Connect the EVAL-ADICUP3029 to the pc using the micro-USB cable and note the serial port from the Device Manager as in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]]
+  - Connect the [[ADI>EVAL-ADICUP3029]] to the PC using the micro-USB cable and note the serial port from the Device Manager as in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]].
   - Open command prompt or terminal and navigate to the examples folder inside the downloaded or cloned //pyadi-iio// directory.
   - Run the example using the command: <code>...\pyadi-iio\examples>python adpd410x_example.py</code>
-  - Input the noted serial port and press //Connect//\\  {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example1_comport.png?nolink&400|}}
+  - Input the noted serial port and press //Connect//\\  {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example1_comport.png?nolink&400|}}.
-  - Once connected, press //Read//\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example1_read.png?nolink&400|}}
+  - Once connected, press //Read//\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example1_read.png?nolink&400|}}.
 \\
 For example 2, follow these steps:
-  - Connect the EVAL-ADPD4100-ARDZ or EVAL-ADPD4101-ARDZ to the EVAL-ADICUP3029
+  - Connect the [[ADI>EVAL-ADPD410x-ARDZ]] to the [[ADI>EVAL-ADICUP3029]].
-  - Connect the EVAL-ADICUP3029 to the pc using the micro-USB cable and note the serial port from the Device Manager as in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]]
+  - Connect the [[ADI>EVAL-ADICUP3029]] to the PC using the micro USB cable and note the serial port from the Device Manager as in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]].
   - Open command prompt or terminal and navigate to the examples folder inside the downloaded or cloned //pyadi-iio// directory.
   - Run the example script using the command: <code>...\pyadi-iio\examples>python adpd410x_plot.py</code>
-  - The script will ask for a serial port. Input the noted serial port and press Enter. In cases when the board is not found, press the reset button (S1) on the EVAL-ADPD4100-ARDZ or EVAL-ADPD4101-ARDZ and input the noted serial port again.\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example2_comport.png?nolink&400|}}
+  - The script will ask for a serial port. Input the noted serial port and press Enter. In cases when the board is not found, press the reset button (S1) on the [[ADI>EVAL-ADPD410x-ARDZ]] and input the noted serial port again.\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example2_comport.png?nolink&400|}}
-  - When the board is detected, you will be asked to specify the number of channels (1 to 8) you want to read. Then you need to specify the desired channel numbers (1 to 8).\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example2_inputchannels.png?nolink&400|}}
+  - When the board is detected, you will be asked to specify the number of channels (1 to 8) you want to read. Then, you need to specify the desired channel numbers (1 to 8).\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example2_inputchannels.png?nolink&400|}}
   - A plot will appear showing the specified channels. You have the option to save a copy of the displayed waveform at any point in time using the matplotlib controls at the top.\\ {{:resources:eval:user-guides:circuits-from-the-lab:adpd410x:pyadiiio_example2_plot.png?nolink&400|}}
 \\
 For example 3, follow these steps:
-  - Connect the EVAL-ADPD4100-ARDZ or EVAL-ADPD4101-ARDZ to the EVAL-ADICUP3029
+  - Connect the [[ADI>EVAL-ADPD410x-ARDZ]] to the EVAL-ADICUP3029.
-  - Connect the EVAL-ADICUP3029 to the pc using the micro-USB cable and note the serial port from the Device Manager as in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]]
+  - Connect the [[ADI>EVAL-ADICUP3029]] to the pc using the micro-USB cable and note the serial port from the Device Manager as in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]].
   - Open command prompt or terminal and navigate to the examples folder inside the downloaded or cloned //pyadi-iio// directory.
   - Run the example script using the command: <code>...\pyadi-iio\examples>python adpd410x_test.py</code>
-  - A GUI window will appear as shown below. There are 4 buttons at the top right for each test namely, open onboard LED test, covered onboard LED test, no load test, and mounted jig test. **Before pressing a button to start the test, select the noted COM port on the dropdown list at the top left.**\\ {{:resources:eval:user-guides:circuits-from-the-lab:softwarewindow.png?nolink&600|}}
+  - A GUI window will appear, as shown below. There are four buttons at the top right for each test namely, open onboard LED test, covered onboard LED test, no load test, and mounted jig test. **Before pressing a button to start the test, select the noted COM port on the dropdown list at the top left.**\\ {{:resources:eval:user-guides:circuits-from-the-lab:softwarewindow.png?nolink&600|}}
     * **Open Onboard LED Test**\\ The test samples raw ADC values from the onboard photodiode and checks whether it is consistent with the standard. Make sure that all shunts on jumper header P10 are present and connected. A sample passing result is shown below\\ {{:resources:eval:user-guides:circuits-from-the-lab:openledresult.png?nolink&600|}}
     * **Covered Onboard LED Test**\\ Place your finger above the onboard photodiode and LED.\\ {{:resources:eval:user-guides:circuits-from-the-lab:coveredled.jpg?nolink&400|}}\\ This test checks if the sampled raw ADC value has significantly increased from the standard uncovered value. A sample passing result is shown below.\\ {{:resources:eval:user-guides:circuits-from-the-lab:coveredledresult.png?nolink&600|}}
-    * **No Load Test**\\ Remove all shunts on jumper header P10. This test checks the photodiode input when no external sensor is connected. A sample passing result is shown below.\\ {{:resources:eval:user-guides:circuits-from-the-lab:noloadtestresult.png?nolink&600|}}
+    * **No Load Test**\\ Remove all shunts on jumper header P10. This test checks the photodiode input when no external sensor is connected. A sample passing result is shown below.\\ {{:resources:eval:user-guides:circuits-from-the-lab:noloadtestresult.png?nolink&600|}}.
-    * **Mounted Jig Test**\\ Using the simple test schematic shown in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]], a test board was fabricated using [[https://www.onsemi.com/pdf/datasheet/moc217m-d.pdf | MOC207M]] optocouplers. Remove all shunts on jumper header P10 and connect the test jig to the EVAL-ADPD4100-ARDZ or EVAL-ADPD4101-ARDZ as shown below. **(The test jig shown below was fabricated with female headers for easy mounting)**\\ {{:resources:eval:user-guides:circuits-from-the-lab:testjig_connection.jpg?nolink&600|}}\\ A sample passing result is shown below.\\ {{:resources:eval:user-guides:circuits-from-the-lab:mountedjigtestresult.png?nolink&600|}}
+    * **Mounted Jig Test**\\ Using the simple test schematic shown in [[resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x#connection | Connection]], a test board was fabricated using [[https://www.onsemi.com/pdf/datasheet/moc217m-d.pdf | MOC207M]] optocouplers. Remove all shunts on jumper header P10 and connect the test jig to the [[ADI>EVAL-ADPD410x-ARDZ]], as shown below. **(The test jig shown below was fabricated with female headers for easy mounting)**\\ {{:resources:eval:user-guides:circuits-from-the-lab:testjig_connection.jpg?nolink&600|}}\\ A sample passing result is shown below.\\ {{:resources:eval:user-guides:circuits-from-the-lab:mountedjigtestresult.png?nolink&600|}}
+\\
+\\
 ===== Schematic, PCB Layout, Bill of Materials =====
 <WRAP round 80% download>
-[[adi>cn0xxx-designsupport|EVAL-AD410X-ARDZ Design & Integration Files]]
+[[adi>media/en/evaluation-documentation/evaluation-design-files/eval-adpd410x-ardz-designsupport.zip | EVAL-ADPD410x-ARDZ Design & Integration Files]]
-  * Schematics
-  * PCB Layout
+  * Schematic
-  * Bill of Materials
+  * PCB Layout
+  * Bill of Materials
   * Allegro Project
 </WRAP>
+\\
 ===== Additional Information and Useful Links =====
@@ Line 244: / Line 256: @@
   * [[:resources:eval:user-guides:circuits-from-the-lab:eval-adpd410x:fluorescence|Fluorescence Measurement Demo]]
-// End of Document //
+=====Registration=====
+<WRAP round tip 80% >
+Receive software update notifications, documentation updates, view the latest videos, and more when you register your hardware.  [[reg>EVAL-CN0511-RPIZ?&v=RevD|Register]] to receive all these great benefits and more!</WRAP>
+//End of Document//

Wiki

Analog Devices Wiki

Differences

Analog Devices Wiki

Differences

Page Tools