diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/579_coraz7_setup.png b/docs/solutions/reference-designs/eval-cn0579-ardz/579_coraz7_setup.png new file mode 100644 index 000000000..c15cc14a7 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/579_coraz7_setup.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c741de596e11707a1cc8bcfb5a05141752ee1b4196a01cacc0fe36c908256cbd +size 277527 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/579_de10_setup.png b/docs/solutions/reference-designs/eval-cn0579-ardz/579_de10_setup.png new file mode 100644 index 000000000..d78b58f6e --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/579_de10_setup.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e463dc0a94e53d1b275f7f7dac71b90181cd95d380d1ccdfb45415850928278 +size 264224 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/579_debug0.png b/docs/solutions/reference-designs/eval-cn0579-ardz/579_debug0.png new file mode 100644 index 000000000..f0e17c6d5 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/579_debug0.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a3f216677bc39133f4123badd67f95998a110dd146e46db112c44fc5a127f5a4 +size 21990 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/579_dmm.png b/docs/solutions/reference-designs/eval-cn0579-ardz/579_dmm.png new file mode 100644 index 000000000..4a7e0f8eb --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/579_dmm.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8ab9e3edbf3b57edea996e84197f469e5d67c36245e3a226a767971cf0e03cb8 +size 35987 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/579_ex_ch0_input.png b/docs/solutions/reference-designs/eval-cn0579-ardz/579_ex_ch0_input.png new file mode 100644 index 000000000..48d012ae8 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/579_ex_ch0_input.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2404ada1250a2d59d6c5761732b499f1afc7334b515ee2bb1ee74ef244d58e43 +size 333266 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/579_ex_no_input.png b/docs/solutions/reference-designs/eval-cn0579-ardz/579_ex_no_input.png new file mode 100644 index 000000000..05d932b4f --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/579_ex_no_input.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3751097b129a6de040235e8df2fab19ad6c555c54fea26f834f8a0c6668c86b4 +size 83995 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/579_osc.png b/docs/solutions/reference-designs/eval-cn0579-ardz/579_osc.png new file mode 100644 index 000000000..cd22795dc --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/579_osc.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c12b34cd05e981a408748247c87630d6d6bc17d2e22f29ba069c566478d7e77 +size 37009 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579-designsupport.zip b/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579-designsupport.zip new file mode 100644 index 000000000..3dd890ff7 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579-designsupport.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4dc037d89979cdbcede1f4e1c245a61d6418494e4e5d1a9fccf9bda69c1702c5 +size 7637508 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579_boot_files.zip b/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579_boot_files.zip new file mode 100644 index 000000000..0b4ccfa3a --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579_boot_files.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dccd0d3345ac2000631398673091db56e30d39dab571ff7ff02c26db685b5d7f +size 17506436 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579_simplified_block_diagram.png b/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579_simplified_block_diagram.png new file mode 100644 index 000000000..9c01f1764 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/cn0579_simplified_block_diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae2596a53b426331bb13899276fc6439b2ca08719b95d0581773e4b572fb5b15 +size 55641 diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/eval-cn0579-ardz_bottom-web.gif b/docs/solutions/reference-designs/eval-cn0579-ardz/eval-cn0579-ardz_bottom-web.gif new file mode 100644 index 000000000..de6704613 Binary files /dev/null and b/docs/solutions/reference-designs/eval-cn0579-ardz/eval-cn0579-ardz_bottom-web.gif differ diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/eval-cn0579-ardz_top-web.gif b/docs/solutions/reference-designs/eval-cn0579-ardz/eval-cn0579-ardz_top-web.gif new file mode 100644 index 000000000..a61d89296 Binary files /dev/null and b/docs/solutions/reference-designs/eval-cn0579-ardz/eval-cn0579-ardz_top-web.gif differ diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/index.rst b/docs/solutions/reference-designs/eval-cn0579-ardz/index.rst new file mode 100644 index 000000000..01d34d23e --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/index.rst @@ -0,0 +1,505 @@ +.. _eval-cn0579-ardz: + +EVAL-CN0579-ARDZ +================ + +Quad-Channel IEPE Vibration Sensor Measurement System +"""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Overview +-------- + +Condition-based monitoring (CbM) enables early detection and diagnosis of +machine and system abnormalities. Identifying and isolating these issues creates +opportunities for optimizing replacement part inventories, scheduling downtime +for planned maintenance, and making run-time process adjustments that can extend +the life of equipment. + +The :adi:`EVAL-CN0579-ARDZ ` is a 4-channel, high resolution, wide +bandwidth, high dynamic range, IEPE-compatible interface data acquisition +(DAQ) system that interfaces with IC piezoelectric (ICP®)/IEPE sensors. While +most solutions that interface with piezoelectric sensors in the market are +AC-coupled and lack DC and subhertz measurement capabilities, this solution is +DC-coupled. By looking at the complete data set from an IEPE vibration sensor +in the frequency domain (DC to 50 kHz), the type and source of a machine fault +can be better predicted using the position, amplitude, and number of harmonics +found in the fast Fourier transform (FFT) spectrum. + +Simplified Block Diagram +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. figure:: cn0579_simplified_block_diagram.png + +Hardware Configuration +---------------------- + +Primary Side +~~~~~~~~~~~~ + +.. figure:: eval-cn0579-ardz_top-web.gif + +Sensor Input +^^^^^^^^^^^^ + +The main input on the :adi:`EVAL-CN0579-ARDZ ` are right-angle +SMA connectors on the primary side of the board, as such it is +highly recommended to connect the sensor using an SMA cable. If this is not +possible, due to the type of sensor or otherwise, use the headers to connect +the board with other standard wires. + +LED Indicators +^^^^^^^^^^^^^^ + ++-------------------------+-------------------------+-------------------------+ +| LED | Location | Function | ++=========================+=========================+=========================+ +| **PWR LEDs (DS1 to | bottom-left corner | indicates board power | +| DS2)** | | | ++-------------------------+-------------------------+-------------------------+ +| **FAULT LEDs (DS3 to | near each SMA connector | indicates the status of | +| DS6)** | | switch’s fault flag | ++-------------------------+-------------------------+-------------------------+ +| **SHUTDOWN LED (DS7)** | left side of U19 | indicates status of | +| | | shutdown logic/buffer, | +| | | FDA, SW disable | ++-------------------------+-------------------------+-------------------------+ + +Secondary Side +~~~~~~~~~~~~~~ + +.. figure:: eval-cn0579-ardz_bottom-web.gif + +Current Source Jumper +^^^^^^^^^^^^^^^^^^^^^ + +The :adi:`EVAL-CN0579-ARDZ ` includes solder jumpers (P17 to P20) to +control current source. The jumpers connect the current source to the circuit +and may be removed for testing without a current source. + +Arduino Interface +^^^^^^^^^^^^^^^^^ + +All connector pinouts for the :adi:`EVAL-CN0579-ARDZ ` are described in +the table below. + +==================== ======= =============== =================== +Connector Pin No. Pin Name CN0579 Pin Function +==================== ======= =============== =================== +Arduino DIO 1 (P12) 1 SCL SCL +\ 2 SDA SDA +\ 3 AREF NC (Not connected) +\ 4 GND GND +\ 5 13 / SCLK SCLK +\ 6 12 / MISO MISO +\ 7 11 / PWM / MOSI MOSI +\ 8 10 / PWM / CS CS_ADC +\ 9 9 / PWM DRDY_N +\ 10 8 DCLK +Arduino DIO 0 (P14) 1 7 DOUT0 +\ 2 6 / PWM DOUT1 +\ 3 5 / PWM DOUT2 +\ 4 4 DOUT3 +\ 5 3 / PWM SHUTDOWN_N +\ 6 2 RESET_N +\ 7 TX NC +\ 8 RX NC +Arduino Analog (P13) 1 AIN0 NC +\ 2 AIN1 NC +\ 3 AIN2 NC +\ 4 AIN3 NC +\ 5 AIN4 NC +\ 6 AIN5 NC +Arduino Power (P11) 1 NC NC +\ 2 IOREF IOREF +\ 3 RESET NC +\ 4 3.3 V 3V3 +\ 5 5V 5V +\ 6 GND GND +\ 7 GND GND +\ 8 Vin NC +==================== ======= =============== =================== + +.. tip:: + To achieve reasonable noise measurements, the piezo + vibration sensor must be stabilized using either an active shaker table, which + cancels environmental vibrations; or anchored to a massive object, which makes + sensor still. For noise measurements done on :adi:`EVAL-CN0579-ARDZ `, + the piezo vibration sensor was anchored to a massive object, where it is also + connected directly to the input of the signal chain. + +Test Points +^^^^^^^^^^^ + +The board also has many test points, most of which are labeled and are fairly +self-explanatory. The table below describes some of the most significant test +points and their connections. + ++---------------------------+-------------------------------------------------+ +| Test Point | Description | ++===========================+=================================================+ +| 26V8 | Connects to the 26.8V rail before it’s reduced | +| | to 26V. | ++---------------------------+-------------------------------------------------+ +| 26V0 | Connects to the 26V rail. | ++---------------------------+-------------------------------------------------+ +| 5V5 | Connects to the 5.5V rail before it’s reduced | +| | to 5V. | ++---------------------------+-------------------------------------------------+ +| 5V0 | Connects to the 5V rail. | ++---------------------------+-------------------------------------------------+ +| TP1 | Connects to the voltage reference of the DAC | +| | for IEPE sensor. | ++---------------------------+-------------------------------------------------+ +| TP6 / TP11 / TP16 / TP21 | Connects to signal chain after passing through | +| | the fault protection switch | ++---------------------------+-------------------------------------------------+ +| TP7 / TP12 / TP17 / TP22 | Connects to VOCM. | ++---------------------------+-------------------------------------------------+ +| TP8 / TP13 / TP18 / TP23 | Connects to signal chain that is level shifted. | ++---------------------------+-------------------------------------------------+ +| TP9 / TP14 / TP19 / TP24 | Connects to FDA_OUT_N0 of the ADC driver. | ++---------------------------+-------------------------------------------------+ +| TP10 / TP15 / TP20 / TP25 | Connects to FDA_OUT_P0 of the ADC driver. | ++---------------------------+-------------------------------------------------+ +| TP27 / TP29 / TP31 / TP33 | Connects to output from the bias voltage | +| | correction. | ++---------------------------+-------------------------------------------------+ +| TP34 | Connects to ADC reference buffer. | ++---------------------------+-------------------------------------------------+ +| TP35 | Connects to differential conversion reference | +| | buffer output / VOCM. | ++---------------------------+-------------------------------------------------+ +| TP36 | Connects to 32.768 MEGHz clock output. | ++---------------------------+-------------------------------------------------+ +| TP37 | Connects to VCM of ADC. | ++---------------------------+-------------------------------------------------+ + +System Setup +------------ + +General Setup Using DE10-Nano +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Demo Requirements +^^^^^^^^^^^^^^^^^ + +The following is the list of items needed in order to replicate this demo. + +**Hardware** + +- :adi:`EVAL-CN0579-ARDZ ` +- `DE10-Nano FPGA Board `__ + + - 5V/2A wall power supply with barrel jack (comes with DE10-Nano) + - mini USB to USB Type A (comes with DE10-Nano) + +- `Class 10 16GB SD Card `__ + with boot files in :download:`cn0579_boot_files.zip` +- Ethernet cable +- IEPE-compatible sensor + +**Software** + +- :dokuwiki:`ADI Kuiper Image ` +- `IIO Oscilloscope `__ + +Hardware Setup +~~~~~~~~~~~~~~ + +.. figure:: 579_de10_setup.png + +#. Mount the EVAL-CN0579-ARDZ onto the DE10-Nano. +#. Connect a monitor to the DE10-Nano using an HDMI cable. +#. Connect a USB OTG adapter to the DE10-Nano's USB OTG port. If additional USB ports + are needed, attach a USB hub to the adapter. +#. Connect your keyboard and mouse to the USB OTG adapter or USB hub. +#. Plug in the DE10-Nano power supply. +#. Wait for the system to boot. The desktop will appear on your monitor once startup is complete. + +.. figure:: kuiper.png + +Software Setup +~~~~~~~~~~~~~~~ + +Preparing the SD Card +^^^^^^^^^^^^^^^^^^^^^ + +To prepare the SD card for the DE10-Nano board: + +#. :dokuwiki:`Download ADI Kuiper Image ` +#. Validate, format, and flash the SD Card + + - :dokuwiki:`Format and flash the SD Card using Windows ` + - :dokuwiki:`Format and flash the SD Card using Linux ` + +Download and Install IIO Oscilloscope +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +#. Download the latest `IIO Oscilloscope + release `__ + from GitHub and install it on your PC. (You may need to right-click the + installer and run as ``Elevated`` in order to get it to install.) +#. Once microSD card has been imaged, safely remove the hardware from the SD + card writer, and insert the card directly into the microSD card slot on the + DE10-Nano. + +---- + +General Setup Using Cora Z7 +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Demo Requirements +^^^^^^^^^^^^^^^^^ + +The following is the list of items needed in order to replicate this demo. + +**Hardware** + +- :adi:`EVAL-CN0579-ARDZ ` +- `CoraZ7-07s FPGA Board `__ +- `Class 10 16 GB SD Card `__ +- Ethernet cable +- Micro USB to USB Type A cable +- IEPE-compatible sensor + +**Software** + +- `ADI Kuiper Image for CN0579 `__ +- `IIO Oscilloscope `__ + +Hardware Setup +~~~~~~~~~~~~~~ + +.. figure:: 579_coraz7_setup.png + +#. Mount the EVAL-CN0579-ARDZ on the Cora Z7. +#. Connect ethernet cable on the Cora Z7 and on your PC. +#. Power up Cora Z7 by plugging its power supply or connecting microUSB. +#. Wait for the system to boot up. Upon boot up, open command terminal or any similar applications like PuTTy to communicate with the board. + +Software Setup +~~~~~~~~~~~~~~~ + +Preparing the SD Card +^^^^^^^^^^^^^^^^^^^^^ + +To prepare the SD card for the DE10-Nano board: + +#. :dokuwiki:`Download ADI Kuiper Image ` +#. Validate, format, and flash the SD Card + + - :dokuwiki:`Format and flash the SD Card using Windows ` + - :dokuwiki:`Format and flash the SD Card using Linux ` + +Download and Install IIO Oscilloscope +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +#. Down the latest `IIO Oscilloscope + release `__ + from Github, and install it on your PC. (You may need to right-click the + installer, and run as ``Elevated`` in order to get it to install.) +#. Once the microSD card has been imaged, safely remove the hardware from the SD + card writer, and insert the card directly into the microSD card slot on the + DE10-Nano. + +---- + +Application Software +-------------------- + +The :adi:`EVAL-CN0579-ARDZ ` is supported by the Libiio library. This +library is cross-platform (Windows, Linux, Mac) with language bindings for C, +C#, Python, MATLAB, and others. Two easy examples that can be used with the +:adi:`EVAL-CN0579-ARDZ ` are: + +- :dokuwiki:`IIO Oscilloscope Installation Guide ` +- :ref:`Python (via Pyadi-iio) ` + +Connection +~~~~~~~~~~ + +To be able to connect your device, the software must be +able to create a context. The context creation in the software depends on the +backend used to connect to the device, as well as the platform where the +EVAL-CN0579-ARDZ is attached. The platforms currently supported for the +:adi:`EVAL-CN0579-ARDZ ` are Cora Z7 and DE10-Nano using the ADI +Kuiper Linux. The user needs to supply a URI, which will be used in the +context creation. The Libiio is a library for interfacing with IIO devices. + +.. admonition:: Download + + Install the `Libiio package `__ + on your machine. + +The `iio_info `__ +command is a part of the libIIO package that reports all IIO attributes. + +Upon installation, simply enter the command on the terminal command line to +access it. + +For Windows machine connected to ZedBoard via Ethernet cable +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Using SSH Terminal Software +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Open SSH Terminal Software (PuTTY, TeraTerm, or similar). The user should now +start the PuTTY application and enter certain values in the configuration +window. In the terminal, run: + +.. code-block:: console + + analog@analog:~$ iio_info -u ip: + +Using Command Terminal +^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: console + + iio_info -s + +Prompting this on the command terminal in your Windows PC will give you the +IP address to access the EVAL-CN0579-ARDZ. + +.. code-block:: console + + ssh analog@ + +.. code-block:: console + + analog@analog:~$ iio_info -u ip: + +IIO Commands +^^^^^^^^^^^^ + +There are different commands that can be used to manage the device being used. +The :dokuwiki:`iio_attr ` +command reads and writes IIO attributes. + +.. code-block:: console + + analog@analog:~$ iio_attr [OPTION]... + +**Example:** + +- To look at the context attributes, enter this code on the terminal: + +.. code-block:: console + + analog@analog:~$ iio_attr -a -C + +IIO Oscilloscope +~~~~~~~~~~~~~~~~ + +.. admonition:: Download + + Make sure to download/update to the latest version of IIO Oscilloscope. + + `Releases: `__ + +#. Once done with the installation or an update of the latest IIO Oscilloscope, + open the application. The user needs to supply a URI, which will be used in + the context creation of the IIO Oscilloscope and the instructions can be seen + in the previous section. +#. Press refresh to display available IIO Devices. Once cn0579 appeared, press + ``Connect``. + + .. figure:: 579_osc.png + +Debug Panel +^^^^^^^^^^^ + +Below is the Debug panel wherein you can directly access +the attributes of the device. + +.. figure:: 579_debug0.png + +DMM Panel +^^^^^^^^^ + +Access the DMM panel to see the instantaneous reading of the ADC voltages. + +.. figure:: 579_dmm.png + +---- + +Pyadi-IIO +~~~~~~~~~~ + +:ref:`PyADI-IIO ` is a Python abstraction module for ADI hardware +with IIO drivers to make them easier to use. This module provides device-specific APIs +built on top of the current libIIO Python bindings. These interfaces try to match +the driver naming as much as possible without the need to understand the complexities +of libIIO and IIO. + +Running the Example +^^^^^^^^^^^^^^^^^^^ + +After installing and configuring PYADI-IIO on your +machine, you are now ready to run Python script examples. In our case, run the +:git-pyadi-iio:`PyADI-IIO CN0579 example `. + +#. Connect the :adi:`EVAL-CN0579-ARDZ ` to the DE10-Nano or Cora Z7. +#. Open command prompt or terminal and navigate through the examples folder + inside the downloaded or cloned *pyadi-iio* directory. +#. Run the example script using the command. + + .. code-block:: console + + /pyadi-iio/examples $ python3 cn0579_example.py + +The expected output should look like this: + +**Without input signal:** + +.. figure:: 579_ex_no_input.png + +**With input from ADALM2000 (1Vp-p, 1 kHz) on Channel 0:** + +.. figure:: 579_ex_ch0_input.png + +GitHub link for the Python sample script: +:git-pyadi-iio:`PyADI-IIO CN0579 example ` + +Reference Demos & Software +-------------------------- + +- :ref:`PyADI-IIO Installation Guide ` +- :dokuwiki:`IIO Oscilloscope Installation Guide ` +- :ref:`Kuiper Images ` +- :git-hdl:`CN0579 HDL Reference Design ` + +More Information and Useful Links +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- :adi:`CN0579 Circuit Note Page ` +- :adi:`AD7768-4 Product Page ` +- :adi:`AD5696R Product Page ` +- :adi:`ADA4807-2 Product Page ` +- :adi:`AD8605 Product Page ` +- :adi:`ADA4945-1 Product Page ` +- :adi:`ADR4540 Product Page ` +- :adi:`ADP1613 Product Page ` +- :adi:`ADP7142 Product Page ` +- :adi:`ADG5421F Product Page ` +- :adi:`ADP7118 Product Page ` +- :adi:`LT3092 Product Page ` +- :adi:`LT8333 Product Page ` + +Schematic, PCB Layout, Bill of Materials +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. admonition:: Download + + :download:`EVAL-CN0579-ARDZ Design & Integration Files ` + + - Schematics + - PCB Layout + - Bill of Materials + - Allegro Project + +Help and Support +~~~~~~~~~~~~~~~~ + +For questions and more information about this product, connect with us through +the Analog Devices :ez:`EngineerZone `. diff --git a/docs/solutions/reference-designs/eval-cn0579-ardz/kuiper.png b/docs/solutions/reference-designs/eval-cn0579-ardz/kuiper.png new file mode 100644 index 000000000..182ef0100 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0579-ardz/kuiper.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9552161853678a23cf118aa91a0645d45d11290062667a41e1a6246a3481b3ac +size 1702507