ANR014 PROTEUS QUICKSTART
CONNECT A SMART PHONE TO A PROTEUS BLUETOOTH LOW ENERGY RADIO MODULE
VERSION 1.0
Revision history
Abbreviations and abstract
Abbreviation | Name | Description |
BTMAC | Bluetooth conform MAC address of the module used on the RF-interface. | |
CS | Checksum | Byte wise XOR combination of the preceding fields. |
BLE | Bluetooth Low Energy | According to Bluetooth specification. |
BT | Bluetooth | According to Bluetooth specification. |
Central | Bluetooth Low Energy device role that scans for advertising packets & initiates connections, e.g. smart phone. | |
DTM | Direct test mode | Mode to test Bluetooth specific RF settings. |
GAP | Generic Access Profile | The GAP provides a basic level of functionality that all Bluetooth devices must implement. |
I/O | Input/output | Pinout description. |
LPM | Low power mode | Mode for efficient power consumption. |
MAC | MAC address of the module. | |
MTU | Maximum transmission unit | Maximum packet size of the Bluetooth connection. |
Payload | The intended message in a frame / package. | |
Peripheral | Bluetooth Low Energy device role that provides services & advertises, e.g. sensor or our Proteus module. | |
RF | Radio frequency | Describes wireless transmission. |
RSSI | Receive Signal Strength Indicator | The RSSI indicates the strength of the RF signal. Its value is always printed in two’s complement notation. |
SoC | System on Chip. | |
Soft device | Operating system used by the nRF52 chip. | |
UART | Universal Asynchronous Receiver Transmitter |
Allows the serial communication with the module. |
[HEX] 0xhh |
Hexadecimal | All numbers beginning with 0x are hexadecimal numbers. All other numbers are decimal, unless stated otherwise. |
Contents
1 Introduction
2 Prerequisites
3 Quick start
3.1 Basics
3.2 Connection setup example using the nRF Connect App
3.3 Summary
4 Important notes
4.1 General customer responsibility
4.2 Customer responsibility related to specific, in particular safety-relevant ap- plications
4.3 Best care and attention
4.4 Customer support for product specifications
4.5 Product improvements
4.6 Product life cycle
4.7 Property rights
4.8 General terms and conditions
5 Legal notice
5.1 Exclusion of liability
5.2 Suitability in customer applications
5.3 Trademarks
5.4 Usage restriction
6 License terms
6.1 Limited license
6.2 Usage and obligations
6.3 Ownership
6.4 Firmware update(s)
6.5 Disclaimer of warranty
6.6 Limitation of liability
6.7 Applicable law and jurisdiction
6.8 Severability clause
6.9 Miscellaneous
1 Introduction
The Proteus series is a radio module series that is based on Nordic Semiconductors SoC which presents various Bluetooth Low Energy (BLE) and low power features.
By default, a radio module of the Proteus series can be controlled and configured by the host using predefined commands, in the so called command mode.
This application note describes how to setup a connection between a BLE enabled smart device, e.g. smart phone or tablet, to a Proteus module and how to interchange data in command mode. These steps are described with help of the nRF Connect App which is an open source App providing standard BLE functions for iOS as well as for Android devices.
2 Prerequisites
To follow the description in this application note, the following prerequisites may be helpful:
• A BLE enabled smart phone and the Nordic Semiconductor nRF Connect App
• A USB cable
• A Proteus evaluation board in factory state, for example
– the Proteus-I evaluation board with only jumpers JP2, JP4 and JP6 set. Other jumpers not set.
– the Proteus-II evaluation board with only jumpers JP2, JP4 and JP6 set. Other jumpers not set.
Figure 1: Default jumper placement of the Proteus-I and Proteus-II evaluation board. Red means "jumper must be set".
Figure 2: USB cable and evaluation board of the Proteus-I and Proteus-II radio module
The complete description of Proteus modules can be found in the respective radio module manual and application notes. This may be helpful to understand the background of the following quick start:
• Proteus-I
– Proteus-I reference manual
– Proteus-I advanced user guide ANR002_Proteus-I_Advanced_Developer_Guide
• Proteus-II
– Proteus-II reference manual
– Proteus-II advanced user guide ANR005_Proteus-II_Advanced_Developer_Guide
3 Quick start
The following description demonstrates how to setup a connection with a smart phone to a Proteus radio module.
3.1 Basics
The setup of a BLE connection to a Proteus module contains several steps:
1. Physical connection establishment
First of all, a physical connection has to be established. Therefore, a central device (usually smart phone) has to connect to the Proteus module which runs as peripheral.
2. Optional: Pairing process
Second, the pairing process is run that consists of the authentication and exchange of encryption information. The central device must request at least the same security level to access the characteristics of the Proteus module.
• In factory state, the Proteus module has no security enabled and this step can be neglected.
• Security can be enabled by modifying the user setting RF_SecFlags.
3. Optional: Exchange of the maximum transmission unit (MTU)
Next, the maximum transmission unit can be increased to allow the transmission of larger data packets. The Proteus module allows an MTU of up to 247 bytes, which results in a payload of up to 243 bytes. This step is optional. Not selecting a higher MTU will use the BT4.0 default MTU which results in 19 bytes payload for the user but will be compatible to pre BT 4.2 devices.
4. Discover the characteristics of the Proteus module SPP-like profile
Afterwards, the characteristics offered by the Proteus module have to be discovered by the central. This is needed to share the information how data can be transmitted.
5. Notification enable
To finalize the connection setup, the notification enabled message has to be send. With this feature, the peripheral device lets the central know, when there is new data, which is important for bidirectional data transmission. After this step, the channel is open and data transmission can start.
For the description, we assume that a smart phone is the initiator of the connection. Thus, it acts as central and the Proteus module acts as peripheral in figure 3.
Figure 3: Steps for the Connection setup
3.2 Connection setup example using the nRF Connect App
This chapter describes how to setup a connection to the Proteus module in command mode, when a smart phone and the nRF Connect App are used. Please perform the following steps:
3.3 Summary
In this application note, we demonstrated how to setup a connection between a smart phone and a Proteus Bluetooth Low Energy module. Furthermore, it has been shown how to trans- mit data from smart phone to a Proteus radio module and vice versa. When developing a custom app, the same steps for connection setup have to be imple- mented. The nRF Connect App from Nordic Semiconductor can be taken as base for any custom app development, as its source code is freely available on the GitHub account of Nordic Semiconductor (nRF Connect Android and nRF Connect iOS ).
4 Important notes
The following conditions apply to all goods within the wireless connectivity product range of Würth Elektronik eiSos GmbH & Co. KG:
4.1 General customer responsibility
Some goods within the product range of Würth Elektronik eiSos GmbH & Co. KG contain statements regarding general suitability for certain application areas. These statements about suitability are based on our knowledge and experience of typical requirements con- cerning the areas, serve as general guidance and cannot be estimated as binding statements about the suitability for a customer application. The responsibility for the applicability and use in a particular customer design is always solely within the authority of the customer. Due to this fact, it is up to the customer to evaluate, where appropriate to investigate and to decide whether the device with the specific product characteristics described in the product speci- fication is valid and suitable for the respective customer application or not. Accordingly, the customer is cautioned to verify that the documentation is current before placing orders.
4.2 Customer responsibility related to specific, in particular safety-relevant applications
It has to be clearly pointed out that the possibility of a malfunction of electronic components or failure before the end of the usual lifetime cannot be completely eliminated in the current state of the art, even if the products are operated within the range of the specifications. The same statement is valid for all software sourcecode and firmware parts contained in or used with or for products in the wireless connectivity and sensor product range of Würth Elektronik eiSos GmbH & Co. KG. In certain customer applications requiring a high level of safety and especially in customer applications in which the malfunction or failure of an electronic component could endanger human life or health, it must be ensured by most advanced technological aid of suitable design of the customer application that no injury or damage is caused to third parties in the event of malfunction or failure of an electronic component.
4.3 Best care and attention
Any product-specific data sheets, manuals, application notes, PCN’s, warnings and cautions must be strictly observed in the most recent versions and matching to the products firmware revisions. This documents can be downloaded from the product specific sections on the wireless connectivity homepage.
4.4 Customer support for product specifications
Some products within the product range may contain substances, which are subject to re- strictions in certain jurisdictions in order to serve specific technical requirements. Necessary information is available on request. In this case, the field sales engineer or the internal sales person in charge should be contacted who will be happy to support in this matter.
4.5 Product improvements
Due to constant product improvement, product specifications may change from time to time. As a standard reporting procedure of the Product Change Notification (PCN) according to the JEDEC-Standard, we inform about major changes. In case of further queries regarding the PCN, the field sales engineer, the internal sales person or the technical support team in charge should be contacted. The basic responsibility of the customer as per section 4.1 and 4.2 remains unaffected. All wireless connectivity module driver software ¨wireless con- nectivity SDK¨ and it’s source codes as well as all PC software tools are not subject to the Product Change Notification information process.
4.6 Product life cycle
Due to technical progress and economical evaluation we also reserve the right to discontin- ue production and delivery of products. As a standard reporting procedure of the Product Termination Notification (PTN) according to the JEDEC-Standard we will inform at an early stage about inevitable product discontinuance. According to this, we cannot ensure that all products within our product range will always be available. Therefore, it needs to be verified with the field sales engineer or the internal sales person in charge about the current product availability expectancy before or when the product for application design-in disposal is con- sidered. The approach named above does not apply in the case of individual agreements deviating from the foregoing for customer-specific products.
4.7 Property rights
All the rights for contractual products produced by Würth Elektronik eiSos GmbH & Co. KG on the basis of ideas, development contracts as well as models or templates that are subject to copyright, patent or commercial protection supplied to the customer will remain with Würth Elektronik eiSos GmbH & Co. KG. Würth Elektronik eiSos GmbH & Co. KG does not warrant or represent that any license, either expressed or implied, is granted under any patent right, copyright, mask work right, or other intellectual property right relating to any combination, application, or process in which Würth Elektronik eiSos GmbH & Co. KG components or services are used.
4.8 General terms and conditions
Unless otherwise agreed in individual contracts, all orders are subject to the current ver- sion of the "General Terms and Conditions of Würth Elektronik eiSos Group", last version available at www.we-online.com.
5 Legal notice
5.1 Exclusion of liability
Würth Elektronik eiSos GmbH & Co. KG considers the information in this document to be correct at the time of publication. However, Würth Elektronik eiSos GmbH & Co. KG re- serves the right to modify the information such as technical specifications or functions of its products or discontinue the production of these products or the support of one of these products without any written announcement or notification to customers. The customer must make sure that the information used corresponds to the latest published information. Würth Elektronik eiSos GmbH & Co. KG does not assume any liability for the use of its products. Würth Elektronik eiSos GmbH & Co. KG does not grant licenses for its patent rights or for any other of its intellectual property rights or third-party rights.
Notwithstanding anything above, Würth Elektronik eiSos GmbH & Co. KG makes no repre- sentations and/or warranties of any kind for the provided information related to their accuracy, correctness, completeness, usage of the products and/or usability for customer applications. Information published by Würth Elektronik eiSos GmbH & Co. KG regarding third-party prod- ucts or services does not constitute a license to use such products or services or a warranty or endorsement thereof.
5.2 Suitability in customer applications
The customer bears the responsibility for compliance of systems or units, in which Würth Elektronik eiSos GmbH & Co. KG products are integrated, with applicable legal regulations. Customer acknowledges and agrees that it is solely responsible for compliance with all le- gal, regulatory and safety-related requirements concerning its products, and any use of Würth Elektronik eiSos GmbH & Co. KG components in its applications, notwithstanding any applications-related in-formation or support that may be provided by Würth Elektronik eiSos GmbH & Co. KG. Customer represents and agrees that it has all the necessary ex- pertise to create and implement safeguards which anticipate dangerous consequences of failures, monitor failures and their consequences lessen the likelihood of failures that might cause harm and take appropriate remedial actions. The customer will fully indemnify Würth Elektronik eiSos GmbH & Co. KGand its representatives against any damages arising out of the use of any Würth Elektronik eiSos GmbH & Co. KG components in safety-critical applications.
5.3 Trademarks
AMBER wireless is a registered trademark of Würth Elektronik eiSos GmbH & Co. KG. All other trademarks, registered trademarks, and product names are the exclusive property of the respective owners.
5.4 Usage restriction
Würth Elektronik eiSos GmbH & Co. KG products have been designed and developed for usage in general electronic equipment only. This product is not authorized for use in equip- ment where a higher safety standard and reliability standard is especially required or wher a failure of the product is reasonably expected to cause severe personal injury or death, unless the parties have executed an agreement specifically governing such use. Moreover, Würth Elektronik eiSos GmbH & Co. KG products are neither designed nor intended for use in areas such as military, aerospace, aviation, nuclear control, submarine, transportation (automotive control, train control, ship control), transportation signal, disaster prevention, medical, public information network etc. Würth Elektronik eiSos GmbH & Co. KG must be informed about the intent of such usage before the design-in stage. In addition, sufficient reliability evaluation checks for safety must be performed on every electronic component, which is used in electrical circuits that require high safety and reliability function or perfor- mance. By using Würth Elektronik eiSos GmbH & Co. KG products, the customer agrees to these terms and conditions.
6 License terms
This License Terms will take effect upon the purchase and usage of the Würth Elektronik eiSos GmbH & Co. KG wireless connectivity products. You hereby agree that this license terms is applicable to the product and the incorporated software, firmware and source codes (collectively, "Software") made available by Würth Elektronik eiSos in any form, including but not limited to binary, executable or source code form.
The software included in any Würth Elektronik eiSos wireless connectivity product is pur- chased to you on the condition that you accept the terms and conditions of this license terms. You agree to comply with all provisions under this license terms.
6.1 Limited license
Würth Elektronik eiSos hereby grants you a limited, non-exclusive, non-transferable and royalty-free license to use the software and under the conditions that will be set forth in this license terms. You are free to use the provided Software only in connection with one of the products from Würth Elektronik eiSos to the extent described in this license terms. You are entitled to change or alter the source code for the sole purpose of creating an application embedding the Würth Elektronik eiSos wireless connectivity product. The transfer of the source code to third parties is allowed to the sole extent that the source code is used by such third parties in connection with our product or another hardware provided by Würth Elektronik eiSos under strict adherence of this license terms. Würth Elektronik eiSos will not assume any liability for the usage of the incorporated software and the source code. You are not entitled to transfer the source code in any form to third parties without prior written consent of Würth Elektronik eiSos.
You are not allowed to reproduce, translate, reverse engineer, decompile, disassemble or create derivative works of the incorporated Software and the source code in whole or in part. No more extensive rights to use and exploit the products are granted to you.
6.2 Usage and obligations
The responsibility for the applicability and use of the Würth Elektronik eiSos wireless con- nectivity product with the incorporated Firmware in a particular customer design is always solely within the authority of the customer. Due to this fact, it is up to you to evaluate and investigate, where appropriate, and to decide whether the device with the specific product characteristics described in the product specification is valid and suitable for your respective application or not. You are responsible for using the Würth Elektronik eiSos wireless connectivity product with the incorporated Firmware in compliance with all applicable product liability and product safety laws. You acknowledge to minimize the risk of loss and harm to individuals and bear the risk for failure leading to personal injury or death due to your usage of the product.
Würth Elektronik eiSos’ products with the incorporated Firmware are not authorized for use in safety-critical applications, or where a failure of the product is reasonably expected to cause severe personal injury or death. Moreover, Würth Elektronik eiSos’ products with the incorporated Firmware are neither designed nor intended for use in areas such as military, aerospace, aviation, nuclear control, submarine, transportation (automotive control, train control, ship control), transportation signal, disaster prevention, medical, public information network etc. You shall inform Würth Elektronik eiSos about the intent of such usage before design-in stage. In certain customer applications requiring a very high level of safety and in which the malfunction or failure of an electronic component could endanger human life or health, you must ensure to have all necessary expertise in the safety and regulatory ramifi- cations of your applications. You acknowledge and agree that you are solely responsible for all legal, regulatory and safety-related requirements concerning your products and any use of Würth Elektronik eiSos’ products with the incorporated Firmware in such safety-critical ap- plications, notwithstanding any applications-related information or support that may be pro- vided by Würth Elektronik eiSos. YOU SHALL INDEMNIFY WÜRTH ELEKTRONIK EISOS AGAINST ANY DAMAGES ARISING OUT OF THE USE OF WÜRTH ELEKTRONIK EISOS’ PRODUCTS WITH THE INCORPORATED FIRMWARE IN SUCH SAFETY-CRITICAL AP- PLICATIONS.
6.3 Ownership
The incorporated Firmware created by Würth Elektronik eiSos is and will remain the exclu- sive property of Würth Elektronik eiSos.
6.4 Firmware update(s)
You have the opportunity to request the current and actual Firmware for a bought wireless connectivity Product within the time of warranty. However, Würth Elektronik eiSos has no obligation to update a modules firmware in their production facilities, but can offer this as a service on request. The upload of firmware updates falls within your responsibility, e.g. via ACC or another software for firmware updates. Firmware updates will not be communicated automatically. It is within your responsibility to check the current version of a firmware in the latest version of the product manual on our website. The revision table in the product manual provides all necessary information about firmware updates. There is no right to be provided with binary files, so called "Firmware images", those could be flashed through JTAG, SWD, Spi-Bi-Wire, SPI or similar interfaces.
6.5 Disclaimer of warranty
THE FIRMWARE IS PROVIDED "AS IS". YOU ACKNOWLEDGE THAT WÜRTH ELEK- TRONIK EISOS MAKES NO REPRESENTATIONS AND WARRANTIES OF ANY KIND RELATED TO, BUT NOT LIMITED TO THE NON-INFRINGEMENT OF THIRD PARTIES’ INTELLECTUAL PROPERTY RIGHTS OR THE MERCHANTABILITY OR FITNESS FOR YOUR INTENDED PURPOSE OR USAGE. WÜRTH ELEKTRONIK EISOS DOES NOT WARRANT OR REPRESENT THAT ANY LICENSE, EITHER EXPRESS OR IMPLIED, IS GRANTED UNDER ANY PATENT RIGHT, COPYRIGHT, MASK WORK RIGHT, OR OTHER INTELLECTUAL PROPERTY RIGHT RELATING TO ANY COMBINATION, MACHINE, OR PROCESS IN WHICH THE WÜRTH ELEKTRONIK EISOS’ PRODUCT WITH THE INCOR- PORATED FIRMWARE IS USED. INFORMATION PUBLISHED BY WÜRTH ELEKTRONIK EISOS REGARDING THIRD-PARTY PRODUCTS OR SERVICES DOES NOT CONSTI- TUTE A LICENSE FROM WÜRTH ELEKTRONIK EISOS TO USE SUCH PRODUCTS OR SERVICES OR A WARRANTY OR ENDORSEMENT THEREOF.
6.6 Limitation of liability
Any liability not expressly provided by Würth Elektronik eiSos shall be disclaimed.
You agree to hold us harmless from any third-party claims related to your usage of the Würth Elektronik eiSos’ products with the incorporated Firmware, software and source code. Würth Elektronik eiSos disclaims any liability for any alteration, development created by you or your customers as well as for any combination with other products.
6.7 Applicable law and jurisdiction
Applicable law to this license terms shall be the laws of the Federal Republic of Germany. Any dispute, claim or controversy arising out of or relating to this license terms shall be resolved and finally settled by the court competent for the location of Würth Elektronik eiSos’ registered office.
6.8 Severability clause
If a provision of this license terms is or becomes invalid, unenforceable or null and void, this shall not affect the remaining provisions of the terms. The parties shall replace any such provisions with new valid provisions that most closely approximate the purpose of the terms.
6.9 Miscellaneous
Würth Elektronik eiSos reserves the right at any time to change this terms at its own discre- tion. It is your responsibility to check at Würth Elektronik eiSos homepage for any updates. Your continued usage of the products will be deemed as the acceptance of the change. We recommend you to be updated about the status of new firmware and software, which is available on our website or in our data sheet and manual, and to implement new software in your device where appropriate. By ordering a wireless connectivity product, you accept this license terms in all terms.
USEFUL LINKS
Contact
Würth Elektronik eiSos GmbH & Co. KG Division Wireless Connectivity & Sensors
Rudi-Schillings-Str. 31
54296 Trier
Germany
Tel.: +49 651 99355-0
Fax.: +49 651 99355-69
www.we-online.com/wireless-connectivity