blusdk v6.1 release notesww1.microchip.com/downloads/en/devicedoc/atbtlc1000-blusdk-… · 5....

ATBTLC1000 BluSDK v6.1 Release Notes

Description

This document details the release notes of ATBTLC1000 BluSDK v6.1.

© 2017 Microchip Technology Inc. Draft Release Note DS00000000A-page 1

Table of Contents

Description.......................................................................................................................1

1. BluSDK Software Architecture...................................................................................4

2. Supported Hardware Platforms and IDEs................................................................. 5

3. BluSDK Host Library Supported Architecture and Compilers....................................7

4. BluSDK Release contents......................................................................................... 84.1. BluSDK Firmware contents.......................................................................................................... 9

5. BluSDK Release features........................................................................................12

6. Release Revision History........................................................................................ 146.1. BluSDK v6.1...............................................................................................................................146.2. BluSDK v5.0...............................................................................................................................146.3. BluSDK v4.0...............................................................................................................................156.4. BluSDK v3.0...............................................................................................................................166.5. BluSDK v2.3...............................................................................................................................176.6. BluSDK v2.2...............................................................................................................................176.7. BluSDK v2.1...............................................................................................................................186.8. BluSDK v2.0...............................................................................................................................18

7. Previous Release History - BluSDK v1.x.................................................................20

8. Known issues.......................................................................................................... 21

9. Limitations............................................................................................................... 229.1. BluSDK Software........................................................................................................................229.2. Mobile Applications.................................................................................................................... 22

10. Additional Information/Pre-requisites.......................................................................23

11. Power save measure settings................................................................................. 2411.1. Hardware Setup......................................................................................................................... 2411.2. Power measure with Data Visualizer..........................................................................................2511.3. Average Advertisement Current................................................................................................. 26

12. Appendix 1 - Atmel BluSDK Change Log................................................................2712.1. BluSDK Module Changes...........................................................................................................2712.2. BLE Library API – New Features............................................................................................... 3012.3. Differences between BLE APIs - BluSDK 6.1 versus BluSDK 5.0............................................. 32

13. Appendix 2 - Hardware UART Flow Control Settings..............................................3313.1. ATBTLC1000 Initialization.......................................................................................................... 3313.2. Hardware Interface details (With Adapter board).......................................................................35

ATBTLC1000


13.3. Hardware Interface details (without Adapter board)...................................................................35

14. Hardware Resources used by BluSDK....................................................................3914.1. Timer.......................................................................................................................................... 3914.2. UART..........................................................................................................................................3914.3. GPIO.......................................................................................................................................... 39

15. Appendix 3 - ASF installation instructions for Atmel Studio 7.0...............................4015.1. Installation Steps for VSIX File...................................................................................................4015.2. External Interrupt (Host Wake-up)..............................................................................................43

16. Appendix 4 - Re-initializing the BluSDK library........................................................44The Microchip Web Site........................................................................................................................ 45Customer Change Notification Service................................................................................................. 45Customer Support................................................................................................................................. 45Product Identification System................................................................................................................46Microchip Devices Code Protection Feature.........................................................................................46Legal Notice.......................................................................................................................................... 47Trademarks........................................................................................................................................... 47Quality Management System Certified by DNV.................................................................................... 47Worldwide Sales and Service................................................................................................................49

ATBTLC1000


1. BluSDK Software ArchitectureThe following diagram illustrates the various layers in the BluSDK Architecture for implementing variousapplications. The External host can be supported hardware platforms and IDEs (see Table 2-1).

Figure 1-1. BluSDK Software Architecture

ATBTLC1000


2. Supported Hardware Platforms and IDEsThe following table provides the supported hardware platforms and IDEs of ATBTLC1000.

Table 2-1. BluSDK – SUPPORTED HARDWARE AND IDE

Platform MCU Supported BLEModule Supported Evaluation Kits Supported IDEs

SAM L21 (MCU) ATSAML21J18B ATBTLC1000

ATBTLC1000-XSTK

