UM1876 User manual - STMicroelectronics
Contents
1. 130 130 130 109 15 15 62 112 112 112 62 62 114 101 114 16 114 a8 101 MAH data_log_09 Jul 2014 1130 12 01 Ready 25 115 115 115 115 115 115 115 115 115 115 115 130 142 142 142 142 142 142 142 142 142 142 142 142 142 142 142 DocID027648 Rev 3 115 106 96 67 88 75 63 8 82 83 64 85 63 88 22 92 4 96 91 97 92 96 15 93 21 90 67 90 13 92 93 11 91 89 90 2 89 81 30 91 92 43 92 79 0 12 73 18 5 21 88 21 95 19 77 18 31 IFAT 18 19 21 64 25 4 24 47 24 28 2 19 26 74 25 92 26 26 23 91 29 43 20 17 25 97 25 48 25 95 25 44 23 13 24 64 SSSssssssessssssessssssseses 12 14 15 55 24 47 36 42 36 88 24 46 18 6 16 91 13 57 9 13 745 13 65 30 93 38 76 62 08 24 81 10 4 12 43 35 48 23 05 24 16 12 21 9 29 15 88 25 66 16 35 51 57 VL6180X software graphical user interface GUI UM1876 92 57 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 from2. Options Ranging Sensor Signal Strength Power N yi Signal Rate Mcps 8 N S e e yi wi oO Signal Rate Mcps 05 pe 3500 3510 3520 3530 3540 3550 3560 3570 3580 3590 3600 Sample Rtn Signal Rate Mcps 0 04 True Range mm S400 Actual Distance Time of Flight A Range mm meannan E W Q Range mm 8 8 E A e E A E oO Sample nnan 3500 3510 3520 3530 3540 3550 3560 3570 3580 3590 3600 3610 COM Ports COM16 _ ResetComms Baud Rate SETTINGS Max Convergence Time ms 50 Inter Meas Period ms SNR Threshold 0 06 ECE Factor 1 1 Offset Factor mm 14 X Talk Compensation Factor 0 00 Device Top v High Speed 2X Scaling Return Signal Rate Display Scale 0 To 250 Continual Gesture Help _ Range Measurement Display A Scale 0 To 400 y High Threshold Enable Low Threshold 60 Ranging Live Result Raw Range mm gt 400 Max mm 510 Min mm 510 19200 Click on Start Si VL6180X Expansion Kit Ranging ALs Calibration Options Ranging Sensor Signal Strength Power N yi a N lt Signal Rate Mcps ee wi O pn l eres Peres BA S re I Signal Rate Mcps 1840 1850 1860 1870 1880 1890 1900 1910 1920 1930 Sample True Range mm P84 Rtn Signal Rate Mcps 48 80 Actual Distance Time of
3. 40 Inter Meas Period ms ALS Gain Selection 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 ALS Scaler 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 This is the maximum scale value for the vertical axis The default value is ALS Count Upper 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 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 0 DocID027648 Rev 3 47 57 VL6180X software graphical user interface GUI UM1876 6 5 6 5 1 48 57 Table 7 ALS information continued Fett i escripticn O O O OOOO O Auto Gain Count The manual Auto Gain ALS count threshold minimum value in Auto Gain Thresh Min mode Auto Gain Count The manual Auto Gain ALS count threshold maximum value in Auto Gain Thresh Max mode Options tab The Options tab is used to enable 12C logging or data logging during ranging and ALS modes Data Logs options window For every measurement relevant system dat
4. EEES EEEE BEET ELEE 1 1030 Sample 1040 1050 1060 1070 1080 1090 COM Ports COMi6 ResetComms Baud Rate Gi Ranging AUS Calibration Options Ranging Sensor Signal Strength Power M Wn ho oO S Signal Rate Mcps ene H U Oo y o O O Signal Rate Mcps o 1140 1150 1160 1170 True Range mm 8 1180 1190 1200 1210 1220 1230 1240 Sample Rtn Signal Rate Mcps 238 88 Actual Distance Time of Flight Range mm at a 1140 1150 1160 1170 1180 ee EEES ELEK os 1230 1190 1200 1210 1220 1240 Sample COM Ports COM16 Reset Comms Baud Rate DoclD027648 Rev 3 j ky lile augmented SETTINGS Max Convergence Time ms Inter Meas Period ms SNR Threshold ECE Factor Offset Factor mm X Talk Compensation Factor Device Top v High Speed 2X Scaling 7 Return Signal Rate Display A A Scale 0 20 Continual Gesture Help Range Measurement Display To Scale 0 To 10 High Threshold Enable Low Threshold 60 Ranging Live Result Raw Range mm 6 Max mm 8 Min mm 4 lile augmented SETTINGS Max Convergence Time ms Inter Meas Period ms SNR Threshold ECE Factor Offset Factor mm X Talk Compensation Factor 0 00 Device Top v High Speed 2X Scaling Return Signal Rate Display A A ba ai Scale 0 Continual Gesture Hel
5. Flight Target moving between 25 and 8 cm a Bama from the VL6180X Prid fixie iiaia a feted oleae Mell ili Bee ai Baiil Cell hal Utada Mia dl idl fell dell iada Leila itv liste Neida Gilead aly 1830 1840 1850 1860 1870 1880 1890 1900 1910 1920 1930 Sample Start Resume display DocID027648 Rev 3 COM Ports COMi6 ResetComms Baud Rate SETTINGS Max Convergence Time ms Inter Meas Period ms SNR Threshold ECE Factor 1 1 Offset Factor mm 14 X Talk Compensation Factor 0 00 Device Top High Speed _ 2X Scaling Return Signal Rate Display a A To 250 v Gesture Help Scale 0 Continual Range Measurement Display a Scale 0 To 400 y High Threshold Enable Low Threshold 60 Ranging Live Result Raw Range mm 84 Max mm 146 Min mm 66 19200 U Values are now displayed on the PC screen and not on the VL6180X expansion board 31 57 VL6180X software graphical user interface GUI UM1876 6 2 32 57 The VL6180X expansion board has one on board device and up to 3 additional VL6180X satellite boards Each sensor can be controlled individually from the GUI and can be selected using the Device drop down control as follows see Figure 47 e Top Default On Board device e Bottom Bottom satellite device e Left Left satellite device e Right Right satellite device The VL6180X software GUI contains several tabs th
6. detected the maximum range is displayed Figure 49 Actual distance ToF graph Gi VLG VL6180X Expansion Kit Signal Strength Power SETTINGS Max Convergence Time ms Inter Meas Period ms SNR Threshold ECE Factor Offset Factor mm lt Talk Compensation Factor 0 00 ten i es 0 iid b a A h 1860 1870 1880 I TEE stare 1 Bina ef et teee I te 190 1910 1920 Sample Return Signal Rate Display plied eal es z l p 1890 1930 Device Top High Speed 2X Scaling Scale 0 To 250 True Range mm 84 Rtn Signal Rate Mcps 18 80 Continual earn Help Actual Distance Time of Flight Range Measurement Display Scale To 400 0 400 y A Range mm High Threshold Ww oS I Enable Low Threshold 60 Ranging Live Result Range mm Raw Range mm 84 cites LILY i egetes ith Natt a Eee pite baa til ed de diii ii ia lle Max mm 146 850 1880 1890 90 1910 92 Min mm 66 Sample i i 1860 COM Ports COM16 ResetComms Baud Rate 19200 The VL6180X expansion board software 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 48 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 6
7. displayed to illustrate how the VL6180X device can be used to detect two different gestures The combination of distance measurement and signal amplitude both reported by the sensor allows the VL6180X to interpret gestures and differentiate vertical gesture from horizontal swipe Vertical Gesture A vertical hand movement up down then back up will cause the signal amplitude to increase then decrease whereas the range measurement will report the opposite Horizontal Swipe A horizontal Swipe movement will cause the signal amplitude to increase while the hand enters the field of view of the sensor and then reaches the center of the field of view and then decrease as the hand moves away At the same time the range measurement will remain constant while the hand is moving horizontally above the sensor Figure 51 Gesture help Hand Movement Classical IR sensor S74 VL6180X lt gt Real measured Signal Amplitude Distance TF Computed distance Signal Amplitude To Signal Amplitude Real measured Distance Tor Computed distance S N Signal Amplitude DocID027648 Rev 3 39 57 VL6180X software graphical user interface GUI UM1876 6 2 5 Dmax DMAX reports the maximum ranging distance mm estimated by the VL6180X for a target of 17 reflectance taking into consideration the maximum convergence time and cross talk compensation settings and the ambient light level DMAX can be selected or di
8. exe stlink_dbg_winusb inf i stlink_ CP inf stlinkdbgwinusb_x86 cat E stlinkycp_x64 cat stlinkvep_x86 cat Favoris Outils Aide Date modified 30 07 2015 15 15 30 07 2015 15 15 08 02 2010 21 36 08 02 2010 20 59 21 01 2014 10 03 10 12 2013 14 08 21 01 2014 10 14 21 01 2014 10 14 10 12 2013 14 08 10 12 2013 14 09 Type File folder File folder Application Application Setup Information Setup Information Security Catalog Security Catalog Security Catalog Security Catalog da Ajouter Extraire gt D placer VW 15 gt Tester Copier x il Supprimer Informations stlinkdbgwinusb_x64 cat stlinkdbgwinusb_x86 cat stlink_dbg_winusb inf ef stlinkycp_x86 cat Ef stlinkycp_x64 cat amp stlink_ CP inf stlink_winusb_install bat dpinst_amd64 exe m dpinst_x86 exe Modifi le 2 313 168 2 724 304 10 706 10 706 3713 8 956 8 956 2 167 114 680 440 552 328 2 202 762 2 607 265 6120 6119 1277 5710 5711 932 102 242 269 231 230 2014 01 21 11 16 2014 01 21 11 16 2014 01 21 11 14 2014 01 21 11 14 2014 01 21 11 03 2013 12 10 15 09 2013 12 10 15 08 2013 12 10 15 08 2013 05 15 16 33 2010 02 08 22 36 2010 02 08 21 59 2014 01 21 11 16 2014 01 21 11 16 2014 01 21 11 16 2014 01 21 11 16 2014 01 21 11 16 2014 05 23 13 15 2014 05 23 13 15 2014 05 23 13 15 2014 01 21 11 16 2014 01 21 11 16 2014 01 21 11 16 Acc d le 2014 01 21
9. functions it is recommended to use vl6180x_i2c c and vl6180x_i2c h files in platform cci_i2c directory see Figure 65 Note Detailed information on these functions can be found in section Modules CCI to RAW I2C translation layer of the APl_Documentation_ version _proximity chm delivery Figure 65 Iheader and CCI service files in the API vi6180x_api h vl6180x_def h me src vl6180x_api c CJ platform cci i2c vl6180x_i2c c vi6180x_i2c h Nucleo STM32F401 rae template vl6180x_platform h vi6180x_types h hy DoclD027648 Rev 3 55 57 Revision history UM1876 8 Revision history Table 9 Document revision history ene f e thane 09 Jun 2015 Initial release release 03 Aug 2015 Replace STSW LINK008 by STSW LINKOO9 Add Chapter 7 Application programming interface API Add support of STM32L476 05 Nov 2015 3 eean Add Section 5 4 GestureDetect1 demonstration Kyy 56 57 DoclD027648 Rev 3 UM1876 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
10. 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 2015 STMicroelectronics All rights reserved 0 DoclD027648 Rev 3 57 57
11. specific devices e Unzip the file e The standalone demonstration software are located in the directory Nucleo Projects Multi Examples VL6180X see Figure 9 0 DoclD027648 Rev 3 9 57 VL6180X standalone demonstrations UM1876 Figure 9 Demonstration binary files location STM32CubeExpansion _VL6180X_Vx y z baad Projects d CJ Multi dA baal Applications 4 m VL6180X an GestureDetect1 G Binary o GestureDetect1_NucleoF401 bin A bisa Examples 4 vL6180X 4 _ RangingAndALs A Binary RangingAndALS _NucleoF401 bin RangingAndALS _NucleoL053 bin RangingAndALS NucleoL476 bin A PE RangingWithSatellites a Binary RangingWithSatellites NucleoF401 bin RangingWithSatellites_NucleoL053 bin RangingWithSatellites_NucleoL476 bin e Each example code RangingAndALS and RangingWithSatellites can be compiled using one of the provided projects MDK ARM EWARM SW4STM82 for each Nucleo board type L476 F401 and L053 e Pre compiled binaries are also provided in the Bin directories of each example For the LO53R8 RangingAndALS_NucleoL053 bin and RangingWithSatellites NucleoL053 bin For the F401RE RangingAndALS_ NucleoF401 bin and RangingWithSatellites_NucleoF401 bin For the L476RG RangingAndALS_NucleoL476 bin and RangingWithSatellites_ NucleoL476 bin e RangingAndALS_ NucleoXXxXxX bin shows the behavior of a single VL6180X in
12. 0X SATEL Two VL6180X satellite boards November 2015 DocID027648 Rev 3 1 57 www st com Contents UM1876 Contents 1 INTTOGUCUON s rrrrre cee ewe AnP enera enna spe cee esses eee we 4 1 1 Document references n anana cc ee eee ees 4 1 2 Hardware description 1 0 cc eee eee 4 2 What is STM32Cube 22 466 000954 0seeh tae enedheeen eee see en aes 5 3 How does this software complement STM32Cube 5 4 VL6180X Nucleo pack software installation nananannaaa 6 4 1 STM32 Nucleo board software suite installation nananana aaaea 6 4 1 1 STSW LINK009 STM32 Nucleo board Windows USB driver installation 6 4 1 2 STSW LINK007 STM32 Nucleo board PC communication driver 8 5 VL6180X standalone demonstrations 0000 e eee 9 5 1 Installation of the VL6180X standalone operation 0 9 5 2 RangingAndALS demonstration 0 0 00 cee ee eee 13 5 2 1 Ranging mode ce eee tees 13 5 2 2 AE SMOG serr Enee e r e r S 19 5 3 RangingWithSatellites demonstration 0 000 cee eee 20 5 4 GestureDetect1 demonstration 0 0000 22 5 4 1 Ranging mode and single swipe single tap TAP_SWIPE_2 mode 25 5 4 2 Single directional swipe DIRSWIPE_1 mode 26 6 VL6180X software graphical user interface GUI 29 6 1 Installation of the VL6180X PC software graphical user interface GUI 29 6 2 Ran AO cae G42h meee edi
13. 11 16 2014 01 21 11 16 2014 01 21 11 16 2014 01 21 11 16 2014 01 21 11 16 2014 05 23 13 15 2014 05 23 13 15 2014 05 23 13 15 2014 01 21 11 16 2014 01 21 11 19 2014 01 21 11 19 Plug a USB cable between the PC and STM32 Nucleo board Allow the board driver installations to complete before proceeding DoclID027648 Rev 3 7 57 VL6180X Nucleo pack software installation UM1876 4 1 2 8 57 STSW LINK007 STM32 Nucleo board PC communication driver To install STSW LINKOO7 repeat the steps 1 to 3 performed for the installation of the STSW LINKOO9 STM32 Nucleo board Windows USB driver installation Unpack the downloaded stsw link007 zip file and run STLinkUpgrade exe Ensure the Nucleo board is connected via the USB port Click device connect on the dialogue and confirm the board has successfully connected When prompted to upgrade to the latest version check that the suggested version is later than the current firmware version then click YES to proceed Figure 6 STM32 Nucleo board communication driver with PC installation step 4 m ST Link Upgrade stsw linkOO7 zip Fichier Edition Affichage Favoris Outils Aide LW o gt Ajouter Extraire Tester Copier D r Supprimer Informations 2 6 Nom Taille Compress Modifi le Cr le A m ST LinkUpgrade exe 676 864 449 692 2014 05 14 14 44 2014 05 14 14 44 2 86 016 38 713 2014 04 25 11 05 2014 04 25 11 05 2 0 obje
14. 2 3 To the right of and above the Actual Distance ToF graph the information described in Table 5 is displayed 3 36 57 DoclD027648 Rev 3 UM1876 VL6180X software graphical user interface GUI Table 5 Actual distance ToF information ee a Manual adjustment of the Range vertical axis permissable range For 2 x scaling the scale can be adjusted from 0 390 at the lower limit to 10 400 at the upper limit For 1 x scaling the scale can be adjusted from 0 190 at the lower limit and 10 200 at the upper limit Enable Check the Enable box to allow thresholding to be enabled Manual adjustment of the lower threshold limit default is 60mm Low Threshold When enabled this threshold line is shown in the Actual Distance ToF graph See Section 6 2 3 Actual distance ToF graph showing thresholds Manual adjustment of the upper threshold limit default is 70mm High Threshold When enabled this threshold line is shown in the Actual Distance ToF graph See Section 6 2 3 Actual distance ToF graph showing thresholds Raw Range mm This is the range measurement including the Offset Factor These are post processed measurement statistics to make noise Max amp Min mm evaluation easier to characterize The max and min are the range data measured by the sensor over 100 measured sample points If enabled DMax is calculated by the software This is the maximum DMax mm measurement distance for a target of 17 reflectanc
15. 476RG STM32 Nucleo board Figure 12 VL6180X standalone RangingAndALs installation step 4 N gt aa NUCLEO E Drag and drop RangingAndALS NucleoXXXX bin 5 2 1 Ranging mode In this ranging mode the left digit displays r see Figure 13 during the ranging measurement Figure 13 Left display digit in ranging mode Kyy DoclD027648 Rev 3 13 57 VL6180X standalone demonstrations UM1876 14 57 When the USB cable is plugged in the message SF 1 is displayed for a few seconds see Figure 14 This message indicates that VL6180X scaler factor is set to 1 Consequently range measurements between the VL6180X and the target are confined to the limits 0 and 20cm with a granularity of 1mm Figure 14 SF 1 message There are two different types of modes available under RangingAndALsS e A short press on the STM32 Nucleo board blue button will activate the Scale Factor mode e Along press on the STM32 Nucleo board blue button will activate the Alarm threshold mode After the first short press on the blue button of the STM32 Nucleo board B1 gt the message SF 2 is displayed for a few seconds see Figure 15 This message indicates that VL6180X scaler factor is set to 2 Consequently range measurements between the VL6180X and the target are confined to the limits 0 and 40cm with a granularity of 2mm Figure 15 SF 2 message the message SF 3 is displayed for a few seconds see Fig
16. 50 Actual distance graphs showing high and low thresholds Below low threshold with green background display Scale z 20 y True Range mm 738 Rin Signal Rate Mcps 60 63 Continua Gesture Help Actual Distance Time of Flight ee en A Scale 0 To 400 y 3 A 1 A Range mm High Threshold i Upper Thresh Lower Thresh Enable Low Threshold 70 Ranging Live Result Range mm Raw Range mm 38 a shel itor Doan level Irma bated ae 6 6040 Min mm 32 eo leche aeiaai aAa Teta ene Shoe Danaa keal berets Geena fear Me Max mm 44 5950 5960 5970 5990 6000 6010 Sample Cane eae 5980 COM Ports COMi6 ResetComms Baud Rate ovale u 10 Vy Continual Gesture Help Range Measurement Display Scale a Range mm High Threshold _ Upper Thresh Lower Thresh Enable Low Threshold Ranging Live Result Raw Range mm gt 400 Max mm 264 Min mm 232 COM Ports COMi6 ResetComms Baud Rate 19200 Color management e Increasing range measurements crossing high threshold will cause a transition to the red state e Decreasing range measurements crossing low threshold will cause a transition to the green state DoclD027648 Rev 3 Kyy UM1876 6 2 4 0 VL6180X software graphical user interface GUI Gesture help When Gesture Help is selected a pop up dialogue is
17. 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 Sampling Rate Hz The number of ALS samples measured per second PC dependent ALS Gain Displays the actual gain value applied This is set by the 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 l Res is 0 56 default The integration period is the time range during a single ALS measurement over which Lux data is captured and averaged The default integration period is 100 ms Integration Period ms The inter measurement period is the time between each ALS measurement in continuous ALS mode The default inter measurement period is 100 ms Changes ALS mode from single shot to continuous mode 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 ALS Gain 1 25 ALS Gain 1 67 ALS Gain 2 5 ALS Gain 5 ALS Gain 10 ALS Gain 20 ALS Gain
18. Lo use case A subsequent long press on the blue button of the STM32 Nucleo board will exit the alarm mode the message rb is displayed for the duration of the press and following release the mode will exit Alarm and return to Ranging SF 1 5 2 2 ALS mode The switch SW1 must be in ALS mode DE If the ambient light value is below 1000 Lux the left digit of the display is as described in Figure 26 and the three other digits give the Lux value Figure 26 Left digit of the display if ambient light value below 1000 Lux If the ambient light value is above 1000 Lux the left digit of the display is as described in Figure 27 and the three other digits give the Lux value minus 1000 Lux In this example the lux value is 1348 lux hy DoclD027648 Rev 3 19 57 VL6180X standalone demonstrations UM1876 Figure 27 Left digit of the display if ambient light value above 1000 Lux The VL6180X sensor is able to measure up to 10kLux however this demonstration kit is limited to 1 8kLux 5 3 RangingWithSatellites demonstration e Drag and drop the RangingWith Satellites __NucleoXXXX bin file which one you select will depend if you use a LO53R8 or a F401RE or a L476RG STM32 Nucleo board Figure 28 VL6180X RangingWithSatellites demonstration installation step 4 eas NUCLEO E Drag and drop RangingWithSatellites NucleoXXXX bin Figure 29 STM32 Nucleo VL6180X expansion and VL6180X satellites
19. RESULT RANGE_VAL 0x0062 in the VL6180X part on the EVK This value includes the crosstalk compensation D True Range 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 cross talk compensation F to l 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 return signal 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 array is the reference array to measure the time photons have left the laser and the second array is the return 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 return signal 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
20. Sample Return Signal Rate Display A A Scale 0 To 250 Continual Gesture Help Range Measurement Display A Scale 0 To 400 y High Threshold Enable Low Threshold Ranging Live Result Raw Range mm 84 eegeces EE E je sy i eeges al i pegeace Max mm 146 J 1920 193 Min mm 66 1880 Sample wre ied hii meee oye 1860 1890 1900 1910 COM Ports COMi6 ResetComms Baud Rate By default it is the VL6180X on the main board called Top which is selected If satellites are connected it is possible to select one of them for this e Click on Stop to stop the current measurement Device e Select one of the VL6180X devices Scale e Click on Start to re start the measurement The buttons listed in Table 3 are available at the bottom of the Ranging tab Table 3 Buttons in the ranging tab SS Start Pause 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 The Reset button resets the 12C communications interface between the application and the VL6180X The COM Ports box display a list of available connection ports to connect PONPON the VL6180X to the PC 0 DocID027648 Rev 3 33 57 VL6180X software graphical user interface GUI 6 2 1 34 57 True Range mm 84 400 Ww Oo ih UM1876 Table 3 Buttons in the
21. The settings and display information described in Table 4 are indicated on the right of the Signal strength power graph 3 DocID027648 Rev 3 UM1876 VL6180X software graphical user interface GUI Table 4 Signal strength power information ee ae This is the maximum time allowed for a range measurement to be made Max Convergence No range output is given if the system has not converged within the time ms specified time that is no target or target out of range Maximum convergence time default for 1 x scaling 30ms and 50ms for 2 x scaling Inter measurement period is the time delay between measurements in continuous range mode Range 10ms to 2 55 seconds default 500ms Only available if the Continual ranging check box is ticked The minimum SNR threshold below which a range measurement is ore i rejected The default value is 0 06 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 ECE factor 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 us
22. UI step 2 Design Resources Quick Links Product Specifications Technical Documentation Description Version Size DB2562 F NUGCLEO 6180X1 and P NUCLEO 6180X2 packs PC graphical user interface 2 0 B4 RK Sample amp Buy ST SWVAMGO04 r2359 Suggested Resale Price per unit USD for BUDGETARY USE ONLY For quotes prices in local cumency please contact your local ST Sales Office or our Distibutors The Maternal Declaration forms available on st com may be generit documents based on the most commonly used package within a package family For this reason they may not be 100 accurate for a specific device Please contact our sales suppor for information on specific devices e Then Save and Run VL6180X_ExplorerSetup exe icon VL6180X_Explorer is installed on the user desktop space DoclD027648 Rev 3 29 57 VL6180X software graphical user interface GUI UM1876 30 57 Figure 45 VL6180X_Explorer icon VL61S0 Ex Connect ST Nucleo pack to an USB PC port Start PC graphic user interface by clicking VL6180X_Explorer icon The Ranging tab is automatically selected Click on the Start Pause Resume button to start the device Start then when running stop see Figure 46 3 DocID027648 Rev 3 UM1876 VL6180X software graphical user interface GUI Figure 46 Starting the device A VL6180X Expansion Kit VL6180X Expansion Kit Ranging ALs Calibration
23. _CONV_TIME 0x0080 L Rtn Signal Count This is the amount of sensor counts triggered by the return array on the VL6180X when the laser is active This data is read directly from the VL6180X 3 DocID027648 Rev 3 UM1876 VL6180X software graphical user interface GUI 6 7 I7C log file Each IC log is stored in a uniquely named txt file The I C log filename configuration is i2c_output_DD_MMM_YYYY_HHMM_SS sss ixt Where e DD _MMM_YYYY is the date the log file was created for example 07_May_2013 e HHMM is the time the log file was created for example 1553 e SS_sss is the time seconds milliseconds the log file was created for example 17_ 367 An example of a IC log is shown in Figure 64 Figure 64 IC log file example File Edit Search View Encoding Language Settings Macro Run TextFA Plugins Window a4 3 io eee Bel S 16a E i2c_output_09_Jul_2014_1133_19_853 t Ed a ead 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 0x0056 Val Write reg 0x0097 Val Write reg 0x00E3 Val Write reg Ox00E4 Val Write reg Ox00E5 Val Write reg Ox00E6 Val Write reg Ox00E7 Val Write reg Ox00F5 Val Write reg 0x00D9 Val Write reg 0x00DB Val Write reg 0x00DC Val Write reg 0x00DD Val Write reg Ox009F Val Write reg 0x00A3 Val Write reg 0Ox00B7 Val Write reg Ox00BB Val Write reg 0x00B2 Val Write reg O0x00CA Val Wri
24. a 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 60 Data logging should be selected either prior to starting measurements or during the paused state Figure 60 Enable data logging iy VL6180X Expansion Kit VL6180X Expansion Kit Calibration Options Data Log Options Enable 12C logging Enable Data Log E C Users username AppData Local STMicroElectronics VL6180XEVK Data log files are created with unique filenames and stored in C Users username AppData Local STMicroElectronics VL6180XEVK DataLog See Figure 60 and 6 6 Data log file for an example 3 DocID027648 Rev 3 UM1876 6 5 2 6 5 3 VL6180X software graphical user interface GUI 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 6 2 Ranging tab Recording I7C transactions The Enable 12C Logging option is used to record IC transactions during ranging or ALS mode The I C transactions are stored in a unique file txt identified by date and time To enable I C logging in the Options tab check the Enable 12C Logging box see Figure 61 C log files are stored in C Users username AppData Local ST MicroElectronics VL6180XEVK I2C See 6 7 C log file for an example Before you can switch off I C
25. at can be used to display calibrate and configure various features of the VL6180X The available tabs are e Ranging see Section 6 2 e Calibration see Section 6 3 e ALS see Section 6 4 e Options see Section 6 5 Ranging tab When the VL6180X expansion software is launched the Ranging tab is displayed the ranging sensor interface as shown in Figure 47 In ranging mode the VL6180X expansion board software 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 6 2 1 e Actual Distance Time of Flight TOF see Section 6 2 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 3 DocID027648 Rev 3 UM1876 VL6180X software graphical user interface GUI Figure 47 Ranging tab Gi VL6180X Expansion Kit Ranging ALS Calibration Options Signal Strength Power SETTINGS 250 Max Convergence Time ms Inter Meas Period ms 200 4 Signal Rate Mcps eth an 1g SNR Threshold 150 4 ev CE Factor 100 4 Offset Factor mm X Talk Compensation Factor 0 00 sen i II tae Aai bidi hh ii a ia aiaa hi tere af top _ 7 880 1890 1900 1910 92 4031 device rop fin Speed 2X Scaling
26. boards m a a ae a PA a nam GEEA 20 57 DoclD027648 Rev 3 3 UM1876 VL6180X standalone demonstrations The multiple VL6180X standalone demonstration is only for ranging When the USB cable is connected the display shows below letters see Figure 30 Figure 30 Letters displayed versus VL6180X satellite boards VL6180X main board indicator VL6180X right satellite indicator VL6180X left satellite indicator VL6180X bottom satellite indicator Each digit letter indicates one of the four potential VL6180X devices in operation e t VL6180X on the main board e L VL6180X on the left satellite board e bob VL6180X on the bottom satellite board e r VL6180X on the right satellite board m i After a short press on the blue button of the STM32 Nucleo board gi horizontal bar segments are displayed on the LCD digits to indicate various ranging distances Each digit corresponds to one of up to four VL6180X devices attached as illustrated in Figure 31 e _ If the target is within short range of a VL6180X device a single bar segment is displayed on its digit e When the target is in medium or long range of the VL6180x device two and three bars are displayed respectively on the corresponding digit Once the target exceeds a pre defined maximum limit the corresponding digit for the VL6180X device has an empty display Kyy DoclD027648 Rev 3 21 57 VL6180X standalone demonstrat
27. cludes e STM382CubeMx a graphical software configuration tool that allows the generation of C initialization code using graphical wizards e A comprehensive embedded software platform delivered per series such as the STM32CubeF4 for STM32F4 series e STM382Cube HAL an STM32 abstraction layer embedded software ensuring maximized portability across the STM32 portfolio A consistent set of middleware components such as RTOS USB TCP IP graphics All embedded software utilities including a full set of examples How does this software complement STM32Cube The proposed software is based on the STM32CubeHAL the hardware abstraction layer for the STM32 microcontroller The package extends STM32Cube by providing a Board Support Package BSP for the X NUCLEO 6180X expansion board and a VL6180X API component in Drivers BSP Components vl6180x directory to program control and get ranging ALS values from the VL6180X device Several example projects are included in the Projects Multi Examples VL6180X directory the developer can use these examples to start experimenting with the code These examples are ready to be compiled using Keil MDK ARM IAR EWARM or STM32 Workbench SW4STM32 e RangingAndALS example features Ranging or ALS modes Selectable scaling in ranging mode Interrupt mode in ranging mode Ranging and ALS measures displayed on 7 segment display e RangingWithSatellites example features Simultaneou
28. e does not equal to 8mm then the offset factor value must be modified e Inthe following example before manual offset calibration the offset factor reports a 14 mm offset factory calibration value see Figure 53 while the actual distance of the target is measured at 6mm The offset factor must be adjusted from 14 to 16mm increasing the raw range of 2mm to reach the value of 8mm after offset calibration see Figure 54 Each time you modify the offset factor you have to do a stop start button sequence Each time the P NUCLEO 6180X i 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 P NUCLEO 6180X i DocID027648 Rev 3 41 57 VL6180X software graphical user interface GUI 42 57 Gi UM1876 Figure 53 Before offset calibration procedure VL6180X Expansion Kit Ranging ts Calibration Options Signal Strength Power Signal Rate Mcps s A gt o Signal Rate Mcps 990 1000 1010 True Range mm P 1030 1020 1040 1050 1060 1070 1080 Sample Rtn Signal Rate Mcps 1240 52 Actual Distance Time of Flight H N A Range mm Range mm S oO a ey Ae ee foe ea ea o 990 1000 1010 1020 poergeree EEES EEEE setapeans EEEE EEEE secapeanes EEEF EEEE
29. e displayed see Figure 19 to indicate that the button must be released to proceed to the various alarm threshold modes provided Figure 19 rb message When the blue button of the STM32 Nucleo board is released the message A Lo Alarm Low is displayed during few seconds see Figure 20 to indicate the transition to the low range threshold mode This mode alerts the user to range measurements crossing below a pre defined lower range threshold it is set for this demonstration mode at 10cm In a real application use case the value of this threshold can be programmed through the VL6180X registers e Range measurements of targets above the threshold will result in the message L see Figure 21 e Range measurements of targets below the threshold will result in the message L to indicate the alarm state see Figure 21 Figure 20 A Lo message 3 DocID027648 Rev 3 UM1876 VL6180X standalone demonstrations Figure 21 L and L message Target below 10 cm from the VL6180X With the device in the Alarm Low mode a subsequent short press BI on the blue button of the STM32 Nucleo board will transition to the Alarm High mode resulting in the message A hi being displayed for a short duration see Figure 22 This mode alerts the user to range measurements transgressing above a pre defined upper range threshold set for this demonstration mode at 25cm In a real applicatio
30. e eee ee hee ee ee hee ee 32 6 2 1 Signal strength power graph 0 0 ce ee 34 6 2 2 Actual distance TOF graph 1 anaana aa ees 36 6 2 3 Actual distance ToF graph showing thresholds 38 6 2 4 Gesture help 2os0dece8ewese sedis ghee ene See teense eeiua ke Sue 39 6 2 5 DOR eeaeee erage ae math a ee wa Sein gece a ecg os a ae on acho oes en E S 40 6 2 6 High speed 0 eee ee eee nee 40 63 Calbration taD aces eid aa apaia beet aiai ea a da aa e a a aa d i i 40 6 3 1 Offset calibration procedure with P NUCLEO 6180X i 40 2 57 DocID027648 Rev 3 Kyy UM1876 Contents 6 3 2 VL6180X offset and cross talk calibration in a final product 43 6 4 Ambient light sensor ALS tab 2 0 0 0 0 eee 46 ceo Mee 0 1 6 oa a ee ee a ea ens re 48 6 5 1 Data Logs options WINdOW 00 ccc eee 48 6 5 2 MElIOWINOOW oxccdcelantaeens osennieeeeeeae Boek eee ee eee oo 49 6 5 3 About window 2464 oudeceeoss Sau ree ese b user eect eseeseteea 49 6 6 Data l g WG ture be sen twee ir Hee eee ee eee Eee ee oh ees Eee 51 BP i E E E oeeedeeeeeeds 53 Application programming interface API nnnanananannannnan 54 Revision history asanannannnnnnnnnnnnnnnnnnnnnnnnnnnne 56 DocID027648 Rev 3 3 57 Introduction UM1876 1 Introduction Note In this document P NUCLEO 6180X i stand for P NUCLEO 6180X1 and P NUCLEO 6180X2 1 1 Document references Table 2 Document references
31. e under current configuration see Section 6 2 5 Range Measurement Display 0 DoclD027648 Rev 3 37 57 VL6180X software graphical user interface GUI UM1876 6 2 3 Note 38 57 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 50 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 lf 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 Note The upper and lower lines combine to effectively provide a binary threshold feature i e reporting when range measurements are above and below the lines The two lines are equivalent to the hysteresis required to account for noise in the range measurements A single threshold value would produce excessive flickering when the target was around the threshold value Figure
32. ee ee Datasheet VL6180X proximity and ambient light sensing ALS module DoclD026171 Data brief Proximity gesture ambient light sensor expansion board based on VL6180X for STM32F401RE DoclD027616 Data brief Proximity gesture ambient light sensor expansion board based on VL6180X for STM32L053R8 DoclD027625 Data brief Proximity and ambient light sensor expansion board based on DoclD027252 VL6180X for STM32 Nucleo Data brief PPNUCLEO 6180X1 and P NUCLEO 6180X2 packs PC graphical user interface GUI DocID027684 Data brief Proximity gesture ambient light sensor software expansion for STM32Cube DoclD027687 Data brief VL6180X application programing interface API DoclD027370 Data brief VL6180X satellite boards compatible with VL6180X boards DocID027253 1 2 Hardware description The X NUCLEO 6180XA1 expansion board e Is compatible with Arduino UNO R3 connectors e Must be plugged into an STM32 Nucleo board e Can be superposed with all ST expansion boards which allows for example to develop VL6180X applications with Bluetooth or Wifi interface The STM32 Nucleo board is connected to the PC via a mini USB connector 3 4 57 DoclD027648 Rev 3 UM1876 2 What is STM32Cube What is STM32Cube STMCube represents an original initiative by STMicroelectronics to ease developers life by reducing development effort time and cost STM32Cube covers the STM22 portfolio Version 1 x of STM32Cube in
33. er to introduce a range adjustment This parameter gets applied as part of the range measurement algorithm It must be determined for each different air gap glass using the calibration procedure Parameter not set by default 2X Scalin Default setting maximum range measurement up to 400mm if box ticked g Maximum range can be approximatively 200 or 400mm 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 Hel Provides some examples of gesture hand movements and signal P comparison from a classical IR sensor with the VL6180X 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 Inter Meas period ms X Talk compensation factor Return Signal Rate Display 0 DocID027648 Rev 3 35 57 VL6180X software graphical user interface GUI UM1876 6 2 2 Actual distance ToF graph The Actual distance ToF graph plots in real time range measurements see Figure 49 The vertical axis can be changed using the Range Measurement display Scale If a target is not
34. f switched to Range the distance detected between VL6180X and the nearest object is displayed in mm If switched to ALS the ambient light level is displayed in Lux Figure 11 Value displayed versus SW1 switch setting VL6180x pansio Board 7 aii DISPLAY e Move your hand or any object in front of VL6180X and read the value displayed on the 4 digit display The VL6180X Nucleo pack provides various demonstration modes for ranging and ambient light sensing e Scale Factor Modes 1 2 and 3 to demonstrate the extended ranging performance of the device with the scale factors applied manually in isolation or automatically e Alarm threshold modes to demonstrate alarm conditions with the VL6180X sending an interrupt to the application host as range measurements cross pre defined range threshold limits The benefit of this interrupt mode is that the host can stay in stand by mode reducing power consumption of the system and the VL6180X will automatically send an interrupt to the host when the thresholds are reached e ALS mode demonstrating the Ambient Light Sensor performance e Multiple VL6180X device operation These are described in more detail in the following sub sections 3 DocID027648 Rev 3 UM1876 VL6180X standalone demonstrations 5 2 RangingAndALS demonstration e Drag and drop the RangingAndALS_NucleoXXXxX bin file which one will depend on whether you use a LO53R8 or a F401RE or a L
35. 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 see Figure 56 select the Calibration tab and follow the instructions DoclD027648 Rev 3 43 57 VL6180X software graphical user interface GUI UM1876 Figure 56 Range offset calibration VL6180X Expansion Kit 7 rl Ranging ALS Calibration Options Calibration Current Status ac Offset Calibrated Programmed offset applied X Talk Compensation Uncalibrated If using glass Auto calibration required Next Action Perform X Talk Calibration or override programmed offset Offset The Factory Programmed offset is currently applied To manually override this select Offset Override on the Offset Controls panel The user will then be able to perform auto calibration or else provide direct manual input X Talk Compensation e If there is glass in front of the sensor X Talk Compensation calibration is required for optimum ranging performance X Talk Compensation Factor Calibration can be achieved by executing one of the following options 1 Manually provide the desired using the control X Talk Compensation Factor 2 Perform Auto Calibration by clicking Cal X Talk e Otherwise calibration can be omitted by clicking Finish Offset Controls Part ID 06 29 2014 8 29 46 0x01 0x58 Ra
36. ions UM1876 Figure 31 Bar graph displayed versus the distance between the target and the 4 VL6180X devices Target dose to ihe d VLE TEOX 5 010 om Target progressively raved back Sin UGS re a from the 4 VLEA1B0x 70 io 20 cm Distance between target and VL6140x Hain board VLEI80x gt 20cm Lett and bottom VLE1G0S satellites 10 19 20 om Right VLG1G08 satelite 5 o 10 cm This demonstration can be used as a starting point for developing basic gesture recognition algorithms using several VL6180X devices 5 4 GestureDetect1 demonstration e Drag and drop the GestureDetect1_NucleoF401 bin file for this you have to use a F401RE STM32 Nucleo board Figure 32 VL6180X GestureDetect1 demonstration installation step 4 N gt aga NUCLEO E Drag and drop GestureDetect1_NucleoF401 bin kys 22 57 DoclD027648 Rev 3 UM1876 VL6180X standalone demonstrations Figure 33 STM32 Nucleo VL6180X expansion and two VL6180X satellites boards GestureDetect1 configuration VLE160X Expansion Board WUCLEO 61 BOA 1 When the USB cable is connected the display shows below letters see Figure 30 Figure 34 Letters displayed versus VL6180X satellite boards VL6180X main board detected VL6180X right satellite detected VL6180X left satellite detected Each digit letter indicates if the VL6180X is present or not e t VL6180X on the main board e L VL6180X on the left sa
37. ively displayed to mimic book page turning Figure 41 Hand movement circles to right DoclID027648 Rev 3 27 57 VL6180X standalone demonstrations UM1876 Figure 42 Hand movement circles to left A 2 second press on the blue button of the STM32 Nucleo board the VL6180X goes back into ranging mode 3 28 57 DoclD027648 Rev 3 UM1876 6 6 1 Caution 0 VL6180X software graphical user interface GUI VL6180X software graphical user interface GUI Installation of the VL6180X PC software graphical 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 expansion board display is Off and values are only visible on the PC screen To install the PC graphical user interface e In P NUCLEO 6180X1 or in P NUCLEO 6180X2 web page select STSW IMGO04 Figure 43 Installation of the VL6180X PC software GUI step 1 Related Tools and Software Part Number Description STSW LINKOO ST UNKN2 1 firmware upgrade STSW LINKOO9 ST Link ST Link V2 ST Link V2 1 USB driver signed for XP Windows Windows CUBE 6160 A1 Windows Graphical User Interface GUI for VL6180X Evaluation Kits Works with P STSW IMGO04 NUCLEO 6180X1 P NUCLEO 6180X2 and EVALKIT VL6130X e Click on Download Figure 44 Installation of the VL6180X PC software G
38. lectronics 2014 50 57 DoclD027648 Rev 3 Kyy UM1876 6 6 0 Data log file VL6180X software graphical user interface GUI 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_Apr_ 2014 e HHMM is the time hours minutes the log file was created for example 1025 e SS_sss is the time seconds milliseconds the log file was created for example 17_367 An example of a ranging data log is shown in Figure 63 KIH I Ms File Home Insert Page Layout A Calibri il A ABUA Clipboard i Font F T Figure 63 Data log file example data_log_09_Jul 2014 1130 12 Ol5 csv Read Only Microsoft Excel Formulas Data wE g Alignment i fe TimeStamp Review View General TE 9 00 00 0 La Conditional Formatting Fe Format as Table E Cell Styles 7 a a g Insert amp j Developer Add Ins Classification JMP Acrobat a o E bs N g Delete 7 a Z sot Find amp B Format 2 Filter Select Range Exe Range Va True Rang True Rang Raw Rang Max Rang Min Rang Mean Rar Range Str Filter Size Rtn Signa R 143 136 139 133 142 134 134 134 134 134 133 134 141 134 152 135 152 135 152 140 13 138 146 134 158 134 115 101 76 98 115 115 115 g7 g7 78 78 78 91 g7 109
39. logging the device must first stop ranging or ALS measurements To do this click on the Stop button in the Ranging tab see Section 6 2 Figure 61 Enable I2C logging iy VL6180X Expansion Kit VL6180X Expansion Kit Ranging AIS Calibration Option Data Log Options Enable 12C logging Enable Data Log E C Users username AppData Local STMicroElectronics VL6180XEVK Help window The Help provides links to documents and on line resources which provide details on the setup and functionalities of the VL6180X expansion board software and also details on the software version e HELP To access help index e www st com VL6180X To access ST VL6180X product and support page About window About GUI Version Provides the GUI version installed DoclD027648 Rev 3 49 57 VL6180X software graphical user interface GUI UM1876 Figure 62 Help and about windows life augmented Ranging ALS Calibratioh Options Help Options Data Log Options HELP E www ST com VL6180X Enable 12C logging E Enable Data Log Nucleo Device Path E NODEF401RE Flash C Users dabine AppData Local S TMicroElectronics VL6180XEVK VL6180X Expansion Kit Version 1 0 0 2261 Product details This application interfaces with the VL6180X proximity sensor EVK to perform range signal and ALS measurements displaying live results in graphical form All Rights Reserved Copyright STMicroe
40. n use case the value of this threshold can be programmed through VL6180X registers e Range measurements of targets above the threshold will result in the message H see Figure 23 e Range measurements of targets above the threshold will result in the message H to indicate the alarm state see Figure 23 Figure 22 A hi message 0 DocID027648 Rev 3 17 57 VL6180X standalone demonstrations UM1876 18 57 Figure 23 H and H message Target above 25 cm from the VL6180X With the device in the Alarm High mode a subsequent short press BT on the blue button will transition to the Dual Alarm mode resulting in the message A O0 being displayed for a short duration see Figure 24 Subsequently moving targets may trigger up to two lower and upper range measurement thresholds If the target is below the pre defined lower threshold 10cm or above the pre defined upper threshold 25cm the message O will be displayed to indicate the alarm state see Figure 25 Otherwise if the target is within the upper and lower thresholds the message O is displayed Figure 24 A Oo message 3 DocID027648 Rev 3 UM1876 VL6180X standalone demonstrations Figure 25 O and O message Target between 10 and 25 cm from the VL6180X Target below 10 cm from the VL6180X At next short press on the blue button of the STM32 Nucleo board the user will return to A
41. nge Measurement ToF Range Offset mm 0 00 oo Vangel a nll Range Offset Cal Height mm 50 00 Factory Programmed Offset mm Offset Override Range mm z 8 X Talk Compensation Controls X Talk Compensation Factor 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 emitter 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 57 cross talk compensation factor Measured range cross talk compensation Actual range 3 44 57 DoclD027648 Rev 3 UM1876 VL6180X software graphical user interface GUI The cross talk compensation factor x talk is calibrated 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 select the Calibration tab and follow the instructions see Figure 58 Figure 58 Cross x talk compensation factor Calibration Offset Calibrated Programmed offset applied X Talk Compensation Uncalibrated If using glass Auto calibration required Next Ac
42. or can be activated in the ALS tab This tab displays the ALS Count graph showing ALS Lux count versus Samples as shown in Figure 59 Table 6 lists the buttons available in the ALS tab Figure 59 ALS tab 47 VL6180X Expansion Kit VL6180X Expansion Kit ALS Count life augmented ALS LUX SETTINGS ALS Count ALS Lux Sampling Rate Hz ALS Gain ALS Max ALS Min ALS Lux Res Integration Period ms Inter Meas Period ms Continual ALS Gain Selection ALS Scaler ALS Count Upper Auto Gain Auto Gain Count Thresh Max Auto Gain Count Thresh Min Reset Settings Reset stats COM Ports COMi4 Reset Comms Baud Rate Table 6 Buttons in the ALS tab Button eseription Start Pause Resume Click on Start to begin measuring the ALS count The Start button then changes to Pause Resume Stop Click on Stop to stop measuring the ALS count Beset The Reset button resets the 12C communications interface between the application and the VL6180X COM Ports The COM Ports list shows available device ports The Reset Comms button resets the comms between the device and the Reset Comms sanare Baud Rate Port COM speed bits per second Default is 19200 The information described in Jable 7 is displayed on the right of the ALS graph 3 DocID027648 Rev 3 UM1876 VL6180X software graphical user interface GUI Table 7 ALS information Fel scription ALS
43. ould be used to calibrate a final customer product in which a glass is used above the VL6180X In this last case 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 6 3 1 Offset calibration procedure with P NUCLEO 6180X i 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 40 57 DoclD027648 Rev 3 Kyy UM1876 Note VL6180X software graphical user interface GUI the product should be very close to the actual distance between a target and the VL6180X module Despite this offset calibration you may notice a remaining offset due to the soldering of the VL6180X module onto the expansion board In this case the VL6180X evaluation pack 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 e Put the jacket delivered with the VL6180X expansion 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 top of the VL6180X e To have a precise measurement set the max value of the range measurement display to 10 see Figure 53 e Check the value of Raw Range if the Raw rang
44. p Range Measurement Display To 250 A Scale 0 To 10 High Threshold 70 Enable Low Threshold 10 Ranging Live Result 10 10 Min mm 4 DMaximm 376 Raw Range mm Max mm UM1876 6 3 2 Note VL6180X software graphical user interface GUI VL6180X offset and cross talk calibration in a final product In case the user replaces the VL6180X module by their own module with glass above VL6180X module ST offers the possibility to calibrate its product using the Calibration tab of the GUI 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 The range offset offset factor is calibrated using a white target at least 60 x 60 mm square placed 50 mm above the sensor The resultant offset is added to the raw range Ro R offset where Ro is the offset range and R is the raw range in mm see Figure 55 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 55 Range offset O Cc e D wn D Actual range The
45. pw UM Gz UMI8ZG Y life augmented User manual Getting started with VL6180X proximity gesture ambient light sensor software expansion for STM32Cube Introduction STMicroelectronics has introduced various evaluation and development tools to facilitate the integration of the VL6180X sensor in customer s applications The VL6180X is a time of flight 3 in 1 proximity gesture and ALS sensor based on ST patented Flightsense technology This document provides detailed firmware installation guidelines for e Standalone operation e PC graphical user interface GUI e Application programming interface API for the use of VL6180X sensor The following list of evaluation devices are available e Two Nucleo packs The P NUCLEO 6180X1 Includes STM32F401RE Nucleo and X NUCLEO 6180XA1 expansion boards The P NUCLEO 6180X2 Includes STM32L053R8 Nucleo and X NUCLEO 6180XA1 expansion boards e The X NUCLEO 6180XA1 expansion board this board can be used with all STM32 nucleo boards e The VL6180X SATEL Includes two VL6180X satellite boards Up to three VL6180X satellite boards can be connected on the X NUCLEO 6180XA1 expansion board Figure 1 P NUCLEO 6180X1 Nucleo pack With VL6180X satellites Table 1 Ordering information P NUCLEO 6180X1 X NUCLEO 6180XA1 and STM32F401RE Nucleo boards P NUCLEO 6180X2 X NUCLEO 6180XA1 and STM32L053R8 Nucleo boards X NUCLEO 6180XA1__ VL6180X expansion board for STM32 Nucleo board family VL618
46. ranging and ALS modes see Section 5 2 RangingAndALS demonstration e RangingWith Satellites NucleoXXXxX bin bin shows the behavior of four VL6180X in ranging mode see Section 5 3 RangingWithSatellites demonstration a The list above shows the examples available in the latest version of the STM32CubeExpansion_VL6180X_Vx y z More examples can be added 1 10 57 DoclD027648 Rev 3 UM1876 VL6180X standalone demonstrations e The example code GestureDetect1 can be compiled using one of the provided projects MDK ARM EWARM SW4STM3z2 e A pre compiled binary is also provided in the Binary directory for this example GestureDetect1_NucleoF401 bin Drag and drop the bin file you want to select to the LO53R8 or F401RE or L476RG STM32 Nucleo board Figure 10 VL6180X standalone demonstration installation step 4 AS aa NUCLEO E Drag and drop YYYYYYY _NucleoXXXX bin Kyy DoclD027648 Rev 3 11 57 VL6180X standalone demonstrations UM1876 12 57 Press the black reset button on the STM32 Nucleo board and release it A the Nucleo pack is now running in standalone mode meaning no PC is required to control the Nucleo pack USB connection is only used to power the Nucleo pack The switch SW1 can be asserted during any stage of operation e When running in Standalone mode the SW1 switch on the VL6180X expansion board selects the value displayed on the 4 digit display see Figure 11
47. ranging tab continued Button O O OOOO Description O O O O O O O O OOOO OO Resets the COM Port connection to the VL6180X software Baud Rate Port COM speed bits per second Default is 19200 Connects the chosen COM Port to the VL6180X expansion board software To read and modify the content of a register 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 48 The Signal Rate can be viewed as a measure of the reflectance of the target with high reflectance targets producing stronger signal rates Figure 48 Signal strength power graph le augmented Signal Strength Power SETTINGS Max Convergence Time ms Inter Meas Period ms SNR Threshold ECE Factor Offset Factor mm X Talk Compensation Factor 0 00 el ee 1860 7 880 Sample Rtn Signal Rate Mcps 18 80 Actual Distance Time of Flight Be ee 1910 eas Device To 1920 1930 P High Speed 2X Scaling ete sero tte enn 1890 1900 Return Signal Rate Display A A Scale 0 To yaa ee Continual Gesture Help Range Measurement Display A Scale 0 To 400 A Range mm High Threshold Enable Low Threshold Ranging Live Result Raw Range mm 84 ceepeeeepes Max mm 146 880 Sample se at 1900 91 cial ides 1890 Min mm 66 COM Ports COM16 ResetComms Baud Rate
48. ross Reference Home Products Applications Support Sample amp Buy About Contact My ST Login fl Parametric Search e Onnext page click on STSW LINKOO9 Figure 3 STM32 Nucleo board Windows USB driver installation step 2 Ti liie augmented Home Products Applications Support Sample amp Buy About Contact My ST Login Part Number Results 1 STSW LINK009 STSW LINKOOS Active ST Link ST Link V2 ST Linkf 2 1 USB driver signed for XP Windows Windows e On next page click on Download DoclID027648 Rev 3 3 UM1876 VL6180X Nucleo pack software installation Figure 4 STM32 Nucleo board Windows USB driver installation step 3 7 my crew Quick View Design Resources Get Software All STSW LINKOOSY ST Link ST Link V2 ST Link V2 1 USB driver signed for XP Windows7 Windows8 Active Design Resources Get Software STSW LINKOOS9 1 01 Marketing Statur Active Order From ST Suggested Resale Price per unit USD for BUDGETARY USE ONLY For quotes prices in local currency please contact your local ST Sales Office or our D strihirtars e From stsw link009 zip unpack the zip file and run stlink_winusb_install bat This will install the necessary USB drivers to allow communications between the Nucleo board and the PC Figure 5 STM32 Nucleo board Windows USB driver installation step 4 Fichier Edition Affichage Name d amd64 x86 S dpinst_amd64 exe S dpinst_x86
49. rt guide for API integration API documentation is in the docs folder and is available in two formats e API_Documentation_proximity chm e API_Documentation_proximity html The VL6180X API is integrated in a software project in two steps 1 Developer has to add link the files listed in Table 8 and in Figure 65 to his source and include code path Some files may require modifications to comply with the final application or the hardware software capabilities Table 8 API header files ee vl6180x _cfg h Application configuration May require modification vl6180x_api c and All operating functions at high and low level to control the sensor vl6180x_api h Must not be modified vi6180x def h Definition of constants and structures used in the API Must not be modified vI6180x_platform h Target platform specific declarations prototypes May require modification vI6180x_types h Basic types definition May require porting 2 To manage the data communication between the VL6180X and the host the developer has to design a camera control interface CCl register communication driver The API low level functions rely on the following set of 7 read amp write functions which perform CCI register access to the device VL6180x_WrByte VL6180x_WrWord VL6180x_WrDWord DoclD027648 Rev 3 Kyy UM1876 Application programming interface API VL6180x_UpdateByte VL6180x_RdByte VL6180x_RdWord VL6180x_RdDWord To implement these 7
50. s ranging from main VL6180X plus up to 3 satellites Ranging measures displayed on 7 segment display One example project is included in Projects Multi Applications directory e GestureDetect1 example feature Ranging mode Single swipe and single tap detection with on board VL6180X Directional swipes detection with two VL6180X satellites DoclD027648 Rev 3 9 97 VL6180X Nucleo pack software installation UM1876 4 4 1 6 57 VL6180X Nucleo pack software installation ST delivers a software suite allowing the user to discover through standalone demonstrations and a PC graphical user interface GUI the VL6180X ranging and ambient light sensing ALS features STM32 Nucleo board software suite installation The Nucleo board software suite is available from www st com this software is compatible with all STM32 Nucleo boards This installation software suite consists of e STSW LINKOOY ST Link ST Link V2 ST Link V2 1 USB driver signed for XP Windows7 and 8 This driver must be first installed e STSW LINKOO7 ST Link V2 1 firmware update When STSW LINKOOY and STSW LINKOO7 firmware are installed the STM32 Nucleo board is configured and ready to use with a PC STSW LINKO009 STM32 Nucleo board Windows USB driver installation e On www st com home page search for STSW LINKOO9 Figure 2 STM32 Nucleo board Windows USB driver installation step 1 L y J life augmented STSW LINKOOS f Part Number Keyword C
51. sabled when in the Idle state not ranging by clicking on the Enable checkbox Figure 52 Dmax feature a vieisox Expansion Kit 4 m A vs VL6180X Expansion Kit Ranging ALS Calibration Options life augmented Signal Strength Power SETTINGS 250 Max Convergence Time ms Inter Meas Period ms SNR Threshold 0 06 200 4 Signal Rate Mcps ECE Factor 1 Offset Factor mm 14 X Talk Compensation Factor 0 00 Signal Rate Mcps soa Nee a rei Was AL a pooogeon j pups I ites bee ee ee a 0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30 32 34 36 38 40 42 44 46 48 50 52 Sample Return Signal Rate Display Device Top v High Speed 2X Scaling 7 A Scale 250 y Continual Gesture Help Range Measurement Display A Scale 0 To 400 y High Threshold Enable Low Threshold Ranging Live Result Raw Range mm 122 E Max mm Opp my yn a pan e am ea a mm 510 2 0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30 32 34 36 38 40 42 44 46 48 50 52 Sample Reset COM Ports COMi6 ResetComms Baud Rate 6 2 6 High speed When high speed mode is selected the VL6180X control is not done by the PC but by the STM82 this allows a faster 12C communication the drawback of the high speed mode is the DMAX value is not reported to the PC 6 3 Calibration tab The calibration tab of the GUI is not used with P NUCLEO 6180X i pack but c
52. single tap mode Another short press on the blue button of the STM32 Nucleo board and the VL6180X goes into single swipe mode single tap mode zi e Single swipe mode if you move your hand from left to right or from right to left at a distance less than 20cm in front of the VL6180X on the main board the display changes as shown in Figure 38 Figure 38 Single swipe mode display e Single Tap mode if you move your hand up above the VL6180X on the main board at a distance higher than 20cm and then take it down to a distance of less than 20cm the display changes as shown in Figure 39 Figure 39 Single tap mode display A short press on the blue button of the STM32 Nucleo board and the VL6180X will go back to ranging mode Single directional swipe DIRSWIPE_1 mode In this mode the left and right VL6180X satellites are used From ranging mode or TAP_SWIPE_2 mode press the blue button of the STM32 Nucleo board for 2seconds the VL6180X will go into single directional swipe mode 3 DocID027648 Rev 3 UM1876 VL6180X standalone demonstrations While the blue button is pressed the message as shown in Figure 40 is displayed Figure 40 Message during blue button is pressed e When blue button is released VL6180X goes into the directional swipe mode passing your hand over the VL6180X devices in a circular motion as shown in Figure 47 Figure 42 the message as shown in Figure 41 Figure 42 are success
53. t s s lectionn s 3 DocID027648 Rev 3 UM1876 VL6180X standalone demonstrations 5 VL6180X standalone demonstrations 5 1 Installation of the VL6180X standalone operation Note If not already done plug VL6180X expansion board on to STM32 Nucleo board To install VL6180X standalone demonstrations e In P NUCLEO 6180X1 or in P NUCLEO 6180X2 web pages select X CUBE 6180XA1 Figure 7 VL6180X standalone demonstration installation step 1 Related Tools and Software Part Number Description 51 SW LINKOO 21 LINK V2 1 firmware upgrade o1 Link ST Link V2 ST Link V2 1 USB driver signed for XP 3TSW LINKOOS WWindrace E iy nal Pe F X CUBE 6180XA1 Proximity gesture ambient light sensor software expansion for STM32 STSW_IMGOO4 Windows Graphical User Interface GUI for VL6160X Evaluation Kits Works j NUCLEO 6160X1 P NUCLEO 6180XxX2 and EVALKIT VL6160X e Click on Download then save it Figure 8 VL6180X standalone demonstration installation step 2 sample amp Buy X CUBE 6160X A1 Suggested Resale Price per unit USD for BUDGETARY USE ONLY For quotes prices in local currency pesse contact your local ST Sales Office or our Distnibutors The Material Declaration forms available on sicom may be generic documents based on the most commonly used package within a package family For this reason they may not be 100 accurate for a specific device Please contact our sales support for information on
54. te reg 0x01986 Val Write reg 0x01B0 Val Write reg OxO1AD Val Write reg OxO00FF Val Write reg 0x0100 Val Write reg 0x0199 Val Write reg 0x010A4 Val Write reg 0x003F Val Write req Ox01A6 Val Write rernm Aw 1 A Wal 762 Ln 1 Col 1 Sel 0 0 Dos Windows ANSI as UTF 8 wm gi Boa jH oy tn am Wh eH ip oo H H H T pap Ia a i Lo 860 ca m Go fo H oo tn co ho Po Bo Bo fo ho Bo A Oo Ue RP eP Be 5 ip A oto bo bo ta amp to Ba gc 0 DocID027648 Rev 3 53 57 Application programming interface API UM1876 7 54 57 Application programming interface API 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 l2C 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 API download To download VL6180X API e onst com search for VL6180X e onnext page select VL6180X e On next page select design resources e On design resources page select STSW IMG003 e On next page download Quick sta
55. tellite board e P VL6180X on the right satellite board The GestureDetect1 VL6180X standalone demonstration shows several features range Swipe and tap detections 0 DoclD027648 Rev 3 23 57 VL6180X standalone demonstrations UM1876 The following sections describe the ranging feature and the two gesture detection features Figure 35 shows how to switch from one feature to another Figure 35 GestureDetect1 demonstration flow The switch SW1 must be in RANGE mode 3 24 57 DoclD027648 Rev 3 UM1876 VL6180X standalone demonstrations 5 4 1 Ranging mode and single swipe single tap TAP_SWIPE_2 mode In this mode only the VL6180X on the main board is used Ranging mode With a short press on the blue button of the STM32 Nucleo board the VL6180X goes in ranging mode a e the message as shown in Figure 36 is displayed if no target is present at a distance higher than 20cm from the VL6180X connected on the main board Figure 36 Target above 20cm from the VL6180X on the main board e the message as shown in Figure 37 is displayed if a target is present at a distance lower than 20 cm from the VL6180X the distance is displayed in mm e g 198mm Figure 37 Target below 20cm from the VL6180X on the main board Indicates that the VL6180X is in ranging mode Kyy DoclD027648 Rev 3 25 57 VL6180X standalone demonstrations UM1876 9 4 2 26 57 TAP_SWIPE_2 Single swipe
56. tion Perform X Talk Calibration or override programmed offset Offset The Factory Programmed offset is currently applied To manually override this select Offset Override on the Offset Controls panel The user will then be able to perform auto calibration or else provide direct manual input X Talk Compensation e If there is glass in front of the sensor X Talk Compensation calibration is required for optimum ranging performance X Talk Compensation Factor Calibration can be achieved by executing one of the following options 1 Manually provide the desired using the control X Talk Compensation Factor 2 Perform Auto Calibration by clicking Cal X Talk Otherwise calibration can be omitted by clicking Finish Offset Controls Part ID 06 29 2014 8 29 46 0x01 0x58 Range Measurement ToF Range Offset mm 0 00 a Range mm ey Range Offset Cal Height mm 50 00 gt Factory Programmed Offset mm Offset Override X Talk Compensation Controls X Talk Compensation Factor When offset calibration and x talk compensation are ended the new values of both parameters are automatically reported in the Ranging tab in the SETTINGS windows and in the fields e Offset factor mm e X Talk Compensation factor 0 DoclD027648 Rev 3 45 57 VL6180X software graphical user interface GUI UM1876 6 4 46 57 Ambient light sensor ALS tab The ambient light sens
57. ure 16 This message indicates that VL6180X scaler factor is set to 3 Consequently range measurements between the VL6180X and the target are confined to the limits 0 and 60cm with a granularity of 3mm Figure 16 SF 3 message 3 DocID027648 Rev 3 UM1876 VL6180X standalone demonstrations At next short press on the blue button of the STM32 Nucleo board i B ms the message SF A is displayed for a few seconds see Figure 17 This message indicates that VL6180X scaler factor is set to automatic mode resulting in range measurements between the VL6180X and the target being confined to the limits 0 to 60cm with a granularity of e 1mm for the range measurement between 0 and 20cm e 2mm for the range measurement between 20 and 40cm e 3mm for range measurement between 40 and 60cm Figure 17 SF A message Starting from a USB cable connection the sequence linked to sequential short presses on the blue button of the STM32 Nucleo board is described in Figure 18 Figure 18 Range measurement sequence versus short presses on blue button USB cable plugged 0 DoclD027648 Rev 3 15 57 VL6180X standalone demonstrations UM1876 16 57 At any time the user can perform a long press on the blue button of the STM32 Nucleo board A long press on the blue button of the STM32 Nucleo board ab will activate the Alarm modes For the duration of the button press the message rb Release Button will b
Download Pdf Manuals
Related Search