Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC...

15
Introduction The BlueNRG-Mesh Android App is designed to help you evaluate the ST Bluetooth low energy Mesh solution. The application works with ST BLE devices running the embedded Mesh over Bluetooth low energy (MoBLE) library. You can use it to evaluate provisioning, un-provisioning and controlling MoBLE embedded nodes in a mesh network over the Bluetooth low energy protocol to create distributed control system such as smart lighting and home automation. Figure 1. ST BlueNRG-Mesh scenario Getting started with the ST BlueNRG-Mesh Android application UM2180 User manual UM2180 - Rev 1 - February 2018 For further information contact your local STMicroelectronics sales office. www.st.com

Transcript of Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC...

Page 1: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

IntroductionThe BlueNRG-Mesh Android App is designed to help you evaluate the ST Bluetooth low energy Mesh solution.

The application works with ST BLE devices running the embedded Mesh over Bluetooth low energy (MoBLE) library. You canuse it to evaluate provisioning, un-provisioning and controlling MoBLE embedded nodes in a mesh network over the Bluetoothlow energy protocol to create distributed control system such as smart lighting and home automation.

Figure 1. ST BlueNRG-Mesh scenario

Getting started with the ST BlueNRG-Mesh Android application

UM2180

User manual

UM2180 - Rev 1 - February 2018For further information contact your local STMicroelectronics sales office.

www.st.com

Page 2: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

1 Getting started with the app

1.1 Installing and running the appFollow the instructions below to install the BlueNRG-Mesh Android App on a compatible Android device.

Step 1. Download the application in one of the following ways:– a. Follow the link to Google Play® store at STSW-BNRG-Mesh to download the app directly to

your Android deviceor

– a. download the app apk file to your PC at STSW-BNRG-Meshb. transfer the apk to your Android devicec. find and launch the apk on your Android device

Step 2. Ensure that Bluetooth radio is enabled.Step 3. Click on the appropriate icon and accept the request prompt to turn on the Bluetooth radio to work with

the app.

Step 4. For Android 6.0 onwards, you must allow the location services (GPS) to work with BLE.

1.2 Introduction to the app controlsThe app has views for provisioned, un-provisioned and group nodes. The un-provisioned node view opens bydefault, as shown below.

UM2180Getting started with the app

UM2180 - Rev 1 page 2/15

Page 3: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Figure 2. ST BlueNRG-Mesh Android App home page with un-provisioned nodes

All the provisioned nodes are represented as DeviceNN (NN is the Provisioned Device number) as shown below.

Figure 3. ST BlueNRG-Mesh Android App home page with provisioned nodes

The following two figures show the Group management and About screens. The About screen has the versioninformation and software license agreement for the app.

UM2180Introduction to the app controls

UM2180 - Rev 1 page 3/15

Page 4: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Figure 4. Group management screen

UM2180Introduction to the app controls

UM2180 - Rev 1 page 4/15

Page 5: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Figure 5. About screen

1.3 Use of app on different Android smartphonesThe app is tested on most of the leading Android smart phones, including those listed in the table below. The appworks with Android 6.0 onwards and Bluetooth 4.0 onwards.

Table 1. Tested smart phones and Android versions

Company Model Android Version

Google Pixel 8.0.1

Motorola G Plus 7.0.1

Samsung Galaxy S5 6.0.1

Lenovo P1 6.0.1

Alcatel Go 6.0.1

Xiaomi Mi5 7.0.0

UM2180Use of app on different Android smartphones

UM2180 - Rev 1 page 5/15

Page 6: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

2 ST BlueNRG-Mesh Android App functionality

2.1 Provisioning the nodeProvisioning is a process of authenticating the nodes and bringing them into the BLE Mesh network.

Step 1. Launch the app.It shows the list of provisioned and un-provisioned devices along with their MAC Address, and an add(+) button to provision the nodes.

Step 2. Click the add (+) button to begin provisioning.Once the provisioning starts, you will see a window showing the provisioning status.

UM2180ST BlueNRG-Mesh Android App functionality

UM2180 - Rev 1 page 6/15

Page 7: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Step 3. Keep the kit stationary and near your Android Smartphone during provisioning procedure.The provisioning takes between 10 and 12 seconds depending on the smart phone hardwarecapability.The provisioned node is listed with a default DeviceNN name along with the MAC address and settingicon for individual node.

