Application Note DN[Document ID] AS5170 Evaluation Software Manual ams Application Note [v1-10] 2016-Jan-12 Page 1 Document Feedback AS5170 Evaluation Software Manual Content Guide 1 General Description ............................................................................................................. 3 2 AS5170 Evaluation Software Installation ............................................................................. 3 3 AS5170 Evaluation Software ............................................................................................... 4 3.1 Hardware Setup ................................................................................................................... 4 3.2 Device Selection .................................................................................................................. 5 3.3 Programming Procedure ...................................................................................................... 6 4 Contact Information ............................................................................................................ 16 5 Copyrights & Disclaimer ..................................................................................................... 17 Revision History Revision Date Owner Description 1.0 12.03.2015 azen Initial version 1.01 11.09.2015 azen Added PWM and Calibration Sequence 1.10 12.01.2016 mzie Updated to latest software release V0.8 ams Application Note [v1-10] 2016-Jan-12 Page 2 Document Feedback AS5170 1 Evaluation Software Manual General Description This application note describes the usage of the AS5170 Evaluation Software for programming the AS5170 magnetic position sensor. 2 AS5170 Evaluation Software Installation First download and install the latest version of the AS5170 Evaluation Software from our webpage at www.ams.com. The software is written in LabVIEW. To be able to run the software properly the latest NI LabVIEW Run-Time Engine and NI VISA Run-Time Engine have to be installed on the computer. This can be downloaded for free from the National Instruments webpage at www.ni.com. Additionally the cable used for communication uses a FT232R – USB-to-UART IC by FTDI. Therefore the installation of the VCP (Virtual COM Port) driver is necessary to detect the USB device as a serial COM port. The driver can be downloaded from the official FTDI website using following link: http://www.ftdichip.com/Drivers/VCP.htm After running these installers it should be possible to run the software without any errors. ams Application Note [v1-10] 2016-Jan-12 Page 3 Document Feedback AS5170 3 3.1 Evaluation Software Manual AS5170 Evaluation Software Hardware Setup 1. Start the AS5170 Evaluation Software. Figure 1: Starting screen 2. Please choose the right COM Port and enter the Baud Rate (typically 9600 baud) ams Application Note [v1-10] 2016-Jan-12 Page 4 Document Feedback AS5170 3.2 Evaluation Software Manual Device Selection 3. Go to “Device Selection” tab Figure 2: Device Selection tab 4. Select the proper device from the dropdown menu. AS5170A – Analog output AS5170B – PWM or SENT output 5. Another possibility is to use the “Detect Device” button which will automatically detect the proper IC version connected. ams Application Note [v1-10] 2016-Jan-12 Page 5 Document Feedback AS5170 3.3 Evaluation Software Manual Programming Procedure 6. Go to “AS517x” tab Figure 3: AS517x tab 7. Enter start angle T1. Either manually enter the position or move the magnet to initial position and click the “GET” button. 8. Enter final angle T2. Either manually enter the position or move the magnet to the final position and click the “GET” button. ams Application Note [v1-10] 2016-Jan-12 Page 6 Document Feedback AS5170 Evaluation Software Manual 9. Additionally you can get the AGC and Magnitude values by pressing the “GET” button. The AGC and Magnitude are informative parameters about the magnetic field strength. (Magnitude typically should be 74 LSB and AGC between 0 and 255 LSB) 10. Enter VDD Ratio. If the supply voltage at programming differs from ideal 5V this parameter has to be set. Enter this parameter as a ratio of 5V / VDD_Prog. For example: 5V / 4.8V = 1,042 If there is no deviation from 5V please use 1,00. 11. Enter the required quadrant mode. There is the choice of 4 quadrant modes with following limitations: 1 quadrant: full 360° 2 quadrants: max. 180° / quadrant 3 quadrants: max. 120° / quadrant 4 quadrants: max. 90° / quadrant 12. Enter the Hysteresis. This function avoids sudden jumps at zero crossing caused by noise in the full turn 360° configuration. (1 quadrant). 0 = 0 LSB 1 = 56 LSB 2 = 91 LSB 3 = 137 LSB 13. Enter the desired direction. If you enter 0 this will result in a rising slope. Entering 1 will result in a falling slope if also T1 and T2 are exchanged. ams Application Note [v1-10] 2016-Jan-12 Page 7 Document Feedback AS5170 Evaluation Software Manual 14. In section “Slope Parameters” enter the characteristic of your desired output function. 15. Enter T1Y in Volts (LSB for SENT and %DC for PWM). T1Y is the output voltage at the initial magnet position T1. 16. Enter T2Y in Volts (LSB for SENT and %DC for PWM). T2Y is the output voltage at the final magnet position T2. 17. Enter CLL in Volts (LSB for SENT and %DC for PWM). CLL is the output voltage for the lower clamping level. 18. Enter CLL in Volts (LSB for SENT and %DC for PWM). CLL is the output voltage for the lower clamping level. 19. Click „Calculate“. The DLL will calculate the programming data in the background and the graph will show a preview of the programmed output slope. Figure 4: Output graph preview ams Application Note [v1-10] 2016-Jan-12 Page 8 Document Feedback AS5170 Evaluation Software Manual 20. When using AS5170 with SENT or PWM please move to step XX. 21. When using AS5170 with analog output there is the option to do a calibration of the output DAC. This reduces the drift of the DAC and can improve the overall accuracy. Therefore click “Enable DAC Calibration” and connect a voltmeter to the OUT pin. 22. Measure T1, write the value into the highlighted box and press enter. 23. A pop-up window will appear and you have to press the reset button on the UART programming board. 24. Measure T2, write the value into the highlighted box and press enter. ams Application Note [v1-10] 2016-Jan-12 Page 9 Document Feedback AS5170 Evaluation Software Manual 25. A pop-up window will appear and you have to press the reset button on the UART programming board. 26. Press “Calculate” again and the “Programming Data” on the right side of the screen will change slightly. 27. Go to “Programming tab”. This section will look different depending on which type of output (Analog, SENT or PWM) was selected. Figure 5: Programming tab for AS5170 Analog 28. In this tab the “Sensor Configuration” settings can be done. ams Application Note [v1-10] 2016-Jan-12 Page 10 Document Feedback AS5170 Evaluation Software Manual 29. Sensor Configuration Settings (AS5170 Analog) Customer Lock: If the Customer Lock is set and the OTP is burned the sensor will permanently startup in functional mode. Diagnostic High: Selects whether the output enters the lower or upper failure band in case the sensor enters a diagnostic mode. Customer ID: An unique identifier which can be chosen by the customer and will be stored in the OTP memory. Airgap Selection: In Airgap Selection you can select your preferred magnetic input range. In “Extended Mode” the input range is from 10 – 90 mT, in Normal Mode from 30 – 70 mT. Filter Configuration: This selects your Filter Configuration. You can choose between Filter Off, Fast Filter, Moderate Filter or Slow Filter. Analog Readback: This sets the maximum timeout period to wait before an error condition is triggered in case of an analog readout failure. (SM11) Figure 6: Programming tab for AS5170 PWM ams Application Note [v1-10] 2016-Jan-12 Page 11 Document Feedback AS5170 Evaluation Software Manual 30. Sensor Configuration Settings (AS5170 PWM) Customer Lock: If the Customer Lock is set and the OTP is burned the sensor will permanently startup in functional mode. Diagnostic High: Selects whether the output enters the lower or upper failure band in case the sensor enters a diagnostic mode. Customer ID: An unique identifier which can be chosen by the customer and will be stored in the OTP memory. Airgap Selection: In Airgap Selection you can select your preferred magnetic input range. In “Extended Mode” the input range is from 10 – 90 mT, in Normal Mode from 30 – 70 mT. Filter Configuration: This selects your Filter Configuration. You can choose between Filter Off, Fast Filter, Moderate Filter or Slow Filter. Operating Mode: This selects the operation mode for the PWM output driver. (Push Pull, Low Side, High Side). PWM Frequency: This selects the frequency for the PWM signal. PWM Rise/Fall Threshold: This sets the maximum timeout period to wait before an error condition is triggered in case of a missing rising or falling edge. (SM11) Figure 7: Programming tab for AS5170 SENT ams Application Note [v1-10] 2016-Jan-12 Page 12 Document Feedback AS5170 Evaluation Software Manual 31. Sensor Configuration Settings (AS5170 SENT) Customer Lock: If the Customer Lock is set and the OTP is burned the sensor will permanently startup in functional mode. Diagnostic High: Selects whether the output enters the lower or upper failure band in case the sensor enters a diagnostic mode. Customer ID: An unique identifier which can be chosen by the customer and will be stored in the OTP memory. Airgap Selection: In Airgap Selection you can select your preferred magnetic input range. In “Extended Mode” the input range is from 10 – 90 mT, in Normal Mode from 30 – 70 mT. Filter Configuration: This selects your Filter Configuration. You can choose between Filter Off, Fast Filter, Moderate Filter or Slow Filter. Operating Mode: This selects the operation mode for the SENT output driver. (Push Pull). SENT Message ID: This is a message identifier which can be programmed and will be transmitted in the Short Serial Message. SENT Tick Period: This selects the tick period for the SENT interface. Short Serial Message: Enables or disables the Short Serial Message which is transmitted according the SENT standard in the Status and Communication nibble. Rolling Counter: Enables or disables the rolling counter in nibble 5 and 6. Pause Pulse: Enables or disables the pause pulse at the end of every transmission. ams Application Note [v1-10] 2016-Jan-12 Page 13 Document Feedback AS5170 Evaluation Software Manual 32. After all this steps are done the data can be written to the sensor. Therefore click the “Write” button. 33. To check if the “Write” command was successful the data has to be read back. Therefore click the “Read” button. 34. If the Write/Read check was successful a green tick will appear. 35. After the data is read back, the Signature has to be calculated. Therefore “Signature” has to be clicked. 36. A tick in “Signature Calculated” will appear. 37. After this again a “Write” and “Read” operation has to be executed. 38. At this point the device can either be switched to “Pass2Function” mode or the OTP fuses can be burned. When using the “Pass2Function” mode the device is only programmed temporarily until it is reset again. When clicking the “FUSE” Button the OTP fuses are burned and the device is permanently programmed. For permanent programming go to step 41. 39. To set the device to “Pass2Function” mode, DO NOT set the “Customer Lock” bit. 40. Click “Pass2Function” button. The device switches from communication mode to functional PSI5 mode. ams Application Note [v1-10] 2016-Jan-12 Page 14 Document Feedback AS5170 Evaluation Software Manual Caution! – Permanent programming beyond this point 41. For permanently programming of OTP fuses the “Customer Lock” bit has to be set. 42. Click “Write” Button. 43. Click “Read” Button 44. Check if Write/Read checksum is correct. 45. Click “FUSE” button. 46. After pressing “FUSE” a successful or failed burning process will be indicated in the Info Box below. ams Application Note [v1-10] 2016-Jan-12 Page 15 Document Feedback AS5170 4 Evaluation Software Manual Contact Information Buy our products or get free samples online at: www.ams.com/ICdirect Technical Support is available at: www.ams.com/Technical-Support Provide feedback about this document at: www.ams.com/Document-Feedback For further information and requests, e-mail us at: [email protected] For sales offices, distributors and representatives, please visit: www.ams.com/contact Headquarters ams AG Tobelbaderstrasse 30 8141 Unterpremstaetten Austria, Europe Tel: +43 (0) 3136 500 0 Website: www.ams.com ams Application Note [v1-10] 2016-Jan-12 Page 16 Document Feedback AS5170 5 Evaluation Software Manual Copyrights & Disclaimer Copyright ams AG, Tobelbader Strasse 30, 8141 Unterpremstaetten, Austria-Europe. Trademarks Registered. All rights reserved. The material herein may not be reproduced, adapted, merged, translated, stored, or used without the prior written consent of the copyright owner. Information in this document is believed to be accurate and reliable. However, ams AG does not give any representations or warranties, expressed or implied, as to the accuracy or completeness of such information and shall have no liability for the consequences of use of such information. Applications that are described herein are for illustrative purposes only. ams AG makes no representation or warranty that such applications will be appropriate for the specified use without further testing or modification. ams AG takes no responsibility for the design, operation and testing of the applications and end-products as well as assistance with the applications or end-product designs when using ams AG products. ams AG is not liable for the suitability and fit of ams AG products in applications and end-products planned. ams AG shall not be liable to recipient or any third party for any damages, including but not limited to personal injury, property damage, loss of profits, loss of use, interruption of business or indirect, special, incidental or consequential damages, of any kind, in connection with or arising out of the furnishing, performance or use of the technical data or applications described herein. No obligation or liability to recipient or any third party shall arise or flow out of ams AG rendering of technical or other services. ams AG reserves the right to change information in this document at any time and without notice. ams Application Note [v1-10] 2016-Jan-12 Page 17 Document Feedback