Boreas Technologies BOS1901-KIT-B02 User manual

BOS1901-KIT

User Guide

BOS1901 Development Kit

1Features

•Plug and play development kit to experience

piezoelectric actuator button and haptic

feedback.

•Low-power BOS1901 integrated circuit, high

voltage driver with SPI digital interface.

•Power supply via the USB port.

•Graphical user interface for ease of use.

•Standard USB audio to prototype haptic

effects in MATLAB®, Python®, Audacity® and

many other softwares

•Easy generation of high-voltage waveforms

up to 190 Vpp.

•Two breakable miniature PCBs with BOS1901

drivers for prototyping.

•Standard commercial piezo actuators

included in the Kit:

oStarter Set: TDK PowerHap™1204 lateral

oPremium Set: TDK PowerHap™ 1204

lateral, 0904 lateral, 0909 square,

Bimitech PythonTM PUA3020-5H200

bending.

Figure 1: BOS1901-KIT overview

2Description

The BOS1901-KIT is a development kit to get

familiar with the BOS1901 Piezo Haptic Driver IC.

The USB-powered kit appears as an USB Audio

device for the computer, which allows quick and

easy generation of waveforms using existing audio

software like Audacity® for haptic prototyping.

The firmware supports autonomous operation for

easy integration into development prototypes.

Each breakable miniature PCB gives access to all

signals allowing the users to experiment with the

BOS1901 using a development platform of their

choice.

Standard commercial piezo actuators are provided

as a starting point to begin experiencing with

haptic feedback.

Table 1: Ordering information

PRODUCT

DESCRIPTION

BOS1901-KIT-B02

Starter Set with One Actuator

(replacement of BOS1901-KIT-B)

BOS1901-KIT-A02

Premium Set with Four Actuators

(replacement of BOS1901-KIT-A)

For details see section 2

MATLAB® is registered trademark of The MathWorks, Inc.

Python® is a registered trademark of the PSF

Audacity® is a registered trademark of Dominic Mazzoni

PowerHap™ is a trademark of TDK Corporation

PythonTM is a trademark of Bimitech Inc.

BOS1901-KIT

User Guide

3What's in the Box

The BOS1901-KIT is currently available in two distinct packages: Premium Set and Starter Set. The

following tables show the content of each set.

Table 2: Premium Set BOS1901-KIT-A02 development kit content

ITEM

DESCRIPTION

REFERENCE

Evaluation PCB

BOS1901-KIT Board

USB Cable

Cable to connect the evaluation PCB to a computer

Stewart Connector part number SC-2AMK001F

TDK Piezo Actuator

TDK Mini PowerHap™1204H018V060 Actuator

Ordering : Z63000Z2910Z 1Z 39

Capacitance : 0.42 μF

Dim : 12.0 x 4.0 x 1.8 mm

TDK Piezo Actuator

TDK Mini PowerHap™0904H014V060 Actuator

Ordering Z63000Z2910Z 1Z 41

Capacitance : 0.32 μF

Dim : 9.0 x 3.75 x 1.4 mm

TDK Piezo Actuator

TDK PowerHap™ 0909H011V060 Actuator

Ordering: B54103H2020A001 (Z63000Z2910Z 1Z 2)

Capacitance : 0.85 μF

Dim : 9.0 x 9.0 x 0.55 mm

Bimitech Piezo

Actuator

Bimitech PythonTM PUA3020-5H200 bender with

Clamp with screws

Capacitance : 71 nF

Dim : 50 x 20 x 0.56 mm

Refer to section 9.3.3 for clamp assembly instructions.

Clamp

Clamp with screws for Bimitech piezo actuator

Power Connector

Connector and cable for external power supply

connection (refer to section Power Supply Source and

UPI Mode Operation)

JST Sales America Inc. part numbers PHR-2 and

ASPHSPH24K51

BOS1901-KIT

User Guide

Two (2) 3-position

terminal block

connector

Male connector used for interfacing the piezoelectric

actuator on the board.

Metz Connect part number 31369103

Two (2) 7-position

thru-hole header

connector

2.54 mm pitch header connector for probing interface

signals and supply.

Sullins Connector Solutions part number

PRPC007SAAN-RC or equivalent.

6-position thru-hole

header connector

2.54 mm pitch header connector for connection to

external system (J3 connector on PCB).

Würth Electronik part number 61300611021 (6-pin) or

equivalent.

Table 3: Starter Set BOS1901-KIT-B02 development kit content

ITEM

DESCRIPTION

REFERENCE

Evaluation PCB

BOS1901-KIT Board

USB Cable

Cable to connect the evaluation PCB to a computer

Stewart Connector part number SC-2AMK001F

TDK Piezo Actuator

TDK Mini PowerHap™1204H018V060 Actuator

Ordering : Z63000Z2910Z 1Z 39

Capacitance : 0.42 μF

Dim : 12.0 x 4.0 x 1.8 mm

Two (2) 3-position

terminal block

connector

Male connector used for interfacing the piezoelectric

actuator on the board.

Metz Connect part number 31369103

Two (2) 7-position

thru-hole header

connector

2.54 mm pitch header connector for probing interface

