Rev A1, Page 1/14 DESCRIPTION ic-haus ic-mh16 evaluation software is developed for PCs running the Windows operating system. The evaluation software is developed in LabVIEW and requires a one-time installation of the LabVIEW Run-Time Engine (RTE) if it is not already installed. The RTE can be downloaded with the evaluation software using the download links below. The evaluation software comes in a.zip file and is downloaded using either of the following download links. The files from both links contain the ic-mh16 evaluation software and the drivers for the USB adapters used to connect with the ic-mh16. Please contact ic-tooling@ichaus.de for interest in the DLL used to develop the evaluation software. Features The evaluation software: Reduces the time and cost of evaluation and design-in Helps to manually set up the parameters of the ic-mh16 Can save configurations to the integrated zapping ROM Allows configurations to be saved and loaded to and from.cfg files Simplifies the reading and displaying of sensor data. Online software overview: http://www.ichaus.de/software Download package without the RTE with the RTE ic-mh16: http://www.ichaus.de/mh16_gui http://www.ichaus.de/mh16_gui_rte LabVIEW is a trademark of National Instruments. Copyright 2017 ic-haus http://www.ichaus.com
Rev A1, Page 2/14 CONTENTS KEY OF TERMS 3 INSTALLATION GUIDE 4 GENERAL SOFTWARE DESCRIPTION 5 Functional description............................................ 5 Connection with hardware......................................... 6 Device configuration............................................. 7 The Hex Editor................................................ 8 READING SENSOR DATA 9 ZAPPING WIZARD 10 CALIBRATION AND MEASUREMENT 12 TROUBLESHOOTING 14 Report generation.............................................. 14 REVISION HISTORY 14
Rev A1, Page 3/14 KEY OF TERMS These key words have specific meanings throughout this document. Adapter Chip Configuration DLL Evaluation Software Parameter Register RTE Smart Connect An MB3U, MB4U, or MB5U USB adapter used to connect the chip to the PC. The ic-mh16 on an evaluation board (eval board). The collection of the hexadecimal values of all parameters. A configuration can be saved as a.cfg or.hex file. The Dynamic Link Library of functions written in C++ for the purposes of communication of configuration and sensor data. Includes both the DLL and the GUI. A setting of fixed length, from 1 bit to 32 bits, which corresponds to one control in the GUI. Parameters are, in most cases, more user-friendly than reading and writing to registers. The usually one byte (8 bits) long units of memory in the chip or external memory with a hexadecimal address (e.g. 0x10). The LabVIEW Run-Time Engine. The automated function to establish a connection between the chip and the PC and synchronize the configurations of both the software and the chip.
Rev A1, Page 4/14 INSTALLATION GUIDE Online software overview: http://www.ichaus.de/software Software download without the RTE with the RTE ic-mh16: http://www.ichaus.de/mh16_gui http://www.ichaus.de/mh16_gui_rte 1. Navigate to ichaus.de/software and select the software for your device. If the 2011 LabVIEW RTE is already installed on your computer, download the software package "ic-mh16", otherwise download the full package "ic-mh16 with RTE". You can also use either of the direct links above to download the software. 2. Unzip the downloaded package. After unzipping the ic-mh16 software packages MH16_1SO_gui_xx or MH16_1SO_gui_xxrte, the following files are located in the selected working directory. Figure 1: Tree view of the downloaded software package, where "NN" is "MH16", "XX" is the revision, e.g. "A1", and "*" is "3", "4" or "5" 3. Run setup.exe to install the evaluation software for your product. 4. To communicate with the evaluation board, USB adapter drivers need to be installed. The driver installation must be completed successfully before connecting the adapter to your PC. If you have not already installed the driver for the USB adapter, run USB_MB * U_driver_xx.exe to install the necessary drivers for the MB3U, MB4U or MB5U. Note: Administrator rights are required to run installations.
Rev A1, Page 5/14 GENERAL SOFTWARE DESCRIPTION Functional description The ic-mh16 software starts in No Hardware mode. For a detailed description of the parameter settings, please refer to the ic-mh16 datasheet. When moving the mouse cursor to a parameter input box, a tool tip is displayed, identifying the corresponding parameter name as described in the datasheet. The options in the controls correspond to the options described in the datasheet. Simply click on the control to see the options, click on the new setting and this will be either set in the software or both set in the software and written to the chip. Figure 2: Green LEDs indicate status bits (good) and red LEDs indicate errors (bad) There are two types of LED indicators, green ones and red ones (see Figure 2). The green LEDs display the according status written next to them and the red LEDs errors. If an LED is on, it means that the corresponding status (green) is OK or an error (red) has occurred. Figure 3: Evaluation software start-up window
Rev A1, Page 6/14 The evaluation software is divided into the following six sections: 1 Menu Section Figure 4: The menu is used to choose the options below Tab Menu Option Functional Description File Save Config File Saves the current configuration from the software to a file (.cfg). Load Config File Loads a configuration file (.cfg) to the software. Exit Quits the software. Interface No Hardware Switches to No Hardware mode to virtually disconnect the adapter from the PC. ic-interface USB (MB*U) Connects to the specific MB*U USB adapter. Interface Setup Opens the adapter information and interface setup window. Smart Connect Enables/disables Smart Connect. It is recommended to have Smart Connect enabled. Initialize BiSS bus Initializes the BiSS communication to the ic-mh16. communication Read Device ID Reads the device ID registers (0x78... 0x7B) of the ic-mh16. Extras Parameter Search Shows the Parameter Search controls. Generate Report Generates a report of the current state of the software for debugging purposes. Help Software Documentation Hyperlinks to further hardware and software information. Datasheet Hyperlinks to the ic-mh16 datasheet. Web Page Hyperlinks to the ic-mh16 product web page. About ic-haus contact information and version control information. 2 Header Section Project title, software version, Parameter Search, Sensor ID/selection, and connection state. 3 Sensor Section Area to read and display sensor data. 4 Parameter Section Area to display and set the device s parameters. 5 Read/Write Section Reads and writes the configuration to and from the chip. 6 Status Section Displays feedback of carried out actions to the user. For a detailed description of parameter settings, please refer to the ic-mh16 s datasheet.
Rev A1, Page 7/14 Connection with hardware For easy to use hardware evaluation, all of our evaluation boards can be used with at least one of our USB adapters (MB3U, MB4U and MB5U) and connected in one click using Smart Connect. Figure 5: Click on this button to use Smart Connect to connect to the chip To be able to control an evaluation board using the software, connect your USB adapter (MB*U) with your computer and the evaluation board with the adapter. Then you only have to press the Smart Connect button, which automatically establishes a stable connection. Smart Connect: 1. Checks which adapter is connected 2. Sets the interface 3. Initializes the adapter 4. Tests the communication between the hardware and software 5. Reads the configuration from the chip into the software. If you are using multiple different adapters, you can connect using your preferred adapter by selecting it in the Interface menu or by using the corresponding keyboard shortcut. Note: Although it is highly recommended to use Smart Connect, you can deactivate Smart Connect in the menu. In this case, the combination of adapter and interface is chosen and no other function (e.g. initialization or reading the parameters from the chip) is executed. Device configuration After connecting with your device, you can control all parameters using the drop-down options for each parameter. You can also type in the hexadecimal value you want to set a parameter to directly. The parameter drop-down selector shows the value or property corresponding to the hexadecimal value, shown on the right, to which the parameter is set. Related parameters are grouped into sections, each group having its own tabulator (tab). Figure 6: Click on a parameter s control to see its options and choose your desired setting The parameters are named according to how they affect the functionality of the chip. By navigating to a parameter with the mouse cursor, their names, according to the datasheet, are shown in the Notes indicator on the bottom right of the window. Every parameter change is logged in the Protocol indicator in the bottom left of the window.
Rev A1, Page 8/14 Figure 7: Left, the Protocol indicator for feedback and right, the Notes indicator To search for a parameter by its name, you can type it in the search input field in the top center of the window. If you are not sure about the spelling of a parameter, the autofill can help you to find it. Pressing ENTER or clicking on the search button brings you to the tab containing the parameter and the control is then illuminated. Figure 8: The Parameter Search function Writing to the chip s RAM is reversible, which allows you to try out any desired configuration. The configuration you set in the software is written to the chip s RAM by pressing the Write RAM button. By pressing the Read RAM button, the configuration is read into the software. The default option Write Immediately helps you to keep the chip and the software synchronous, which is recommended. Enabling it causes the software to write every single parameter change to the chip s RAM. If disabled, you can set all parameters you wish and write them to the chip all at once by pressing the Write RAM button. Figure 9: The Read RAM and Write RAM buttons read and write the configurations from and to the chip Once you have a working system and you would like to restore the configuration at a later point in time, use the Save Config File function under File. This saves the configuration in Intel Hex format. Using Load Config File restores the configuration to the software. The Hex Editor The Hex Editor exists only for special purposes. Please use it only in cooperation with ic-haus. Note: Incorrect usage of the Hex Editor may damage or destroy your device.
Rev A1, Page 9/14 READING SENSOR DATA The evaluation software allows you to read the sensor data from your device and display it both as a raw number and in a visual format. Push the Read Sensor button to read the sensor data. If Read Continuously is checked, the data is read cyclically, otherwise it is read a single time. The error bits are overwritten every time the data is read. To prevent the possibility of not seeing an error when it occurs, check Stop On Error, which interrupts the reading of sensor data when an error occurs. The data is displayed in the indicator right next to the Read Sensor button. Using the drop-down selector under the Read Sensor button, you can change the display format. By enabling the additional Data Display window, the raw data, the corresponding angle, and the resolution are displayed. The data clock corresponds to the raw data and shows you the current position of your sensor graphically. Figure 10: Left: The Data Display window with the data clock, raw data, resolution, and angle. Right: The Status Information Window with gain, port, and error indicators. For additional information about the gain, active ports, and error types, enable the Status Information Window. If the options for continuous reading are enabled, the corresponding information will be refreshed while continuously reading the sensor data. If you are not reading the sensor data continuously, you can get the status information by pressing the corresponding Read buttons next to the indicators. Be aware that the refresh rate of the software slows down the more status or position information you want to read at the same time.
Rev A1, Page 10/14 ZAPPING WIZARD The Zapping Wizard demonstrates the zapping functionality of the ic-mh16. The wizard has different options for verification and zapping. Note: The Zapping Wizard is not meant for production. All functions that are used for the zapping procedure are available in the ic-mh16 DLL, which can be used for customer specified production software. B A C Figure 11: The Zapping Wizard Window including: A: Zapping Flowchart; B: Zapping Wizard; and C: Comparison Table. A: Zapping Flowchart This flowchart shows the recommended zapping procedure. There are two flowcharts, one with the internal test mode ENHC and one without it. Using ENHC is recommended because the test is more strict than without it and it saves time because the procedure can be fully automated using software. The process has two main procedures: verification and zapping. Already zapped bits should not be zapped again and already zapped bits can not be unzapped. To avoid zapping multiple times, the RAM configuration has to be compared to the ROM configuration. The verification procedure uses two test modes (Verify Low and Verify High). It is also important to figure out if the present configuration is even able to be zapped. For the zapping procedure, a bit mask, which is to be zapped, is generated from the verification step. This mask is zapped to the ic-mh16 during the zapping procedure. The chip can signal two different errors after the zapping procedure, PROG_ERROR and ZAP_ERROR. The main cause of these two errors is not using the correct zapping voltage at VZAP. After zapping, a verification is needed to see if the zapping was successful. If some bits were not successfully zapped, a new zapping process can be started from the verification information. Repeat this until the desired configuration is zapped to the ic-mh16.
Rev A1, Page 11/14 B: Zapping Wizard The Zapping Wizard is controlled here. It includes all steps from the flowchart, that need user interaction. 1. Start: here the user chooses to either verify or to verify and zap. Also the use of the test mode ENHC can be deactivated (not recommended). 2. Configuration: you can choose to use the current RAM configuration or load a configuration from a configuration file and write it to the ic-mh16. 3. Verify: Auto Verify: this starts the automatic verification procedure. This procedure is fully executed by the software. The results are shown in the comparison table. Low Voltage and High Voltage verification: these steps start the automatic verification procedure without using the test mode ENHC. The user has to change the voltage on VPA/VPD according to the wizard dialog. The results are shown in the comparison table. 4. ZAP: this dialog is only displayed if you have chosen the zapping procedure. It is also only displayed if there are still differences between the RAM and ROM after verification, which are able to be zapped. After the zapping procedure is executed, a verification is needed to verify its success. C: Comparison Table This table shows the result of the verification steps of the wizard. This table has three rows. The first row RAM shows the RAM of the ic-mh16 during the verification. The second and third rows Verify Low and Verify High show the ROM configuration read out from the chip. The ZAP registers are marked in three colors (see Figures 12 to 14). Green is shown if the ROM configuration matches the RAM configuration, yellow if the ROM configuration still misses zapped bits of the RAM configuration, and red if the ROM configuration has zapped bits, which are not set to 1 in the current RAM configuration. If the last case occurs, the zapping procedure is stopped because already zapped bits can not be unzapped. Figure 12: Verification result where the RAM matches the ROM Figure 13: Verification result with unzapped bits Figure 14: Verification error, zapping not possible
Rev A1, Page 12/14 CALIBRATION AND MEASUREMENT Note: The calibration using the ic-mh16 Calibrate and Measure window is not meant for production. All functions that are used for the calibration are available in the ic-mh16 DLL, which can be used for customer-specified production software. The Calibrate and Measure window demonstrates the analog calibration features of the ic-mh16 and simplifies the evaluation of the chip. The calibration calculations used in the Calibrate and Measure window are based on a time-based reference. Therefore good results will only achieved with a good time base, which happens when the axis turns at a constant velocity. Because a real-time sensor data acquisition is needed, the calibration only works with MB4U and MB5U adapters. Note: The user must validate the calibration results after the software calibration has been executed. A B C D Figure 15: Calibration and Measurement window with the sections: A: Calibration Graph; B: Calibration Settings; C: Calibration Functions; and D: Calibration Results. A: Calibration Graph The calibration curves show the results of the last measurement. The Error Curve (red) shows the nonlinearity/angular error of the ic-mh16. The Adjust Curve (blue) shows the errors which can be corrected by the ic-mh16. The encoder can adjust sine and cosine offsets, cosine amplitude, and harmonic errors.
Rev A1, Page 13/14 B: Calibration Settings The calibration settings are needed to adjust the calibration for your application. To get good calibration results, at least two full revolutions are to be acquired. The Calculated Sampling Time indicates how long the acquisition will take. It is equal to the number of Samples multiplied by the Frame Repetition Rate, which can be adjusted in the Interface Settings. See Table 1, page 13 for recommended settings. The calibration will take more time than the sample time because the ic-mh16 is reconfigured before and after the acquisition. C: Calibration Functions Reset to default resets the values of the parameters VOSS, VOSC, GCC, and HARMCAL to zero. Calibrate starts the calibration procedure. It includes a reconfiguration of the ic-mh16 for the acquisition (and restoration afterwards), the data acquisition, the analysis of the sensor data, and finally the adjustment of the analog parameters of the ic-mh16. The results are shown on the Calibration Graph and to the right of the Calibrate button. An automatic verification of the results is triggered by pressing the Measure button. Measure starts the measurement procedure. It includes a reconfiguration of the ic-mh16 for the acquisition (and restoration afterwards), the data acquisition, and the analysis of the sensor data. The results are shown on the calibration graph and to the right of the Measure button. If Measure Continuously is activated, a new measurement is started after the last successful measurement. This can be used to easily evaluate the effects of mechanical misalignment between the magnet and the ic-mh16. D: Calibration Results The ic-mh16 provides four parameters to calibrate the encoder for your application. These parameters are the Sine Offset Calibration (VOSS), Cosine Offset Calibration (VOSC), Cosine Amplification Calibration (GCC), and Harmonic Calibration (HARMCAL). The first row shows the present values of these parameters. The second row shows the results of the last executed calibration, which were written to the ic-mh16. The third row shows the results of the last executed measurement. These results were not written to the ic-mh16. The Calibration Results show the correction, in LSB, needed to adjust the parameter values of the ic-mh16 for calibration. For example, if you have VOSC (in the first row) of 0 mv, execute a measurement and the result is -6 LSB. This would mean that you should decrease the parameter VOSC by 6 LSB, which displays -6 mv in the parameter s control. The relative changes in the Calibration Results correspond to the adjust curve of the Calibration Graph. Revolutions and Rotational Velocity show the movement information of the last acquisition. The leading sign indicates the rotation direction. A positive value indicates a clockwise rotation and a negative counter-clockwise. Calibration Settings RPM Samples Frame Repetition Sampling Measured Revolutions min. max. Samples Rate (AGS in µs) time in ms for min. RPM for max. RPM 10 60 3000 4000 12000 2.00 12.0 60 180 1500 1500 2250 2.3 6.8 180 400 1500 750 1125 3.4 7.5 400 1200 1500 250 375 2.5 7.5 1200 3600 1000 100 100 2.0 6.0 3600 8000 1000 50 50 3.0 6.7 Table 1: Recommended calibration settings
Rev A1, Page 14/14 TROUBLESHOOTING Report generation If you have an issue that you can not resolve with the given information, please use the automated report generation function, which collects information about the steps you carried out and the current state of the software. There are three ways to generate a report. The first is by pressing the Generate Report button when an error message appears. The second is to click on the menu item Extras Generate Report and the third is to press the shortcut Ctrl + F12. A.zip file will be generated and saved to a directory of your choice. The.zip file contains screenshots of every window of the software, the initial file, the currently loaded configuration, and the content of the protocol. If you are facing such an issue, please contact our support team by sending an e-mail including the report file to ic-tooling@ichaus.de. Figure 16: Press this menu item to generate a report REVISION HISTORY Rev. Notes Pages affected GUI rev. A1 Initial version All pages C1 ic-haus expressly reserves the right to change its products and/or specifications. An Infoletter gives details as to any amendments and additions made to the relevant current specifications on our internet website www.ichaus.com/infoletter and is automatically generated and shall be sent to registered users by email. Copying even as an excerpt is only permitted with ic-haus approval in writing and precise reference to source. The data specified is intended solely for the purpose of product description and shall represent the usual quality of the product. In case the specifications contain obvious mistakes e.g. in writing or calculation, ic-haus reserves the right to correct the specification and no liability arises insofar that the specification was from a third party view obviously not reliable. There shall be no claims based on defects as to quality in cases of insignificant deviations from the specifications or in case of only minor impairment of usability. No representations or warranties, either expressed or implied, of merchantability, fitness for a particular purpose or of any other nature are made hereunder with respect to information/specification or the products to which information refers and no guarantee with respect to compliance to the intended use is given. In particular, this also applies to the stated possible applications or areas of applications of the product. ic-haus products are not designed for and must not be used in connection with any applications where the failure of such products would reasonably be expected to result in significant personal injury or death (Safety-Critical Applications) without ic-haus specific written consent. Safety-Critical Applications include, without limitation, life support devices and systems. ic-haus products are not designed nor intended for use in military or aerospace applications or environments or in automotive applications unless specifically designated for such use by ic-haus. ic-haus conveys no patent, copyright, mask work right or other trade mark right to this product. ic-haus assumes no liability for any patent and/or other trade mark rights of a third party resulting from processing or handling of the product and/or any other use of the product. Software and its documentation is provided by ic-haus GmbH or contributors "AS IS" and is subject to the ZVEI General Conditions for the Supply of Products and Services with ic-haus amendments and the ZVEI Software clause with ic-haus amendments (www.ichaus.com/eula).