VL6180X premium evaluation kit (EVK) software
Contents
1. 3 1 2 Launching the premium EVK 3 2 Premium EVK software user interface 4 2 1 Calibrating the 5 2 1 1 Calibrating the range offset 00 cece eee 5 2 1 2 Calibrating cross talk compensation factor 6 2 2 Measuring the range lt 2s5s scceca bee nee eb eae ee bis eae ee teehee 7 2 2 1 Signal Strength Power 8 7 2 9 2 Range Measurement 8 9 2 2 3 Configuration settings tees 12 2 9 Ambient light sensing 5 14 2 4 Creating a data log 16 2 5 Recording IC transactions 18 2 6 Interleaved mode 18 2 7 Persistent data 19 Appendix A Data log Mes due dceereera deen sane wd ed owes wn 20 Appendix B C log file ccc cece cee eee eee 21 REVISION HISIOLY sees 22 ky DoclD026336 Rev 4 2 23 Introduction UM1764 1 1 1 2 3 23 Introduction This document describes how to set2. Sampling Rate Hz The number of ALS samples measured per second PC dependent ALS Gain Displays the actual gain value applied corresponding to the ALS Gain Selection setting ALS Max Min Mean Std Dev These are post processed measurement statistics to make noise evaluation easier to characterize The max min and mean are the ALS data measured by the sensor over 100 sample points Error Status If there is an ALS error the ALS result error code will be displayed here as defined in the data sheet Address 0x04E ALS Lux Res This calibrates the ALS Count Lux conversion The characterized ALS Lux Res without glass is 0 56 default This value must be re calibrated if glass is added or the air gap is modified see Recalibrating ALS Lux Res for glass Integration Period ms Inter Meas Period ms The integration period Tint is the time range during a single ALS measurement over which Lux data is captured and averaged The default integration period is 100 ms The inter measurement period is the time between each ALS measurement in continuous ALS mode The default inter measurement period is 100 ms Continual Changes ALS mode from single shot to continuous mode ALS Gain Selection This is the device register setting 0 to 7 The corresponding gain value is displayed in the ALS Gain box Gain settings are as follows 0 ALS Gain 1 1 ALS Gain 1 25 2 ALS Gain
3. lt 7 UM1764 yf 4 life augmented User manual VL6180X premium evaluation kit EVK software Overview The VL6180X proximity sensor premium EVK demonstrates the basic proximity ranging and light sensing capabilities of the VL6180X sensor The premium EVK software utility interfaces with the VL6180X proximity sensor premium EVK to perform range signal and ambient light measurements and display results in both graphical and numerical form Additionally the utility provides the facility to configure and calibrate the VL6180X device and provides comprehensive access to internal data for diagnostic purposes The purpose of this user manual is to describe how to setup and use the premium EVK software for evaluation configuration and demonstration References 1 VL6180X premium evaluation kit EVK hardware user manual DoclID024985 2 VL6180X datasheet DoclID026171 Glossary ALS Ambient light sensor EVK Evaluation kit 12C Inter integrated circuit serial communications interface MCpS Mega counts per second NVM Nonvolatile memory P2P Part to part SNR Signal to noise ratio ToF Time of flight UI User interface VL6180X Proximity sensor X talk Cross talk compensation factor November 2014 DoclD026336 Rev 4 1 23 www st com UM1764 Contents Contents 1 DEO anim ee aa 3 1 1 Installing the premium EVK software utility n a 3 1 1 1 Trouble shooting
4. ST reserve the right to make changes corrections enhancements modifications and improvements to ST products and or to this document at any time without notice Purchasers should obtain the latest relevant information on ST products before placing orders ST products are sold pursuant to ST s terms and conditions of sale in place at the time of order acknowledgement Purchasers are solely responsible for the choice selection and use of ST products and ST assumes no liability for application assistance or the design of Purchasers products No license express or implied to any intellectual property right is granted by ST herein Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product ST and the ST logo are trademarks of ST All other product or service names are the property of their respective owners Information in this document supersedes and replaces information previously supplied in any prior versions of this document 2014 STMicroelectronics All rights reserved 23 23 DoclD026336 Rev 4
5. 1 67 3 ALS Gain 2 5 4 ALS Gain 5 5 ALS Gain 10 6 ALS Gain 20 7 ALS Gain 40 ALS Scaler The count output is a 16 bit value Internally the device uses a 20 bit counter Gain and integration time are normally used to increase sensitivity However if this is not sufficient and more resolution is required in low light the ALS scaler can be used to access the 4 LSBs of the internal counter Apply a value in the range 2 to 15 to apply additional gain ALS Count Upper This is the maximum scale value for the vertical axis The default value is 15000 The user can input a new value to scale the ALS Count graph up or down as required for measurements up to a maximum value of 65 000 ky DoclD026336 Rev 4 UM1764 Premium EVK software user interface 2 4 Table 6 ALS information continued Field Auto Gain Description Enables and disables the auto gain feature Auto gain automatically adjusts the gain selection in response to the current ALS Count value in order to provide and effective dynamic range for the current lighting conditions Auto Gain Count Thresh Min The manual Auto Gain ALS count threshold minimum value in Auto Gain mode Auto Gain Count Thresh Max The manual Auto Gain ALS count threshold maximum value in Auto Gain mode Recalibrating ALS Lux Res for glass To recalibrate the ALS Lux Res for glass 1 Set ALS Gain Selection to 0 ALS
6. Insert PageLlayout Formulas Data Review View Developer Add Ins Classification JMP Acrobat a2Q o A 4 Calibri General Fi Conditional Formatting g lnset Ay Ar Gy BZU Aa ESSA Be BFormatas Table 3 Delete g gt A nerd aste Sort amp Fin gt EAA Pe 8 EB Cell styles v Format gt Fiter Selet Clipboard Font i Alignment a Number i Styles Cells Editing Al v fe TimeStamp B G D E F G H l J K L Timesta Range Ext Range Va True Rang True Rang Raw Rang Max Rang Min Rang Mean Rar Range Str Filter Size Rtn Signa 18 148 22 130 130 37 130 138 0 54 25 31 4 6 7 18 22 37 122 122 122 122 138 54 44 1156 7 27 18 262 26 118 118 122 118 138 54 63 31 7 8 06 18 302 39 116 116 122 116 138 54 81 31 83 8 85 18 325 21 110 110 118 110 138 54 97 31 92 9 37 18 385 53 106 106 116 106 138 55 12 31 99 9 72 18 41 21 104 104 110 104 138 55 26 32 06 11 02 18 457 45 100 100 106 100 138 55 39 32 1 11 32 18 481 21 96 96 104 96 138 55 5 32 13 12 73 18 505 22 93 93 100 93 138 5561 432 14 13 48 18 573 66 86 86 96 86 138 55 7 32 14 15 8 18 653 24 75 75 93 75 138 55 75 3211 20 65 18 71 56 71 71 86 71 138 55 79 32 07 18 74 24 62 62 75 62 138 55 81 32 03 18 778 36 61 61 71 61 138 55 83 31 99 18 801 19 62 138 55 82 31 94 18 826 22 138 55 8 31 9 18 864 36 138 55 77 31 86 18 885 19 138 55 72 31 83 18 908 21 36 36 36 138 55 67 31 8 18 956 46 37 37 37 138 55 62 31 7 18 977 19 35 35 37 35 138 55 56 31 4 19
7. Read reg 0x0119 Val 01 Read reg 0x01A0 Val 00 Read reg 0x004D Val 03 Write 0x0207 Val 01 Write 0x0208 Val 01 Write 0x0133 Val 01 Write 0x0096 Val 00 Write 0x0097 Val FD Write 0x00E3 Val 00 Write 0x00E4 Val 04 Write OxOOES Val 02 Write 0x00E6 Val 01 Write Val 03 Write OxOOFS Val 02 Write Ox00D9 Val 05 Write OxOODB Val CE Write OxOODC Val 03 Write OxOODD Val Write 0x009F Val 00 Write Ox00A3 Val 3C Write 0x00B7 Val 00 Write 0x00BB Val 3C Write 0x00B2 Val 09 Write OxOOCA Val 09 Write 0x0198 Val 01 Write 0x01B0 Val 17 Write 0x01AD Val 00 Write 0x00FF Val 05 Write 0x0100 Val 05 Write 0x0199 Val 05 Write 0x0109 Val 07 Write 0x010A Val 30 Write 0x003F Val 46 Write 0x01A6 Val 1B Write 0x01AC Val 3E length 49354 Ln 1 Col 1 Sel 0 0 Dos Windows ANSI as UTF 8 INS 21 28 DoclD026336 Rev 4 UM1764 Revision history Revision history Table 7 Document revision history Date Revision Changes 14 May 2014 1 Initial release 23 May 2014 2 Correct typo error 10 Jun 2014 3 Change document properties 19 Nov 2014 4 Change disclaimer and confidentiality level DoclD026336 Rev 4 22 23 UM1764 IMPORTANT NOTICE PLEASE READ CAREFULLY STMicroelectronics NV and its subsidiaries
8. no 9 3 n o Actual range The factory calibrated NVM offset is used by default Manual calibration is only required if the offset is incorrect resulting in incorrect range measurements To activate the automatic offset calibration tick the Offset Override check box this will turn yellow then click the Apply button The Cal Offset button will now become available see Figure 4 follow the on screen instructions to complete the calibration To manually apply offset calibration enter the offset value in the Range Offset mm field after ticking the Offset Override check box and click on Apply DoclD026336 Rev 4 UM1764 Premium EVK software user interface Figure 4 Offset calibration VL6180X Part ID Range Offset mm Range Measurement ToF Fal oF _ li menses Programmed Range Offset mm Cross Talk Compensation Factor Range Offset Cal Height mm X Talk Comp Factor Cal Height mm ALS Lux Res ALS Gain Selection Lighting ALS Count Min Li 53 2000 A ALS i LUX 29120 0 217964 5600 7800 820 0 ALS Count 4000 aa ne tantwanl ansee antaaa ea pezoo 02 04 06 08 Sample 2 1 2 Calibrating cross talk compensation factor The glass in front of the VL6180X device introduces stray light also known as cross talk where a proportion of the e
9. Gain x1 Integration period to 100 ms and ALS Scaler to 1 2 Either note the ALS Lux value without glass while looking at a reasonably diffuse scene for example a ceiling or use the transmission characteristics of the glass if known 3 Add glass and note the new ALS Lux value 4 Multiply the ALS Lux Res value by the ratio of new old Lux value to compensate for the attenuation of the glass Creating a data log The Data Log tab is used to record data during ranging and ALS modes For every measurement relevant system data is stored in a comma separated value file csv identified by date and time To enable data logging in the Data Log tab check the Enable Data Log box see Figure 11 Data logging should be selected either prior to starting measurements or during the paused state DoclD026336 Rev 4 16 23 Premium EVK software user interface UM1764 17 23 Figure 11 Data Log tab VL6180X augmented Ranging ALS Interleaved Calibration Data Log Filel TimeStamp Range Execution Time ms 5 io Range Val True Range True Range Smoothed Raw Range Max Range JIMin Range a Mean Range o dc nk Range Stn Dev S511 E Fitter Size Rtn Signal Rate Ref Signal Rate 5 in ui Rtn Signal Count o Ref Signal Count Rtn Amb Rate Amb Rate Rt
10. at the bottom of the tab Table 1 Buttons in the Ranging tab Button Description Click on Start to begin ranging The Start button changes to Start Pause Resume Pause Resume while the device is ranging Stop Click on Stop to stop ranging Reset The Reset button resets the 20 communications interface between the application and the VL6180X HW Reset The HW Reset button resets the VL6180X hardware The Reset Stats button clears the measurement statistics Max Min Mean Reset Stats and Std Dev values The Configure button displays the Configuration dialog which allows the Configure user to configure key parameters and initialization settings see Section 2 2 3 Signal Strength Power graph The Signal Strength Power graph plots in real time the Signal Rate Mega Counts per Second returned from the target as shown in Figure 6 The Signal Rate can be viewed as a measure of the reflectance of the target with high reflectance targets producing stronger signal rates DoclD026336 Rev 4 UM1764 Premium EVK software user interface Si VL6180X Figure 6 Signal Strength Power graph ALS Interleaved Calibration Data Log I2C Log About Signal Strength Power Rtn Amb Rate Mcps 2 4200 4 S l 3 l w 8 l Ta ts 2 25 3 E D a Signal Rate Mcps Rtn Conv Time us 20 SNR Ref Signal Rate Mcps Ref Amb Rate M
11. augmented 126 Log About Filel File2 V Clear Enable Data Log Merge Dual Axis 1 Dual Axis 2 TimeStamp True Range Mean Range Range Execution Time ms Range Val True Range True Range Smoothed Raw Range Max Range _IMin Range Mean Range Range Stn Dev Filter Size Rtn Signal Rate Ref Signal Rate 9 Signal Count Ref Signal Count Rtn Amb Rate Ref Amb Rate uw D 3 Rtn Amb Cnt _ Ref Amb Cnt w T Rtn Conv Time ae o4 4 74 a 40 4 3 93 TE pampa pa paa oar paia baa pea 8 3 8 S 1 Conv Time LIV Zero Zero Diff V Ave o wy N 9 wy is T 2 5 Recording I C transactions The 120 Log tab is used to record transactions during ranging mode The 1 C transactions are stored in a unique file txt identified by date and time To enable IC logging check the Enable 120 Logging box in the 12C Log tab 20 log files are stored in Users username AppData Local STMicroElectronics VL6180XEVK I2C See Appendix B I2C log file for an example The Laad previous button allows the user to open an existing 1 C log txt file containing captured transactions The Log live button displays 20 transactions in real time on the display Before you can switch off 20 logging the device must first sto
12. displayed here as defined in the data sheet Address 0x04D Displays the tuning settings file applied to override default settings DoclD026336 Rev 4 8 23 Premium EVK software user interface UM1764 2 2 2 Note 9 23 True Range mm 36 Rtn Signal Rate Mcps 131 77 Range Measurement ToF graph The Range Measurement ToF graph plots in real time range measurements see Figure 7 The maximum range is 255 mm The vertical axis can be changed using the Configuration dialog see Section 2 2 3 If a target is not detected the maximum range is displayed The graph default is 255mm True Range shows the correct numerical range and this may exceed the graph limits Figure 7 Range Measurement graph Range Measurement ToF Raw Range mm 360 2 Max mm Min mm 8 a Mean mm 2627 S Std Devimm 13 97 f s salossslasssrssel s 3 1 Range Offset mm Range mm Cross Talk Comp Factor a rl a a SNR Threshold ee ee Ee ee ee T a Ta o Tr 620 630 640 650 f 70 680 690 700 Continual Thresholding Sample Configure The VL6180X premium EVK can be run in single shot ranging mode default or continuous ranging mode by ticking the Continual check box If in Continual ranging mode the time between measurements can be changed using the Configuration dialog see Section 2 2 3 The Range
13. short for Time of Flight To use the software place a target above the VL6180X premium EVK hardware and click on Start The device begins ranging and the Signal Strength and Range Measurement graphs will display data in real time and numerically in the boxes to the right The true range may be incorrect until the device has been calibrated see Section 2 1 Figure 2 Ranging mode interface P VL6180X VL6180X Ranging ALS Interleaved Calibration Data Log I2C Log About Signal Rate Mcps e amp 8 u 6 Signal Strength Power Rtn Amb Rate Mcps Rtn Conv Time us 0 SNR Ref Signal Rate Mcps 9 Ref Amb Rate Mcps Ref Conv Time s Sampling Rate Hz Error Status 0x0000 Tuning Settings eb ih il hd Ml ld Al Waid ad dd edi ill bibisi bitilib aibb biih 0 6 065 07 O75 08 085 09 0 95 3 035 04 045 05 055 0 Sample Range Measurement ToF Raw Range mm Max mm Min mm 350 0 Mean mm Std Dev mm Range Offset mm Cross Talk Comp Factor Max Converg ms bl ey bak id a 0 005 01 015 02 025 03 035 04 045 05 055 06 065 07 075 08 085 09 095 Continual Thresholding Sample Crees SNR Threshold 900 The premium EVK software contains several tabs that can be used to display calibrate and configure various features of the premium EVK The available tabs are e Calibration se
14. up and use the VL6180X premium EVK software utility The premium EVK hardware is described in the VL6180X premium evaluation kit EVK hardware user manual DocID024985 Figure 1 VL6180X premium evaluation kit EVK Installing the premium EVK software utility The premium EVK software utility is available from http www st com web catalog tools FM147 SC1870 PF260779 Double click on the setup exe application and then follow the on screen instructions to install the VL6180X premium EVK software utility Minimum installation requirement is Windows XP SP3 Trouble shooting If an installation fails the user should ensure that any previous installations are removed as follows Select Start Menu Control Panel Programs and Features Locate any entries of VL6180X premium EVK and uninstall Select Right Click Change Next Remove then attempt the installation again Launching the premium EVK software To launch the premium EVK software utility double click on the VL6180X EVK 1 04 shortcut created on the desktop DocID026336 Rev 4 ky UM1764 Premium EVK software user interface 2 Note Premium EVK software user interface When the premium EVK software is launched the Ranging tab is displayed containing the ranging mode interface as shown in Figure 2 The ranging mode interface consists of two graphs Signal Strength Power and Range Measurement ToF where ToF is
15. 21 31 31 36 31 138 55 49 31 73 19 048 46 35 35 35 35 138 55 44 31 7 19 09 27 35 39 138 55 39 31 67 19 133 38 39 45 138 55 36 31 63 19 154 19 45 50 138 55 35 31 59 54 67 7 54 54 54 48 48 48 44 4 4 41 41 41 61 54 48 44 41 19 115 19 50 138 55 35 31 54 19 23 53 54 138 55 38 31 51 138 0 54 11 47 B S 5 51 51 5 8 8 8 8 8 8 8 8 8 1 5 5555 58 8 8 8 31 21 70 70 data_log_07_May_2014_1338_17_36 Lo Ready 7 100 5 DoclD026336 Rev 4 20 23 I7C log file UM1764 AppendixB 1C log file Each 120 log is stored in a uniquely named txt file The 20 log filename configuration is i2c_output_DD_MMM_YYYY_hhmm_ss_SSS txt Where e DD _MMM_YYYYis the date the log file was created for example 07 May 2013 hhmmis the time hours minutes the log file was created for example 1553 e 55 9595 is the time seconds milliseconds the log file was created for example 15 657 An example of a Ko log is shown in Figure 15 Figure 15 2 log file example 2 CA Users sandisoh AppData Local STMicroElectronics BabyBearEVK I2C i2c_output_08_ May File Edit Search View Encoding Language Settings Macro Run TextFX Plugins Window 7 X 5 8 8 4 5 5 1 5 H ReadFMT Dataa 3 E VLGi80 Register Map be 3 M6180 Activation ta E3 i2c_output_08 May 20141 T 1 Read reg 0x0000 Val B401010100113831206F9510
16. Enable Signal Rate Upper Mcps Range Display Upper mm 250 00 Override Range Display Lower mm I2C Speed KHz Upper threshold mm Lower threshold mm Override Tuning Settings Apply Customer settings The parameters and settings that can be changed by the user are described in Table 4 The Reset button resets the parameters to use the default settings Note When you have changed the settings override and customer the hardware must be reset powered off and on to ensure the new settings are used Table 4 Configuration dialog Field Description This parameter defines the minimum range measurement for which Cross Cross Talk Valid Height Talk compensation will be applied If the raw range measurement is greater mm than this parameter cross talk compensation will be applied This parameter ranges from 0 30mm with the default being 20mm Maximum convergence time 50 ms max default 30 ms This can be reduced but doing so will proportionally limit the minimum detectable signal rate Max Converg Time ms Inter Meas Period ms Inter measurement period The time delay between measurements in continuous range mode Range 10 ms to 2 55 seconds default 50 ms DoclD026336 Rev 4 12 23 Premium EVK software user interface UM1764 Table 4 Configuration dialog continued Field SNR Threshold Description The minimum SNR threshold below which a
17. Measurement ToF graph can be changed to show threshold information see Range Management ToF graph showing thresholds To the right of and above the Range Measurement ToF graph the information described in Table 3 is displayed DoclD026336 Rev 4 UM1764 Premium EVK software user interface Table 3 Range Measurement information Field Description This reports the measured distance of a detected target includes offset True Range mm and x talk This is the range measurement prior to applying cross talk compensation Raw Range mm but includes offset These are post processed measurement statistics to make noise evaluation easier to characterize The max min and mean are the range data measured by the sensor over 100 measured sample points Max Min Mean Std Dev mm This is a fixed offset parameter unique to each part which gets applied as part of the range measurement algorithm This parameter must be Range Offset determined for each part using the calibration procedure detailed in Section 2 1 Calibrating the VL6180X Cross Talk This parameter gets applied as part of the range measurement algorithm It must be determined for each different air gap glass using the calibration compensation factor procedure detailed in Section 2 1 Calibrating the VL6180X This is the maximum time allowed for a range measurement to be made No range output is given if the system has n
18. cps 0 2 Ref Conv Time us Sampling Rate Hz Error Status 90000 Tuning Settings s811 True Range mm 30 Rtn Signal Rate Mcps 80 13 To the right of and below the Signal Strength graph the information described in Table 2 is displayed Table 2 Signal Strength information Field Rtn Signal Rate MCpS Rtn Amb Rate MCpS Description Number of ToF pixel counts per second on the return array Number of ToF pixel counts per second due to ambient light on the return array Rtn Conv Time ps The time required to reach the convergence threshold on the return array SNR Ratio of signal rate ambient rate A minimum SNR threshold can be set using the Configuration dialog see Section 2 2 3 below which a range measurement is rejected The SNR threshold is typically set in the range 0 1 to 0 3 Ref Signal Rate MCpS Number of ToF pixel counts per second on the reference array Ref Amb Rate MCpS Number of ToF pixel counts per second due to ambient light on the reference array Ref Conv Time ps The time required to reach the convergence threshold on the reference array Sampling Rate Hz Number of samples captured per second The premium EVK software can use single shot default or continuous ranging mode Sampling rate is PC dependent Error Status Tuning Settings If there is an ranging error the range result error code will be
19. e Section 2 1 e Ranging see Section 2 2 e ALS see Section 2 3 Data Log see Section 2 4 12C Log see Section 2 5 Interleaved see Section 2 6 e About this tab provides a summary of the premium EVK software DoclD026336 Rev 4 4 23 Premium EVK software user interface UM1764 2 1 Note 5 23 Calibrating the VL6180X In order to get accurate readings the user may be required to calibrate the VL6180X range offset and the cross talk compensation factor This is carried out in the Calibration tab To move from the Ranging tab to the Calibration tab the VL6180X must stop ranging Calibrating the range offset The VL6180X device requires a unique part to part range offset correction The default programmed value may be correct however it may be required for the user to override this and apply a different setting To calibrate the range offset use the calibration tool delivered with the VL6180X premium evaluation kit and described in the VL6180X premium evaluation kit EVK hardware user manual UM1651 The resultant offset is added to the raw range Rg Rp offset where Ro is the offset range and R is the raw range in mm see Figure 3 If there is a glass in front of the VL6180X device a unique cross talk compensation factor must be determined and applied If the glass configuration is altered in any manner a new cross talk compensation factor must be determined Figure 3 Range offset o D 5 g
20. ettings can be modified in the Configuration dialog see Section 2 2 3 DoclD026336 Rev 4 10 23 Premium EVK software user interface UM1764 11 23 Figure 8 Range Measurement graph showing thresholds Ranging ALS Interleaved Calibration Data Log I2C Log About Signal Rate Mcps e p N p a 8 8 8 o Signal Rate Mcps Signal Strength Power Signal Rate Mcps Range mm Upper Thresh Lower Thresh DoclD026336 Rev 4 Rtn Amb Rate Mcps 2 02 Rtn Conv Time us SNR Ref Signal Rate Mcps Ref Amb Rate Mcps Ref Conv Time s Sampling Rate Hz Error Status Tuning Settings Raw Range mm Max mm Min mm Mean mm Std Dev mm Range Offset mm Max Converg ms SNR Threshold Continual Thresholding Vi Configure 88 008 0 232 196 340 oo 78 67 4613 Cross Talk Comp Factor oo UM1764 Premium EVK software user interface 2 2 3 Configuration settings The Configuration dialog allows the user to configure key parameters and initialization settings To access the Configuration dialog click on the Configure button in the Ranging tab Figure 9 Configuration dialog 47 VL6180X Range Configuration Cross Talk Valid Height mm Max Converg Time ms Inter Meas Period ms SNR Threshold 10 2 Enable Ignore Thresh Factor 2 Enable ECE Factor 05
21. fault value 60 mm This is enabled by selecting the Enable thresholding box next to the Range Management graph see Section 2 2 2 Override Tuning Settings Apply Customer Settings When selected tuning settings defined in an external text file can be applied to override default settings applied within the software To apply tuning settings check the box and select the file containing the settings see the Release Notes for filename and version information When selected customer settings defined in an external text file can be applied The purpose of the customer settings is to apply specific settings required to meet specific customer needs To apply external customer settings check the box and select the file containing the settings see the Release Notes for filename and version information 1 the two settings files customer settings get applied last DoclD026336 Rev 4 UM1764 Premium EVK software user interface 2 3 Si 6 Ambient light sensing ALS mode Ambient Light Sensing mode can be activated in the ALS tab This tab displays the ALS Count graph showing ALS Count Lux versus Samples as shown in Figure 10 Table 5 lists the buttons available in the tab Figure 10 ALS tab Ranging Al VL6 ALS Lux 3 v N lt 180000 110000 100000 30000 augmented ALS Count ALS Lux Sampling Rate Hz ALS Gai
22. mitter output is reflected back to the receiver This distorts the range measurement but can be corrected by applying cross talk compensation If there is glass in front of the VL6180X device a unique cross talk compensation factor must be determined and applied If the glass configuration is altered in any manner a new cross talk compensation factor must be determined Figure 5 cross talk compensation factor Measured range cross talk compensation Actual range DoclD026336 Rev 4 6 23 Premium EVK software user interface UM1764 2 2 2 2 1 7 23 The cross talk compensation factor x talk is calibrated with the premium EVK using a target of approximately 3 black reflectance at least 60 x 60 mm square placed 100 mm above the sensor To activate automatic x talk calibration click on the pink Cal x talk button follow the on screen instructions then click Apply Once calibrated the button will turn green To manually set the x talk enter the x talk value in the cross talk compensation factor field and click on Apply as shown in Figure 4 Measuring the range When the premium EVK software is in ranging mode it measures absolute range from the sensor to a target This is shown in graphical form in the Ranging tab see Figure 2 The Ranging tab displays two graphs e Signal Strength Power see Section 2 2 1 e Range Measurement ToF see Section 2 2 2 The buttons listed in Table 7 are available
23. n ALS Max ALS Min ALS Mean ALS Std Dev Error Status ALS Lux Res z Integration Period ms Inter Meas Period ms Continual ALS Gain Selection ALS Scaler ALS Count Upper Auto Gain _ Auto Gain Count Thresh Min Auto Gain Count Thresh Max Table 5 Buttons in the ALS tab 1126 0 3152 80 77 0 20 165 2 1 00 2 100 gt 15 000 01 2 Button Start Pause Resume Stop Description Click on Start to begin measuring the ALS count The Start button then changes to Pause Resume Click on Stop to stop measuring the ALS count Reset The Reset button resets the 20 communications interface between the application and the VL6180X Reset Settings The Reset Seitings button resets the parameters to use the default settings Reset Stats The Reset Stats button clears the measurement statistics Max Min Mean and Std Dev values To the right of the ALS graph the information described in Table 6 is displayed DoclD026336 Rev 4 14 23 Premium EVK software user interface UM1764 15 23 Table 6 ALS information Field Description ALS Count This is the raw output from the ambient light sensor The count is proportional to the light level The count output is a 16 bit binary value The ALS Count value is converted automatically to a Lux value depending ALS Lux on the ALS Lux Res ALS Gain Integration Period and ALS Scaler settings
24. n Amb Cnt 2 Amb Cnt Rtn Conv Time Ref Conv Time OV Zero V Zero Diff V Ave Data log files are created with unique filenames and stored in c Users username AppData Local STMicroElectronics VL6180XEVK Dat aLog See Appendix A Data log file for an example Before you can switch off data logging the device must first stop ranging To do this click on the Stop button in the Ranging tab see Section 2 2 Measuring the range The File1 button allows the user to open an existing data log csv file containing a captured ranging data log Once the file has been opened the menu to the right hand side allows the user to select the data to plot The menu displays all the data types recorded in the data log file The File2 button allows the user to open another existing data log csv file containing the captured ranging data log By clicking on the File2 button the screen is split in two and the File2 graph is displayed below the File1 graph The Merge button allows File1 and File2 to be plotted on the same graph When plotting data the y axis scale automatically adjusts to suit the selected data set When plotting multiple data items the graph is adjusted to accommodate all scales Figure 12 shows an example of how various data is selected and displayed for a ranging data log DoclD026336 Rev 4 UM1764 Premium EVK software user interface Figure 12 Ranging data log example 47 VL6180X Kys fe
25. n mm Std Dev mm ALS Gain ALS Gain Selection ALS Max ALS Scaler Range Offset mm Range mm Cross Talk Comp Factor Max Converg ms ALS Min ALS Count Upper SNR Threshold ALS Mean 0 Thresholding C ALS Std Dev __ Reset stats Reset stats ALS Error Code Persistent data Specific data values are remembered between execution cycles of the premium EVK software application The remembered values are Range Offset e Cross Talk compensation factor e Maximum Convergence Time Inter measurement period e Threshold ignore Threshold Factor e ECE Factor e External NVM Register Tuning and Patch Files e Maximum ALS Count e ALS Lux Resolution e ALS Integration period e ALS Inter measurement period e ALS Gain DoclD026336 Rev 4 UM1764 Data log file Appendix A Data log file Each data log is stored in a uniquely named csv file The data log filename configuration is data log DD MMM YYYY hhmm_ss_SSS csv Where e DD_MMM_YYYY is the date the log file was created for example 17 2013 hhmmis the time hours minutes the log file was created for example 1025 e 55 _SSSis the time seconds milliseconds the log file was created for example 15 657 An example of a ranging data log is shown in Figure 14 Figure 14 Data log file example Fal EE data_log_07_May_2014_1338_17_367 csv Microsoft Excel Home
26. ot converged within the specified time that is no target or target out of range Max Convergence ms In high ambient conditions range accuracy can be impaired The SNR limit is used to invalidate range measurements where the signal ambient ratio is too low The SNR threshold defines the signal to noise threshold below which the range data is unreliable SNR Threshold Continual Changes ranging mode from single shot to continuous mode Check this box to enable upper lower thresholds defaults are 70 mm and 60 mm see Section 2 2 3 Thresholding When enabled these threshold lines are shown in the Range Measurement graph See Range Management ToF graph showing thresholds Range Management ToF graph showing thresholds The thresholding feature allows the user to define upper and lower limits and be alerted as the range measurements transition across these limits by the display changing colour Figure 8 shows an example of the Range Management ToF graph with thresholding enabled It shows a minimum threshold of 60 mm a maximum threshold of 70 mm anda range measurement of 50 mm If the range measurement goes below the lower threshold the graph turns green If it goes above the upper threshold the graph turns pink The graph will stay pink green till the lower upper threshold is crossed Thresholding is enabled by checking the Thresholding check box see Table 3 and the upper and lower threshold s
27. p ranging measurements To do this click on the Stop button in the Ranging tab see Section 2 2 Measuring the range 2 6 Interleaved mode Interleaved mode performs range and ALS measurements together in an interleaved sequence and is performed by selecting the Interleaved Tab as shown in Figure 13 During interleaved mode ALS measurements are performed in continual mode with a Single Shot measurement being performed immediately after each ALS measurement It is DoclD026336 Rev 4 18 23 Premium EVK software user interface UM1764 2 7 19 23 therefore necessary that the inter measurement period is large enough to perform both ALS and range measurements Therefore the following condition must be satisfied InterMeasPeriod gt AlsintegrationPeriod RangeConvergenceTime Figure 13 Interleaved mode tab 47 VL6180X Interleaved Signal Strength Power Rtn Amb Rate Mcps 0 ALS Lux Rtn Conv Time us SNR Ref Signal Rate Mcps Ref Amb Rate Mcps t 8 8 1 3 Ref Conv Time us Sampling Rate Hz 8 l E 000 S 3 Signal Rate Mcps Error Status 0x0000 Tuning Settings 20000 ALS Count 10000 True Range mm 0 Rtn Signal Rate Mcps 0 00 Range Measurement ToF Raw Range mm Max mm ALS Count ALS Lux Res ALS Lux Integration Period ms Mean mm Sampling Rate Hz Inter Meas Period ms 1 Mi
28. range measurement is rejected The default value is 0 06 Ignore Thresh Factor This is used to ensure the device is not able to range on the glass The signal rate must be above the ignore threshold before a range measurement will be considered valid The default value is 1 2 When adjusting the Ignore Threshold Factor x talk calibration must be performed to ensure that a valid cross talk compensation factor has been determined see Section 2 1 2 Ignore Threshold MCpS cross talk compensation Factor MCpS Ignore Threshold Factor MCpS ECE Factor The VL6180X has a built in Early Convergence Estimate feature When enabled the rate of convergence is automatically calculated 0 5 ms after the start of each measurement If the return count is below the ECE threshold the measurement is aborted This minimizes power consumption and reduces red glow when there is no target The ECE threshold is calculated as follows ECE threshold convergence threshold max_convergence 2 1 2 Signal Rate Upper MCpS Graph vertical scale limit Range Display Upper mm Graph vertical scale limit max of 300 mm 12C Speed KHz 50 interface control speed This cannot be changed Upper threshold mm Upper threshold value Default value is 70 mm This is enabled by selecting the Enable thresholding box next to the Range Management graph see Section 2 2 2 Lower threshold mm Lower threshold value De
Download Pdf Manuals
Related Search