signals and supply.

Sullins Connector Solutions part number

PRPC007SAAN-RC or equivalent.

6-position thru-hole

header connector

2.54 mm pitch header connector for connection to

external system.

Würth Electronik part number 61300611021 (6-pin) or

equivalent.

BOS1901-KIT

User Guide

4Board Overview

The purpose of this section is to show the location of the components that allow you to interact with

the BOS1901-KIT board. This section is in a way the definition of the user interface provided by the

development board. The focus is on buttons and LEDs which allow you to know and modify the current

operating state.

Figure 2: BOS1901-KIT board user interface

Table 4: BOS1901-KIT board user interface

Components

Name

Description

USB connector

Supply power and provides connectivity with the GUI.

Operation mode LED

Flashing if alive and color shows the current operation mode.

BOS1901 error LED

Flashing if an error is detected on a BOS1901.

Change operation mode button

Change the current operation mode on press.

Reset button

Reset the micro-controller on press.

GPIO to trigger haptic feedback

If configured as a haptic trigger event, a falling edge on that

GPIO will trigger a haptic feedback on a piezo actuator.

BOS1901 A/B status LED

LEDs displaying the current state of the BOS1901.

BOS1901 A/B terminal block

Terminals where piezoelectric actuator are connected.

BOS1901-KIT

User Guide

4.1 Operation Mode LED Details

This section describes the meaning of the different colors and state transitions of the operation mode

LED.

Table 5: Operation mode LED detail

Pattern

Color

Description

1 second on, 1 second off

Green

In Haptic mode and working normally.

1 second on, 1 second off

Blue

In Audio mode and working normally.

Any other pattern or color behavior maybe caused by unofficial firmware or bug.

4.2 BOS1901 Error LED Details

This section describes the meaning of the different colors and state transitions of the BOS1901 Error

LED. The two BOS1901 of the BOS1901-KIT board are monitored to validate the presence of an internal

error. If an error is detected, the BOS1901 Error LED is used to indicate the detection of this error. See

section 8.5.3, for more information on the procedure to get the details of the error.

Table 6: BOS1901 error LED details

Pattern

Color

Description

Always off

N/A

No error detected on any BOS1901.

700 ms on, 700 ms off

Red

At least one internal error has been detected by a BOS1901.

4.3 BOS1901 Status LEDs Details

This section describes the meaning of the different colors and state transitions of the BOS1901 status

LED. There is a status LED for each BOS1901.

Table 7: BOS1901 status LED details

Pattern

Color

Description

Always on

Green

Sensing the voltage of the piezo electric actuator to detect

press or release event.

Always on

Blue

Sending haptic feedback data to the BOS1901.

BOS1901-KIT

User Guide

5Your First Piezoelectric Actuator Button Experience

The BOS1901 and a piezoelectric actuator can be used together to implement the equivalent of a

button. Before being shipped, the BOS1901-KIT board is set up in this button mode, so that you can

experience it without additional extensive configuration or software installation.

1. Open the box, take the BOS1901-KIT board, the USB cable, the terminals block plugs, and the

TDK 1204 piezo actuators.

2. Insert the terminal block plugs into the development kit’s terminal blocks.

3. Using a small slotted screwdriver, install TDK 1204 piezo electric actuator on terminals block

plugs. Pay attention to connect the red wire on the OUT+ terminal and the black wire on the

OUT- terminal. Refer to Figure 2 to identify location of OUT+ and OUT- on the terminal block.

4. Connect the development kit board to a USB port using the USB cable.

5. When the operation mode green LED is blinking and BOS1901 A/B status LED are solid green,

you are ready to go. Press on the piezo actuation to experience the piezo actuator button.

BOS1901-KIT

User Guide

6Get Started

The purpose of this section is to give instructions on where to get the latest versions of Boréas software

and firmware. Keeping the software up to date ensures the latest features available are taken

advantage of.

6.1 Creating a Boréas Account

Relevant documentation and software are available in the support section of Boréas website. Here are

the instructions for accessing it:

1) Go to https://www.boreas.ca/account.

2) Click on “Create account”.

3) Enter the requested information.

4) Click on “Create Account”.

6.2 Identifying the BOS1901-KIT Board Revision

Each PCB board reference design (“REF:”) and revision (BT###-DK-v#.#) numbers are printed on the

board. The following table indicates compatibility with the firmware and Devkit Controller software.

Table 8: BOS1901-KIT board and software compatibility list

REF NUMBER

REVISION

COMPATIBLE FIRMWARE

COMPATIBLE PC SOFTWARE

PCB-0118

BT004-DK-v1.0

Starting at 1.10.x

Starting at 2.9.x

PCB-0136

BT004-DK-v1.1

Starting at 1.10.x

Starting at 2.9.x

Any PCB reference design number not listed into Table 8 are considered obsolete. The relevant

documentation and software for obsolete products are still available into the archive section of our web

site.

6.3 Download Boréas Application

1) Log in your Boréas account.

2) Go to the "Technical Documents" section.

3) Click on the "BOS1901-KIT Documents" link.

4) Scroll down to section BOS1901-KIT Controller (GUI).

