Quick Start Guide - waveshare

Version 1.1 (Jun 15, 2015)

Quick Start GuideMotion MEMS and environmental sensor expansion board for

STM32 Nucleo

(X-NUCLEO-IKS01A1)

Overview2

Introduction to the STM32 Open Development Environment

STM32 Nucleo Motion MEMS and environmental sensor expansion board• Hardware overview

• Software overview

Documents & related resources

Setup & demo examples

1

2

3

4

Overview3






1

2

3

4

Market

STM32 Open Development EnvironmentLowering the barriers for “developers”

4

Device

prototypeForm-factor

deviceFinal

device

IdeaApplication

software

development

Field

testing

Commercial

software

Fast, flexible, affordable and based on commercial components

Easy access to technology

Scalable software for faster time to market

STM32 Nucleo

development boards

STM32Cube

development software

STM32Cube

expansion software

STM32 Nucleo

expansion boards

Compatibility with

multiple development environments

STM32 Open Development Environment

The STM32 Open Development Environment consists

of a set of modular developer boards and a

software environment designed around the STM32

microcontroller family

5

STM32 Open Development EnvironmentBuilding block approach

6

Move / Actuate

Connect

Power

Sense

Process

Inertial modules, magnetometer,

Proximity, microphone

Pressure, temperature, humidity, UV,

Bluetooth LE, Sub-GHz radio,

NFC, Wi-Fi, GNSS

Energy management & battery

General-purpose microcontrollers

Stepper motor driver

DC & BLDC motor driver

Audio amplifier

COLLECT

TRANSMIT

ACCESS

CREATE

POWER

PROCESS

Software

Secure microcontrollers

Touch controller

Operational amplifier

Accelerometer, gyroscope,

Translate

www.st.com/stm32ode

The building blocks Your need Our answer

• Based on ST’s 32-bit ARM

Cortex-M based STM32

microprocessors

• Development boards with 1 MCU and

hardware to program/debug

• Two connectors for companion

chip boards

• For all STM32 families

STM32 Nucleo Development Board7

Arduino UNO extension

connectors for easy access to

add-ons (*)

Integrated debugging and

programming probe

STM32 microcontroller

Flexible board power supply

through USB or external source

(*) Thanks to its electrical compatibility, it can be used as a shield for Arduino UNO R3 or similar.

Complete product range

from ultra-low power to high-performance

Morpho extension headers for

direct access to all STM32 I/Os

Overview8






1

2

3

4

Key products on board

LSM6DS0: MEMS 3D accelerometer (±2/±4/±8 g) + 3D

gyroscope (±245/±500/±2000 dps)

LIS3MDL: MEMS 3D magnetometer (±4/ ±8/ ±12/ 16 gauss)

LPS25HB: MEMS pressure sensor, 260-1260 hPa absolute

digital output barometer

HTS221: Capacitive digital relative humidity and temperature

DIL 24-pin: Socket available for additional MEMS adapters

and other sensors (UV index)

DIL 24-pin

Motion MEMS and environmental sensor expansion board

Hardware overview (1/2) 9

Hardware description

• The X-NUCLEO-IKS01A1 is a motion MEMS and

environmental sensor evaluation board system.

• It is compatible with the Arduino UNO R3 connector

layout, and is designed around ST’s latest sensors.

Order code: X-NUCLEO-IKS01A1

Arduino UNO R3 connector

ST Morpho connector**

** Connector for the STM32 Nucleo Board

HTS221

LPS25HB

LSM6DS0

LIS3MDL

Latest info available at

X-NUCLEO-IKS01A1

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=LSM6DS0&s_searchtype=LSM6DS0

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=LIS3MDL&s_searchtype=LIS3MDL

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=LPS25HB&s_searchtype=LPS25HB

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=HTS221&s_searchtype=HTS221

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=X-NUCLEO-IKS01A1&s_searchtype=X-NUCLEO-IKS01A1


Hardware overview (2/2) 10

Key features

• The X-NUCLEO-IKS01A1 is a motion MEMS and

environmental sensor evaluation board system.

• All sensor sensors are connected on a single I²C bus

• Sensor I²C address selection

• Each sensor has separate power supply lines

allowing power consumption measurements

• Sensor disconnection (disconnects the I²C bus as

well as the power supply)

• Interrupt and DRDY signals from sensors

• DIL24 socket (compatible with STEVAL-MKI***V*

MEMS adapter boards)

Order code: X-NUCLEO-IKS01A1

* is used as a wildcard character for related part number

http://www.st.com/web/en/catalog/tools/FM116/SC1248/PF261191



Software overview (1/2) 11

X-CUBE-MEMS1 software description

• The X-CUBE-MEMS1 software package is an expansion for

STM32Cube, associated with the X-NUCLEO-IKS01A1

expansion board.

• It is compatible with NUCLEO-F401RE, NUCLEO-L053R8 or

NUCLEO-L152RE

Key features

• Complete middleware to build applications using temperature

and humidity sensors (HTS221), pressure sensor (LPS25HB)

