Differences

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

--- resources:eval:user-guides:inertial-mems:imu:vibrationevaluationprogram [08 Jan 2021 09:36] – Fixed bad link for ADIS16228 Ioana Chelaru
+++ resources:eval:user-guides:inertial-mems:imu:vibrationevaluationprogram [17 Feb 2021 05:58] (current) – Fixed English Juan Chong
@@ Line 1: / Line 1: @@
-====VIBRATION EVALUATION PROGRAM WIKI GUIDE=====
+====== EVAL-ADIS2 Vibration Evaluation Software User Guide ======
-=====PRODUCT SUPPORT=====
+<note warning>The [[adi>EVAL-ADIS2|EVAL-ADIS2]] has been superseded by the [[adi>EVAL-ADIS-FX3|EVAL-ADIS-FX3]] and is **no longer supported**.</note>
-The [[http://www.analog.com/en/evaluation/EVAL-ADIS/eb.html#SOFTWARE_AND_TOOLS|Vibration Evaluation Program]] supports PC-based evaluation of the following products with the [[adi>EVAL-ADIS|EVAL-ADIS]] Evaluation System.
+<note warning>This guide assumes that you've connected your vibration sensor to the [[adi>EVAL-ADIS2|EVAL-ADIS2]], drivers were successfully installed on your PC, and you've downloaded the correct software for your sensor. We recommend reviewing the [[:resources:eval:user-guides:inertial-mems:evaluation-systems:eval-adis2-hardware-guide|Hardware User Guide]] before continuing.</note>
-^IMU Evaluation/EVAL-ADIS Product Support List  ^
+===== Software Downloads =====
-|[[adi>ADIS16000|ADIS16000AMLZ]]/[[adi>ADIS16229|ADIS16229AMLZ]] |
-|[[adi>ADIS16227|ADIS16227/PCBZ]] |
-|[[adi>ADIS16228|ADIS16228/PCBZ]] |
-| |
-NOTE: The [[adi>ADIS16000|ADIS16000AMLZ]] manages wireless communication with the [[adi>ADIS16229|ADIS16229AMLZ]].
+Click [[adi>media/en/evaluation-boards-kits/evaluation-software/Vibration_Evaluation.zip|here]] to download the latest version of the Vibration Evaluation software.
-NOTE: The [[adi>ADIS16000|ADIS16000AMLZ]] requires an interface board to connect to the [[adi>eval-adis|EVAL-ADIS]] evaluation system. This board will be released shortly as the ADIS16COM1/PCBZ.
+Click [[adi>media/en/evaluation-boards-kits/evaluation-software/SDPDrivers.zip|here]] to download the latest drivers for the [[adi>EVAL-ADIS2|EVAL-ADIS2]].
-=====PC SYSTEM REQUIREMENTS=====
+<note important>This application requires Microsoft .NET 3.5 to be installed and enabled on the host PCs running Windows 10. Additional information on enabling .NET 3.5 can be found [[https://answers.microsoft.com/en-us/windows/forum/windows_10-windows_install-winpc/installingenabling-net-35-on-windows-10/fe7b4699-c096-4369-b06f-e1063da42e18|here]].</note>
-Windows XP, Vista, 7
-.NET Framework 3.5
+===== EVAL-ADIS2 Vibration Evaluation Software Overview =====
-NOTE: Newer versions of the .NET framework do not currently support the [[/resources/eval/user-guides/inertial-mems/imu/vibrationevaluationprogram|Vibration Evaluation Program]].
+The Vibration Evaluation Software is a Microsoft Windows (.NET) application that works in conjunction with the EVAL-ADIS2, in order to provide users with a PC-Based interface to a subset of iSensor products designed specifically for machine health and vibration monitoring applications. The platform enables observation of basic sensor functions, read/write access to all user-accessible registers, and full-rate data acquisition.
-=====VIBRATION EVALUATION PROGRAM DOWNLOAD=====
+Due to the specialized nature of the machine health monitoring portfolio, only a subset of sensors is supported by this software. These devices are shown below.
-[[http://www.analog.com/en/evaluation/EVAL-ADIS/eb.html#SOFTWARE_AND_TOOLS|Vibration Evaluation Software]] installation only requires two simple step:
+^SENSOR DEVICE NUMBER  ^
+|[[adi>ADIS16000|ADIS16000AMLZ]]  |
+|[[adi>ADIS16229|ADIS16229AMLZ]]  |
+|[[adi>ADIS16227|ADIS16227/PCBZ]]  |
+|[[adi>ADIS16228|ADIS16228/PCBZ]]  |
-. Download, unzip and install the EVAL-ADIS USB Driver [[http://www.analog.com/en/evaluation/EVAL-ADIS/eb.html#SOFTWARE_AND_TOOLS|(click here to see the download link)]]
+<note important>The [[adi>ADIS16000|ADIS16000AMLZ]] manages wireless communication between several [[adi>ADIS16229|ADIS16229AMLZ]] devices. </note>.
-. Download, unzip and copy the Vibration*.exe file to the desired location on the test PC [[http://www.analog.com/en/evaluation/EVAL-ADIS/eb.html#SOFTWARE_AND_TOOLS|(click here to see the download link)]]
+<note important>This guide builds upon the [[:resources:eval:user-guides:inertial-mems:evaluation-systems:eval-adis2-hardware-guide|EVAL-ADIS2 Hardware User Guide]] and assumes that you've installed the necessary drivers and software.</note>
-=====USB DRIVER INSTALLATION=====
-After downloading the EVAL-ADIS USB Driver file, extract the SDPDrivers.exe file from the zip file, into a convenient location and then double click on it to start the process.
-{{:resources:eval:user-guides:inertial-mems:imu:USBDriver-Install-000.png?500|}}
+=====Using the EVAL-ADIS2 Vibration Evaluation Software=====
+Once the Vibration Evaluation software loads, you should be presented with a window similar to the image shown below.
-When the setup wizard opens, click on **Next** to start the installation process
+{{:resources:eval:user-guides:inertial-mems:imu:227-main.png?700|}}
-{{:resources:eval:user-guides:inertial-mems:imu:USBDriver-Install-001.png?500|}}
+If an error similar to the image below pops up, click OK to proceed.
-Click on **Next** to accept the default driver location.
+{{:resources:eval:user-guides:inertial-mems:imu:227-select-device.png?400|}}
-{{:resources:eval:user-guides:inertial-mems:imu:USBDriver-Install-002.png?500|}}
+====Device Selection====
+Click on **Device**, located on the left side of the Menu bar, at the top of the **Main Screen**, and select the model number corresponding to your sensor. The [[adi>adis16228|ADIS16228]] was used for the following examples.
-The process will involve at least two progress bars that look like the following:
+{{:resources:eval:user-guides:inertial-mems:imu:227-main-device.png?600|}}
-{{:resources:eval:user-guides:inertial-mems:imu:USBDriver-Install-003.png?500|}}
+{{:resources:eval:user-guides:inertial-mems:imu:228-main-select.png?600|}}
-If you encounter this type of message during the process, click on **Install** to continue with the installation.
+<note important>Some menu options may appear "grayed out." This normal and indicates that some of the software features may not be available for the selected device type.
-{{:resources:eval:user-guides:inertial-mems:imu:USBDriver-Install-003a.png?500|}}
+For example, all of the **Network** options presently only apply [[adi>ADIS16229|ADIS16229]].
+</note>
-Once the installation has completed, click on **Finish** to complete the process.
+====Data Collection Mode====
-{{:resources:eval:user-guides:inertial-mems:imu:USBDriver-Install-004.png?500|}}
+The [[adi>ADIS16227|ADIS16227]], [[adi>ADIS16228|ADIS16228]] and [[adi>ADIS16229|ADIS16229]] all have four basic modes of data collection: Manual FFT, Automatic FFT, Manual Time (Time Domain) and Real-Time. Each of these modes can be configured using the **Register Access** window.  For ease of use, the **Main Screen** offers a drop-down selection menu for these modes, along with a **Start** that kicks off a data capture.
-=====DOWNLOAD SOFTWARE=====
+{{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_mainscreen_modeselection_01b.png?600|}}
-Download to the **Vibration Evaluation Program** package from the [[adi>EVAL-ADIS|EVAL-ADIS]] home page, under SOFTWARE AND TOOLS ([[adi>en/evaluation/EVAL-ADIS/eb.html#SOFTWARE_AND_TOOLS|Click here to access]]). Extract the *.exe file from the zip file and copy it to any directory on the PC.
-=====LAUNCH SOFTWARE=====
+====Waveform Display====
-Plug the EVAL-ADIS (with ADIS16xxx/PCBZ device installed) and wait for both LED1 and LED2 to illuminate on the EVAL-ADIS.  After LED1 and LED2 illuminate, double click on the *.exe file to launch the **Vibration Evaluation Program** and access the **Main Menu**.
-You might see the appearance of a Window that indicates a search for an SDP device (USB), but this will disappear quickly. If this error message appears, click **OK** to proceed to the **Main Screen**.
+The **Waveform Display** quickly displays the data read back from the sensor. The data format, units, etc. will automatically change based upon the selected data capture mode.
-{{:resources:eval:user-guides:inertial-mems:imu:227-select-device.png?400|}}
+{{:resources:eval:user-guides:inertial-mems:imu:227-wavfrms.png?600|}}
-{{:resources:eval:user-guides:inertial-mems:imu:227-main.png?600|}}
+====Enable Data Log====
-=====PROGRAM FEATURES=====
+When the "Enable Data Log" check box in the main form is set, a data capture file will be saved every time a new FFT or time-domain capture is executed. The number located beside the "Enable Data Log" check box will also increment indicating that a new file was written to the host PC disk.
-====Device Selection====
-Click on **Device**, located on the left hand side of the Menu bar, at the top of the **Main Screen**, to select the appropriate DUT (Device Under Test). In this example, the [[adi>adis16228|ADIS16228]] is in use. Note that some of the Menu bar options appear in a lighter gray color, to indicate that they are not associated with a particular device.  For example, all of the **Network** options presently only apply to the [[adi>adis16299|ADIS16229]] at this time, so they will appear in the lighter gray color when either [[adi>ADIS16227|ADIS16227]] or [[adi>ADIS16228|ADIS16228]] options are in use.
-{{:resources:eval:user-guides:inertial-mems:imu:227-main-device.png?600|}}
+{{:resources:eval:user-guides:inertial-mems:imu:227-enable-datalog.png?600|}}
-{{:resources:eval:user-guides:inertial-mems:imu:228-main-select.png?600|}}
+====RegisterAccess====
-====Register Access====
+The **Register Access** option on the **Menu Bar** provides read and write access to all user-accessible registers listed in the selected device's datasheet. The image below shows a screenshot of the window.
-The **Register Access** option on the **Menu Bar** provides direct read and write access to all of the user-accessible registers in DUT.
-{{:resources:eval:user-guides:inertial-mems:imu:228-reg-sel.png?600|}}
+{{:resources:eval:user-guides:inertial-mems:imu:228-reg-sel.png?700|}}
-===Register Access Window Appearance===
+The image below shows the **Register Access** window when an [[adi>ADIS16228|ADIS16228]] is connected.
-Here is an example of the **Register Access** window that illustrates the [[adi>ADIS16228|ADIS16228]].
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_registeraccesswindow_01.png?600|}}
-===Reading Register Contents===
+===Reading Sensor Register===
-Select a specific register to read the contents.
+In order to read the contents of a sensor register, click on the register in the table and then click on "Read Selected Register." The [[adi>EVAL-ADIS2|EVAL-ADIS2]] will issue the correct commands to the sensor and update the GUI with the data the sensor responded with.
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_registeraccesswindow_regselect_01.png?600|}}
-===Writing Data to Registers===
+===Writing to Sensor Registers===
 Use the following two steps to write a value to the register.
-. Enter the hex code for the register.
+. Enter the data to be written to the sensor in the text box shown below.
+<note important>Register data must be written in hexadecimal format!</note>
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_registeraccesswindow_regselect_02.png?600|}}
 . Click on **Write**
-NOTE: Clicking on **Write** causes the Vibration Evaluation Program to write to both upper and lower bytes
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_registeraccesswindow_regselect_03.png?600|}}
+<note important>The **Register Access** form **always** writes to both the upper and lower bytes of a given register. When writing to a register, make sure to include the desired 16-bit value in hexadecimal format **before** clicking the **Write Register** button.</note>
 ===Single-Command Options===
-The vibration sensor products often come with registers that support "Global Commands."  While these commands are associated with specific bits, located in user-accessible registers, the right side of the **Register Access** Window provides access to them through a drop down menu that offers each related register and a series of **Write** buttons.
+The section on the right side of the window provides a means of easily calling subroutines within the connected sensor. Clicking on a "Write" button is equivalent to writing a single-bit command to the respective register.
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_registeraccesswindow_singlecommand_01.png?600|}}
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_registeraccesswindow_singlecommand_02.png?600|}}
+====Configuring Alarms====
+The **Alarm > Alarm Settings** option on the **Menu Bar** provides a convenient means of configuring the Spectral Alarm functions. The interface makes configuring and tuning these functions much easier!
-====Alarms====
-The **Alarm > Alarm Settings** option on the **Menu Bar** provides a more convenient method for configuring the Spectral Alarm functions.  This provides a more convenient method for tuning this function, in comparison with the single-register access method associated with **Register Access** window.
 {{:resources:eval:user-guides:inertial-mems:imu:227-alrm.png?600|}}
@@ Line 130: / Line 116: @@
 Select boxes in the matrix and enter values that are associated with the magnitude of the output data and FFT bin numbers.
+<note important>The same results can be achieved by issuing individual writes to the respective registers using the **Register Access** window.</note>
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_alarms_settings_02.png?600|}}
-Click on **Write to DUT** to update all registers that are associated with these entries.
+Click on **Write to DUT** to update all of the registers associated with these entries.
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_alarms_settings_03.png?600|}}
-Close this window, then go back in. The values will not appear automatically. Click on **Read from DUT** to make sure the settings are still in place.
+In order to verify that the settings were written to the sensor, close and re-open the window. Doing so will reset the form. Click on **Read from DUT** to read back the configuration settings from the sensor.
-{{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_alarms_settings_04.png?600|}}
+{{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_alarms_settings_04.png?400|}}
-The **Alarms > Alarm Status Form** option provides a convenient monitor for the conditions. The dashes will change to green (no alarm), yellow ("warning" alarm, associated with Level 1) or red ("critical" alarm, associated with Level 2), depending on the conditions, after a data capture event completes.
+The **Alarms > Alarm Status Form** provides a convenient way to monitor each of the different alarm conditions. The dashes in each cell will change to green (no alarm), yellow ("warning" alarm, associated with Level 1) or red ("critical" alarm, associated with Level 2), depending on the conditions, after a data capture event completes.
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_alarms_statusform_01.png?400|}}
 ====Data Capture====