Step 4. Press the bulb icon next to the device name to turn the LED on and off.The proxy node is indicated by blue circle around the bulb icon.The provisioned is listed with a default DeviceNN (Device 01 in this example) name along with theMAC address and setting button.

Step 5. Press the bulb icon next to the device name to turn the LED on the device on and off.

UM2180Provisioning the node

UM2180 - Rev 1 page 7/15

Page 8: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

2.2 Un-provisioning the nodeUn-provisioning the node involves removing the node from the BLE Mesh network.

Step 1. To un-provision the nodes, go to the setting view of the nodes and click the “Remove Node” button.

UM2180Un-provisioning the node

UM2180 - Rev 1 page 8/15

Page 9: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Step 2. Click Yes to confirm the operation

2.3 Using the app with an already provisioned networkFollowing provisioning, the nodes form a network which is saved by the app.If you close and reopen the app, you will find the nodes configured as they were last saved.New nodes seen in the network appear in the app as un-provisioned nodes and must undergo provisioning if youwish to interact with them.

2.4 Communication securityAll communication between Android app and the mesh network is secured by encryption and authentication. Theunderlying standards of secured communication are compliant with the BLE Mesh technology standards.

2.5 Smart lighting application using the appThe ST BlueNRG-Mesh Android App has a smart lighting demonstration that you can use to control the nodesprovisioned in a BLE Mesh network. The following commands are available:

UM2180Using the app with an already provisioned network

UM2180 - Rev 1 page 9/15

Page 10: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Step 1. Switch the lights on any single node on and off individually.

Step 2. Switch all the nodes in a group on and off.

Step 3. Create a new group by selecting 'Add Group' in the settings.The group name is editable, but the group address is fixed.

Step 4. Add a node in an existing group by selecting the check box next to the nodes you wish to add.

UM2180Smart lighting application using the app

UM2180 - Rev 1 page 10/15

Page 11: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Step 5. Assign a publication address to a node by selecting the check box of any provisioned node address orgroup address already created.The BlueNRG node can then control all the devices in a group if the publication address assigned is agroup address, or a given node if the publication address assigned is a unicast address. Only onepublication address can be given to a Node. Only one check box can be selected at a time.

UM2180Smart lighting application using the app

UM2180 - Rev 1 page 11/15

Page 12: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

UM2180Smart lighting application using the app

UM2180 - Rev 1 page 12/15

Page 13: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Licensing and other information• Developer-friendly license terms• Initial BlueNRG-Mesh is built over Motorola’s Mesh Over Bluetooth Low Energy (MoBLE) technology. The

present solution is developed and maintained for both Mesh library and Applications solely bySTMicroelectronics.

Revision history

Table 2. Document revision history

Date Version Changes

01-Feb-2018 1 Initial release.

UM2180

UM2180 - Rev 1 page 13/15

Page 14: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

Contents

1 Getting started with the app. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

1.1 Installing and running the app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.2 Introduction to the app controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.3 Use of app on different Android smartphones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2 ST BlueNRG-Mesh Android App functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

2.1 Provisioning the node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2.2 Un-provisioning the node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.3 Using the app with an already provisioned network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.4 Communication security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.5 Smart lighting application using the app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Licensing and other information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

UM2180Contents

UM2180 - Rev 1 page 14/15

Page 15: Getting started with the ST BlueNRG-Mesh Android … · – a. download the app apk file to your PC at STSW-BNRG-Mesh b. transfer the apk to your Android device c. find and launch

IMPORTANT NOTICE – PLEASE READ CAREFULLY

STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, enhancements, modifications, and improvements to STproducts and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. STproducts are sold pursuant to ST’s terms and conditions of sale in place at the time of order acknowledgement.

Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design ofPurchasers’ products.

No license, express or implied, to any intellectual property right is granted by ST herein.

Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.

ST and the ST logo are trademarks of ST. All other product or service names are the property of their respective owners.

Information in this document supersedes and replaces information previously supplied in any prior versions of this document.

© 2018 STMicroelectronics – All rights reserved

UM2180

UM2180 - Rev 1 page 15/15