and motion sensors (LIS3MDL and LSM6DS0)

• Easy portability across different MCU families, thanks to

STM32Cube

• Sample application to transmit real-time sensor data to a PC

• PC-based application (Windows®) to log sensor data

• Low-power optimization (suitable for the STM32L0 MCU

family)

• Free, user-friendly license terms

X-CUBE-MEMS1

Latest software available at

Overall software architecture

Hardware abstraction layer API Board support packages

Drivers

Board demonstrations

X-NUCLEO-IKS01A1 Expansion boardSTM32 Nucleo board

MiddlewareCMSIS

Utilities

Hardware components

STM32 HTS221

Applications

Sample application

Serial

LPS25HB LSM6DS0 LIS3MDL

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=X-CUBE-MEMS1&s_searchtype=X-CUBE-MEMS1


Software overview (2/2) 12

osxMotionFX software description

• The package is an add-on for X-CUBE-MEMS1 providing real-

time motion sensor data fusion and gyroscope bias and

magnetometer calibration routines

• The package contains source code examples (Keil, IAR,

System Workbench) based only on NUCLEO-F401RE

Key features

• osxMotionFX (iNEMOEngine PRO) real-time motion-sensor

data fusion (under OPEN.MEMS license)

• Complete middleware to build applications using temperature

and humidity sensor (HTS221), pressure sensor (LPS25HB)

and motion sensors (LIS3MDL and LSM6DS0)

• Gyroscope bias and magnetometer calibration routine

• Easy portability across different MCU families, thanks to

STM32Cube

• Sample application to transmit real-time both sensor data and

sensor fusion data to a PC

• Sample implementation available on board X-NUCLEO-

IKS01A1 when connected to NUCLEO-F401RE

Overall software architecture

osxMotionFX

Software webpage:

Hardware abstraction layer API Board support packages

Drivers

Board demonstrations

X-NUCLEO-IKS01A1 expansion boardSTM32 Nucleo board

MiddlewareCMSIS

Utilities

Hardware components

STM32 HTS221

Applications

Sample application

Serial

LPS25HB LSM6DS0 LIS3MDL

osxMotionFX

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=osxMotionFX&s_searchtype=osxMotionFX

Overview13






1

2

3

4


X-NUCLEO-IKS01A1: Product webpage (Link)

• Gerber files, BOM, Schematics

• DS10619: Motion MEMS and environmental sensor expansion board for STM32

Nucleo - Databrief

• UM1820: Getting started with motion MEMS and environmental sensor

expansion board for STM32 Nucleo – User manual

X-CUBE-MEMS1: Product webpage (Link)

• DB2442: Motion MEMS and environmental sensor software expansion for

STM32Cube - Databrief

• UM1859: Getting started with the X-CUBE-MEMS1 motion MEMS and

environmental sensor software expansion for STM32Cube – User manual

• SW Setup File

osxMotionFX: Product webpage (Link)

• DB2531: Real-time motion-sensor data fusion software expansion for

STM32Cube - Databrief

• UM1866: Getting started with the osxMotionFx fusion and compass library for X-

CUBE-MEMS1 expansion for STM32Cube – User manual

• Software setup file

14

All documents are available in the Design Resources tab of the

product webpage

X-NUCLEO-IKS01A1Product webpage

Design Resources tab



http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=osxMotionFX&s_searchtype=osxMotionFX

Overview15






1

2

3

4


Hardware prerequisites 16

• Motion MEMS and environmental sensor expansion

board (X-NUCLEO-IKS01A1)

• STM32 Nucleo development board

(NUCLEO-F401RE, NUCLEO-L053R8 or NUCLEO-

L152RE)

• Windows 8/7 - Laptop/PC

• 1 x mini USB cable

Mini USB X-NUCLEO-IKS01A1

NUCLEO-F401RE / NUCLEO-L053R8 /

NUCLEO-L152RE


http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=NUCLEO-F401RE&s_searchtype=NUCLEO-F401RE

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=NUCLEO-L053R8&s_searchtype=NUCLEO-L053R8

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=NUCLEO-L152RE&s_searchtype=NUCLEO-L152RE


Software prerequisites 17

• ST-LINK/V2-1 USB driver (Link)

• ST-LINK/V2-1 firmware upgrade (Link)

• X-CUBE-MEMS1 (Link)

• Copy the .zip file content into a folder on your PC

• The package contains source code examples (Keil, IAR, System Workbench) based on NUCLEO-F401RE, NUCLEO-L053R8 or NUCLEO-L152RE

• OSXMotionFX (Link)

• The package is an add-on for X-CUBE-MEMS1 providing real-time motion sensor data fusion and gyroscope bias and magnetometer calibration routines

• The package contains source code examples (Keil, IAR, System Workbench) based only on NUCLEO-F401RE

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=STSW-LINK009&s_searchtype=STSW-LINK009




http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=NUCLEO-L053R8&s_searchtype=NUCLEO-L053R8

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=NUCLEO-L152RE&s_searchtype=NUCLEO-L152RE

