Application Note – AS5000 Programmer 1 General Overview This operational manual describes the function of the AS5000 Programmer in combination with the programming boards. This tool can program the ams AS5000 series magnetic rotary encoders. The graphical user interface (GUI) runs on PC running Windows XP or later and controls the programmer via the USB interface. All major access modes to the OTP memories can be established. Be aware that ams provides the AS5000 Programmer as a reference for programming and reading of mentioned devices (refer to Appendix A) under laboratory conditions (no warranty for mass production). Note: Since firmware version v2.10 the AS5000-Programmer contains a boot loader, which provides an update function for new software release. Please refer to the corresponding application note AN5000-60 (available on our webpage). 2 Hardware Components 2.1 Description of the Hardware Components LCD display (programmer v1.3 or older only) USB cable AS5000 programmer Programming board (AS5xxx-PB) Figure 1: Three components of the Programmer solutio n Figure 1 shows the three components which are needed to program the ams magnetic position sensor. Take care that the connector between programmer and programming board is plugged in the right way. Warning: In case of wrong connection, the components in the AS5000 programmer or the encoder can be destroyed! www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Programmer’s right side 19 17 15 13 11 9 7 5 3 1 20 18 16 14 12 10 8 6 4 2 Figure 2: AS5000 Programmer MRE connector ( right side view) Pin # 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 www.ams.com Signal Vzap Vzap D10 ADC2 D9 ADC1 D8 D11 D7 D6 VDD VDD GND GND D5 D0 D4 D1 D3 D2 Comment Programming voltage Programming voltage Encoder signal Device autodetection voltage Encoder signal Vzap feedback Encoder signal Encoder signal Encoder signal Encoder signal Encoder power supply Encoder power supply Ground Ground Encoder signal Encoder & LCD display signal Encoder signal LCD signal – Do not use Encoder & LCD display signal Encoder & LCD display signal Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 2.2 Description of the programming board Jumper J6: Supply voltage selection Open: 5V – Close: 3.3V (default) Connector to the AS5000 programmer Jumper J9: Gain = 1 (AS5043 only) ZIF socket Location of pin 1 of the encoder Figure 3: Example for an AS5043-PB Programming board Device Selection jumper The programming board (AS5xxx-PB) is specific for a group of devices. By jumper setting on this board the build in firmware in the programming box automatically detects the selected device. It is not recommended to change the jumper setting to a different encoder type than installed in the socket. To place or remove a device form the socket, push the black frame of the socket down. This socket has more connectors as the AS50xx/ AS51xx part and therefore it is important to align the device to the left side of the socket. The pin 1 of the device must be on the bottom left side. Figure 2 shows the detailed placed device in the socket. The jumper J9 is specific for the AS5043/AS5143. This Jumper is used to close the feedback loop used for the analog output operation mode. With this jumper the gain can set to 1. The jumper J6 is by default closed because the AS5000 Programmer provides 3.3V operation. In case of 5 V operation the jumper must be removed and the configuration can be changed over the GUI. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 3 Installation 3.1 Hardware setup First connect the AS5xxx-PB to the 20-pin connector of the AS5000 Programmer, as shown on Figure 1. The AS5000 Programmer is directly powered by the PC via USB. An external power supply is not needed. 3.2 Installing the GUI on the PC The preliminary software is developed for a Microsoft Windows XP operating system with Service Pack 2. In addition the dotnet (.NET) framework version 2.0 or more must be installed on the PC. This package can be downloaded free of charge from the Microsoft webpage: http://www.microsoft.com/downloads/details.aspx?FamilyID=0856eacb-4362-4b0d-8edd-aab15c5e04f5&displaylang=en Following Procedure is recommended before starting the GUI: 1. 2. 3. 4. check on your PC if Service Pack 2 is installed install the mentioned .net package to your computer execute AS5000GUI_setup.exe Finally start the GUI using the shortcut in the start menu or desktop. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 4 Graphical User Interface (GUI) Figure 4: Main window of the GUI , no PB board inserted Figure 4 shows the main window of the GUI. In the top left corner, informations about the connected hardware are displayed: firmware (FW) type of the connected hardware: ubox (AS5000 Programmer) or dbrd (Demoboard) firmware (FW) version By default the GUI is in the auto detection mode. Any ams device connected on the USB port (one device at the same time) will be automatically detected and displayed in the right top corner. Note: The autodetect mode can be disabled and forced to any other device type by selecting the device manually. Once a PB board inserted, tabs will be displayed allowing go into two main sections: SSI (or TWI) and OTP. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 4.1 Programming the AS5040/AS5045/AS5140/AS5145/AS5045B Programming AS5040/AS5140 encoders requires the AS5040-PB ZIF socket board. This adapter is compatible with AS5040, AS5140, AS5045,AS5145 and AS5045B. Jumper J6 must be close for normal operation and programming operation. Pin 1 Figure 5: AS5040-PB Programming board By selecting the SSI tab, information of the angular position and the status bits appear: Selected die (dual die AS52xx devices only) Status bits and field alarm a Counter Clockwise mode Set the actual angle as Zero Position Position of the magnet Figure 6: SSI tab with AS5040 encoder inserted in AS5040-PB - Die selection: This option is for dual die AS52xx devices only. For AS50xx and AS51xx devices Die 0 (default) must be selected. Value field is the raw angle extracted from the SSI stream. The angle range is 0 (0°) to 1023 (359.6°) Status field displays the status bits extracted from the SSI stream. Green light means that the airgap between the magnet and encoder is correct. Orange light means the magnet is too close of too far. CCW checkbox is the angle direction. To invert the rotating direction, check CCW. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer - Zero Position field: Set button writes the actual angle value into the Zero Position register of the encoder. This programming is not permanent. The actual value will be 0 after zero position programming. To reset the zero position register, or to set a new zero position, click on Reset first. Read interval is the SSI stream readout and refresh rate the GUI. Figure 7: AS5040 SSI tab after Zero Position programming This example is the effect when the function Zero Position SET has been performed. Before programming, the encoder shows the position 651 (Figure 6). One click on Zero Position Set makes the software writing the value 651 into the OTP Zero Position register (not permanent programming). Selecting Zero Position Reset will write the value 0 to the OTP Zero Position register. Note: The Zero Position function is the same for all the AS50xx, AS51xx, AS52xx rotary encoders offering this feature. Selecting the OTP tab will read the OTP configuration from the IC. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Figure 8: OTP tab of an unprogrammed AS5040 AS5040/AS5045: Read reads the OTP configuration from the permanent fuse register. Write writes the bits checked by the user into the volatile OTP register. Selecting the SSI after the configuration is possible to check the effect of the new configuration. Zap! writes permanently the checked OTP bits to the encoder’s fuses. AS5140/AS5145: Load reads the OTP configuration from the permanent fuse register. Read reads the OTP configuration from the volatile register. Write writes the bits checked by the user into the volatile OTP register. Selecting the SSI after the configuration is possible to check the effect. Zap! writes permanently the checked OTP bits to the encoder’s fuses. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 4.1 Programming the AS5043 Programming AS5043 encoders requires the AS5043-PB ZIF socket board. Jumper J6 must be close for normal operation and programming operation. AS5043-PB ZIF socket board Device selection for autodetect: Jumper position 1: AS5043 Pin 1 Figure 9: AS5043-PB Programming board By selecting the SSI tab, information of the angular position and the status bits appear: Selected die (dual die AS52xx devices only) Status bits and field alarm a Counter Clockwise mode Position of the magnet Set the actual angle as Zero Position Figure 10: SSI tab with AS5043 inserted in AS5043 -PB - Die selection: This option is for dual die AS52xx devices only. For AS50xx and AS51xx devices Die 0 (default) must be selected. Value field is the raw angle extracted from the SSI stream. The angle range is 0 (0°) to 1023 (359.6°) Status field displays the status bits extracted from the SSI stream. Green light means that the airgap between the magnet and encoder is correct. Orange light means the magnet is too close of too far. CCW checkbox is the angle direction. To invert the rotating direction, check CCW. Zero Position field: Set button writes the actual angle value into the Zero Position register of the encoder. This programming is not permanent. The actual value will be 0 after zero position programming. To reset the zero position register, or to set a new zero position, click on Reset first. Read interval is the SSI stream readout and refresh rate the GUI. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Figure 11: OTP tab of AS5043, with FBintEN option checked by user AS5043: Read reads the OTP configuration from the permanent fuse register. Write writes the bits checked by the user into the volatile OTP register. Selecting the SSI after the configuration is possible to check the effect of the new configuration. Zap! Writes permanently the checked OTP bits to the encoder’s fuses. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 4.2 Programming the AS5245 Programming AS5245 encoders requires the AS5245-PB socket board. Jumper J6 (J6+J8 for AS5245) must be close for normal operation and programming operation. AS5245-PB ZIF socket board Device selection for autodetect: Jumper position 2: AS5245 Pin 1 Figure 12: AS5245-PB Programming board By selecting the SSI tab, information of the angular position and the status bits appear: Selected die (dual die AS52xx devices only) Status bits and field alarm a Counter Clockwise mode Set the actual angle as Zero Position Position of the magnet Figure 13: SSI tab with AS5045 inserted in AS504 0-PB - Die selection: This option is for dual die AS52xx devices only. For AS50xx and AS51xx devices Die 0 (default) must be selected. Value field is the raw angle extracted from the SSI stream. The angle range is 0 (0°) to 1023 (359.6°) Status field displays the status bits extracted from the SSI stream. Green light means that the airgap between the magnet and encoder is correct. Orange light means the magnet is too close of too far. CCW checkbox is the angle direction. To invert the rotating direction, check CCW. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer - Zero Position field: Set button writes the actual angle value into the Zero Position register of the encoder. This programming is not permanent. The actual value will be 0 after zero position programming. To reset the zero position register, or to set a new zero position, click on Reset first. Read interval is the SSI stream readout and refresh rate the GUI. Selected die (dual die AS52xx devices only) Figure 14: OTP tab of AS5045 AS5245: Load reads the OTP configuration from the permanent fuse register. Read reads the OTP configuration from the volatile register. Write writes the bits checked by the user into the volatile OTP register. Selecting the SSI after the configuration is possible to check the effect. Zap! writes permanently the checked OTP bits to the encoder’s fuses. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 4.3 Programming the AS5134 Programming AS5134 encoders requires the AS5134-PB socket board. AS5134-PB ZIF socket board Device selection: Jumper position 1: AS5134 Figure 15: AS5134-PB Programming Board AGC value a Multi Turn Counter a Figure 16: GUI for the AS5134 - Additional window for the BLDC output signals a Value field is the raw angle extracted from the interface. The angle range is 0° to 359° Status field (AGC) displays the status bits depending on the set AGC values. Green light means that the airgap between the magnet and encoder is correct. Red light means the magnet is too far away. Zero Position field: Set button writes the actual angle value into the Zero Position register of the encoder. This programming is not permanent. The actual value will be 0 after zero position programming. To reset the zero position register, or to set a new zero position, click on Reset first. Read interval is the readout and refresh rate the GUI. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer - Digital interface opens an additional window (see Figure 17), which provides all communications commands like WRTIE_CONFIG or EN_PROG (for entering the exentended mode). Figure 17: Communication command window Figure 18: OTP tab of AS5134 AS5134: Read reads the OTP configuration from the permanent fuse register. Write writes the bits checked by the user into the volatile OTP register. Selecting the SSI after the configuration is possible to check the effect of the new configuration. Zap! writes permanently the checked OTP bits to the encoder’s fuses. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Analog Readback is not implemented yet. It will be available soon. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 4.4 Programming the AS5163/AS5263 Figure 19: AS5x63-CB Connection Board (left) and AS5163 -PB Programming Board (right) Programming AS5163/AS5263 encoders requires the AS5163-PB/AS5263-PB socket board and the AS5x63-CB connection board. The connection board provides the load, needed for programming and operating the AS5163/AS5263. Further details concerning all programming options are provided in application note AN5163-10 (available on our webpage). 4.5 Programming the AS5115/AS5215 Figure 20: AS115-PB Programming Board (left) and AS5215 -PB Programming Board (right) www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Figure 21: TWI tab of AS5115 The AS5115-PB and AS5215-PB does not support an angle readback of the analogue outputs. Selected die (dual die AS52xx devices only) Figure 22: OTP tab of AS5115 AS5115/AS5215: Read reads the OTP configuration from the permanent fuse register. Write writes the bits checked by the user into the volatile OTP register. Selecting the SSI after the configuration is possible to check the effect of the new configuration. Zap! writes permanently the checked OTP bits to the encoder’s fuses. www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 5 Programming boards (PB) Schematics 5.1 AS5040-PB-1.1 www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 5.2 AS5043-PB-1.1 www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 5.3 AS5115-PB1.1 5.4 AS5134-PB-1.1 www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 5.5 AS5163-PB-1.0 5.6 AS5215-PB-1.1 5.7 AS5245-PB-1.1 www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer 5.8 AS5263-PB-1.0 www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Appendix A Programming Board Part number AS5030 AS5040 AS5043 AS5045 AS5046 AS5115 AS5130 AS5134 AS5140 AS5145 AS5163 AS5215 AS5245 AS5263 www.ams.com AS5030 PB AS5040 PB AS5043 PB AS5115 PB AS5130 PB AS5134 PB AS5163 PB AS5215 PB AS5245 PB AS5263 PB Supported by firmware ≥ ● Future Release 0.12 0.12 0.12 Future Release 2.24 Future Release 0.10 0.10 0.10 0.13 2.24 0.10 0.13 ● ● ● ● ● ● ● ● ● ● ● ● ● Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Index 1 General Overview ...................................................................................................................................................... 1 2 Hardware Components .............................................................................................................................................. 1 2.1 Description of the Hardware Components ........................................................................................................ 1 2.2 Description of the programming board.............................................................................................................. 3 3 Installation ................................................................................................................................................................. 4 3.1 Hardware setup ........................................................................................................................................................ 4 3.2 Installing the GUI on the PC ............................................................................................................................. 4 4 ......................................................................................................................................................................................... 5 5 ......................................................................................................................................................................................... 5 4 Graphical User Interface (GUI) .................................................................................................................................. 5 4.1 Programming the AS5040/AS5045/AS5140/AS5145/AS5045B ....................................................................... 6 4.1 Programming the AS5043................................................................................................................................. 9 4.2 Programming the AS5245............................................................................................................................... 11 4.3 Programming the AS5134............................................................................................................................... 13 4.4 Programming the AS5163/AS5263 ................................................................................................................. 16 4.5 Programming the AS5115/AS5215 ................................................................................................................. 16 5 Programming boards (PB) Schematics ................................................................................................................... 18 5.1 AS5040-PB-1.1 ............................................................................................................................................... 18 5.2 AS5043-PB-1.1 ............................................................................................................................................... 19 5.3 AS5115-PB1.1 ................................................................................................................................................ 20 5.4 AS5134-PB-1.1 ............................................................................................................................................... 20 5.5 AS5163-PB-1.0 ............................................................................................................................................... 21 5.6 AS5215-PB-1.1 ............................................................................................................................................... 21 5.7 AS5245-PB-1.1 ............................................................................................................................................... 21 5.8 AS5263-PB-1.0 ............................................................................................................................................... 22 Appendix A ....................................................................................................................................................................... 23 Revision History ............................................................................................................................................................... 25 Copyright .......................................................................................................................................................................... 26 Disclaimer ......................................................................................................................................................................... 26 www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Revision History Revision Date Description R1.0 March.29, 2008 New copy R1.1 May 22, 2008 All paragraphs, new pictures included R1.2 June 16, 2008 AS5134 device added R1.3 September 4, 2008 New devices added, minor corrections R1.4 September 26, 2008 Minor corrections R1.5 December 15, 2008 Minor corrections R1.6 January 26, 2009 Layout modification, PB schematics R1.7 March 3, 2009 Supported devices table added R1.8 August 10, 2009 AS5x40, AS5x45 chapter added, screenshot updated. R1.9 February 04, 2010 AS5134 updated, AS5143 removed, AS5245 added R1.10 March 04, 2010 AS5115, AS5215, AS5163 and AS5263 added R1.11 Feb, 2014 AS5045B added www.ams.com Revision 1.11/ 02/18/2014 Application Note – AS5000 Programmer Copyright Copyright © 1997-2012, 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. All products and companies mentioned are trademarks or registered trademarks of their respective companies. Disclaimer Devices sold by ams AG are covered by the warranty and patent indemnification provisions appearing in its Term of Sale. ams AG makes no warranty, express, statutory, implied, or by description regarding the information set forth herein or regarding the freedom of the described devices from patent infringement. ams AG reserves the right to change specifications and prices at any time and without notice. Therefore, prior to designing this product into a system, it is necessary to check with ams AG for current information. This product is intended for use in normal commercial applications. Applications requiring extended temperature range, unusual environmental requirements, or high reliability applications, such as military, medical life-support or lifesustaining equipment are specifically not recommended without additional processing by ams AG for each application. For shipments of less than 100 parts the manufacturing flow might show deviations from the standard production flow, such as test flow or test location. The information furnished here by ams AG is believed to be correct and accurate. However, 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 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. Contact Information Headquarters ams AG Tobelbader Strasse 30 8141 Unterpremstaetten Austria T. +43 (0) 3136 500 0 For Sales Offices, Distributors and Representatives, please visit: http://www.ams.com/contact www.ams.com Revision 1.11/ 02/18/2014