(ATSAML21-XPRO-B +(ATBTLC1000 XPRO orATBTLC1000ZR XPRO)

Atmel Studiov7.0

IAR EmbeddedWorkbench forARM 7.40.5*

SAM L21 (MCU) ATSAML21J18A ATBTLC1000ATSAML21 XPRO +

(ATBTLC1000 XPRO orATBTLC1000ZR XPRO)

Atmel Studiov7.0

IAR EmbeddedWorkbench for

ARM 7.40.3.8938or above

SAM L22 (MCU) ATSAML22N18A ATBTLC1000ATSAML22 XPRO +


Atmel Studiov7.0



SAM D21 (MCU) ATSAMD21J18A ATBTLC1000ATSAML21 XPRO +


Atmel Studiov7.0



SAM G55 (MCU) ATSAMG55J19 ATBTLC1000ATSAMG55-XPRO +


Atmel Studiov7.0



SAM 4S (MCU) ATSAM4SD32C ATBTLC1000ATSAM4S-XPRO +


Atmel Studiov7.0



ATBTLC1000


Note: Support for ATSAML21J18B (SAM L21 Rev B) device is added in IAR for ARM version 7.40.5.

ATBTLC1000


3. BluSDK Host Library Supported Architecture and CompilersThe following table provide the details on BluSDK Host library supported architecture and compilers.

Table 3-1. BluSDK - SUPPORTED ARCHITECTURE AND COMPILERS (LIBRARY SUPPORT)

Architecture\Compiler GCC IAR Keil

ARM Cortex-M0+Yes

[Path:\lib\cm0p\gcc\]

Yes

[Path: \lib\cm0p\iar\]

Yes

[Path: \lib\cm0p\keil\]

ARM Cortex-M3Yes

[Path: \lib\cm3\gcc\]

Yes

[Path: \lib\cm3\iar\]

Yes

[Path: \lib\cm3\keil\]

ARM Cortex-M4Yes

[Path: \lib\cm4\gcc\]

Yes

[Path: \lib\cm4\iar\]

Yes

[Path: \lib\cm4\keil\]

Note: Refer "Platform porting guide" (http://www.microchip.com/wwwproducts/en/atbtlc1000) for portingthe similar architecture library to other supported MCU’s.

ATBTLC1000


http://www.microchip.com/wwwproducts/en/atbtlc1000

4. BluSDK Release contentsFolder Name Description

Documentation

Adapter Layer API Documentation

Software Development Guide

Platform Porting Guide

BLE Example Application Getting Started Guide: This includes Getting started guidesfor following example application.

1. Proximity Monitor Profile Example (pxp_monitor)2. Proximity Reporter Profile Example (pxp_reporter)3. Apple Notification Centre Service Example (ANCS)4. Battery Service Example (battery_info)5. Observer Example (ble_observer)6. Device Information Service Example (device_info)7. Health Thermometer Profile Example (htpt_temperature_sensor)8. Time Information Profile Example (time_information)9. Scan Parameter Example (scan_parameter)10. Simple Broadcaster Example (simple_broadcaster)11. Simple BLE Connection Example (simple_btlc1000_connection)12. HID Keyboard Example (hid_device_keyboard)13. HID Mouse Example (hid_mouse_keyboard)14. DTM Application Example (ble_dtm)15. Alert Notification Profile Example (alert_notification)16. Blood Pressure Profile Example (blood_pressure)17. Custom Profile Example (custom_serial_chat)18. Find me Profile Example (find_me)19. Heart Rate Profile Example (hr_sensor)20. Phone Alert Status Profile Exmaple (phone_alert_status)21. BLE Startup Template (startup_template)22. Multi Role Multi Connect Example (multi_role_multi_connect)23. L2CAP Peripheral Example (l2cap_peripheral)24. L2CAP Central Example (l2cap_central)25. Eddystone Beacon Example (eddystone_beacon)26. Alt-Beacon Example (Altbeacon)

Firmware

Example BLE Apps, BLE Profiles and BLE Services are fully integrated in ASF.

Added pre-build example hex files for SAM L21 XPro B and ATBTLC1000-ZR devices.

For Atmel Studio:

Install the BluSDK6.1 at http://www.microchip.com/development-tools/atmel-studio-7/advanced-software-framework-%28asf%29.

ATBTLC1000


http://www.microchip.com/development-tools/atmel-studio-7/advanced-software-framework-%28asf%29http://www.microchip.com/development-tools/atmel-studio-7/advanced-software-framework-%28asf%29

Folder Name Description

MobileApplication

Contains the following mobile applications:

1. SmartConnect Android application available in Google play at https://play.google.com/store/apps/details?id=com.microchip.bleanalyser&hl=en orInstall Microchip SmartConnect Android application from Release packagecontent (Microchip_SmartConnect_409.apk).

2. SmartConnect iOS application is into Apple iTunes Stores at https://itunes.apple.com/us/app/microchip-smartconnect/id1240153044?mt=8.

Library IAR and GCC, Keil compiler based Adaptor Library for Cortex M0+, CortexM3 andCortex M4 MCU’s. Also includes the header files for Library

PCApplication

Wireless Composer [BLE Performance Analyzer].

ATBTLC1000-MR eFuse Block Program [Programming ATBTLC1000 eFuse].

DTM Tool.

4.1 BluSDK Firmware contentsBluSDK firmware builds and runs on a MCU host (Table 2-1). BluSDK Libraries are ported to other vendorMCU’s, for details refer Table 3-1. The Getting Started guide for each profile example provides moreinformation on, how to find the example project using the ASF Example Project Wizard, build, Flash andexecute the software.

Table 4-1. BluSDK FIRMWARE CONTENTS


Apps

BLE Example Application Profiles and Services.

Contains the following Example Applications:

1. Proximity Monitor Profile Example (pxp_monitor)2. Proximity Reporter Profile Example (pxp_reporter)3. Apple Notification Centre Service Example (ANCS)4. Battery Service Example (battery_info)5. Observer Example (ble_observer)6. Device Information Service Example (device_info)7. Health Thermometer Profile Example (htpt_temperature_sensor)8. Time Information Profile Example (time_information)9. Scan Parameter Example (scan_parameter)10. Simple Broadcaster Example (simple_broadcaster)11. Simple BLE Connection Example (simple_btlc1000_connection)12. HID Keyboard Example (hid_device_keyboard)13. HID Mouse Example (hid_mouse_keyboard)14. DTM Application Example (ble_dtm)15. Alert Notification Profile Example (alert_notification)16. Blood Pressure Profile Example (blood_pressure)

ATBTLC1000


https://play.google.com/store/apps/details?id=com.microchip.bleanalyser&hl=enhttps://play.google.com/store/apps/details?id=com.microchip.bleanalyser&hl=enhttps://itunes.apple.com/us/app/microchip-smartconnect/id1240153044?mt=8https://itunes.apple.com/us/app/microchip-smartconnect/id1240153044?mt=8


17. Custom Profile Example (custom_serial_chat)18. Find me Profile Example (find_me)19. Heart Rate Profile Example (hr_sensor)20. Phone Alert Status Profile Exmaple (phone_alert_status)21. BLE Startup Template (startup_template)22. Multi Role Peripheral Multi Connect Example

(multi_role_peripheral_multiconnect)23. L2CAP Peripheral Example (l2cap_peripheral)24. L2CAP Central Example (l2cap_central)25. Eddystone Beacon Example (eddystone_beacon)26. Alt-Beacon Example (Altbeacon)

ble_profiles

Contains the following BLE Profiles:

1. Alert Notification2. Apple Alert Notification Service (ANCS)3. Proximity Monitor4. Proximity Reporter5. Time Information6. HID over GATT profile (HOGP)7. Phone Alert Status8. Blood Pressure9. Heart Rate10. Find me11. Custom Serial Chat

ble_services

Contains the following BLE Services:

1. Alert Notification Service2. BLE Manager-Common BLE Event Frame Work3. Apple Alert Notification Service (ANCS)4. Battery Service (BAS)5. Current Time Service (CTS)6. Device Information Service (DIS)7. Immediate Alert Service (IAS)8. Link Loss Service (LLS)9. Scan Parameter Service (SPS)10. Tx Power Service (TXPS)11. HID Device (HOGP Service)12. Blood Pressure13. Custom Serial Chat Service14. Heart Rate Service15. Next DST Service16. Phone Alert Service

ATBTLC1000



17. Reference Time Service18. Health Thermometer Service

Inc Top level includes for the delivered libraries and Platform API’s.

Lib IAR and GCC compiler based Adaptor Library for Cortex M0+ and Cortex M4MCU’s.

services Application level services and Platform level - console, serial driver,serial_fifo, timer and serial bridge.

src Platform abstraction implementation for BLE Adapter Library.

utils Utility functions used by BluSDK components (Eg: DBG_LOG andDBG_LOG_DEV etc.)

ATBTLC1000


5. BluSDK Release featuresBluSDK 6.1 release supports the following profiles and services.

1. Profiles– Alert Notification– Apple Alert Notification Center Service (ANCS)– Blood Pressure– Custom Serial Chat– Find Me Target– Heart Rate– HOGP (HID Over GATT Profile)– Health Thermometer– Phone Alert Status– Scan Parameters– Time Information– Proximity

2. Services Support– Alert Notification Service– BLE Manager-Common BLE Event framework– Apple Alert Notification Service (ANCS)– Battery Service (BAS)– Current Time Service (CTS)– Device Information Service (DIS)– Immediate Alert Service (IAS)– Link Loss Service (LLS)– Scan Parameter Service (SPS)– Tx Power Service (TXPS)– HID Device (HOGP Service)– Blood Pressure– Custom Serial Chat Service– Heart Rate Service– Next DST Service– Phone Alert Service– Reference Time Service– Health Thermometer Service

3. Mobile Applications– Microchip Smart Connect Mobile Application for Android

• Health Thermometer• Proximity Monitor• Blood Pressure• Alert Notification• Time Information• Scan Parameters

ATBTLC1000


• Find Me• Heart Rate• Battery• Device Information Service• Eddystone Beacon• iBeacon• Alt Beacon• Phone Alert Status• Simple broadcaster• Generic GATT Database

– Microchip Smart Connect Mobile Application for iOS• Health Thermometer• Proximity Monitor• Blood Pressure• Scan Parameters• Find Me• Heart Rate• Battery• Device Information Service• Eddystone Beacon• iBeacon• Alt Beacon• Generic GATT Database

Example applications are provided for the profile/services mentioned above and are available for ATSAML21/SAM L21 Rev B/SAM L22/SAM G55/SAM D21/SAM 4S MCU platforms.

ATBTLC1000


6. Release Revision History

6.1 BluSDK v6.1

6.1.1 Major New Features of BluSDK Software1. ATBTLC1000-ZR module support is added.2. Eddy stone and Alt beacon applications are added.3. L2CAP throughput Central/Peripheral applications are added.4. Added support for multiple Baudrate of ATBTLC1000 and Host Interface 9600, 19200, 38400,

57600, 115200, 230400, 460800, and 921600. BluSDK validation done with followingBaudrate9600, 115200 and 921600.

5. Added Host wake-up feature from ATBTLC1000 for Host events, when Host MCU is in Sleep mode.6. SAM L22 Startup template support added for quick start application development.7. PTS compliance is achieved for the Standard Bluetooth SIG profile examples.8. Added new API to support for cooperative multi-tasking RTOS.

6.1.2 Major improvements and bug fixes1. Supports the update of On-the-fly advertisement data.2. BLE Manager event callback structure added for GATT, GAP, L2CAP and Custom events.3. Replaced the Library software timers with platform timers.4. Reduced the startup delay from 3000 ms to 1600 ms.5. Added fail-safe mechanism for Host communication out of synch. Refer to Appendix 4 - Re-

initializing the BluSDK library for details on implementation.6. Rx FIFO memory and event pool memory are configured from user application.7. Added custom events for Host MCU application interrupts in BluSDK examples.8. Fixed value length of Indication/Notification is from uint8_t to uint16_t.9. Fixed missing calibration events occurring during shorter sleep intervals.10. Fixed recovery issue observed when device is disconnected during and ‘in and out’ of range

situation.11. Fixed Out of Order Packet (OOP) issue occurring during high throughput.12. Added new API to get RF settings version. Current version is 1.0.13. Fixed Tx modulation issue observed on some devices.14. Fixed connection parameter update issue observed in some iOS and Android devices.

6.2 BluSDK v5.0

6.2.1 Major New Features of BluSDK Software1. Added support for SAM 4S Platform.2. Added support for periodic temperature and voltage calibration for every two seconds.3. Added Tx-Fm calibration on cold-boot.4. Added one time 26 MHz RC calibration to enable injection locking.5. Added 3 new APIs for Calibration:

ATBTLC1000


– at_ble_calib_config()– at_ble_calib_get_temp()– at_ble_calib_get_voltage()

6. Changed Hardware Flowcontrol compilation flag selection during runtime.7. Platform modularization to make the Library as an independent module.8. Added support for wireless composer – BLE Performance Analyzer in Atmel Studio 7.0, where the

DTM Tx Power set and CW Tone are incorporated.

6.2.2 Major improvements and bug fixes1. UART flow control 2-wire mode is removed, due to instability between Host and ATBTLC1000

communication.2. Fixed issue for encryption without MITM (No Authentication and No Authorization) and insufficient

key permissions.3. Fixed 6-Wire mode UART initialization issue on SAM G55 serial_drv.c.4. Storing the LTK of peer device for encryption.5. DTM instability issue is fixed.6. Mobile Application: Atmel SmartConnect for Android

6.1. Bug fixes in Scan Param profile and battery service.6.2. Support for tablets that do not have android hardware Telephony feature.

6.3 BluSDK v4.0

6.3.1 Major New Features of BluSDK Software1. Support for wireless composer – BLE Performance Analyzer in Atmel Studio 7.0.2. Support for configurable UART flow control modes like 6_WIRE (for 2 stage UART communication

for flow control support), 4_WIRE (single UART with flow control) and no flow control.

6.3.2 Mobile ApplicationEnhanced: Atmel SmartConnect (Version 2.0) tablet application for iOS and Android.

6.3.3 Adapter Library1. Added support for ULP (Ultra Low Power).2. Support for configurable UART hardware flow control for ATBTLC1000.

ATBTLC1000


Figure 6-1. ATBTLC1000 XPRO EXTENSION BOARD WITH EXT1

Important: 1. This SDK package is only compatible with the revised ATBTLC1000 XPRO

extension boards. The revised boards can be identified with a green dot on thefront and a yellow wire on the back, as shown in following figure. The revisedboards have the CHIP_ENABLE pin re-mapped to allow the use of UART flowcontrol on the extension header.

2. For example projects/apps using the SAM L21, ensure to plug the ATBTLC1000XPRO extension board to EXT1 only.

6.3.4 Major improvements and bug fixes1. GAP advertisement is moved from all profiles/services/application to ”ble_manager”.2. Generic BLE event handling call back mechanism.

6.4 BluSDK v3.0

ATBTLC1000


6.4.1 Major New Features of BluSDK Software1. Support for new profiles like Blood Pressure, Heart Rate Monitor, Phone Alert Status, Time

Information, Custom Serial Chat, Find Me, and Alert Notification on SAM L21/SAM D21/SAM G55platforms.

2. Support for new services Alert Notification, Blood Pressure, Custom Serial Chat, Current Time,Heart Rate, Next Daylight Saving Time, Phone Alert, and Reference Time on SAM L21/SAM L21Rev B/SAM D21/SAM G55 platforms.

3. Support for wireless composer – BLE Performance Analyzer.4. BLE Startup template example.

6.4.2 Mobile ApplicationEnhanced: Atmel SmartConnect mobile application for iOS and Android.

6.4.3 Adapter LibraryEnhanced: New version of adapter library upgraded and compatible to ATBTLC1000 Rev B1 running witha BLE 4.1 stack (Refer to "Annexure" for more details).

6.4.4 Documentation1. Updated BLE API Reference Manual.2. Updated BLE API Software Development User Guide.3. Updated BLE Platform Porting Guide.4. Enhanced Getting Started User Guide documents for each example application.

Important: 1. It is recommended to use ATBTLC1000 XPRO extension board delivered with the starter

kit (ATBTLC1000-XSTK) for running the example applications delivered as part of theSDK.

2. The user must plug the ATBTLC1000 XPRO extension board in EXT2 of SAM L21Xplained Pro.

6.5 BluSDK v2.3

6.5.1 Major New Features of BluSDK Software• Support for Direct Test mode on SAM L21/SAM D21/SAM G55 Platforms.

Important: 1. It is recommended to use ATBTLC1000 XPRO extension board delivered with the

starter kit for running the example applications, which are delivered as part of theSDK.

2. The user must plug the ATBTLC1000 XPRO extension board in EXT2 of SAM L21.

6.6 BluSDK v2.2

ATBTLC1000


6.6.1 Major New Features of BluSDK SoftwareSupport for ATBTLC1000 - XSTK (Starter Kit) with addition of SAM L21 MCU platform.

Important: 1. It is recommended to use ATBTLC1000 XPRO extension board delivered with the starter

kit to run the example applications delivered as part of the SDK.2. The user must plug the ATBTLC1000 XPRO extension board in EXT2 of SAM L21.

6.6.2 Major improvements and bug fixesDocumentation update: Applicable to all "Getting Started" documentation – adding setup information anddetails for using ATBTLC1000/SAM L21 starter kit.

6.7 BluSDK v2.1

6.7.1 Major New Features of BluSDK Software• HID keyboard Example Application• HID mouse Example Application

6.7.2 Major improvements and bug fixes1. Adaptor Library adds supports for report reference descriptor (refer structure:

at_ble_characteristic_gen_t).– Descriptor value set API added (refer API: at_ble_descriptor_value_set)– Descriptor value get API added (refer API: at_ble_descriptor_value_get)– New data structure added to hold the descriptor and presentation format.

2. Added new adaptor API for common service definition of both primary and secondary service (referAPI: at_ble_service_define).

6.8 BluSDK v2.0

6.8.1 Major New Features of BluSDK Software1. ANCS Profile Example Application2. Time Profile Example Application3. Proximity Monitor Example Application4. Proximity Reporter Example Application5. Observer Mode Example Application6. Broadcaster Mode Example Application7. Battery Service Example Application8. Scan Parameter Service Example Application9. Device Information Service Example Application10. BLE Manager – Common event handling support11. BLE – Services and Profiles are converted as pluggable components

ATBTLC1000


6.8.2 Mobile Application1. New: Atmel SmartBLU iOS Application supporting Proximity Monitor2. New: Atmel SmartBLU Android Application supporting

– HTPT Profile– Proximity Monitor

6.8.3 Major improvements and bug fixesHTPT Disable and Enable Notification for temperature added to HTP application.

ATBTLC1000


7. Previous Release History - BluSDK v1.xTable 7-1. PREVIOUS RELEASE HISTORY

Fix/Update Description

BluSDK v1.3 Release

1. Health ThermometerProfile example usingATBTLC1000 board andIO1 Sensor board onboth SAM D21 and SAMG55

2. Simple ATBTLC1000Connection example,which advertisesiBeacon data on bothSAM D21 and SAM G55

3. Adds support forATBTLC1000 A5devices (ES2)

Major new features:

* [BLUSDK-17] - Support added for ATBTLC1000 A5 (ES2) andATBTLC1000 A3 (ES1) devices in a single Library.

* [BLUSDK-5] - ATBTLC1000 is unable to recover during power-on.

* [BLUSDK-27] - IAR Support for HTP BluSDK.Note: This feature is only available, as a part of standalone ASFpublic release].

* [BLUSDK-28] - Support Atmel Studio 7.0.

* [BLUSDK-29] - Serial Buffer mechanism between ATBTLC1000 andHost.

* [BLUSDK-30] - Floating point conversion from IEEE754 to IEEE11073for precision temperature measurement.

Major improvements and bug fixes:

* [BLUSDK-24] - Addresses the disconnection issue after pairing failsin HTP.

* [BLUSDK-31] - Delay utility for initialization.

* [BLUSDK-32] - Random temperature type and temperaturemeasurement location change, during button press.

* [BLUSDK-33] - ATBTLC1000 chip id version display in console.

* [BLUSDK-34] - ATBTLC1000 BD address display in console.

BluSDK v1.2 Release

BUG Fix: D21 Clock Drift Issuewith respect to temperature

Major improvements and bug fixes:

* [BLUSDK-4] - D21 Clock Drift issue with respect to temperature.

ATBTLC1000


8. Known issuesThe following table provide the details on BluSDK Software.Table 8-1. BluSDK SOFTWARE

JIRA ID Description

BLUSDK-1093 Observed link disconnection with mobile on one device after 8 hours. Issue underinvestigation.

BLUSDK-1092 Multi Role/Multi Connect feature observed stability issue for multiple connectionsafter 30 minutes. Issue under investigation.

BLUSDK-1078 Pairing information's are not stored in the NVM. During power-cycle, the host MCUdisconnect its peer device bonding information, since there is no PDSimplementation on host side.

BLECORE-1000 At 9600 Baudrate, the L2CAP application connection get fails.

Note: 1. BluSDK6.1 supports only with UART hardware flow control (4-Wire/6-Wire) in SAM L21/SAM

L22/SAM D21/SAM G55/SAM 4S platforms.2. BluSDK6.1 supports ATBTLC1000-ZR modules with 4-Wire mode only. Hardware flow control is

supported in SAM L21/SAM L22/SAM D21/SAM G55/SAM 4S platforms.

The following table provide the details on mobile applications.Table 8-2. MOBILE APPLICATIONS

JIRA ID Description

BLEMAPPS-68 Android 6.x and 5.x: unread status alert for SMS, that are not supported.

BLEMAPPS-72 Go to "out of range" and "come back", it fails to reconnect Health ThermometerProfile (HTP).

BLEMAPPS-48 If pairing request is cancelled, Microchip Smart Connect App shows “pairing inprogress” status for some time. After timeout, it cancels the pairing.

BLEMAPPS-55 Issue in pairing with HTC one m8 phone.

BLEMAPPS-66 Ipad Mini is unable to display iBeacon on radar screen.

ATBTLC1000


9. LimitationsThis section describes about BluSDK Software and Microchip Smart Connect Mobile Applications.

9.1 BluSDK Software1. Adapter Layer & Platform:

– Adapter library require enhancements to make it RTOS compatible and thread-safe.– SPI interface is not yet supported.

2. Profiles:2.1. HOGP – HID

• HID keyboard device example application and HID mouse device exampleapplication are compatible only with Android based mobile devices (Android 4.4/KitKat and higher versions).

• HID keyboard device example application supports only "Just Works" pairing.2.2. PTS Compliance:

• ANCS and TIP are Apple iOS specific implementations.• PTS test cannot be executed for BT SIG profile specification compliance.

3. Standalone ASF archive3.1. In Windows OS, the maximum path length is 260 characters. It is always recommended to

extract the standalone ASF archive into root directory of the Local drive.Note: Example C:\ASF\

9.2 Mobile Applications1. Microchip Smart Connect Android Application

1.1. Common• Android Framework limitations: When wrong pass-key is entered, still pairing

succeeds.1.2. Phone Alert: Display state is not supported.1.3. Custom Serial Chat:

• Android-4.4.4 (KitKat): Can support only upto 20 characters.• Android-5.x and 6.x: (Lollipop and marshmallow): Can support less than 150

characters. If more than 150 characters are entered, then complete data is not sent.• iOS: Can support upto 150 characters.

1.4. When the device is moved, the beacon icon updates are as not fast as the movementpace. However there is an improvement in beacon icon update, compared to older versionsof Android app.

ATBTLC1000


10. Additional Information/Pre-requisites1. It is recommended to use the ATBTLC1000 XPRO (MR/ZR) extension boards provided, as part of

the ATBTLC1000 X-STK (Starter Kit).2. To test ANCS and Time Profile, an iPhone® supporting iOS version above 7.0, is required.3. General information with reference to BLE support on mobile devices are as follows:

3.1. iOS:• iPhone 4S and above supports the BT 4.0, and higher. It is recommended to use a

device with iOS version 8.0 or above for best performance and stability.3.2. Android:

• Preliminary support for BT 4.0 is added in Android Jellybean (4.2 onwards).• For best performance and stability, it is recommended to use a device with Android

version above 5.x and 6.x (that is, preferably Marshmallow or Lollipop).• Due to a wide-spectrum of Android devices with many variants (customized Android

devices, various hardware/connectivity chipset configurations), the performance ofBLE Application are not the same on all devices. Android phone that includes aBluetooth chipset supporting version 4.0 or higher is a pre-requisite.

• Due to evolving nature of BLE APIs in Android, the performance/stability variationsare observed, when testing with different Android release flavor’s (Jellybean/4.3,KitKat/4.4 and Lollipop/5.1).

• HID over GATT profile was introduced in Android from version 4.4 (KitKat). A mobiledevice supporting Android 4.4 and higher is a pre-requisite for running the HIDkeyboard device and HID mouse device example applications.

• Disconnection triggered by the application running in an Android takes a long time(12 to 15 seconds) to complete.

• When the peripheral device is reset, then the manual unpair is required in Androidphone to reconnect.

ATBTLC1000


11. Power save measure settings

11.1 Hardware Setup

11.1.1 Board WiringSet the board wiring, as shown in following figure.

Note: Jumper is connected to "Bypass" to measure only for ATBTLC1000.

Figure 11-1. BOARD WIRING

11.1.2 Connection1. Connect the DEBUG-USB jack with a Micro-USB cable to the PC.2. Remember the COM port.3. Open Atmel Studio 7.0.

ATBTLC1000


Figure 11-2. ATBTLC1000 CONNECTION

11.1.3 Trouble shooting (optionally)1. Sometimes the upgrade of the EDBG firmware fails, as shown in following figure.

Figure 11-3. FIRMWARE UPGRADE WINDOW

2. In this kind of situations, the command line can be last rescue, as shown in following figure.Figure 11-4. COMMAND LINE WINDOW

11.2 Power measure with Data VisualizerThe following figure illustrates the Atmel Studio window.

ATBTLC1000


Figure 11-5. ATMEL STUDIO

1. In Menu bar, select Tools > DataVisualizer that displays DGI control panel.Note: Data Visualizer runs effectively in Standalone mode.

2. On the control panel, click “Connect”/"Disconnect" (1) and select “Power” (2).– Click "Connect" to pair with "SAM L21 Xplained Pro B".– Click "Disconnect" to un-pair with "SAM L21 Xplained Pro B".

3. On the control panel, click “Start”/"Stop" (3) that displays the "Power Analysis" (4) window.– Click "Start" to calibrate the power.– Click "Stop" to stop the power calibration.

11.3 Average Advertisement Current• Initially the example advertises for every 1s interval rather than 62.5 ms with approximately 250 µA

current.• Advertisement interval is changed by using “BECON_ADV_INTERVAL”.• Verify the average advertisement current in "Power Analysis" window.• Auto calibration must be disabled (continuous calibration consumes more power) and

advertisement type must be set to AT_BLE_ADV_TYPE_NONCONN_UNDIRECTED.Figure 11-6. POWER ANALYSIS WINDOW

ATBTLC1000


12. Appendix 1 - Atmel BluSDK Change LogThe BluSDK v6.1 release includes an enhanced version of BLE API compatible with ATBTLC1000 RevB1 and BLE 4.1 compliant devices. This section provide details of the new features introduced in the APIand a change comparison with the previous version of BluSDK API.

12.1 BluSDK Module ChangesThe following table provides the details on "New features in the APIs".

Table 12-1. NEW FEATURES IN THE API - NEW SIGNATURE VERSUS MODIFIED SIGNATURE

Category S.No Description Old signature New signature

BLE Manager 1

handler forProfile/Service/application toregister the BLEevents callbacks

boolble_mgr_events_callback_handler(ble_mgr_event_cb

_tevent_cb_type,

ble_mgr_event_tevent_type,

constble_event_callba

ck_t*ble_event_handl

er)

boolble_mgr_events_callback_handler(ble_mgr_event_cb_tevent_cb_type,

ble_mgr_event_tevent_type,

const void*ble_event_handler)

2

handler for outof synchronousindication

handler. Whendevice startsmissing few

events or UARTBLE event data

at_ble_status_tble_device_out_of_sync_handler(void *params)

3

handler for BLEdevice deadindication

handler. Whenthe applicationreceives this

event that meansBLE device isnot responding.The applicationstarts the BLEdevice frombeginning by

at_ble_status_tble_device_dead_handler(void*params)

ATBTLC1000


calling theat_ble_init.

Platform 1

Configure theprimary UARTinterface with

specifiedbaudrate

voidplatform_configure_primary_uart(uint32_t baudrate)

2

Configure thesecondary UARTwith hardwareflow control isenabled (Tx, Rx,RTS and CTS)

voidplatform_configure_hw_fc_uart(vo

id)

voidplatform_configure_hw_fc_uart(uint32_t baudrate)

3

Applicationmakes the HostMCU to sleep or

to RTOSenvironment,

which yields thetask for

scheduler toperform other

task

voidplatform_enter_sleep(void)

Sam0/serial_drv.c

1Dynamic Baudrateconfiguration

for Host

voidconfigure_usart_after_patch(void

)

voidconfigure_usart_after_patch(uint32_t )

2

Serial driverinitializationfor ATBTLC1000communication

uint8_tconfigure_serial

_drv(void)

uint8_tconfigure_serial_drv(uint32_t)

3Set Host UARTRTS pin to high

voidplatform_set_btlc1000_rts_high(void)

4Set Host UARTRTS pin to Low

voidplatform_set_btlc1000_rts_low(void)

5Set platformHost to sleep

voidplatform_set_hostsleep(void)

ATBTLC1000


6

Restore theplatform from

sleep for normalcommunication

voidplatform_restore_from_sleep(void)

7

Configure theSleep managerfor Host sleepfunctionality

voidplatform_configure_sleep_manager(void)

Timer_hw.h 1Platform createtimer API name

changed

void*platform_configure_timer(platform_hw_timer_call

back_tbus_tc_cb_ptr)

void*platform_create_hw_timer(platform_hw_timer_callback_tbus_tc_cb_ptr)

2

Platform starttimer APIchanged toreflect thetimer unit in

seconds

voidhw_timer_start(u

int32_ttimer_val)

voidhw_timer_start(uint32_ttimer_val_s)

3

Platform APIadded to startthe timer withtime units in ms

voidhw_timer_start_ms(uint32_ttimer_val_ms)

The following table provides the details on "Data Structures".

Table 12-2. DATA STRUCTURES

Category Description Status Structure Name

BLE-Manager BLE GAP Event callbacktypes

New ble_gap_event_cb_t

BLE GATT Client callbacktypes

New ble_gatt_client_event_cb_t

BLE GATT Servercallback types

New ble_gatt_server_event_cb_t

BLE L2CAP callbacktypes

New ble_l2cap_event_cb_t

BLE HTPT event callbacktypes

New ble_htpt_event_cb_t

BLE DTM event callbacktypes

New ble_dtm_event_cb_t

ATBTLC1000


BLE Custom eventcallback types

New ble_custom_event_cb_t

This event types are usedto:

• subscribe theGroup of BLE

Event callbacks or• un-subscribe the

Group of BLEEvent callbacks

New ble_mgr_event_t

Subscribe the events orUn-subscribe the events.

New ble_mgr_event_cb_t

Advertisement/Scanningthe Link layer states andPaired encryption statesused by BLE manager.

New ble_device_ll_state_t

Client characteristics theConfiguration descriptor

status.

New ble_gatt_cccd_status_t

Memory for BLE eventpool and Host UART

received bytes are storedin FIFO memory.

New Uint32_t event_pool_memory,rx_fifo_memory

Resolve the Address flag,used to identify theaddress of the peer

device, which is alreadyknown to host MCU.

New resolve_addr_flag

12.2 BLE Library API – New FeaturesBluSDK v6.1 release includes an enhanced version of BLE API compatible with ATBTLC1000 Rev B1and BLE 4.1 compliant devices. This section provide details of the new features introduced in the API anda change comparison with the previous version of the API.Table 12-3. NEW FEATURES IN THE API

Category New features Description API/Event

Dynamic Baudrate Select the UARTBaudrate from userapplication, duringinitialization (9600,

19200, 38400, 57600,

at_ble_init

ATBTLC1000


115200, 230400,460800, and 921600)

UARTthroughput

Dynamic event pool depth User applicationallocates the required

memory pools forevents and event

parameters dependingon applicationrequirements.

at_ble_init

Event pool Ability for Host MCU to detect thefailures in ATBTLC1000 and

recover from it

New events added toinform the host of crash/failures and allows host

to recover from thisstate.

Support forRTOS/HostMCU Sleep

API library to the support widerange of RTOS with less changes

Or

New API defined to yieldthe tasks to schedulerfor supporting RTOS

features and supportingHost MCU Sleep.

Or

at_ble_event_wait

Feature to support Host MCUSleep

Defining requirements toreuse the Host IRQ

signal fromATBTLC1000 for UART

interfaces to supportHost MCU Sleep.

at_ble_event_wait

Eddystonebeacon

Add the following APIs to supportEddystone beacon:

• at_ble_adv_data_update_on_the_fly

• at_ble_get_adv_cnt• at_ble_rst_adv_cnt• at_ble_en_recv_adv_cm

p_event• AT_BLE_ADV_CMP_EVENT

Set ULPdelay

Set the ULP delay based on theCrystal Startup time

Add support for differentULP delay parameters

at_ble_set_ulp_delay

RTOSsupport

enhancement

Enhance RTOS support by addingsignals to provide context switchingwith complete take over to the OS.

Following API'sfunctions need's to be

implemented andregistered before callingat_ble_init. For

void*(*at_ble_create_si

gnal)(void);

void(*at_ble_delete_sig

nal)(void *);

ATBTLC1000


more information referplatform porting guide.

void(*at_ble_trigger_si

gnal)(void *);

void(*at_ble_reset_sign

al)(void *);

void(*at_ble_wait_for_signal)(uint32_t,

void **);

12.3 Differences between BLE APIs - BluSDK 6.1 versus BluSDK 5.0Table 12-4. MODIFIED API

Category Feature Old signature New signature

SystemInitialization

AdvertisementChannel mapsetting API

at_ble_set_adv_channel_Map

at_ble_adv_channel_map_set

Table 12-5. MODIFIED STRUCTURES

Category New features Status Structure Name

SystemInitialization

Platform callbackregister New

at_ble_platform_api_list_t

GAP Structures Bus information New at_ble_bus_info_t

Init Configuration Modified at_ble_init_config_t

ATBTLC1000


13. Appendix 2 - Hardware UART Flow Control SettingsGo to below path and set the configurations on Project Settings.

Project Settings > Properties > Toolchain > ARM/GNU C Compiler > Symbols.

Table 13-1. HARDWARE UART FLOW CONTROL SETTINGS

FLOW CONTROL Mode Description Supported ATBTLC1000Module and Host MCU

UART_FLOWCONTROL_4WIRE_MODE= true

UART_FLOWCONTROL_6WIRE_MODE= false

Only one UART is used forboth patch download andUART data transmission byusing flow control. To test thismode, eFuse must be set. Usethe GUI to write eFuse5 andOffset 0xc to 0x10000000

Host MCU: SAM L21,SAM L22, SAM G55, SAM4S and SAM D21

ATBTLC1000:ATBTLC1000 XPro-MRmodule (with eFuse) andATBTLC1000 XPro-ZRmodule come with flowcontrol in eFuse by default



Two UARTs are used; one forpatch download and anotherone for UART datatransmission with flow control

Host MCU: SAM L21,SAM L22, SAM G55 andSAM D21

ATBTLC1000: OnlyATBTLC1000 XPro-MRModule (without eFuse)



Invalid option Not supportedUART_FLOWCONTROL_4WIRE_MODE= true


13.1 ATBTLC1000 InitializationIn case of BluSDK or supplied BluSDK, the BLE Manager is not used and the below settings are requiredfor at_ble_init API. This parameters are passed as arguments to at_ble_init. These arguments containsat_ble_init_config_t and platform_config structures. This structures are to be properly initialised andpassed to at_ble_init API. In case of incorrect configuration, the wrong patch file downloads intoATBTLC1000, which disrupts an UART functionality.

Register Platform API’s for ATBTLC1000 communication

at_ble_init_config_t pf_cfg = { /* Register Platform callback API's */ .platform_api_list.at_ble_create_timer = platform_create_timer,.platform_api_list.at_ble_delete_timer = platform_delete_timer,.platform_api_list.at_ble_start_timer = platform_start_timer,.platform_api_list.at_ble_stop_timer = platform_stop_timer,

ATBTLC1000


.platform_api_list.at_ble_sleep = platform_sleep,

.platform_api_list.at_ble_gpio_set = platform_gpio_set,

.platform_api_list.at_ble_send_sync = platform_send_sync,

.platform_api_list.at_ble_recv_async = platform_recv_async,

.platform_api_list.at_ble_reconfigure_usart = platform_configure_hw_fc_uart,

.platform_api_list.at_ble_event_wait = platform_enter_sleep};

Attribute data base memory

pf_cfg.memPool.memSize = BLE_ATT_DB_MEMORY_SIZE; pf_cfg.memPool.memStartAdd = (uint8_t *)&att_db_data;

Memory for Events and UART Rx FIFO

pf_cfg.event_mem_pool.memStartAdd = (uint8_t *)event_pool_memory; pf_cfg.event_mem_pool.memSize = sizeof(event_pool_memory); pf_cfg.event_params_mem_pool.memStartAdd = (uint8_t *)event_params_memory; pf_cfg.event_params_mem_pool.memSize = sizeof(event_params_memory); pf_cfg.rx_fifo_mem_pool.memStartAdd = (uint8_t *)rx_fifo_memory;pf_cfg.rx_fifo_mem_pool.memSize = sizeof(rx_fifo_memory);

Module Configuration:

For ATBTLC1000-ZR module

pf_cfg.btlc1000_module_version = AT_BTLC1000_ZR;

For ATBTLC1000-MR module

pf_cfg.btlc1000_module_version = AT_BTLC1000_MR;

Bus type configuration

pf_cfg.bus_info.bus_type = AT_BLE_UART;

Host Wake-up ATBTLC1000 Pin No configuration

pf_cfg.bus_info.host_external_wakeup_gpio = BTLC1000_EXT_PIN9;

Hardware Flow Control Enabling thru Patch

pf_cfg.bus_info.bus_flow_control_enabled = true; pf_cfg.platform_api_list.at_ble_reconfigure_usart = platform_configure_hw_fc_uart; //Configure secondary USART with Hardware Flow control enabled.

Hardware Flow Control Enabled via eFuse

pf_cfg.bus_info.bus_flow_control_enabled = false; pf_cfg.platform_api_list.at_ble_reconfigure_usart = platform_configure_primary_uart;//Re-configure the USART with specified baudrate.

Host ATBTLC1000 Communication Baudrate

pf_cfg.bus_info.bus_baudrate = HOST_UART_BAUDRATE_CONFIG_VALUE; // 9600, 19200, 38400, 57600, 115200, 230400 and 460800.

Set Device configuration

Device configurations are like Device role, GATT handles, MTU value, enable service changed indication,device address and address renewal duration etc.

Refer ble_mgr.c ble_set_dev_config and ble_device_init API for (at_ble_init) initialization.

ATBTLC1000


Refer supplied: AT_BLE_API_USER_MANUAL.chm, for more information.

13.2 Hardware Interface details (With Adapter board)The ATBTLC1000-XPRO-ADPT is an adapter board used with ATBTLC1000-XPRO expansion board. Itis required for an UART hardware flow control functionality to operate correctly, when the ATBTLC1000-XPRO expansion board is connected to certain Xplained MCU base boards.

Note: Adapter board is not required for ATBTLC1000-ZR.

The ATBTLC1000XPRO-ADP adapter board support the SMART SAM L21 Xplained Pro, SAM D21Xplained Pro, SAM 4S Xplained Pro and SAM G55 Xplained Pro boards.

For more information, refer http://www.microchip.com/developmenttools/productdetails.aspx?partno=atbtlc1000-xpro

Table 13-2. ADAPTOR BOARD REQUIREMENT

Host XPlainedPro Board

Host FlowControl Mode

ATBTLC1000eFuse Required

ATBTLC1000Adapter Board

Required

Adaptor BoardJumper Configuration

SAM D21 XPro,SAM L21 XPro,

SAM L22 XPro4-Wire mode Yes Yes

Jumpers must beplaced only on W2 and

W3 sides

SAM D21 XPro,SAM L21 XPro,

SAM L22 XPro6-Wire mode No No Not applicable

SAM G55 XPro,

SAM 4S XPro4-Wire mode Yes Yes

Jumpers must beplaced only on W1 and

W3 sides

SAM G55 XPro 6-Wire mode No YesJumpers must be

placed only on W1 andW4 sides

SAM 4S XPro 6-Wire modeNot Supported No No Not applicable

13.3 Hardware Interface details (without Adapter board)Loose wires are connected to support UART hardware flow control for SAM G55 (4-Wire, 6-Wire) andSAM D21/L21/L22/4S (4-Wire).

ATBTLC1000


http://www.microchip.com/developmenttools/productdetails.aspx?partno=atbtlc1000-xprohttp://www.microchip.com/developmenttools/productdetails.aspx?partno=atbtlc1000-xpro

Figure 13-1. HARDWARE INTERFACE DETAILS (WITHOUT ADAPTER BOARD)

The following table specify the details on SAM G55 4-Wire mode UART flow control connection (Pinmapping).

Table 13-3. HARDWARE FLOW CONTROL 4-WIRE MODE INTERFACE DETAILS – ATBTLC1000 MRMODULE

Pin Description SAM G55/SAM 4SXPro (EXT1)SAM D21/L21/L22

XPro (EXT1) ATBTLC1000 XPro

ATBTLC1000 Wake-up

(EXT1-PIN4) (EXT1-PIN6) PIN6 – ATBTLC1000 Wake-up

ATBTLC1000 ChipEnable

(EXT1-PIN10) (EXT1-PIN4) PIN10 – ATBTLC1000 Chip Enable

MCU UART Rx (EXT1-PIN13) (EXT1-PIN15) PIN13 – ATBTLC1000 Tx

MCU UART Tx (EXT1-PIN14) (EXT1-PIN17) PIN14 – ATBTLC1000 Rx

MCU UART RTS (EXT1-PIN5) (EXT1-PIN16) PIN11 – ATBTLC1000 CTS

MCU UART CTS (EXT1-PIN6) (EXT1-PIN18) PIN12 – ATBTLC1000 RTS

Host Wake-up (EXT1-PIN9) (EXT1-PIN9) PIN9 – GPIO_MS1

GND (EXT1-PIN19) (EXT1-PIN19) PIN19 – GND

VCC (EXT1-PIN20) (EXT1-PIN20) PIN20 – VCC

Table 13-4. HARDWARE FLOW CONTROL 4-WIRE MODE INTERFACE DETAILS – ATBTLC1000 ZRMODULE



ATBTLC1000 Wake-up

(EXT1-PIN3) (EXT1-PIN3) PIN6 – ATBTLC1000 Wake-up


(EXT1-PIN7) (EXT1-PIN7) PIN10 – ATBTLC1000 Chip Enable

ATBTLC1000




MCU UART Rx (EXT1-PIN13) (EXT1-PIN15) PIN13 – ATBTLC1000 Tx

MCU UART Tx (EXT1-PIN14) (EXT1-PIN17) PIN14 – ATBTLC1000 Rx

MCU UART RTS (EXT1-PIN5) (EXT1-PIN16) PIN11 – ATBTLC1000 CTS

MCU UART CTS (EXT1-PIN6) (EXT1-PIN18) PIN12 – ATBTLC1000 RTS




Table 13-5. HARDWARE FLOW CONTROL 6-WIRE MODE INTERFACE DETAILS – ATBTLC1000 MRMODULE

Pin Description SAM G55 XPro(EXT1)SAM D21/L21/L22


ATBTLC1000 Wake-up (EXT1-PIN4) (EXT1-PIN6) PIN6 – ATBTLC1000 Wake-up


(EXT1-PIN10) (EXT1-PIN4) PIN10 – ATBTLC1000 ChipEnable

MCU Primary UART Rx (EXT1-PIN17) (EXT1-PIN13) PIN13 – ATBTLC1000 Tx

MCU Primary UART Tx (EXT1-PIN16) (EXT1-PIN14) PIN14 – ATBTLC1000 Rx

MCU Secondary UARTRx

(EXT1-PIN13) (EXT1-PIN15) PIN13 – ATBTLC1000 Tx

MCU Secondary UARTTx

(EXT1-PIN14) (EXT1-PIN17) PIN14 – ATBTLC1000 Rx

MCU Secondary UARTRTS

(EXT1-PIN5) (EXT1-PIN16) PIN11 – ATBTLC1000 CTS

MCU Secondary UARTCTS

(EXT1-PIN6) (EXT1-PIN18) PIN12 – ATBTLC1000 RTS




Note: Only Primary USART is used for enabling the Hardware flow control on Secondary USART. All thecommunications happen through the secondary USART after enabling the Hardware flow control .

For equivalent pin names for respective platforms, refer the following documents.

http://ww1.microchip.com/downloads/en/devicedoc/atmel-42474-sam-l22-xplained-pro_user-guide.pdf

ATBTLC1000


http://ww1.microchip.com/downloads/en/devicedoc/atmel-42474-sam-l22-xplained-pro_user-guide.pdf

http://ww1.microchip.com/downloads/en/devicedoc/atmel-42405-saml21-xplained-pro_user-guide.pdf

http://ww1.microchip.com/downloads/en/devicedoc/atmel-42220-samd21-xplained-pro_user-guide.pdf

http://ww1.microchip.com/downloads/en/devicedoc/atmel-42389-sam-g55-xplained-pro_user-guide.pdf

http://ww1.microchip.com/downloads/en/devicedoc/atmel-42075-sam4s-xplained-pro_user-guide.pdf

ATBTLC1000


http://ww1.microchip.com/downloads/en/devicedoc/atmel-42405-saml21-xplained-pro_user-guide.pdfhttp://ww1.microchip.com/downloads/en/devicedoc/atmel-42220-samd21-xplained-pro_user-guide.pdfhttp://ww1.microchip.com/downloads/en/devicedoc/atmel-42389-sam-g55-xplained-pro_user-guide.pdfhttp://ww1.microchip.com/downloads/en/devicedoc/atmel-42075-sam4s-xplained-pro_user-guide.pdf

14. Hardware Resources used by BluSDK

14.1 Timer

Board BLE Library Timer 0 BLE Library Timer 1 Application Timer

SAM D21 XPro TC4 TC6 TC3

SAM G55 XPro TC0

(ID_TC1)

TC0

(ID_TC2)

TC0

(ID_TC0)

SAM 4S XPro TC0

(ID_TC1)

TC0

(ID_TC2)

TC0

(ID_TC0)

SAM L21 XPro TC0 TC2 TC4

SAM L22 XPro TC0 TC2 TC3

Note: Timer can be changed by user.

14.2 UART

Board 6-Wire Mode 4-Wire Mode

SAM D21 SERCOM4, SERCOM0 SERCOM0

SAM 4S Not Applicable USART1

SAM G55 USART0, USART5 USART0

SAM L21 SERCOM4, SERCOM0 SERCOM0

SAM L22 SERCOM2, SERCOM3 SERCOM3

Note: The SERCOM's listed are based on UART available on evaluation board. The customer canchange these SERCOM's as per their board configuration.

14.3 GPIOFor controlling the ATBTLC1000 Wake-up pin and ATBTLC1000 Chip Enable pin, refer the pins used in Hardware Interface details (without Adapter board).

ATBTLC1000


15. Appendix 3 - ASF installation instructions for Atmel Studio 7.0This section describes the step by step procedure for installation of new Atmel Software Framework intoAtmel Studio 7.0.

15.1 Installation Steps for VSIX File1. Click Tools > Extensions and Updates.

2. Select “Atmel Software Framework” and click Uninstall on Extension and Updates window.

3. Click Yes to uninstall the Atmel Software Framework.

ATBTLC1000


4. Click Tools > Command Prompt.

5. Install Command Prompt and type format vsixinstaller.exe[vsix_path\][filename.vsix, and then click Yes in next dialog box.Note: Example: vsixinstaller.exe C:\ATBTLC1000\as-asf-vsix-7.0.352-win32.win32.x86.vsix.

6. Click Install to continue the VSIX installation.

ATBTLC1000


7. Click Close and restart the Atmel Studio 7.0.

ATBTLC1000


15.2 External Interrupt (Host Wake-up)Any new event in the ATBTLC1000 board, wakes up the MCU. This wake-up happens from configuredexternal interrupt to receive the event. For pin information, refer Hardware Interface details (withoutAdapter board).

ATBTLC1000


16. Appendix 4 - Re-initializing the BluSDK librarySupport for re-initializing the Library is added in BluSDKv6.1. This support is added under symbolBTLC_REINIT_SUPPORT. So, by default the symbol is not enabled, the user needs to enable by addingthis symbol into the project (IAR, GCC Makefile, Atmel Studio).

Figure 16-1. RE-INITIALIZATION OF BluSDK LIBRARY

ATBTLC1000


The Microchip Web SiteMicrochip provides online support via our web site at http://www.microchip.com/. This web site is used asa means to make files and information easily available to customers. Accessible by using your favoriteInternet browser, the web site contains the following information:

• Product Support – Data sheets and errata, application notes and sample programs, designresources, user’s guides and hardware support documents, latest software releases and archivedsoftware

• General Technical Support – Frequently Asked Questions (FAQ), technical support requests,online discussion groups, Microchip consultant program member listing

• Business of Microchip – Product selector and ordering guides, latest Microchip press releases,listing of seminars and events, listings of Microchip sales offices, distributors and factoryrepresentatives

Customer Change Notification ServiceMicrochip’s customer notification service helps keep customers current on Microchip products.Subscribers will receive e-mail notification whenever there are changes, updates, revisions or erratarelated to a specified product family or development tool of interest.

To register, access the Microchip web site at http://www.microchip.com/. Under “Support”, click on“Customer Change Notification” and follow the registration instructions.

Customer SupportUsers of Microchip products can receive assistance through several channels:

• Distributor or Representative• Local Sales Office• Field Application Engineer (FAE)• Technical Support

Customers should contact their distributor, representative or Field Application Engineer (FAE) for support.Local sales offices are also available to help customers. A listing of sales offices and locations is includedin the back of this document.

Technical support is available through the web site at: http://www.microchip.com/support

ATBTLC1000


http://www.microchip.com/http://www.microchip.com/http://www.microchip.com/support

Product Identification SystemTo order or obtain information, e.g., on pricing or delivery, refer to the factory or the listed sales office.

PART NO. –X /XX

Package

[X](1)

Tape and Reel

Device TemperatureRange

Device: Device A, Feature A, (Package A)Device B, Feature B, (Package B)

Tape & Reel Option: Blank = Tube

T = Tape & Reel

Temperature Range: I = -40°C to +85°C (Industrial)

E = -40°C to +125°C (Extended)

Package: AA = Package AA

BB = Package BB

Examples:• MCPXXXXXAT-E/AA: Tape and Reel, Extended temperature, XAA package• MCPXXXXXBT-E/BB: Tape and Reel Extended temperature, XBB package

Note: 1. Tape and Reel identifier only appears in the catalog part number description. This identifier is used

for ordering purposes and is not printed on the device package. Check with your Microchip SalesOffice for package availability with the Tape and Reel option.

2. Small form-factor packaging options may be available. Please check http://www.microchip.com/packaging for small-form factor package availability, or contact your local Sales Office.

Microchip Devices Code Protection FeatureNote the following details of the code protection feature on Microchip devices:

• Microchip products meet the specification contained in their particular Microchip Data Sheet.• Microchip believes that its family of products is one of the most secure families of its kind on the

market today, when used in the intended manner and under normal conditions.• There are dishonest and possibly illegal methods used to breach the code protection feature. All of

these methods, to our knowledge, require using the Microchip products in a manner outside theoperating specifications contained in Microchip’s Data Sheets. Most likely, the person doing so isengaged in theft of intellectual property.

• Microchip is willing to work with the customer who is concerned about the integrity of their code.• Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their

code. Code protection does not mean that we are guaranteeing the product as “unbreakable.”

Code protection is constantly evolving. We at Microchip are committed to continuously improving thecode protection features of our products. Attempts to break Microchip’s code protection feature may be aviolation of the Digital Millennium Copyright Act. If such acts allow unauthorized access to your softwareor other copyrighted work, you may have a right to sue for relief under that Act.

ATBTLC1000


http://www.microchip.com/packaginghttp://www.microchip.com/packaging

Legal NoticeInformation contained in this publication regarding device applications and the like is provided only foryour convenience and may be superseded by updates. It is your responsibility to ensure that yourapplication meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS ORWARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORYOR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITSCONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE.Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in lifesupport and/or safety applications is entirely at the buyer’s risk, and the buyer agrees to defend,indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resultingfrom such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectualproperty rights unless otherwise stated.

TrademarksThe Microchip name and logo, the Microchip logo, AnyRate, AVR, AVR logo, AVR Freaks, BeaconThings,BitCloud, CryptoMemory, CryptoRF, dsPIC, FlashFlex, flexPWR, Heldo, JukeBlox, KeeLoq, KeeLoq logo,Kleer, LANCheck, LINK MD, maXStylus, maXTouch, MediaLB, megaAVR, MOST, MOST logo, MPLAB,OptoLyzer, PIC, picoPower, PICSTART, PIC32 logo, Prochip Designer, QTouch, RightTouch, SAM-BA,SpyNIC, SST, SST Logo, SuperFlash, tinyAVR, UNI/O, and XMEGA are registered trademarks ofMicrochip Technology Incorporated in the U.S.A. and other countries.

ClockWorks, The Embedded Control Solutions Company, EtherSynch, Hyper Speed Control, HyperLightLoad, IntelliMOS, mTouch, Precision Edge, and Quiet-Wire are registered trademarks of MicrochipTechnology Incorporated in the U.S.A.

Adjacent Key Suppression, AKS, Analog-for-the-Digital Age, Any Capacitor, AnyIn, AnyOut, BodyCom,chipKIT, chipKIT logo, CodeGuard, CryptoAuthentication, CryptoCompanion, CryptoController,dsPICDEM, dsPICDEM.net, Dynamic Average Matching, DAM, ECAN, EtherGREEN, In-Circuit SerialProgramming, ICSP, Inter-Chip Connectivity, JitterBlocker, KleerNet, KleerNet logo, Mindi, MiWi,motorBench, MPASM, MPF, MPLAB Certified logo, MPLIB, MPLINK, MultiTRAK, NetDetach, OmniscientCode Generation, PICDEM, PICDEM.net, PICkit, PICtail, PureSilicon, QMatrix, RightTouch logo, REALICE, Ripple Blocker, SAM-ICE, Serial Quad I/O, SMART-I.S., SQI, SuperSwitcher, SuperSwitcher II, TotalEndurance, TSHARC, USBCheck, VariSense, ViewSpan, WiperLock, Wireless DNA, and ZENA aretrademarks of Microchip Technology Incorporated in the U.S.A. and other countries.

SQTP is a service mark of Microchip Technology Incorporated in the U.S.A.

Silicon Storage Technology is a registered trademark of Microchip Technology Inc. in other countries.

GestIC is a registered trademark of Microchip Technology Germany II GmbH & Co. KG, a subsidiary ofMicrochip Technology Inc., in other countries.

All other trademarks mentioned herein are property of their respective companies.© 2017, Microchip Technology Incorporated, Printed in the U.S.A., All Rights Reserved.

ISBN: xxx-x-xxxxx-xxx-x

Quality Management System Certified by DNV

ISO/TS 16949Microchip received ISO/TS-16949:2009 certification for its worldwide headquarters, design and waferfabrication facilities in Chandler and Tempe, Arizona; Gresham, Oregon and design centers in Californiaand India. The Company’s quality system processes and procedures are for its PIC® MCUs and dsPIC®

ATBTLC1000


DSCs, KEELOQ® code hopping devices, Serial EEPROMs, microperipherals, nonvolatile memory andanalog products. In addition, Microchip’s quality system for the design and manufacture of developmentsystems is ISO 9001:2000 certified.

ATBTLC1000


AMERICAS ASIA/PACIFIC ASIA/PACIFIC EUROPECorporate Office2355 West Chandler Blvd.Chandler, AZ 85224-6199Tel: 480-792-7200Fax: 480-792-7277Technical Support:http://www.microchip.com/supportWeb Address:www.microchip.comAtlantaDuluth, GATel: 678-957-9614Fax: 678-957-1455Austin, TXTel: 512-257-3370BostonWestborough, MATel: 774-760-0087Fax: 774-760-0088ChicagoItasca, ILTel: 630-285-0071Fax: 630-285-0075DallasAddison, TXTel: 972-818-7423Fax: 972-818-2924DetroitNovi, MITel: 248-848-4000Houston, TXTel: 281-894-5983IndianapolisNoblesville, INTel: 317-773-8323Fax: 317-773-5453Tel: 317-536-2380Los AngelesMission Viejo, CATel: 949-462-9523Fax: 949-462-9608Tel: 951-273-7800Raleigh, NCTel: 919-844-7510New York, NYTel: 631-435-6000San Jose, CATel: 408-735-9110Tel: 408-436-4270Canada - TorontoTel: 905-695-1980Fax: 905-695-2078

Asia Pacific OfficeSuites 3707-14, 37th FloorTower 6, The GatewayHarbour City, KowloonHong KongTel: 852-2943-5100Fax: 852-2401-3431Australia - SydneyTel: 61-2-9868-6733Fax: 61-2-9868-6755China - BeijingTel: 86-10-8569-7000Fax: 86-10-8528-2104China - ChengduTel: 86-28-8665-5511Fax: 86-28-8665-7889China - ChongqingTel: 86-23-8980-9588Fax: 86-23-8980-9500China - DongguanTel: 86-769-8702-9880China - GuangzhouTel: 86-20-8755-8029China - HangzhouTel: 86-571-8792-8115Fax: 86-571-8792-8116China - Hong Kong SARTel: 852-2943-5100Fax: 852-2401-3431China - NanjingTel: 86-25-8473-2460Fax: 86-25-8473-2470China - QingdaoTel: 86-532-8502-7355Fax: 86-532-8502-7205China - ShanghaiTel: 86-21-3326-8000Fax: 86-21-3326-8021China - ShenyangTel: 86-24-2334-2829Fax: 86-24-2334-2393China - ShenzhenTel: 86-755-8864-2200Fax: 86-755-8203-1760China - WuhanTel: 86-27-5980-5300Fax: 86-27-5980-5118China - XianTel: 86-29-8833-7252Fax: 86-29-8833-7256

China - XiamenTel: 86-592-2388138Fax: 86-592-2388130China - ZhuhaiTel: 86-756-3210040Fax: 86-756-3210049India - BangaloreTel: 91-80-3090-4444Fax: 91-80-3090-4123India - New DelhiTel: 91-11-4160-8631Fax: 91-11-4160-8632India - PuneTel: 91-20-3019-1500Japan - OsakaTel: 81-6-6152-7160Fax: 81-6-6152-9310Japan - TokyoTel: 81-3-6880- 3770Fax: 81-3-6880-3771Korea - DaeguTel: 82-53-744-4301Fax: 82-53-744-4302Korea - SeoulTel: 82-2-554-7200Fax: 82-2-558-5932 or82-2-558-5934Malaysia - Kuala LumpurTel: 60-3-6201-9857Fax: 60-3-6201-9859Malaysia - PenangTel: 60-4-227-8870Fax: 60-4-227-4068Philippines - ManilaTel: 63-2-634-9065Fax: 63-2-634-9069SingaporeTel: 65-6334-8870Fax: 65-6334-8850Taiwan - Hsin ChuTel: 886-3-5778-366Fax: 886-3-5770-955Taiwan - KaohsiungTel: 886-7-213-7830Taiwan - TaipeiTel: 886-2-2508-8600Fax: 886-2-2508-0102Thailand - BangkokTel: 66-2-694-1351Fax: 66-2-694-1350

Austria - WelsTel: 43-7242-2244-39Fax: 43-7242-2244-393Denmark - CopenhagenTel: 45-4450-2828Fax: 45-4485-2829Finland - EspooTel: 358-9-4520-820France - ParisTel: 33-1-69-53-63-20Fax: 33-1-69-30-90-79France - Saint CloudTel: 33-1-30-60-70-00Germany - GarchingTel: 49-8931-9700Germany - HaanTel: 49-2129-3766400Germany - HeilbronnTel: 49-7131-67-3636Germany - KarlsruheTel: 49-721-625370Germany - MunichTel: 49-89-627-144-0Fax: 49-89-627-144-44Germany - RosenheimTel: 49-8031-354-560Israel - Ra’ananaTel: 972-9-744-7705Italy - MilanTel: 39-0331-742611Fax: 39-0331-466781Italy - PadovaTel: 39-049-7625286Netherlands - DrunenTel: 31-416-690399Fax: 31-416-690340Norway - TrondheimTel: 47-7289-7561Poland - WarsawTel: 48-22-3325737Romania - BucharestTel: 40-21-407-87-50Spain - MadridTel: 34-91-708-08-90Fax: 34-91-708-08-91Sweden - GothenbergTel: 46-31-704-60-40Sweden - StockholmTel: 46-8-5090-4654UK - WokinghamTel: 44-118-921-5800Fax: 44-118-921-5820

Worldwide Sales and Service


DescriptionTable of Contents1. BluSDK Software Architecture2. Supported Hardware Platforms and IDEs3. BluSDK Host Library Supported Architecture and Compilers4. BluSDK Release contents4.1. BluSDK Firmware contents

5. BluSDK Release features6. Release Revision History6.1. BluSDK v6.16.1.1. Major New Features of BluSDK Software6.1.2. Major improvements and bug fixes

6.2. BluSDK v5.06.2.1. Major New Features of BluSDK Software6.2.2. Major improvements and bug fixes

6.3. BluSDK v4.06.3.1. Major New Features of BluSDK Software6.3.2. Mobile Application6.3.3. Adapter Library6.3.4. Major improvements and bug fixes

6.4. BluSDK v3.06.4.1. Major New Features of BluSDK Software6.4.2. Mobile Application6.4.3. Adapter Library6.4.4. Documentation

6.5. BluSDK v2.36.5.1. Major New Features of BluSDK Software



6.8. BluSDK v2.06.8.1. Major New Features of BluSDK Software6.8.2. Mobile Application6.8.3. Major improvements and bug fixes

7. Previous Release History - BluSDK v1.x8. Known issues9. Limitations9.1. BluSDK Software9.2. Mobile Applications

10. Additional Information/Pre-requisites11. Power save measure settings11.1. Hardware Setup11.1.1. Board Wiring11.1.2. Connection11.1.3. Trouble shooting (optionally)

11.2. Power measure with Data Visualizer11.3. Average Advertisement Current

12. Appendix 1 - Atmel BluSDK Change Log12.1. BluSDK Module Changes12.2. BLE Library API – New Features12.3. Differences between BLE APIs - BluSDK 6.1 versus BluSDK 5.0

13. Appendix 2 - Hardware UART Flow Control Settings13.1. ATBTLC1000 Initialization13.2. Hardware Interface details (With Adapter board)13.3. Hardware Interface details (without Adapter board)

14. Hardware Resources used by BluSDK14.1. Timer14.2. UART14.3. GPIO

15. Appendix 3 - ASF installation instructions for Atmel Studio 7.015.1. Installation Steps for VSIX File15.2. External Interrupt (Host Wake-up)

16. Appendix 4 - Re-initializing the BluSDK libraryThe Microchip Web SiteCustomer Change Notification ServiceCustomer SupportProduct Identification SystemMicrochip Devices Code Protection FeatureLegal NoticeTrademarksQuality Management System Certified by DNVWorldwide Sales and Service

blusdk v6.1 release notesww1.microchip.com/downloads/en/devicedoc/atbtlc1000-blusdk-… · 5....

Documents