http://www.st.com/stonline/stappl/productcatalog/app?page=partNumberSearchPage&search=OSXMotionFX&s_searchtype=OSXMotionFX


X-CUBE-MEMS1 in 7 steps

Use of Sensors_DataLog GUI with precompiled BIN FW 18

Download & unpack

www.st.com/x-nucleo

www.st.com

1

2

3

4

X-CUBE-MEMS1X-NUCLEO-IKS01A1

Select

Docs

Low-level sensor drivers

Serial utility

L0 / F4/ L1 DataLog FW src code + binary

PC GUI (Sensors_DataLog)

X-CUBE-MEMS1 package structure

Download & install STM32

Nucleo ST-LINK/V2-1 USB driver

STSW-LINK009

(Link)

5

Download / Install / Run

ST-Link FW Upgrade utility

STSW-LINK007

(Link)

X-CUBE-MEMS1 for NUCLEO-F401RE or NUCLEO-L053R8 or NUCLEO-L152RE

http://www.st.com/x-nucleo



X-CUBE-MEMS1 in 7 steps

Use of Sensors_DataLog GUI with precompiled BIN fmw 19

drag and drop DataLog.bin for F4 or for L0 or for L1

on Nucleo drive

Open Utilities Folder in the X-CUBE-MEMS1 SW package

7

…and Run Sensors_DataLog

PC GUI

6

\STM32CubeExpansion_MEMS1_V1.3.0\Projects\Multi\Examples\DataLog\Binary\STM32F401RE-Nucleo

\STM32CubeExpansion_MEMS1_V1.3.0\Projects\Multi\Examples\DataLog\Binary\STM32L053R8-Nucleo

\STM32CubeExpansion_MEMS1_V1.3.0\Projects\Multi\Examples\DataLog\Binary\STM32L152RE-Nucleo

X-CUBE-MEMS1 for NUCLEO-F401RE or NUCLEO-L053R8 or NUCLEO-L152RE

X-CUBE-MEMS1

Utilities - Sensors_DataLog 20

Sensors_DataLog PC GUI

1Select COM port

3

Select sensors

2

Select sensor reading

interval

4 Select graph plots

Data Log Area

5

Start data logging

X-CUBE-MEMS1 for NUCLEO-F401RE, NUCLEO-L053R8 or NUCLEO-L152RE

X-CUBE-MEMS1

Compile the DataLog FW using a supported IDE 21

Download & unpack

www.st.com/x-nucleo

www.st.com

1

2

3

4

X-CUBE-MEMS1X-NUCLEO-IKS01A1

Select

Docs

Low-level sensor drivers

Serial utility

L0 / F4 / L1 example (DataLog FW)

PC GUI (Sensors_DataLog)

X-CUBE-MEMS1 package structure

X-CUBE-MEMS1 for NUCLEO-F401RE, NUCLEO-L053R8 or NUCLEO-L152RE

.\STM32CubeExpansion_MEMS1_V1.3.0\Projects\Multi\Examples\DataLog\EWARM\STM32F401RE-Nucleo

Flash and run the project.

X-CUBE-MEMS1

Using serial line monitor – e.g.TeraTerm

• Close the Sensors_DataLog GUI

• Configure the serial line monitor (speed, LF)

• Press the BLUE user button on STM32Nucleo

22

X-CUBE-MEMS1 for NUCLEO-F401RE, NUCLEO-L053R8 or

NUCLEO-L152RE

OSXMotionFX in few steps

OSXMotionFX Sensor Fusion license request 23

Installer

www.st.com/openmems

www.st.com

1

2

OSXMotionFX

Download OSXMotionFX

OSXMotionFX for NUCLEO-F401RE

3Install OSXMotionFX

in the X-CUBE-MEMS1

workspace

24

OSXMotionFX in few steps

OSXMotionFX Sensor Fusion license request

Click: Send License request email

c:\Program Files (x86)\STMicroelectronics\OpenSoftwareX\OSX_LicenseWizard\

3

4

• Click: Identify STM32Nucleo board

• Enter user information

• Click: Generate license request56

Run OsX License wizard


OSXMotionFX in 5 stepsStart using the DataLogFusion or coding your ideas in just few minutes 25

License activation email received

Start developing(demo project included)

1


.\STM32CubeExpansion_MEMS1_V1.3.0\Middlewares\

ST\STM32_OSX_MotionFX_Library\

2 Copy the license key in osx_license.h located in

. \STM32CubeExpansion_MEMS1_V1.3.0\Projects\STM32F4xx-Nucleo\

Applications\DataLogFusion\EWARM\

3 Open for example IAR project from

. \STM32CubeExpansion_MEMS1_V1.3.0\Utilities\PC_software\Sensors_DataLog\

4

5

• Run the X-CUBE-MEMS1 GUI

• Click: Start Sensor Fusion

• Make figure-8 movement to

calibrate magnetometer, green

LED2 on Flash and Run the project

www.st.com/stm32ode