atsamb11 blusdk smart v5.2 release - microchip...
TRANSCRIPT
ATSAMB11 BluSDK Smart v5.2 Release
Release Notes
Description
This document details the release notes for ATSAMB11 BluSDK Smart v5.2 for
Atmel Studio 7.0.
ATSAMB11 BluSDK Smart v5.2 Release Notes 2
2
Table of Contents
1 BluSDK Smart Software Architecture Overview ........................................................ 3
2 Supported Hardware Platforms and IDEs .................................................................. 4
3 BluSDK Smart Release contents ................................................................................ 5
3.1 BluSDK Smart SDK contents ................................................................................................................ 7
4 BluSDK Smart Release features ............................................................................... 10
5 Release Revision History .......................................................................................... 12
5.1 BluSDK Smart v5.2 ............................................................................................................................. 12
5.1.1 Major New Features ............................................................................................................... 12
5.1.2 Major improvements and bug fixes ......................................................................................... 12
5.2 BluSDK Smart v5.1 ............................................................................................................................. 12
5.2.1 Major New Features ............................................................................................................... 12
5.2.2 Major improvements and bug fixes ......................................................................................... 13
5.3 BluSDK Smart v5.0 ............................................................................................................................. 13
5.3.1 Major New Features ............................................................................................................... 13
5.3.2 Major improvements and bug fixes ......................................................................................... 13
5.4 BluSDK Smart v4.1 ............................................................................................................................. 14
5.4.1 Major New Features ............................................................................................................... 14
5.5 BluSDK Smart v4.0 ............................................................................................................................. 14
5.5.1 Major New Features ............................................................................................................... 14
5.6 BluSDK Smart v3.0 ............................................................................................................................. 14
5.6.1 Major New Features ............................................................................................................... 14
5.7 BluSDK Smart v2.1 ............................................................................................................................. 15
5.7.1 Major New Features ............................................................................................................... 15
5.8 BluSDK Smart v2.0 ............................................................................................................................. 15
5.8.1 Major New Features ............................................................................................................... 15
6 Known issues ............................................................................................................ 16
6.1 BluSDK Smart Software ...................................................................................................................... 16
6.2 Mobile Applications ............................................................................................................................. 16
7 Limitations ................................................................................................................. 17
7.1 BluSDK Smart Software ...................................................................................................................... 17
7.2 Mobile Applications ............................................................................................................................. 18
8 Additional Information / Pre-requisites .................................................................... 19
8.1 How to install SAMB11 device pack using Device Pack Manager ...................................................... 21
8.2 How to install SABM11 device pack with atpack file............................................................................ 23
8.3 How to measure power consumption .................................................................................................. 25
ATSAMB11 BluSDK Smart v5.2 Release Notes 3
3
1 BluSDK Smart Software Architecture Overview
ATSAMB11 BluSDK Smart v5.2 Release Notes 4
4
2 Supported Hardware Platforms and IDEs
BluSDK Smart – supported hardware and IDEs
Device Development Kit Supported IDEs
ATSAMB11G18A ATSAMB11 Xplained PRO Atmel Studio v7.0
Keil uVision v5.14.0.0
ATSAMB11 BluSDK Smart v5.2 Release Notes 5
5
3 BluSDK Smart Release contents
Folder Name Description
Documentation
Atmel Adapter Layer API Documentation
SAMB11 Platform Driver API Documentation
Software Development Guide
Interrupts and ULP Guide
Memory Map Guide
Wireless Composer Guide
BLE Example Application Getting Started Guide - Includes Getting started guides
for following example application
1. Proximity Monitor Profile Example
2. Proximity Reporter Profile Example
3. Apple Notification Centre Service Example
4. Battery Service Example
5. Observer Example
6. Device Information Service Example
7. Health Thermometer Profile Example
8. Time Information Profile Example
9. Scan Parameter Example
10. Simple Broadcaster Example
11. Simple BLE Connection Example
12. HID Keyboard Example
13. HID Mouse Example
14. Alert Notification Profile Example
15. Blood Pressure Profile Example
16. Custom Profile Example
17. Find Me Profile Example
18. Heart Rate Profile Example
19. Phone Alert Status Profile Example
20. Multi Role Multi Connect Example
21. Direct Test Mode Example
22. AT Command Example
23. OTAU Example
ATSAMB11 BluSDK Smart v5.2 Release Notes 6
6
Folder Name Description
SDK
Example BLE Apps, BLE Profiles, BLE Services are integrated in ASF. SDK is fully integrated in ASF version 3.32 and SAMB11 Device Pack must be up-dated to version 2.1.157.
Note :
1. Use Atmel Studio Extension Manager (Tools -> Extension Manager) or
visit Atmel Gallery to update ASF in Atmel Studio 7.0
Use Device Pack Manager (Tools-> Device Pack Manager) to update SAMB11
Device Pack.
Mobile
Application
Contains the following mobile applications:
- Atmel SmartConnect Android application having support for BLE profiles and
beacons can be downloaded from the following URL:[
https://play.google.com/store/apps/details?id=com.atmel.bleanalyser&hl=en ]
- Atmel Beacon Radar Android application can be downloaded from the
following URL:
[https://play.google.com/store/apps/details?id=au.net.iapps.atmel]
- Atmel SmartConnect iOS application having support for BLE profiles and
beacons can be downloaded from the following URL:[
https://itunes.apple.com/us/app/atmel-smart-
connect/id1041425299?ls=1&mt=8 ]
- Atmel Beacon Radar iOS application can be downloaded from the following
URL: [ https://itunes.apple.com/us/app/atmel-beacon-
radar/id989086488?mt=8 ]
ATSAMB11 BluSDK Smart v5.2 Release Notes 7
7
3.1 BluSDK Smart SDK contents
BluSDK Smart SDK builds and runs on a MCU host (supported platform). The Getting Started guide for each
profile example provide more information on how to find the example project using the ASF Example Project
Wizard, build, flash and execute the software.
Folder Name Description
apps
BLE Example Application Profiles and Services
Contains 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(ibeacon_app)
12. HID Keyboard Example(hid_device_keyboard)
13. HID Mouse Example(hid_mouse_keyboard)
14. Alert Notification Profile Example(alert_notification)
15. Blood Pressure Profile Example(blood_pressure)
16. Custom Profile Example(custom_serial_chat)
17. Find me Profile Example(find_me)
18. Heart Rate Profile Example(hr_sensor)
19. Phone Alert Status Profile Exmaple(phone_alert_status)
20. BLE Startup Template(startup_template)
21. Multi Role Multi Connect Example(multirole_multiconnect_app)
22. Direct Test Mode Example(ble_dtm)
23. AT Command Example(at_cmd_app)
24. Battery and Device Information Service with OTAU support
Example (bas_otau_app)
ATSAMB11 BluSDK Smart v5.2 Release Notes 8
8
Folder Name Description
ble_profiles
Contains the following BLE Profiles.
- Alert Notification
- ANCS
- Proximity Monitor
- Proximity Reporter
- Time Information
- HID over GATT profile (HOGP)
- Phone Alert Status
- Blood Pressure
- Heart Rate
- Find Me
- Custom Serial Chat
- OTAU Profile (Target)
ble_services
Contains the BLE Services.
- Alert Notification Service
- BLE Manager-Common BLE Event Frame Work
- 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
- OTAU Service (Target)
inc Top level includes for the delivered libraries, and Platform API’s
lib Adaptor Library
services Application level services and Platform level - console, serial driver, timer
ATSAMB11 BluSDK Smart v5.2 Release Notes 9
9
Folder Name Description
src Platform abstraction implementation for Atmel BLE Adapter Library
utils Utility functions used by BluSDK Smart components (Eg: DBG_LOG,
DBG_LOG_DEV etc.)
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
0
10
4 BluSDK Smart Release features
BluSDK Smart v5.2 release supports the following profiles and services.
Profiles
o Alert Notification
o Apple Alert Notification Center Service
o Blood Pressure
o Custom Serial Chat
o Find Me Target
o Heart Rate
o HOGP (HID Over GATT Profile)
o Health Thermometer
o Phone Alert Status
o Scan Parameters
o Time
o OTAU Profile(Target)
Services Support
o Alert Notification Service
o BLE Manager-Common BLE Event framework
o Apple Alert Notification Service (ANCS)
o Battery Service (BAS)
o Current Time Service(CTS)
o Device Information Service (DIS)
o Immediate Alert Service (IAS)
o Link Loss Service (LLS)
o Scan Parameter Service (SPS)
o Tx Power Service (TXPS)
o HID Device (HOGP Service)
o Blood Pressure
o Custom Serial Chat Service
o Heart Rate Service
o Next DST Service
o Phone Alert Service
o Reference Time Service
o OTAU Service(Target)
Mobile Applications:
o Atmel SmartConnect Mobile Application for Android:
Health Thermometer
Proximity Monitor
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
1
11
Blood Pressure
Alert Notification
Time Information
Scan Parameters
Find Me
Heart Rate
Battery
Device Information Service
OTAU (Manager)
o Atmel SmartConnect Mobile Application for iOS
Health Thermometer
Proximity Monitor
Blood Pressure
Scan Parameters
Find Me
Heart Rate
Battery
Device Information Service
OTAU (Manager)
o Atmel Beacon Radar (Android and iOS)
Example applications are provided for the profile/services mentioned above and are available for Atmel
SAMB11 MCU platform.
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
2
12
5 Release Revision History
5.1 BluSDK Smart v5.2
5.1.1 Major New Features
BluSDK Smart Software
Addition of an example application supporting and demonstrating basic OTAU (Over The Air
Upgrade). Example is based on Battery and Device Information Service. The following are the top
level features of OTAU service/profile:
a. Fail-Safe upgrade mechanism
b. Image integrity check using 32-bit CRC
c. Updated process can resume back from left over during power interruptions and any other
interrupts
d. Application profile and OTAU profile can run in parallel
e. Pause and Resume of the upgrade supported at both OTAU Manager and OTAU Target
f. Forced upgrade – OTAU Manager can initiate to download same version of software as
and when required. Pause and Resume is not allowed during this operation.
g. Easy to include OTAU profile in any BLE application
GATT level user configurable authentication
Atmel Adapter Library & Firmware
No change.
Mobile Application
Enhanced: Atmel SmartConnect (Version 3.0) for both Android and iOS to support OTAU and
integrated Beacon Radar .
Platform
No change.
Tools
Support for creation of factory and OTAU image by using new ‘OTAUImageCreator’ tool.
5.1.2 Major improvements and bug fixes
Simplified Start-up template.
5.2 BluSDK Smart v5.1
5.2.1 Major New Features
BluSDK Smart Software
Add Direct Test Mode and AT CMD example.
ULP examples with AON_GPIO and AON_Timer Support
Atmel Adapter Library & Firmware
AON (Always ON) Timer support.
AON GPIO support
GPIOs latch to maintain GPIO status in ULP mode.
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
3
13
Fixed WDT ISR handler.
.
Platform
platform_chip_reset API updated.
Tools
Support for Atmel Wireless Composer/Performance Analyzer using Direct Test Mode example
5.2.2 Major improvements and bug fixes
Fix BLECORE-795 issue (WDT reset is not behalf as expected).
Fix BLECORE-865 issue (Support for AON_GPIO callback).
Fix BLECORE-874 issue (Save and restore of pull enables).
Fix BLECORE-876 issue (Disabling the output enables for GPIO 14 and GPIO 15).
Fix BLUSMART-73 issue (Disconnect test with HTPT).
Fix BLUSMART-74 issue (Reconnect test with HTPT).
Fix BLUSMART-77 issue (System blocked with ‘send_plf_int_msg_ind' API).
Fix BLUSMART-78 issue (Advertising is stopped after first interrupt of AON timer).
Fix BLUSMART-88 issue (2MHz GPIO clock generating).
Fix BLUSMART-109 issue (The timeout of at_ble_event_get doesn't work).
Fix BLUSMART-110 issue (The platform_chip_reset api doesn't work.).
Fix BLUSMART-121 issue (AON timer working after adding debug message).
5.3 BluSDK Smart v5.0
5.3.1 Major New Features
Atmel Adapter Library
Support Timeout functionality for at_ble_event_get API.
API Updates
at_ble_event_get() can support timeout value.
At_ble_chip_reset() API added.
5.3.2 Major improvements and bug fixes
Fix vbat & vtemp calibration update issue
Fix channel 39 advertising issue
Fix disconnection with error 0x08
Fix disconnect with error 0x3E
Fix instability with some boards
Fix system reset issue
Fix timeout issue of at_ble_event_get
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
4
14
5.4 BluSDK Smart v4.1
5.4.1 Major New Features
BluSDK Smart Software
Support for Features like Multi-Role/Multi-Connect to maintain both central and peripheral role simulta-neously and multiple connections for various applications
Mobile Application
Enhanced: Atmel SmartConnect (Version 2.0) tablet application for iOS and Android
Atmel Adapter Library
Optimized ULP (Ultra Low Power) mode
Vbat/Temp calibration support
TX-FM calibration on cold-boot
Added 3 new APIs
at_ble_calib_config()
at_ble_calib_get_temp()
at_ble_calib_get_voltage()
Fix missing Advertising packet on Channel 37
5.5 BluSDK Smart v4.0
5.5.1 Major New Features
BluSDK Smart Software
1. Support for profiles like, Blood Pressure, Heart Rate Monitor, Phone Alert Status, Time
Information, Custom Serial Chat, Find Me, and Alert Notification on SAMB11 Platform.
2. Support for services like, Alert Notification, Blood Pressure, Custom Serial Chat, Current Time,
Heart Rate, Next Destination Standard Time, Phone Alert, and Reference Time on SAMB11
Platform.
5.6 BluSDK Smart v3.0
5.6.1 Major New Features
- Updated Profile and Example application. o Device information sample application. o Battery Service sample application. o Tx power Service sample application. o Device information sample application. o Battery Service sample application. o Scan Parameter Service sample application. o Proximity Monitor sample application. o Proximity Reporter sample application. o Simple Broadcaster sample application. o Simple Observer sample application.
- Included Test applications. o Atmel Smart BLU. o Atmel Beacon Rader. o Health Thermometer.
- Keil IDE support.
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
5
15
- SAMB11 Carrier Board and SAMB11 Xplained (A5) Board support.
5.7 BluSDK Smart v2.1
5.7.1 Major New Features
- Updated Profile and Example application. o HID keyboard o HID Mouse
- Included Test applications. o Atmel Smart BLU o Atmel Beacon Rader o Health Thermometer
- Keil IDE support. - SAMB11 Carrier Board and SAMB11 Xplained (A5) Board support.
5.8 BluSDK Smart v2.0
5.8.1 Major New Features
- Profile and Example application. o ANCS o TIP o HTPT o iBeacon
- Included Test applications. o Atmel Smart BLU o Atmel Beacon Rader o Health Thermometer
- Keil IDE support. - SAMB11 Carrier Board support.
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
6
16
6 Known issues
6.1 BluSDK Smart Software
JIRA ID Description
BLUSMART-60 Link layer connection failed to establish connection and returns 3E error
BLUSMART-66 unregistered interrupt can be added to registered interrupts list and vice-versa
BLUSMART-80 iOS Application / TIP / Go back from Bluetooth menu
BLUSMART-81 Connect and disconnect without user interact.
BLUSMART-83 BLP, TIP & HID App's hangs while continuously pressing SW0 button
BLUSMART-106 AON timer stops suddenly after 10 to 40 minutes
BLUSMART-107 SAMB11 halt while testing scan
BLUSMART-128 RX/TX current with Pre-release DTM tool measured is much different with datasheet
BLUSMART-130 BAS: Battery level shown on terminal even after device enter into ADV mode
BLUSMART-131 BAS: After new pairing Application getting struck On 0% battery level
BLUSMART-133 Validation / HTP / Multiple connect & disconnect
BLUSMART-134 Validation / PxP Monitor / Input Handling
BLUSMART-135 Validation / Find Me / Out of range + auto reconnection
6.2 Mobile Applications
JIRA ID Description
BLEMAPPS-6 RSSI value is fluctuating more for Android Proximity Reporter Application
BLEMAPPS-9 When Bluetooth is turned off during scan, the scan progress bar shows that scanning
is in progress
BLEMAPPS-25 Upon out of range and reconnect, ANP mobile app is not sending the alerts to client
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
7
17
7 Limitations
7.1 BluSDK Smart Software
1. Adapter Library & Platform
a. ULP (Ultra Low Power): the use of the ULP has some restrictions
Cannot use the ULP mode with any application that uses timers except AON timer.
After wake up from ULP mode, SAMB11 Peripherals should be reinitialized(ex. UART, SPI)
b. Single Thread mode only.
c. No OS Features available for User app.
2. Profiles
a. Common
i. ULP is enabled by default in the iBeacon and Battery example application.
ii. ULP is enabled optionally by using NENABLE_ULP or ENABLE_ULP symbol in the HID
keyboard example application.
iii. For other applications it is disabled explicitly. The rationale to disable ULP is because most of
the examples rely on user input via user button (SW0 button) on the SAMB11 Xplained PRO,
serial console that are not mapped as wake-up source on the development kit.
iv. ULP can be enabled by connecting an external wake-up source. The AO_GPIO pins are
mapped to the EXT1 header (pin 6/pin 9). Refer to the SAMB11 Xplained PRO User Guide
and also to Atmel-42662-ATSAMB11-BluSDK-SMART-Interrupts-and-ULP-Architecture-and-
Usage_UserGuide for further details.
v. AON timer is applied to only Battery Info example application.
b. HOGP – HID
i. HID Keyboard device example application and HID Mouse device example application are
compatible only with Android based mobile devices (Android 4.4/KitKat and higher versions).
ii. HID Keyboard device example application supports only Just Works pairing
c. Multi-Role/Multi-Connect
i. Both Scan and Advertisement can’t be performed simultaneously.
d. PTS Compliance
i. PTS compliance has not yet been achieved for the profile examples.
ii. ANCS & TIP are Apple iOS specific implementations and PTS test cannot be executed for BT
SIG profile specification compliance.
e. OTA Upgrade
i. Image security is not supported currently
ii. Individual section upgrade is not tested
iii. Pause and Resume is not enabled after completion of 98% upgrade to avoid the system enter
into sleep state.
iv. Downgrade is not possible as per the current system design.
3. IDE
a. IAR IDE is not supported.
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
8
18
7.2 Mobile Applications
1. Atmel SmartConnect Android Application
a. Common
i. When app is minimized and notifications sent from the device are not received
(background operation of application is not supported)
ii. Atmel SmartConnect Android application is currently not supported for Marshmallow
iii. Android Framework limitations
1. When mobile is already in vibration state, the alert read status sent from the App
shows vibrate status as inactive
2. When wrong pass-key is entered, pairing still succeeds
b. Phone Alert: Display state is not supported
c. Custom Serial Chat:
i. Android-4.4.4 (KitKat): Can support only upto 20 characters
ii. Android-5.x: (Lollipop): Can support upto 150 characters
iii. iOS: Can support upto 150 characters
iv. Android/iOS: Will not receive the data, if security is been disabled
2. Atmel SmartConnect iOS Application
a. When app is minimized and notifications sent from the device are not received (background
operation of application is not supported)
3. Atmel Beacon Radar (Android)
a. When the device is moved, the beacon icon updates are as fast as the movement pace.
ATSAMB11 BluSDK Smart v5.2 Release Notes 1
9
19
8 Additional Information / Pre-requisites
1. Testing ULP mode – pre-requisites
b. Following AON_GPIOs have to be connected to GND for ULP (Ultra Low Power) mode to fully function
properly. Leaving AON_GPIOs floating could produce undefined behavior.
AON_GPIO_0 : Pin 9 of EXT1 should be connected with GND
AON_GPIO_1 : Pin 9 of EXT3 should be connected with GND
AON_GPIO_2 : Pin 6 of EXT1 should be connected with GND
1.
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:
a. iOS:
i. iPhone 4S and above support BT 4.0 and higher. It is recommended to use a device with
iOS version 8.0 or above for best performance and stability
b. Android:
i. Preliminary support for BT 4.0 was added in Android Jellybean (4.2 onwards)
ii. For best performance and stability, it is recommended to use a device with Android version
above 4.4 (i.e. preferably Kit-Kat or Lollipop)
iii. Due to a wide-spectrum of Android devices with many variants (customized Android
devices, various hardware/connectivity chipset configurations) – performance of the BLE
Application may not be the same on all devices. Android phone that include a Bluetooth
chipset supporting version 4.0 or higher is a pre-requisite.
iv. Due to evolving nature of BLE APIs in Android, performance/stability variations may be
observed when testing with different Android release flavor’s (Jellybean/4.3, KitKat/4.4 and
Lollipop/5.1)
v. HID over GATT profile was introduced in Android from version 4.4 (KitKat). A mobile
device supporting Android 4.4 and higher is a pre-requisite for running the HID Keyboard
device and HID Mouse device example applications.
ATSAMB11 BluSDK Smart v5.2 Release Notes 2
0
20
vi. Disconnection triggered by application running in Android taking a long time (12 ~ 15
seconds) to complete.
vii. Nexus6/Stock Android version: Following issues have been observed
1. When peripheral device is reset, Android still shows this as a connected requiring
manual un-pair.
2. HTPT pairing is not successful with Lollipop version.
ATSAMB11 BluSDK Smart v5.2 Release Notes 2
1
21
8.1 How to install SAMB11 device pack using Device Pack Manager
1. Click Tools -> Device Pack Manager
2. Click ‘Check for Updates’ and check new pack of SAMB11 and “Install selected packs”
ATSAMB11 BluSDK Smart v5.2 Release Notes 2
2
22
3. Click ‘Install’
4. Click ‘Close’ and restart Atmel Studio
ATSAMB11 BluSDK Smart v5.2 Release Notes 2
3
23
8.2 How to install SABM11 device pack with atpack file
1. Click Tools -> Device Pack Manager
2. Click Install -> Browse pack file
3. Select atpack file and Open
ATSAMB11 BluSDK Smart v5.2 Release Notes 2
4
24
4. Click Install
ATSAMB11 BluSDK Smart v5.2 Release Notes 2
5
25
8.3 How to measure power consumption
1. ATSAMB11 board setting
a. The first jumper on the right (Below SW0 push button) should be on “By-Pass” position – (1)
b. The next one should be on “Measure” position – (2)
c. AON_GPIO_0 : Pin 9 of EXT1 should be connected with GND – (3)
d. AON_GPIO_1 : Pin 9 of EXT3 should be connected with GND – (4)
e. AON_GPIO_2 : Pin 6 of EXT1 should be connected with GND – (5)
2. Create iBeacon sample of SAMB11
3. Build the project and run
4. Click Tools -> Data Visualizer
ATSAMB11 BluSDK Smart v5.2 Release Notes 2
6
26
5. Press “Connect” – (1)
6. Checkmark “Power” – (2)
7. Press “Start” – (3)
8. The “Power Analysis” window opens – (4)
The measured value in the image will be optimized further.