5) Download the appropriate GUI version based on your development kit identification.

6.4 Install Boréas Application

Double click on the installer executable you downloaded and follow the instructions.

BOS1901-KIT

User Guide

6.5 Upgrade Development Kit Firmware

The native BOS1901-KIT board firmware includes an over-USB firmware upgrade mechanism. The

BOS1901-KIT software will upgrade the firmware if needed on next connection with the development

kit.

1) Connect the development kit to a PC using the USB cable.

2) Start the BOS1901-KIT software.

3) Select the development kit communication port into the drop-down field:

Figure 3: Connection dialog

4) Click on Connect to port.

5) If an upgrade is needed the BOS1901-KIT software will pop up a dialog:

Figure 4: BOS1901-KIT Firmware upgrade dialog

6) Click on Yes to proceed and wait for the update process to complete.

7) BOS1901-KIT software will automatically start after the upgrade.

8) All is up-to-date and ready to go.

BOS1901-KIT

User Guide

7Product Overview

The BOS1901-KIT has been designed to meet a multitude of needs. The main objective is to

demonstrate the capacity of the BOS1901 but also to help integrators in the development of haptic

effects and in its product prototyping.

The BOS1901-KIT is delivered with a graphical user interface (GUI) for ease of use but it is not required

to operate. It can save and restore its configuration at start-up. We will refer to operation without the

GUI by saying that the development board is used autonomously. It is configured in one of these

autonomous mode before shipping (see section 5). We will explain in more detail the so-called

autonomous modes in this document.

The BOS1901-KIT supports multiple operation modes:

Table 9: Operation mode list

Mode

Will help you to

Haptic

•Experience piezo haptic button emulation.

•Experiment with simple waveforms on various piezoelectric actuators.

•Experiment with piezoelectric device sensing.

•Evaluate any piezoelectric actuator for your application.

•Evaluate BOS1901 performance (waveform output, power consumption) in the

context of your application.

•Optimize BOS1901 operation using specific registers value.

•Command BOS1901-KIT waveform trigger from your system using an external

trigger signal.

Audio

•Easily experiment with various waveform shapes and amplitudes.

•Easily produce and compare various waveforms and identify the effects most

suited for your application.

•Play synchronous waveforms on both channels of BOS1901-KIT.

In Haptic mode, the GUI allows you to fire a given waveform from a variety of trigger mechanisms.

The BOS1901-KIT is used to test the capacity of the BOS1901 with various piezoelectric actuators. The

trigger events that can be used are: an action Play in the GUI, a falling edge on IO1, an action of pressing

and releasing the piezoelectric actuator. When the IO1 or the piezoelectric actuator are used as trigger,

the development kit can work without the GUI. The GUI also provides a section to read and write all

registers of the IC. For more details about this mode refer to section 8.5.1

In Audio mode, the development kit is detected as a standard stereo USB audio device by the PC.

We know that our customers require more flexibility and control over the waveform used for their

haptic effects. For these reasons, we put at your disposal the audio mode which allows you to have

complete control over the wave transmitted to the BOS1901 via the USB port. Your PC can select the

BOS1901-KIT as an audio card stereo output. You can configure audio mode settings using the graphical

user interface, but this mode is designed to work without the GUI. For more details about the audio

mode refers to section 8.5.2.

BOS1901-KIT

User Guide

The BOS1901-KIT development kit can be used as a basis for the development of a prototype.

It is possible to connect an external SPI master without separating the breakable mini-boards from the

BOS1901-KIT. This operation requires a good knowledge of the electrical design of the BOS1901-KIT.

For more details about the hardware refers to section 9.

This manual suits for next models

Table of contents

Other Boreas Technologies Microcontroller manuals

Boreas Technologies

Boreas Technologies BOS1211 User manual

Boreas Technologies

Boreas Technologies BOS1901 User manual

Popular Microcontroller manuals by other brands

AMS

AMS AS7261 Demo Kit user guide

Novatek

Novatek NT6861 manual

Espressif Systems

Espressif Systems ESP8266 SDK AT Instruction Set

Nuvoton

Nuvoton ISD61S00 ChipCorder Design guide

STMicrolectronics

STMicrolectronics ST7 Assembler Linker user manual

Texas Instruments

Texas Instruments Chipcon CC2420DK user manual

Lantronix

Lantronix Intrinsyc Open-Q 865XR SOM user guide

NEC

NEC 78GK0S/K 1+ Series Application note

Mikroe

Mikroe SEMITECH N-PLC Click Application note

Intel

Intel Agilex user guide

Cypress

Cypress CY4607 HX2VL quick start guide

DIGITAL-LOGIC

DIGITAL-LOGIC MICROSPACE manual

Texas Instruments

Texas Instruments TMS320F2837 D Series Workshop Guide and Lab Manual

CYPRES

CYPRES CY14NVSRAMKIT-001 user guide

Texas Instruments

Texas Instruments INA-DUAL-2AMP-EVM user guide

Espressif Systems

Espressif Systems ESP8266EX Programming guide

Abov

Abov AC33M8128L user manual

Laird

Laird BL654PA user guide