(EVALKIT-VL6180X) software installation
Contents
1. vi Return Signal Rate Display E EE 200 205 210 215 220 225 230 235 240 245 250 255 260 265 270 275 280 285 290 295 300 Sample True Range mm 04 Rtn Signal Rate Mcps 2245 E Actual Distance Time of Flight SEETI a SES Range mm Ranging Live Result 200 205 210 215 220 225 230 235 240 245 250 255 260 265 270 275 280 285 290 295 300 Pause Stop Reset COM Ports com12 w ResetComms Baud Rate 19200 Connect 3 DoclD026604 Rev 2 UM1796 VL6180X software GUI description The buttons listed in Table 3 are available at the bottom of the Ranging tab Table 3 Buttons in the ranging tab Button Start Pause Resume Description Click on Start to begin ranging The Start button changes to Pause Resume while the device is ranging Stop Click on Stop to stop ranging Reset The Reset button resets the I C communications interface between the application and the VL6180X COM Ports The COM Ports box display a list of available connection ports to connect the VL6180X to the PC Reset Comms Resets the COM Port connection to the VL6180X software Baud Rate Port COM speed bits per second Default is 19200 Connect Connects the chosen COM Port to the VL6180X explorer software 2 1 1 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 s2. y life augmented UM1796 User manual VL6180X explorer kit EVALKIT VL6180X software installation Introduction This document provides detailed firmware installation guidelines for a standalone demonstration a PC graphical user interface GUI and an application programming interface API for the use of VL6180X explorer kit EVALKIT VL6180X This explorer kit consists of the VL6180X plug in board and the STM32 F401RE Nucleo board This product is part of STMicroelectronics offering for demonstration and development tools designed around the VL6180X 3 in 1 proximity gesture and ALS sensor based on ST patented FlightSense technology Figure 1 EVALKIT VL6180X ky X NUCLEO IKPOIA1 Swi VL6180X ES F VL6180X EXPLORER SHIELD lt p SCL 9 SDA G 3 GND 4 GPIO0 GPIO1 5 Table 1 Ordering information Ordering code EVALKIT VL6180X Description VL6180X plug in board and STM32 F401RE Nucleo board February 2015 DoclD026604 Rev 2 1 32 www st com Contents UM1796 Contents 1 Getting started ai Pt Son hs Sg ao fe nit aman a TA a 3 1 1 Document references 22 cca ee ee anaana 3 1 2 Hardware description 0 cee ee 3 1 3 EVALKIT VL6180X demonstration software installation 4 1 3 1 Demonstration software suite 0 00 cece eee 4 1 3 2 STM32 F401RE driver and upgrade firmware installation 6 1
3. 115 115 115 115 115 115 130 142 142 142 142 142 142 142 142 142 142 142 142 142 142 142 DoclD026604 Rev 2 115 115 aAaRanetPtRESEREERRRSA oo e e ee e J K B G pea Range Ext Range Va True Rang True Rang Raw Rang Max Rang Min Rang Mean Rar Range Str Filter Size Rtn Signa 0 12 73 18 5 21 88 21 95 19 77 18 31 17 57 18 19 21 64 25 4 24 47 24 28 25 79 26 74 25 92 26 26 25 91 25 73 26 17 25 57 25 48 25 95 25 44 25 13 24 64 A Ol 100 L 12 14 15 55 24 47 36 42 38 88 24 46 18 6 16 91 13 57 9 13 7 45 13 65 30 93 58 76 62 08 24 81 10 4 12 43 35 48 53 05 24 16 12 21 9 29 15 88 25 66 16 35 3888883888388888 8888888588885858 23 32 VL6180X software GUI description UM1796 24 32 Range output column data definitions A TimeStamp The time stamp is generated by the EVK software so the data can easily be plotted on a graph and it represents the time of start of the test There is latency due to the USB interface to send and receive data to the sensor B Range Execution Time ms The range execution time is measured by the software for the amount of time that the test was executed to the time the data was received over the USB interface to display the data C Range Val The range value read directly from RESULT__RANGE_VAL 0x0062 in the VL6180X part on the EVK This value includes the crosstalk compensation D True Ra
4. Part Number ons gt Description Version Version 475 KB Size Size 6B DoclD026604 Rev 2 Plug a USB cable between the PC and NUCLEO F401RE board Allow the board driver installations to complete before proceeding Figure 8 Nucleo F401RE communication driver with PC installation step 1 Getting started UM1796 8 32 Following windows Click on Download Figure 9 Nucleo F401RE communication driver with PC installation step 2 Languages EN ys lile cugmented Search ter Part Number Keyword Cross Reference My ST Login STSW LINKOO7 ST LINK V2 1 firmware upgrade Oime Online Support Oriine Suppo Design Resources s Release Notes a Technical Documentation Description version Size rNoos3 NK 6 30 144 KB Get Software Following windows From stsw link007 zip by unpacking zip file and running ST LinkUpgrade exe Press device connect in the application Then press YES to upgrade the communication driver with the PC with the last version Figure 10 Nucleo F401RE communication driver with PC installation step 3 Name Date modified Type Size ail ST LinkUpgrade exe 14 05 2014 14 44 1 KB uSseDriverd 25 04 2014 11 05 4 KB w folder Eaz stsw link007 zip Fichier Edition Affichage Favoris Outils Aide a fh vw gt x ii Ajouter Extraire Tester Copier De Sup
5. USD for BUDGETARY USE ONLY For quotes prices in local currency please contact your local ST Sales Office or our lt e then drag and drop the bin file to Nucleo Figure 13 VL6180X standalone demonstration installation step 4 a N u Drag and drop _ VL6180X_API_W0100_1_NUCLEO_F401RE bin 08 01 2015 10 30 BIN File 40 KB DoclD026604 Rev 2 9 32 Getting started UM1796 10 32 The explorer kit is now running in standalone mode meaning no PC is required to control the explorer kit USB connection is only used to power the explorer kit The switch SW1 can be changed on the fly e When running in Standalone mode the SW1 switch on the VL6180X plug in selects the value displayed on the 4 digit display see Figure 14 If switch is on range the distance detected between VL6180X and the nearest object is displayed in mm f switch is on ALS the ambient light level is displayed in Lux Figure 14 Value displayed versus SW1 switch setting sci i el gt a ta Pi2 X EXPLORER SHIELD ro Os0 S sci O mn Gepke eae p SDA P13 Ranging 1 BS OAS OM 3Z o 6 5 o a 8 i ie B 1o e Move your hand or any object in front of VL6180X and read the value displayed on the 4 digit display 3 DocID026604 Rev 2 UM1796 Getting started 1 3 4 Caution 3 Installation of the VL6180X PC software graphi
6. mm This is the range measurement including the Offset Factor Max amp Min mm These are post processed measurement statistics to make noise evaluation easier to characterize The max and min are the range data measured by the sensor over 100 measured sample points DoclD026604 Rev 2 17 32 VL6180X software GUI description UM1796 2 1 3 Actual distance 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 color Figure 23 shows examples of the Actual Distance ToF graph with high and low thresholding enabled It shows a minimum threshold of 60 mm a maximum threshold of 150 mm and range measurements above and below the thresholds If the range measurement goes below the lower threshold the graph turns green as shown in the top graph If it goes above the upper threshold the graph turns pink as shown in the lower graph The graph will stay pink green till the lower upper threshold is crossed Thresholding is enabled by checking the Enable check box see Table 5 and the upper and lower threshold settings can be modified in the High amp Low Threshold settings Figure 23 Actual distance graphs showing high and low thresholds Low threshold reached with green background display oe IS Range mm 8 a Range mm Range mm Upper Thresh Range Measur
7. Maximum convergence time default 30ms Inter Meas period ms Inter measurement period is the time delay between measurements in continuous range mode Range 10ms to 2 55 seconds default 50ms SNR threshold The minimum SNR threshold below which a range measurement is rejected The default value is 0 1 ECE factor The VL6180X has a built in Early Convergence Estimate feature When enabled the rate of convergence is automatically calculated 0 5ms 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 example with ECE factor 80 ECE threshold 80 x 0 5 x 15360 SYSRANGE__ MAX_CONVERGENCE_TIME in ms Offset factor mm This is fixed range offset parameter which can be manually applied by the user to introduce a range adjustment 2X Scaling Default setting maximum range measurement up to 400mm if box not ticked maximum range can be approximatively 200 or 400mm Return Signal Rate Display Continual Manual adjustment of the Signal Rate vertical axis permissible range Scale can be adjusted from 0 240 at the lower limit to 10 300 at the upper limit Changes ranging mode from single shot to continuous mode Gesture Help Provides some examples of gesture hand movements and signal comparis
8. captured and averaged The default integration period is 100 ms Inter Meas Period ms The inter measurement period is the time between each ALS measurement in continuous ALS mode The default inter measurement period is 10 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 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 Auto Gain 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
9. 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 3 DocID026604 Rev 2 UM1796 VL6180X software GUI description 2 3 Options The Options tab is used to enable I2C logging or data logging during ranging and ALS modes 2 3 1 Recording Data Logs 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 Options tab check the Enable Data Log box see Figure 25 Data logging should be selected either prior to starting measurements or during the paused state Figure 25 Enable data logging Si VL6180X Explorer VL6180X Explorer Ranging ag 2 3 2 3 Enable 12C logging 7 Enable Data Log Data log files are created with unique filenames and stored in C Users username AppData Local ST MicroElectronics VL6180XEVK DataLog See 2 5 Data log file for an example Before you can switch off data logging the device must first stop ranging or ALS measurements To do this click on the Stop button in the Ranging tab see Section 2 1 Ranging Recording I7C transactions The Enable 12C Logging option is used to record 1 C transactions during ranging or ALS mode The I C transactions are stored in a unique file txt identified by
10. 230 235 240 245 250 255 260 265 270 275 280 285 290 295 300 Pause Stop Reset COM Ports comi2 w ResetComms Baud Rate 19200 Connect it tng T T The VL6180X explorer can be run in single shot ranging mode default or continuous ranging mode by ticking the Continual check box to the right of the Signal Strength Power graph see Figure 27 If in Continual ranging mode the time between measurements can be changed by adjusting the Inter Meas Period ms The Actual Distance ToF graph can be changed to show threshold information see Section 2 1 3 To the right of and above the Actual Distance ToF graph the information described in Table 5 is displayed Table 5 Actual distance ToF information Field Actual Distance ToF Display Description Manual adjustment of the Range vertical axis permissable range Scale can be adjusted from 0 110 at the lower limit to 10 255 at the upper limit Enable Check the Enable box to allow thresholding to be enabled Low Threshold Manual adjustment of the lower threshold limit default is 60mm When enabled this threshold line is shown in the Actual Distance ToF graph See Actual distance ToF graph showing thresholds High Threshold Manual adjustment of the upper threshold limit default is 70mm When enabled this threshold line is shown in the Actual Distance ToF graph See Actual distance ToF graph showing thresholds Raw Range
11. 3 3 Installation of the VL6180X standalone demonstration 9 1 3 4 Installation of the VL6180X PC software graphical user interface GUI 11 2 VL6180X software GUI description 2000 cece eee eee 14 2 1 Ranging eerren rie na eaa E e E Ea a aE a teva Aa 14 2 1 1 Signal strength power graph 00 eee eee 15 2 1 2 Actual distance ToF graph 0 0 eee 16 2 1 3 Actual distance ToF graph showing thresholds 18 2 2 Ambient light sensor ALS 0000 ee 18 2 3 OONCNS eaa eaa ease nse eee ure ashe eenseeiesGheene seed 21 2 3 1 Recording Data Logs 0 anaa kan EEA nes 21 2 3 2 Recording C transactions acca agndbcouraheucrseun bk beaters 21 2 4 Help s2scess2 0 vias telew Ses edewenns Gee eee Va a e b kale an 22 2 5 Data logue 22 1veve ed eh Se See ha ee EEN E EEEREN a PASE See Ee 23 2 6 C logfile nunnana 25 2 7 Range offset calibration procedure 000 eee eee eee 26 3 VL6180X application programming interface API 29 4 Revision history vaccavcsctu dest we ee inde edie date ee ee 31 2 32 DoclD026604 Rev 2 ky UM1796 Getting started 1 Getting started 1 1 Document references Table 2 Document references Description Data brief VL6180X plug in and STM32F401 Nucleo board evaluation kit DocID DoclD026599 Datasheet VL6180X proximity and ambient light sensing ALS module DoclID026171 AN4545 applicatio
12. 8 mE Range mm S 8 Ranging Live Result Values are now displayed on the PC screen and no more on the VL6180X plug in display 3 DocID026604 Rev 2 13 32 VL6180X software GUI description UM1796 2 2 1 14 32 Gd v1 6180x Explorer VL6180X software GUI description The VL6180X software GUI contains several tabs that can be used to display calibrate and configure various features of the VL6180X The available tabs are e Ranging see Section 2 1 e ALS see Section 2 2 e Options see Section 2 3 e Help see Section 2 4 Ranging When the VL6180X explorer software is launched the Ranging tab is displayed containing the ranging sensor interface as shown in Figure 20 In ranging mode the VL6180X explorer measures absolute range from the sensor to a target This is shown in graphical form in the two graphs displayed e Signal Strength Power see Section 2 1 1 e Actual Distance Time of Flight TOF see Section 2 1 2 To use the software place a target above the VL6180X device and click on Start The device begins ranging and the Signal Strength Power and Actual Distance ToF graphs will display data in real time and numerically in the settings and display boxes to the right Figure 20 Ranging tab VL6180X Explorer Range mm ALS Options Help Ranging Sensor SETTINGS Signal Strength Power Signal Rate Mcps Signal Rate Mcps j
13. Resale Price per unit USD for BUDGETARY USE ONLY For quotes prices in local currency please contact your local ST Sales Office or our laterial Declaration forms available on st com may be generic documents based on the most commonly used package within a package family For this reason Save and unzip STSW IMG003 zip User has now all information to develop its own application with VL6180X The best way to discover VL6180X API features is to open API_Documentation proximity chm file in the DOCS folder 3 DoclD026604 Rev 2 UM1796 Revision history 4 Revision history Table 8 Document revision history Date Revision Changes 12 Aug 2014 1 Initial release R F 5 F 03 Feb 2015 2 emove al 80X plug in haraware information Update Section 1 3 1 Demonstration software suite 3 DocID026604 Rev 2 31 32 UM1796 IMPORTANT NOTICE PLEASE READ CAREFULLY STMicroelectronics NV and its subsidiaries 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 appli
14. VL6180X COM Ports The COM Ports list shows available device ports The Reset Comms button resets the comms between the device and the software Baud Rate Port COM speed bits per second Default is 19200 To the right of the ALS graph the information described in Table 7 is displayed Table 7 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 DoclD026604 Rev 2 19 32 VL6180X software GUI description UM1796 20 32 Table 7 ALS information continued Field Sampling Rate Hz Description The number of ALS samples measured per second PC dependent Displays the actual gain value applied corresponding to the ALS Gain ALS Gain Selection setting These are post processed measurement statistics to make noise ALS Max amp Min evaluation easier to characterize The max min and mean are the ALS data measured by the sensor over 100 sample points This calibrates the ALS Lux count conversion The characterized ALS Lux ALS Lux Res Res is 0 32 default Integration Period ms The integration period is the time range during a single ALS measurement over which Lux data is
15. ansion board under Keil IDE e API documentation csh and html Description The VL6180X API is a set of C functions controlling the VL6180X init ranging ALS to enable the development of end user applications This API is structured in a way it can be compiled on any kind of platforms through a well isolated platform layer mainly for low level I2C access Several code examples are provided to show how to use API and perform ranging and ALS measures A complete Nucleo F401 VL6180X expansion board project is also provided Keil IDE required to compile the project as well as the pre compiled binary that can be directly used STSW IMGO03 installation e In EVALKIT VL6180X page select STSW IMG003 Figure 31 VL6180X API installation step 1 Design Resources E Technical Documentation Description Version Size a m ea Description Version Size M1796 11 2655 KB Related Tools and Software Part Number Description DocID026604 Rev 2 29 32 VL6180X application programming interface API UM1796 30 32 Following windows click on Download Figure 32 VL6180X API installation step 2 Ti ife augmented Search B Part Number Keyword Cross Reference Products iNtesibe ites Support Sample amp Buy About Contact My ST Login STSW IMG003 vL6180X AP Ocie Online Support Design Resources Sample amp Buy Marketing ae ee Status STSW IMG003 3 0 083 Active gested
16. ay on the VL6180X when the laser is active This data is read directly from the VL6180X 3 DocID026604 Rev 2 UM1796 VL6180X software GUI description 2 6 3 I7C log file Each I C log is stored in a uniquely named txt file The 2c log filename configuration is i2c_output_DD_MMM_YYYY_HHMM_SS sss ixt Where e DD_MMM_YYYYis the date the log file was created for example 07_May_2013 e HHMMis the time the log file was created for example 1553 e SS_sssis the time seconds milliseconds the log file was created for example 17_367 An example of a 1 C log is shown in Figure 28 Figure 28 C log file example GY CAUsers sandisoh Desktop i2c_output_09_Jul_2014_1133_19_853 txt Notepad File Edit Search View Encoding Language Settings Macro Run TextFX Plugins Window odn anlk T C n h BAE E i2c_output_09_Jul_2014_1133_19_853p Ed Read reg 0x0119 Val Read reg Ox01A0 Val Read reg Ox004E Val Write reg 0x0207 Val Write reg 0x0208 Val Write reg 0x0133 Val Write reg 0x0096 Val Write reg 0x0097 Val Write reg 0x00E3 Val Write reg Ox00E4 Val Write reg Ox00E5 Val Write reg Ox00E6 Val Write reg 0x00E7 Val Write reg Ox00F5 Val Write reg 0x00DS Val Write reg Ox00DB Val Write reg 0x00DC Val Write reg 0x00DD Val Write reg Ox00SF Val Write reg 0x00A3 Val Write reg 0x00B7 Val Write reg 0x00BB Val Write reg 0x00B2 Val Write reg OxO00CA Val Write reg 0x0198 Val Write r
17. cal user interface GUI The GUI shows on the PC screen the result of a range or an ALS measurement and allows the user to discover and test the different VL6180X settings As soon as the PC software runs the VL6180X plug in display is Off and values are only visible on the PC screen To install the PC graphical user interface e In EVALKIT VL6180X page select STSW IMG002 Figure 15 Installation of the VL6180X PC software GUI step 1 Design Resources Quick Links Product Specifications Z Technical Documentation Description Version Size a 475KB Description Version Size B UM1796 6180X er ex 3 NUCLEO F401RE 11 2655 KB Related Tools and Software Part Number Description SW LINKOOS 5 NK V2 1 USB drive TSW LINKOO7 TSW IMG003 180X A e _ Following windows click on Download Figure 16 Installation of the VL6180X PC software GUI step 2 1S Ti ife augmented Search BDB Part Number Keyword Cross Reference Products Applications Support Sample amp Buy About Contact My ST Login STSW IMG002 Gul Graphical User Interface for VL6180X Evaluation boards Propos Online Support Featured Products X orer kit Design Resources Get Software ee gt Status STSW4AMG002 1 0 Propo DocID026604 Rev 2 11 32 Getting started UM1796 e Then Save and Run VL6180X_ExplorerSetup exe icon VL6180X_Explorer is installed on the user deskt
18. cation 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 2015 STMicroelectronics All rights reserved 32 32 DocID026604 Rev 2 3
19. date and time To enable 1 C logging in the Options tab check the Enable 12C Logging box see Figure 25 DoclD026604 Rev 2 21 32 VL6180X software GUI description UM1796 12C log files are stored in C Users username AppData Local ST MicroElectronics VL6180XEVK I2C See 2 6 PC log file for an example Before you can switch off 12C logging the device must first stop ranging or ALS measurements To do this click on the Stop button in the Ranging tab see Section 2 1 Figure 26 Enable 12C logging Si VL6180X Explorer Sos VL6180X Explorer Ranging ALS Options Help 7 Enable I2C logging Enable Data Log 2 4 Help The Help tab provides links to documents and on line resources which provide details on the setup and functionalities of the VL6180X explorer and also details on the software version e HELP To access help index e HW User Manual To access hardware user manual e SW User Manual To access software user manual e www ST com VL6180X To access ST VL6180X product and support page e About GUI Version Provides the GUI version installed 3 22 32 DocID026604 Rev 2 UM1796 VL6180X software GUI description 2 5 3 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 DD_MMM_YYYY is the date the log file was created for example 17_Apr_2014 e HHMMis the tim
20. e hours minutes the log file was created for example 1025 e SS_sssis the time seconds milliseconds the log file was created for example 17_367 An example of a ranging data log is shown in Figure 27 T MAI i7 Home Inset Page Layout Formulas Data 3 Calibri qu fay BZU AW SO Ae Clipboard amp Font Figure 27 Data log file example data_log_09_Jul_2014 113012 _015 csv Read Only Microsoft Excel Alignment Review View General v A Conditional Formatting 3 Insert 7 s E Format as Table E Cell Styles Styles lt 0 00 00 0 Number m Developer Add Ins 3 Delete v ppt Z Format Cells Qr e Classification JMP Acrobat A og amp ZFA Sort amp Find amp Filter Select Editing Al fe TimeStamp 14 129 143 115 14 268 136 14 408 139 14 542 133 14 685 142 14 82 134 14 955 134 15 09 134 15 225 134 15 36 134 15 494 133 15 629 134 109 15 771 141 75 15 906 134 55 16 059 152 55 16 195 135 82 16 348 152 122 16 484 135 112 16 637 152 70 16 778 140 58 16 936 157 82 17 075 138 17 222 146 126 17 357 134 101 17 516 158 76 17 651 134 98 M 4 h data_log_09_Jul_2014 wan nun amp wN D E 115 115 115 97 97 78 78 78 91 97 109 130 130 130 109 75 75 82 112 112 112 82 82 126 114 101 114 76 114 98 101 1130_12_01 J Ready 23 F 115 G 115 115 115 115
21. eg 0x01B0 Val Write reg Ox01AD Val Write reg OxO0OFF Val Write reg 0x0100 Val Write reg 0x0199 Val Write reg Ox010A Val Write reg 0x003F Val Write reg Ox01A6 Val Write red OvO1AaC Val 64Ln 1 Col 1 Sel 0 0 Dos Windows ANSI as UTF 8 DoclD026604 Rev 2 25 32 VL6180X software GUI description UM1796 2 7 Note Note 26 32 Range offset calibration procedure If a measurement with an accuracy below 10 mm is required offset calibration must be done An offset calibration is performed for each VL6180X module during the final test of the manufacturing process and stored into the NVM So the ranging measurement reported by the product should be very close to the actual distance between a target and the VL6180X module Despite this offset calibration you may notice eventually a significant offset due to the soldering of the VL6180X module on the plug in In this case the VL6180X evaluation kit provides you with the possibility to make a manual offset calibration The calibration procedure described below is efficient but will not deliver the highest precision For precise offset calibration refer to AN4545 VL6180X basic ranging application note section 4 1 1 e _ Put the jacket delivered with the VL6180X explorer board or a grey paper horizontally on the 4 digit display and above the VL6180X this corresponds to the distance of 8 mm between the target and the VL6180X e To have a precise measurement s
22. ement Display Actual Distance Time of Flight Upper Thresh 150 y Lower Thresh Lower Thresh e2 Ranging Live Result COM Ports COM7 Reset Comms Baud Rate 19200 High threshold reached with red background display 2 2 18 32 D D True Range mm 164 Rtn Signal Rate Mcps Actual Distance Time of Flight Range Measurement Display peer A Range mm Range mm Upper Thresh J Upper Thresh F Lower Thresh Lower Thresh l Ranging Live Result Reset COM Ports COM7 Reset Comms Baud Rate Ambient light sensor ALS The ambient light sensor can be activated in the ALS tab This tab displays the ALS Count graph showing ALS Lux count versus Samples as shown in Figure 24 Table 6 lists the buttons available in the ALS tab DocID026604 Rev 2 ky UM1796 VL6180X software GUI description 3 Figure 24 ALS tab F G VL6180X Explorer o VL6180X Explorer ky ALS Count augmented Ambient Light Sensor ALS LUX COM Ports COM43 ResetComms Baud Rate Table 6 Buttons in the ALS tab Button Start Pause Resume Description Click on Start to begin measuring the ALS count The Start button then changes to Pause Resume Reset Comms Stop Click on Stop to stop measuring the ALS count Reset The Reset button resets the 12C communications interface between the application and the
23. et the max value of the range measurement display to 30 see Figure 29 e Check the value of Raw Range if the Raw range does not equal to 8 then the offset factor value must be modified e in the following example before manual offset calibration the Raw range reports a value of 22 mm see Figure 29 while the actual distance of the target is 8mm The offset factor must be adjusted from 30 to 15 reducing the raw range from 22mm before offset calibration back to the true value of 8mm after offset calibration see Figure 30 bb Each time you modify the offset factor you have to do a stop start bottom sequence Each time the EVALKIT VL6180X is switched off the offset factor value is cleared back to the factory calibration so if previously manually modified the offset factor must be reloaded at the next switch on of the EVALKIT VL6180X 3 DocID026604 Rev 2 UM1796 VL6180X software GUI description Figure 29 Before offset calibration procedure Givicisox Explorer VL6180X Explorer 8 hy Ranging ALS Options Help Ranging Sensor SETTINGS Signal Strength Power _ Signal Rate Mcps E Sonal Rate Meps vl Return Signal Rate Display True Range mm pr Rtn Signal Rate Mcps a Range Measurement Display TE ES Actual Distance Time of Flight EEE Ranging Live Result Start Stop Reset COM Ports com
24. he demonstration software suite is available at the bottom of the page of the EVALKIT VL6180X htto www st com web en catalog tools PF260896 see Figure 4 This software suite is consisting of STSW LINKOO8 Windows vista 7 and 8 driver for STM32 F401RE Nucleo board This driver must be first installed e STSW LINKOO7 STM32 F401RE Nucleo board communication driver with PC When STSW LINK008 and STSW LINKOO7 firmware s are installed the STM32 F401RE Nucleo board is configured and ready to use with a PC e STSW IMG 001 binary code to be downloaded into STM32 F401RE microcontroller in order to enable the EVALKIT VL6180X standalone demonstration showing on the display the result of a range or an ALS measurement This stand alone demonstration will start each time the USB cable is plugged between the EVALKIT VL6180X and the PC In standalone demonstration mode the USB cable is only used to supply the EVALKIT VL6180X no data are transferred on DP and DN DocID026604 Rev 2 ky UM1796 Getting started e STSW IMGO02 this executable enables the graphical user interface GUI on the PC The GUI shows on the PC screen the result of a range or an ALS measurement and allows the user to discover and test the different VL6180X settings Note When the GUI is in use the display of the EVALKIT VL6180xX is disabled Figure 4 EVALKIT VL6180X web page on st com Design Resources Quick Links Product Specifications vi Tech
25. hown in Figure 21 The Signal Rate can be viewed as a measure of the reflectance of the target with high reflectance targets producing stronger signal rates J vi6180x Explorer Figure 21 zis gnal strength power graph Signal Rate Mcps aleallaconies Explorer SETTINGS Signal Strength Power Signal Rate Mcps u Return Signal Rate Display Range mm Range mm in aad il ares a re il a a eit E a ot bg pe As 210 215 220 225 230 235 240 245 250 255 260 265 270 275 280 285 290 295 ae sample True Range mm 104 Rtn Signal Rate Mcps 22 45 u N dlha pea Range Measurement Display emo me Actual Distance Time of Flight Ranging Live Result asa Yaa T T 200 205 210 215 220 225 230 235 240 245 250 255 260 265 270 275 280 285 290 295 300 rae W EEA G ee ek E T ek ee ke Sample se COM Ports comz Raset Comms Baud Rate 10200 E M To the right of the Signal strength power graph the settings and display information described in Table 4 is shown 3 DocID026604 Rev 2 15 32 VL6180X software GUI description UM1796 2 1 2 16 32 Table 4 Signal strength power information Field Max Convergence time ms Description This is the maximum time allowed for a range measurement to be made No range output is given if the system has not converged within the specified time that is no target or target out of range
26. i2 ResetComms Baud Rate 19200 _ Connect 3 DoclD026604 Rev 2 27 32 VL6180X software GUI description UM1796 Figure 30 After Offset calibration procedure Giivieisox Explorer VL6180X Explorer v STi lile augmented ALS Options Help Ranging Sensor SETTINGS Signal Strength Power Signal Rate Meps o Signal Ratetmcps vl Return Signal Rate Display LOS 250 True Range mm lt Rtn Signal Rate Mcps 210 88 2 z Actual Distance Time of Flight Rango Msasunoneiit Dispiay Ja Range mm E Ranging Live Result Start Stop Reset COM Ports comi2 z Reset Comms Baud Rate 19200 z Connect 3 28 32 DocID026604 Rev 2 UM1796 VL6180X application programming interface API 3 3 VL6180X application programming interface API Previous chapters described how to use EVALKIT VL6180X in demonstration mode this chapter gives information to use EVALKIT VL6180X as a development tool STSW IMG003 contains VL6180X API API features e VL6180X application programming interface API source code C language e Full ranging and ALS features control e API structured in a way it can be easily ported compiled on any microcontroller platforms e Several examples showing how to use API to perform ranging and ALS measurements e Complete Nucleo STM32 F401 project Source code binary working with VL6180X explorer exp
27. n note Getting started VL6180X basic ranging DoclD026571 AN4466 application note VL6180X cover glass selection DocID026155 AN4478 application note Using multiple VL6180Xs in a single design DoclID026250 1 2 Hardware description The VL6180X plug in is a board for use with most of the Arduino compatible connectors With its companion software package it is particularly well suited for STM32 Nucleo boards To function in a nominal way the VL6180X must be connected to the STM32 Nucleo board as shown in Figure 2 and Figure 3 Figure 2 VL6180X plug in connected to STM32 Nucleo board ot s7 VL6180X EXPLORER SHIELD P y X NUCLEO IKP01A1 SDA 9 i P14 3 eno r gt DH arg pti E F PS 3 DocID026604 Rev 2 3 32 Getting started UM1796 1 3 1 3 1 4 32 Figure 3 VL6180X plug in connected to STM32 Nucleo board D gt eiA A at EER a a pa GA IA eN A A e Seep The interconnection between STM32 Nucleo board and VL6180X plug in is optimal with NUCLEO F401RE The NUCLEO F401RE is connected to the PC via a cable ended by a mini USB connector EVALKIT VL6180X demonstration software installation ST delivers a software suite allowing the user to discover through a standalone demonstration and a PC graphical user interface GUI the VL6180X ranging and ambient light sensing ALS features Demonstration software suite T
28. nge The range value read directly from the VL6180X part on the EVK There is no difference between this value and the Range Value E True Range Smoothed The Raw Range value read from RESULT__ RANGE_RAW 0x0064 on the VL6180X that would show a range measured without any stray light compensation F to I Max Min Mean Standard Deviation Statistical data on the range data in mm gathered since the EVK software was started or the statistics were reset Stopping and starting the capture will create a new file but not reset the statistics J Rtn Signal Rate The actual count rate of signal returns of light measured by the return sensor when the laser is active on the return array This is calculated by the formula RESULT__RANGE_RETURN_SIGNAL_COUNT 0x006C RESULT__RANGE_RETURN_CONV_TIME 0x007C This data is read directly from the VL6180X Note There are two photon triggering arrays The first reference array is the reference array to measure the time photons have left the laser and the second return array is the array used to measure the time that the photons traveled to the target and back to the sensor K Ref Signal Rate The actual count rate of signal returns of light measured by the reference sensor when the laser is active This is calculated by the formula RESULT__RANGE_REFERENCE_SIGNAL_COUNT 0x0070 RESULT__RANGE_REFERENCE_CONV_TIME 0x0080 L Rtn Signal Count This is the amount of sensor counts triggered by the return arr
29. nical Documentation Description Version Size DB237 0 75 KB Description Version Size Bee Related Tools and Software Part Number Description STSW LINKOOS STSW LINKOO7 STSW IM MG002 STSW IMGQ01 3 DocID026604 Rev 2 5 32 Getting started UM1796 1 3 2 STM32 F401RE driver and upgrade firmware installation STSW LINKOO8 Windows USB driver installation e In EVALKIT VL6180X page select STSW LINKO008 Figure 5 NUCLEO F401RE Windows USB driver installation step 1 Technical Documentation Description Version Size DB2370 VL6180X explorer kit ete solution with STM32 F401RE ard and 3 0 475 KB Description Version Size UM1796 VL61 amp 80X explorer expans board with NUCLEO F401RE boa 1 1 2 655 KB Related Tools and Software Part Number Description SW IM S MiG SV A e Then Click on Download Figure 6 NUCLEO F401RE Windows USB driver installation step 2 hy fe augmented Search B Products Applications Support Sample amp Buy About Contact My ST Login Quick View Design Resources Get Software All STSW LINKOO8 sT LINK v2 1 USB driver on Windows Vista 7 and 8 onines anA Design Resources Get Software SW LINK008 1 01 Active 6 32 DoclD026604 Rev 2 ky UM1796 Getting started e _ Following windows From stsw link008 zip by unpacking the zip file and running stlink_winusb_install bat This will install the necessary USB drivers to allow communications bet
30. on from a classical IR sensor with the VL6180X 1 Under certain conditions the VL6180X will detect targets above the specified 100mm With the 2x Scaler default setting the maximum distance measurement can be up to 400 mm with a reported granularity of 2mm For applications requiring a granularity of 1mm scaling factor must be set to 1 and maximum distance measurement will be reported up to 200mm Actual distance ToF graph The Actual distance ToF graph plots in real time range measurements see Figure 22 The vertical axis can be changed using the Range Measurement display Scale If a target is not detected the maximum range is displayed 3 DocID026604 Rev 2 UM1796 VL6180X software GUI description 3 Figure 22 Actual distance ToF graph verson peparen aan la x VL6180X Explorer Ranging ALS Options Help Signal Strength Power Signal Rate Mcps kyy augmented SETTINGS Signal Rate Mcps Lv Return Signal Rate Display Peano he eh te de S R A he de ee tee 200 205 210 215 220 225 230 235 240 245 250 255 260 265 270 275 280 285 290 295 300 Sampl True Range mm Range mm RE WO SO BEONE ESE URE Ve ee OL es Fl fat LE 104 Rtn Signal Rate Mcps Actual Distance Time of Flight E BEE Range Measurement Display a Ranging Live Result ait intl ned it nia id hiai i tint andi Wad 200 205 210 215 220 225
31. op space Figure 17 VL6180X_Explorer icon e The explorer software needs to know which COM Port the Nucleo is connected to the PC on This can be found under Device Manager Mouse right button on Computer icon select property then click on Device manager and expand Ports COM amp LPT section Figure 18 COM ports a 1F Ports COM amp LPT Communications Port COM1 1 ECP Printer Port LPT1 YS STMicroelectronics STLink Virtual COM Port COM9 e Read the COM Port listed against STMicroelectronics STLink Virtual COM Port in the drop down list of COM Ports e Start PC graphic user interface by clicking VL6180X_Explorer icon e Inthe port list select the port com previously listed against STMicroelectronics STLink Virtual COM Port in the drop down list of COM Ports e Press the Connect button to establish communications between the software and the board e Press the Start Stop button to start the device Start then when running stop 3 12 32 DocID026604 Rev 2 UM1796 Getting started Figure 19 Starting the device 7 cr VL6180X Explorer Le ST fe augmented SETTINGS Signal Strength Power Signal Rate Mcps Return Signal Rate Display EA True Range mm W320 Rtn Signal Rate Mcps Wa z i Actual Distance Time of Flight Range Measurement Display Range mm Exe
32. primer Informations P Taille Compress Modifi le Cr le A 676 864 449692 2014 05 14 14 44 2014 05 14 14 44 2 86 016 38713 2014 04 25 11 05 2014 04 25 11 05 2 0 objet s s lectionn s 3 DoclD026604 Rev 2 UM1796 Getting started 1 3 3 Installation of the VL6180X standalone demonstration Note If not already done plug VL6180X plug in on STM32 F401RE Nucleo board 3 To install VL6180X standalone demonstration e In EVALKIT VL6180X page select STSW IMG001 Figure 11 VL6180X standalone demonstration installation step 1 Design Resources Quick Links Product Specifications X Technical Documentation Description Version Size DB237 e e STM32 F4 3 0 475 KB Description Version Size Related Tools and Software Part Number Description e Following windows click on Download then save it Figure 12 VL6180X standalone demonstration installation step 2 STSW IMG001 bb Seve to Myst e RM Prine Quick View Design Resources Get Software All STSW IMGO01 Firmware for VL6180X Explorer shield with STM32 F401RE Nucleo board Online Support Proposa Featured Products VL6 X explorer kit 80X Design Resources Top VL6180X 3 in 1 time of flight Get Software module Part Number Kw maketing Order From ST 3 Featured Videos All STSW IMG001 1 0 Proposal Download G ted with 3 4 VL6180X explorer kit Suggested Resale Price per unit
33. ween the Nucleo board and the PC Figure 7 NUCL EO F401RE Windows USB driver installation step 3 T dpinst_x86 exe E stlink_dbg_winusb inf E stlink_winusb_install bat E stlink winusb_uninstall bat stlinkdbgwinusb_y64 cat stlinkdbgwinusb_86 cat amp stlinkvep_64 cat stlinkvep_ 86 cat E 010 1 stsw link008 1 zip pplicatior K STSW LINK007 NUCLEO F401RE communication driver with the PC In EVALKIT VL6180X page select STSW LINK007 3 Fichier Edition Affichage Favoris Outils Aide v ow gt Ajouter Extraire Tester Copier placer x il Supprimer Informations a Bl Nom stlink_winusb_uninstall bat stlinkvcp 86 cat E stlinkvcp x64 cat A stlinkdbgwinusb x86 cat stlinkdbgwinusb_x64 cat E stlink VCP inf E stlink_dbg_winusb inf amp stlink_winusb_install bat m dpinst_x86 exe 4 Taille Compress 130 5719 5718 5728 5728 940 1181 94 253 507 552328 239022 Modifi le Cr le 2013 12 12 08 16 2013 12 10 14 09 2013 12 10 14 08 2013 12 10 14 08 2013 12 10 14 08 2013 12 10 14 08 2013 12 10 14 08 2013 05 15 15 33 2010 02 08 21 36 2010 02 08 20 59 Acc d le Attributs 1 objet s s lectionn s 234 2013 12 12 08 16 Design Resources Quick Links Product Specificati Technical Documentation Description DB2370 VL Description B UM1796 VL Related Tools and Software
Download Pdf Manuals
Related Search