STMICROELECTRONICS UM1486

UM1486
User manual
iNEMOENgine_PW8
software package
Introduction
This document describes the features of the iNEMOENgine_PW8 software package and the
device firmware upgrade (DFU) procedure to upload it to the microcontroller of the STEVALMKI119V1 MEMS sensor demonstration kit.
November 2011
Doc ID 022415 Rev 1
1/12
www.st.com
Contents
UM1486
Contents
1
Software package description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2
iNEMOENgine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3
Device upgrade procedure (DFU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4
3.1
DFU software installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.2
Firmware upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Using the board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1
5
2/12
Board calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Doc ID 022415 Rev 1
UM1486
List of figures
List of figures
Figure 1.
Figure 2.
Figure 3.
Figure 4.
Figure 5.
Figure 6.
DfuSe user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
STEVAL-MKI119V1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Device manager - no DFU driver installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Device manager - DFU driver installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Free movement calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Fixed movement calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Doc ID 022415 Rev 1
3/12
Software package description
1
UM1486
Software package description
The iNEMOENgine_PW8 software package includes the following directory structure:
4/12
–
Doc: contains the license agreement for the software, the release notes and this
document
–
DFU: contains the installation package for the software needed to upgrade the
firmware of the STEVAL-MKI119V1 demonstration kit
–
Firmware: contains the binary file that can be flashed to the microcontroller of the
STEVAL-MKI119V1 using the DFU software
Doc ID 022415 Rev 1
UM1486
2
iNEMOENgine
iNEMOENgine
The iNEMOENgine_PW8 software package includes the iNEMOENgine library.
The iNEMOENgine is a new, advanced software engine that fuses accelerometer,
gyroscope and magnetometer data to deliver accurate and reliable motion-sensing
information that is easy to integrate into smart consumer devices.
The iNEMOENgine fuses data from the integrated 9-axis sensor suite with advanced
algorithms that use true high-number-of-states adaptive Kalman filtering.
The iNEMOENgine’s adaptive filters converge so that correct heading data overrides
magnetic distortions and anomalies, resulting in more accurate and reliable data.
iNEMO allows the correction of:
●
magnetic distortions registered on the magnetometers
●
dynamic distortion measured by the accelerometers
●
inherent drift of the gyroscope over time
The iNEMO engine integrates all 9 inertial axes plus compass with complex fusion
algorithms, so the output of the sensor cluster is optimized.
This allows for faster, easier integration into smart consumer devices and higher
performance of the solution as a whole.
Library output:
●
Quaternions four number hpr system
●
Rotation: heading, pitch, and roll
●
Linear acceleration: device frame linear accelerations
●
Gravity: device frame gravity acceleration
Doc ID 022415 Rev 1
5/12
Device upgrade procedure (DFU)
UM1486
3
Device upgrade procedure (DFU)
3.1
DFU software installation
Run the DfuSe_Demo_V3.0_Setup.exe file located in the DFU directory of the software
package. The InstallShield Wizard will guide you to install the DfuSe applications and
source code on your computer. When the software is successfully installed, click the “Finish”
button. You can then explore the driver directory.
The driver files are located in the “Driver” directory in the install path (C:\Program
files\STMicroelectronics\DfuSe).
The documentation is located in the
“C:\Program Files\STMicroelectronics\DfuSe\Sources\Doc” folder.
Figure 1.
DfuSe user interface
!-V
6/12
Doc ID 022415 Rev 1
UM1486
3.2
Device upgrade procedure (DFU)
Firmware upgrade
1.
While keeping button 1 on the board (Figure 2, item 1) pressed, connect the device to a
spare USB port on your PC. LED 1, 2 and 3 (Figure 2, item 2) will switch ON to signal
that the microcontroller has entered DFU mode.
2.
Open the Device Manager, and go to “Other devices”. Right click on the “STM32 DFU”
item (Figure 3) and select “Update Driver...”. Use the drivers located in the “C:\Program
Files\STMicroelectronics\Software\DfuSe\Driver” folder.
3.
The driver is now correctly installed (Figure 4).
4.
Run the “DfuSe demonstration” application (Start -> All Programs ->
STMicroelectronics -> DfuSe -> DfuSe Demonstration or
C:\Program Files\STMicroelectronics\Software\DfuSe\BIN\DfuSeDemo.exe). The
STEVAL-MKI119V1 is recognized in DFU mode (Figure 1, item 4).
5.
Click the “Choose” button (Figure 1, item 1) to select the DFU file provided with the
package in the Firmware directory. The displayed information, such as VID, PID,
Version and target number is read from the DFU file.
6.
Click the “Upgrade” button (Figure 1, item 2) to start upgrading file content to the
memory.
7.
Click the “Verify” button (Figure 1, item 3) to verify that the data was successfully
downloaded.
8.
Click the “Leave DFU mode” button (Figure 1, item 5) or disconnect the board.
The firmware is now updated and the board ready to be used.
Figure 2.
STEVAL-MKI119V1
!-V
Doc ID 022415 Rev 1
7/12
Device upgrade procedure (DFU)
Figure 3.
UM1486
Device manager - no DFU driver installed
!-V
Figure 4.
Device manager - DFU driver installed
!-V
8/12
Doc ID 022415 Rev 1
UM1486
4
Using the board
Using the board
Once the STEVAL-MKI119V1 has been upgraded with the iNEMOENgine_PW8 software
package, it allows connection through the USB interface to any PC running the Windows 8
operating system. After the kit is connected, it is recognized as an HID sensor cluster and
accesses gyroscope, accelerometer, heading, inclinometer and quaternions data to be
employed for user applications.
4.1
Board calibration
Before using the board for the first time, calibration is required. To enable the calibration
routine, press button 3 (Figure 2, item 4). LED D6 of the board (Figure 2, item 2) will remain
ON until the calibration routine is completed.
Two movements may be executed to calibrate the board:
1.
Move the board in the space as shown in Figure 5
Figure 5.
2.
Free movement calibration
Move the board in the space as described in Figure 6
Doc ID 022415 Rev 1
9/12
Using the board
Figure 6.
UM1486
Fixed movement calibration
3IDEVIEW
53"
3TEP
3TEP
3TEP
3TEP
&RONTVIEW
53"
3TEP
3TEP
3TEP
3TEP
3IDEVIEW
3TEP
!-V
10/12
Doc ID 022415 Rev 1
UM1486
5
Revision history
Revision history
Table 1.
Document revision history
Date
Revision
02-Nov-2011
1
Changes
Initial release.
Doc ID 022415 Rev 1
11/12
UM1486
Please Read Carefully:
Information in this document is provided solely in connection with ST products. STMicroelectronics NV and its subsidiaries (“ST”) reserve the
right to make changes, corrections, modifications or improvements, to this document, and the products and services described herein at any
time, without notice.
All ST products are sold pursuant to ST’s terms and conditions of sale.
Purchasers are solely responsible for the choice, selection and use of the ST products and services described herein, and ST assumes no
liability whatsoever relating to the choice, selection or use of the ST products and services described herein.
No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted under this document. If any part of this
document refers to any third party products or services it shall not be deemed a license grant by ST for the use of such third party products
or services, or any intellectual property contained therein or considered as a warranty covering the use in any manner whatsoever of such
third party products or services or any intellectual property contained therein.
UNLESS OTHERWISE SET FORTH IN ST’S TERMS AND CONDITIONS OF SALE ST DISCLAIMS ANY EXPRESS OR IMPLIED
WARRANTY WITH RESPECT TO THE USE AND/OR SALE OF ST PRODUCTS INCLUDING WITHOUT LIMITATION IMPLIED
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE (AND THEIR EQUIVALENTS UNDER THE LAWS
OF ANY JURISDICTION), OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT.
UNLESS EXPRESSLY APPROVED IN WRITING BY TWO AUTHORIZED ST REPRESENTATIVES, ST PRODUCTS ARE NOT
RECOMMENDED, AUTHORIZED OR WARRANTED FOR USE IN MILITARY, AIR CRAFT, SPACE, LIFE SAVING, OR LIFE SUSTAINING
APPLICATIONS, NOR IN PRODUCTS OR SYSTEMS WHERE FAILURE OR MALFUNCTION MAY RESULT IN PERSONAL INJURY,
DEATH, OR SEVERE PROPERTY OR ENVIRONMENTAL DAMAGE. ST PRODUCTS WHICH ARE NOT SPECIFIED AS "AUTOMOTIVE
GRADE" MAY ONLY BE USED IN AUTOMOTIVE APPLICATIONS AT USER’S OWN RISK.
Resale of ST products with provisions different from the statements and/or technical features set forth in this document shall immediately void
any warranty granted by ST for the ST product or service described herein and shall not create or extend in any manner whatsoever, any
liability of ST.
ST and the ST logo are trademarks or registered trademarks of ST in various countries.
Information in this document supersedes and replaces all information previously supplied.
The ST logo is a registered trademark of STMicroelectronics. All other names are the property of their respective owners.
© 2011 STMicroelectronics - All rights reserved
STMicroelectronics group of companies
Australia - Belgium - Brazil - Canada - China - Czech Republic - Finland - France - Germany - Hong Kong - India - Israel - Italy - Japan Malaysia - Malta - Morocco - Philippines - Singapore - Spain - Sweden - Switzerland - United Kingdom - United States of America
www.st.com
12/12
Doc ID 022415 Rev 1