boards/arm/hexiwear_k64/doc/hexiwear_k64.rst - third_party/github/zephyrproject-rtos/zephyr - Git at Google

 .. _hexiwear_k64:

 Hexiwear
 ########

 Overview
 ********

 Hexiwear is powered by a Kinetis K64 microcontroller based on the ARM Cortex-M4
 core. Another Kinetis wireless MCU, the KW40Z, provides Bluetooth Low Energy
 connectivity. Hexiwear also integrates a wide variety of sensors, as well as a
 user interface consisting of a 1.1” 96px x 96px full color OLED display and six
 capacitive buttons with haptic feedback.

 - Eye-catching Smart Watch form factor with powerful, low power Kinetis K6x MCU
   and 6 on-board sensors.
 - Designed for wearable applications with the onboard rechargeable battery,
   OLED screen and onboard sensors such as optical heart rate, accelerometer,
   magnetometer and gyroscope.
 - Designed for IoT end node applications with the onboard sensor’s such as
   temperature, pressure, humidity and ambient light.
 - Flexibility to let you add the sensors of your choice nearly 200 additional
   sensors through click boards.

 .. image:: hexiwear_k64.jpg
    :width: 442px
    :align: center
    :alt: Hexiwear

 Hardware
 ********

 - Main MCU: NXP Kinetis K64x (ARM Cortex-M4, 120 MHz, 1M Flash, 256K SRAM)
 - Wireless MCU: NXP Kinetis KW4x (ARM Cortex-M0+, Bluetooth Low Energy &
   802.15.4 radio)
 - 6-axis combo Accelerometer and Magnetometer NXP FXOS8700
 - 3-Axis Gyroscope: NXP FXAS21002
 - Absolute Pressure sensor NXP MPL3115
 - Li-Ion/Li-Po Battery Charger NXP MC34671
 - Optical heart rate sensor Maxim MAX30101
 - Ambient Light sensor, Humidity and Temperature sensor
 - 1.1” full color OLED display
 - Haptic feedback engine
 - 190 mAh 2C Li-Po battery
 - Capacitive touch interface
 - RGB LED

 For more information about the K64F SoC and Hexiwear board:

 - `K64F Website`_
 - `K64F Datasheet`_
 - `K64F Reference Manual`_
 - `Hexiwear Website`_
 - `Hexiwear Fact Sheet`_
 - `Hexiwear Schematics`_

 Supported Features
 ==================

 The hexiwear_k64 board configuration supports the following hardware features:

 +-----------+------------+-------------------------------------+
 | Interface | Controller | Driver/Component                    |
 +===========+============+=====================================+
 | NVIC      | on-chip    | nested vector interrupt controller  |
 +-----------+------------+-------------------------------------+
 | SYSTICK   | on-chip    | systick                             |
 +-----------+------------+-------------------------------------+
 | PINMUX    | on-chip    | pinmux                              |
 +-----------+------------+-------------------------------------+
 | GPIO      | on-chip    | gpio                                |
 +-----------+------------+-------------------------------------+
 | I2C       | on-chip    | i2c                                 |
 +-----------+------------+-------------------------------------+
 | UART      | on-chip    | serial port-polling;                |
 |           |            | serial port-interrupt               |
 +-----------+------------+-------------------------------------+
 | FLASH     | on-chip    | soc flash                           |
 +-----------+------------+-------------------------------------+
 | SENSOR    | off-chip   | fxos8700 polling;                   |
 |           |            | fxos8700 trigger                    |
 +-----------+------------+-------------------------------------+

 The default configuration can be found in the defconfig file:

 	``boards/arm/hexiwear_k64/hexiwear_k64_defconfig``

 Other hardware features are not currently supported by the port.

 Connections and IOs
 ===================

 The K64F SoC has five pairs of pinmux/gpio controllers.

 +-------+-----------------+---------------------------+
 | Name  | Function        | Usage                     |
 +=======+=================+===========================+
 | PTC8  | GPIO            | Red LED                   |
 +-------+-----------------+---------------------------+
 | PTC9  | GPIO            | Green LED                 |
 +-------+-----------------+---------------------------+
 | PTD0  | GPIO            | Blue LED                  |
 +-------+-----------------+---------------------------+
 | PTD13 | GPIO            | FXOS8700 INT2             |
 +-------+-----------------+---------------------------+
 | PTB16 | UART0_RX        | UART Console              |
 +-------+-----------------+---------------------------+
 | PTB17 | UART0_TX        | UART Console              |
 +-------+-----------------+---------------------------+
 | PTE24 | UART4_RX        | UART BT HCI               |
 +-------+-----------------+---------------------------+
 | PTE25 | UART4_TX        | UART BT HCI               |
 +-------+-----------------+---------------------------+
 | PTC10 | I2C1_SCL        | I2C / FXOS8700            |
 +-------+-----------------+---------------------------+
 | PTC11 | I2C1_SDA        | I2C / FXOS8700            |
 +-------+-----------------+---------------------------+

 System Clock
 ============

 The K64F SoC is configured to use the 12 MHz external oscillator on the board
 with the on-chip PLL to generate a 120 MHz system clock.

 Serial Port
 ===========

 The K64F SoC has six UARTs. One is configured for the console, another for BT
 HCI, and the remaining are not used.

 Programming and Debugging
 *************************

 Flashing
 ========

 The Hexiwear docking station includes an `OpenSDA`_ serial and debug adaptor
 built into the board. The adaptor provides:

 - A USB connection to the host computer, which exposes a Mass Storage and an
   USB Serial Port.
 - A Serial Flash device, which implements the USB flash disk file storage.
 - A physical UART connection which is relayed over interface USB Serial port.

 .. note::
    The OpenSDA is shared between the K64 and the KW40Z via switches, therefore
    only one SoC can be flashed, debugged, or have an open console at a time.

 Flashing an application to Hexiwear
 -----------------------------------

 #. Build the Zephyr kernel and application:

    .. code-block:: console

       $ cd $ZEPHYR_BASE
       $ . zephyr-env.sh
       $ cd $ZEPHYR_BASE/samples/hello_world/
       $ make BOARD=hexiwear_k64

 #. Make sure the docking station USB cable is unplugged.
 #. Attach the Hexiwear board to the docking station.
 #. Configure the docking station switches to route the desired SoC signals to
    the OpenSDA circuit:

    +--------+-------------+-------+-----+
    | Switch | Signal      | KW40Z | K64 |
    +========+=============+=======+=====+
    | 1      | MK64 SWDIO  | OFF   | ON  |
    +--------+-------------+-------+-----+
    | 2      | MK64 RST    | OFF   | ON  |
    +--------+-------------+-------+-----+
    | 3      | MKW40 RST   | ON    | OFF |
    +--------+-------------+-------+-----+
    | 4      | MKW40 SWDIO | ON    | OFF |
    +--------+-------------+-------+-----+
    | 5      | OSDA        | ON    | ON  |
    +--------+-------------+-------+-----+
    | 6      | LED1        | OFF   | OFF |
    +--------+-------------+-------+-----+
    | 7      | LED2        | OFF   | OFF |
    +--------+-------------+-------+-----+
    | 8      | LED3        | OFF   | OFF |
    +--------+-------------+-------+-----+

 #. Attach the USB cable and make sure the power switch is ON. A USB Mass
    Storage Device called DAPLINK will enumerate.
 #. Copy the application binary ``zephyr.bin`` to the DAPLINK drive. The drive
    will temporarily disappear, then reappear after several seconds.
 #. Open a serial terminal (minicom, putty, etc.) with the following settings:

    - Speed: 115200
    - Data: 8 bits
    - Parity: None
    - Stop bits: 1

 #. Reset the SoC. Each SoC has a reset button on docking station. You should
    see the following message on the Serial Port:

   .. code-block:: console

      Hello World! arm

 Using Bluetooth
 ***************

 Configure the KW40Z as a Bluetooth controller
 =============================================

 The K64 can support Zephyr Bluetooth host applications when you configure the
 KW40Z as a Bluetooth controller.

 #. Download and install the `KW40Z Connectivity Software`_. This package
    contains Bluetooth controller application for the KW40Z.
 #. Flash the file ``tools/binaries/BLE_HCI_Modem.bin`` to the KW40Z.

 Now you can build and run the sample Zephyr Bluetooth host applications on the
 K64. You do not need to repeat this step each time you flash a new Bluetooth
 host application to the K64.

 Peripheral Heart Rate Sensor
 ============================
 Navigate to the Zephyr sample application and build it for the Hexiwear K64.

 .. code-block:: console

    $ cd samples/bluetooth/peripheral_hr
    $ make BOARD=hexiwear_k64

 Flash the application to the Hexiwear K64. Make sure the OpenSDA switches on
 the docking station are configured for the K64.

 Reset the KW40Z and the K64 using the push buttons on the docking station.

 Install the Kinetis BLE Toolbox on your smartphone:

 - `Kinetis BLE Toolbox for iOS`_
 - `Kinetis BLE Toolbox for Android`_

 Open the app, tap the **Heart Rate** feature, and you should see a **Zephyr
 Heartrate Sensor** device. Tap the **Zephyr Heartrate Sensor** device and you
 will then see a plot of the heart rate data that updates once per second.


 .. _Hexiwear Website:
    http://www.nxp.com/hexiwear

 .. _Hexiwear Fact Sheet:
    http://www.nxp.com/assets/documents/data/en/fact-sheets/HEXIWEAR-FS.pdf

 .. _Hexiwear Schematics:
    http://cdn-docs.mikroe.com/images/c/c0/Sch_Hexiwear_MainBoard_v106c.pdf

 .. _OpenSDA:
    http://www.nxp.com/products/software-and-tools/hardware-development-tools/startertrak-development-boards/opensda-serial-and-debug-adapter:OPENSDA

 .. _K64F Website:
    http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/kinetis-cortex-m-mcus/k-series-performance-m4/k6x-ethernet/kinetis-k64-120-mhz-256kb-sram-microcontrollers-mcus-based-on-arm-cortex-m4-core:K64_120

 .. _K64F Datasheet:
    http://www.nxp.com/assets/documents/data/en/data-sheets/K64P144M120SF5.pdf

 .. _K64F Reference Manual:
    http://www.nxp.com/assets/documents/data/en/reference-manuals/K64P144M120SF5RM.pdf

 .. _KW40Z Connectivity Software:
    https://www.nxp.com/webapp/Download?colCode=KW40Z-CONNECTIVITY-SOFTWARE&appType=license&location=null&fpsp=1&WT_TYPE=Protocol%20Stacks&WT_VENDOR=FREESCALE&WT_FILE_FORMAT=exe&WT_ASSET=Downloads&fileExt=.exe&Parent_nodeId=1432854896956716810497&Parent_pageType=product

 .. _Kinetis BLE Toolbox for iOS:
    https://itunes.apple.com/us/app/kinetis-ble-toolbox/id1049036961?mt=8

 .. _Kinetis BLE Toolbox for Android:
    https://play.google.com/store/apps/details?id=com.freescale.kinetisbletoolbox
	.. _hexiwear_k64:

	Hexiwear
	########

	Overview
	********

	Hexiwear is powered by a Kinetis K64 microcontroller based on the ARM Cortex-M4
	core. Another Kinetis wireless MCU, the KW40Z, provides Bluetooth Low Energy
	connectivity. Hexiwear also integrates a wide variety of sensors, as well as a
	user interface consisting of a 1.1” 96px x 96px full color OLED display and six
	capacitive buttons with haptic feedback.

	- Eye-catching Smart Watch form factor with powerful, low power Kinetis K6x MCU
	and 6 on-board sensors.
	- Designed for wearable applications with the onboard rechargeable battery,
	OLED screen and onboard sensors such as optical heart rate, accelerometer,
	magnetometer and gyroscope.
	- Designed for IoT end node applications with the onboard sensor’s such as
	temperature, pressure, humidity and ambient light.
	- Flexibility to let you add the sensors of your choice nearly 200 additional
	sensors through click boards.

	.. image:: hexiwear_k64.jpg
	:width: 442px
	:align: center
	:alt: Hexiwear

	Hardware
	********

	- Main MCU: NXP Kinetis K64x (ARM Cortex-M4, 120 MHz, 1M Flash, 256K SRAM)
	- Wireless MCU: NXP Kinetis KW4x (ARM Cortex-M0+, Bluetooth Low Energy &
	802.15.4 radio)
	- 6-axis combo Accelerometer and Magnetometer NXP FXOS8700
	- 3-Axis Gyroscope: NXP FXAS21002
	- Absolute Pressure sensor NXP MPL3115
	- Li-Ion/Li-Po Battery Charger NXP MC34671
	- Optical heart rate sensor Maxim MAX30101
	- Ambient Light sensor, Humidity and Temperature sensor
	- 1.1” full color OLED display
	- Haptic feedback engine
	- 190 mAh 2C Li-Po battery
	- Capacitive touch interface
	- RGB LED

	For more information about the K64F SoC and Hexiwear board:

	- `K64F Website`_
	- `K64F Datasheet`_
	- `K64F Reference Manual`_
	- `Hexiwear Website`_
	- `Hexiwear Fact Sheet`_
	- `Hexiwear Schematics`_

	Supported Features
	==================

	The hexiwear_k64 board configuration supports the following hardware features:

	+-----------+------------+-------------------------------------+
	\| Interface \| Controller \| Driver/Component \|
	+===========+============+=====================================+
	\| NVIC \| on-chip \| nested vector interrupt controller \|
	+-----------+------------+-------------------------------------+
	\| SYSTICK \| on-chip \| systick \|
	+-----------+------------+-------------------------------------+
	\| PINMUX \| on-chip \| pinmux \|
	+-----------+------------+-------------------------------------+
	\| GPIO \| on-chip \| gpio \|
	+-----------+------------+-------------------------------------+
	\| I2C \| on-chip \| i2c \|
	+-----------+------------+-------------------------------------+
	\| UART \| on-chip \| serial port-polling; \|
	\| \| \| serial port-interrupt \|
	+-----------+------------+-------------------------------------+
	\| FLASH \| on-chip \| soc flash \|
	+-----------+------------+-------------------------------------+
	\| SENSOR \| off-chip \| fxos8700 polling; \|
	\| \| \| fxos8700 trigger \|
	+-----------+------------+-------------------------------------+

	The default configuration can be found in the defconfig file:

	``boards/arm/hexiwear_k64/hexiwear_k64_defconfig``

	Other hardware features are not currently supported by the port.

	Connections and IOs
	===================

	The K64F SoC has five pairs of pinmux/gpio controllers.

	+-------+-----------------+---------------------------+
	\| Name \| Function \| Usage \|
	+=======+=================+===========================+
	\| PTC8 \| GPIO \| Red LED \|
	+-------+-----------------+---------------------------+
	\| PTC9 \| GPIO \| Green LED \|
	+-------+-----------------+---------------------------+
	\| PTD0 \| GPIO \| Blue LED \|
	+-------+-----------------+---------------------------+
	\| PTD13 \| GPIO \| FXOS8700 INT2 \|
	+-------+-----------------+---------------------------+
	\| PTB16 \| UART0_RX \| UART Console \|
	+-------+-----------------+---------------------------+
	\| PTB17 \| UART0_TX \| UART Console \|
	+-------+-----------------+---------------------------+
	\| PTE24 \| UART4_RX \| UART BT HCI \|
	+-------+-----------------+---------------------------+
	\| PTE25 \| UART4_TX \| UART BT HCI \|
	+-------+-----------------+---------------------------+
	\| PTC10 \| I2C1_SCL \| I2C / FXOS8700 \|
	+-------+-----------------+---------------------------+
	\| PTC11 \| I2C1_SDA \| I2C / FXOS8700 \|
	+-------+-----------------+---------------------------+

	System Clock
	============

	The K64F SoC is configured to use the 12 MHz external oscillator on the board
	with the on-chip PLL to generate a 120 MHz system clock.

	Serial Port
	===========

	The K64F SoC has six UARTs. One is configured for the console, another for BT
	HCI, and the remaining are not used.

	Programming and Debugging
	*************************

	Flashing
	========

	The Hexiwear docking station includes an `OpenSDA`_ serial and debug adaptor
	built into the board. The adaptor provides:

	- A USB connection to the host computer, which exposes a Mass Storage and an
	USB Serial Port.
	- A Serial Flash device, which implements the USB flash disk file storage.
	- A physical UART connection which is relayed over interface USB Serial port.

	.. note::
	The OpenSDA is shared between the K64 and the KW40Z via switches, therefore
	only one SoC can be flashed, debugged, or have an open console at a time.

	Flashing an application to Hexiwear
	-----------------------------------

	#. Build the Zephyr kernel and application:

	.. code-block:: console

	$ cd $ZEPHYR_BASE
	$ . zephyr-env.sh
	$ cd $ZEPHYR_BASE/samples/hello_world/
	$ make BOARD=hexiwear_k64

	#. Make sure the docking station USB cable is unplugged.
	#. Attach the Hexiwear board to the docking station.
	#. Configure the docking station switches to route the desired SoC signals to
	the OpenSDA circuit:

	+--------+-------------+-------+-----+
	\| Switch \| Signal \| KW40Z \| K64 \|
	+========+=============+=======+=====+
	\| 1 \| MK64 SWDIO \| OFF \| ON \|
	+--------+-------------+-------+-----+
	\| 2 \| MK64 RST \| OFF \| ON \|
	+--------+-------------+-------+-----+
	\| 3 \| MKW40 RST \| ON \| OFF \|
	+--------+-------------+-------+-----+
	\| 4 \| MKW40 SWDIO \| ON \| OFF \|
	+--------+-------------+-------+-----+
	\| 5 \| OSDA \| ON \| ON \|
	+--------+-------------+-------+-----+
	\| 6 \| LED1 \| OFF \| OFF \|
	+--------+-------------+-------+-----+
	\| 7 \| LED2 \| OFF \| OFF \|
	+--------+-------------+-------+-----+
	\| 8 \| LED3 \| OFF \| OFF \|
	+--------+-------------+-------+-----+

	#. Attach the USB cable and make sure the power switch is ON. A USB Mass
	Storage Device called DAPLINK will enumerate.
	#. Copy the application binary ``zephyr.bin`` to the DAPLINK drive. The drive
	will temporarily disappear, then reappear after several seconds.
	#. Open a serial terminal (minicom, putty, etc.) with the following settings:

	- Speed: 115200
	- Data: 8 bits
	- Parity: None
	- Stop bits: 1

	#. Reset the SoC. Each SoC has a reset button on docking station. You should
	see the following message on the Serial Port:

	.. code-block:: console

	Hello World! arm

	Using Bluetooth
	***************

	Configure the KW40Z as a Bluetooth controller
	=============================================

	The K64 can support Zephyr Bluetooth host applications when you configure the
	KW40Z as a Bluetooth controller.

	#. Download and install the `KW40Z Connectivity Software`_. This package
	contains Bluetooth controller application for the KW40Z.
	#. Flash the file ``tools/binaries/BLE_HCI_Modem.bin`` to the KW40Z.

	Now you can build and run the sample Zephyr Bluetooth host applications on the
	K64. You do not need to repeat this step each time you flash a new Bluetooth
	host application to the K64.

	Peripheral Heart Rate Sensor
	============================
	Navigate to the Zephyr sample application and build it for the Hexiwear K64.

	.. code-block:: console

	$ cd samples/bluetooth/peripheral_hr
	$ make BOARD=hexiwear_k64

	Flash the application to the Hexiwear K64. Make sure the OpenSDA switches on
	the docking station are configured for the K64.

	Reset the KW40Z and the K64 using the push buttons on the docking station.

	Install the Kinetis BLE Toolbox on your smartphone:

	- `Kinetis BLE Toolbox for iOS`_
	- `Kinetis BLE Toolbox for Android`_

	Open the app, tap the Heart Rate feature, and you should see a **Zephyr
	Heartrate Sensor device. Tap the Zephyr Heartrate Sensor** device and you
	will then see a plot of the heart rate data that updates once per second.


	.. _Hexiwear Website:
	http://www.nxp.com/hexiwear

	.. _Hexiwear Fact Sheet:
	http://www.nxp.com/assets/documents/data/en/fact-sheets/HEXIWEAR-FS.pdf

	.. _Hexiwear Schematics:
	http://cdn-docs.mikroe.com/images/c/c0/Sch_Hexiwear_MainBoard_v106c.pdf

	.. _OpenSDA:
	http://www.nxp.com/products/software-and-tools/hardware-development-tools/startertrak-development-boards/opensda-serial-and-debug-adapter:OPENSDA

	.. _K64F Website:
	http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/kinetis-cortex-m-mcus/k-series-performance-m4/k6x-ethernet/kinetis-k64-120-mhz-256kb-sram-microcontrollers-mcus-based-on-arm-cortex-m4-core:K64_120

	.. _K64F Datasheet:
	http://www.nxp.com/assets/documents/data/en/data-sheets/K64P144M120SF5.pdf

	.. _K64F Reference Manual:
	http://www.nxp.com/assets/documents/data/en/reference-manuals/K64P144M120SF5RM.pdf

	.. _KW40Z Connectivity Software:
	https://www.nxp.com/webapp/Download?colCode=KW40Z-CONNECTIVITY-SOFTWARE&appType=license&location=null&fpsp=1&WT_TYPE=Protocol%20Stacks&WT_VENDOR=FREESCALE&WT_FILE_FORMAT=exe&WT_ASSET=Downloads&fileExt=.exe&Parent_nodeId=1432854896956716810497&Parent_pageType=product

	.. _Kinetis BLE Toolbox for iOS:
	https://itunes.apple.com/us/app/kinetis-ble-toolbox/id1049036961?mt=8

	.. _Kinetis BLE Toolbox for Android:
	https://play.google.com/store/apps/details?id=com.freescale.kinetisbletoolbox