-The **Data Capture** window provides user inputs for file location, base file name and for resetting the file count.
+The **Data Capture** window provides a means of configuring the file location, base file name, and file count for each data capture.
-{{:resources:eval:user-guides:inertial-mems:imu:vep_datacapturewindow_01.png?500|}}
+{{:resources:eval:user-guides:inertial-mems:imu:vep_datacapturewindow_01.png?600|}}
-When this function is active (See the [[/resources/eval/user-guides/inertial-mems/imu/vibrationevaluationprogram#enable_data_capture|Enable Data Capture checkbox]], located in the **Main Screen**), each trigger will cause the creation of a new file that contains the FFT result and FFT Header information. Notice the increments in the file count, after three clicks on the **Start** button.
+When the "Enable Data Log" check box in the main form is set, a data capture file will be saved every time a new FFT or time-domain capture is executed. The number located beside the "Enable Data Log" check box will also increment indicating that a new file was written to the host PC disk.
 {{:resources:eval:user-guides:inertial-mems:imu:227-main-datalog-file.png?600|}}
-This counter is also in the **Data Capture Window**
+This counter is also shown in the **Data Capture Window**.
 {{:resources:eval:user-guides:inertial-mems:imu:vep_datacapturewindow_02.png?500|}}
 ====Tools====
 The **Tools** option in the **Menu Bar** offers two options: **USB** and **SPI**.
@@ Line 162: / Line 151: @@
 {{:resources:eval:user-guides:inertial-mems:imu:227-tools-menu.png?600|}}
-Use the **USB** option to manually connect or disconnect to the USB port on the [[adi>eval-adis|EVAL-ADIS]].
+The **USB** option allows for manually connecting or disconnecting the active [[adi>EVAL-ADIS2|EVAL-ADIS2]].
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_tools_usb_01.png?400|}}
@@ Line 168: / Line 157: @@
 {{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_tools_usb_02.png?400|}}
-Use the **SPI** option to adjust the timing in between the [[adi>EVAL-ADIS|EVAL-ADIS]] and the DUT. this should not be required for normal operation but the "typical" settings are offered in the following picture:
+The **SPI** option allows for adjusting the SPI SCLK and stall time (time between each 16-bit transaction). The image below shows the default settings.
 {{:resources:eval:user-guides:inertial-mems:imu:227-spi-utilities.png?400|}}
+====Demo====
+Visit the [[resources:eval:user-guides:inertial-mems:imu:vibrationdemo|ADIS16229 Vibration Demo Wiki Guide]] for more details on this function.
-====Demo====
-Visit the [[resources/eval/user-guides/inertial-mems/imu/vibrationdemo|ADIS16229 Vibration Demo Wiki Guide]] for more details on this function.
 ====About====
 This option offers the revision and some codes that might be useful when seeking technical support.
 {{:resources:eval:user-guides:inertial-mems:imu:227-version-1-2.png?400|}}
-====Data Collection Mode====
-The [[adi>ADIS16227|ADIS16227]], [[adi>ADIS16228|ADIS16228]] and [[adi>adsi16229|ADIS16229]] all have four basic modes of data collection: Manual FFT, Automatic FFT, Manual Time (Time Domain) and Real-Time. Inside of these products, these modes are typically related to the settings in the REC_CTRL1 register.  The **Main Screen** offers a drop-down selection menu for these modes, along with a **Start** button to begin operation.
-{{:resources:eval:user-guides:inertial-mems:imu:vep_wiki_mainscreen_modeselection_01b.png?600|}}
-====Waveform Display====
-The **Waveform Display** enables quick access to sensor data.
-{{:resources:eval:user-guides:inertial-mems:imu:227-wavfrms.png?600|}}
-====Enable Data Capture====
-Checking the box next to **Enable Data Capture** results in every capture of data being copied into a data file, according to the configuration settings in the **Data Capture Window**.
-{{:resources:eval:user-guides:inertial-mems:imu:227-enable-datalog.png?600|}}
@@ Line 212: / Line 177: @@
 =====SOFTWARE REVISION HISTORY=====
+<hidden>
 ^REVISION  ^RELEASE DATE ^SUMMARY OF UPDATES ^
 |v1.3.0| 2/17/2014| See the [[/resources/eval/user-guides/inertial-mems/imu/vibrationevaluationprogram?&#reported_issues_solutions|Reported Issues & Solutions Table]] for  list of issues being addressed |
@@ Line 236: / Line 201: @@
 | | | Increased period mode sleep cycle time to 10 seconds|
 |v1.0.0 | 8/1/2013| Initial Release|
+</hidden>
 =====REPORTED ISSUES, UPGRADE REQUESTS & SOLUTIONS=====
+<hidden>
 ^REVISION  ^ # ^DATE ^STATUS ^DEVICE ^ DESCRIPTION & RELATED NOTES ^SOLUTION ^
 | | | | | | | |
@@ Line 268: / Line 235: @@
 | | |  | | | **CLOSED** means that the issue has been resolved|
 |  |  |  |  |  |  |
+</hidden>

Analog Devices Wiki

Differences

Page Tools