Bluetooth Low Energy on DK-S7G2 and DK S3A7

Transcription

1 Application Note Renesas Synergy Platform Bluetooth Low Energy on DK-S7G2 and DK S3A7 R12AN0027EU0102 Rev.1.02 Introduction This application note shows the Bluetooth Low Energy (BLE) interface capabilities of the Renesas Synergy Development Kits. This example pairs the kits with ios devices (iphone/ipad) to transmit and receive sensor values and LED on/off commands. This application note covers BLE operation with the Renesas Synergy Development kits, including connection, range, and latency behaviors, and interfacing the Synergy family of MCUs with BLE-capable devices such as iphones. This application note introduces the Synergy architecture, illustrating the ease of development and timesaving features of the Synergy Software Package (SSP). Target Device and Required Hardware Renesas Synergy DK-S7G2 or DK-S3A7 Development Kit Digilent PmodACL2 Accelerometer Minimum PC Recommendation Microsoft Windows 7 Intel Core family processor running at 2.0 GHz or higher (or equivalent processor) 8 GB memory 250 GB hard disk or SSD USB 2.0 Connection to the internet Installed Software Synergy e 2 studio Synergy Software Platform (SSP) v1.2.0 IAR EW for Synergy v SSC v Note: If you do not have both of these software applications, you should install them before you continue. Purpose This document demonstrates how to exercise the BLE interface on different Renesas Synergy Development Kits through an example application. Intended Audience The intended audience is users who want to develop applications with BLE interface using the S7G2 or S3A7 Synergy MCUs. Alpwise License This example application uses an evaluation version of the BLE Stack from Renesas partner company Alpwise. Please contact Alpwise directly at alpwisesales@alpwise.com to purchase a commercial copy of the BLE stack for your development. R12AN0027EU0102 Rev.1.02 Page 1 of 16

2 Contents 1. BLE example overview DK-S3A7 Development Kit v DK-S7G2 Development Kit v Running the embedded application e 2 studio IAR EW for Synergy Loading the ios app Running the application Development of the embedded application Background Hardware interfaces Software libraries Developing with Renesas Synergy e 2 studio ISDE Application Code ADC IAR Compiler Summary Website and Support R12AN0027EU0102 Rev.1.02 Page 2 of 16

3 BLE example overview The BLE example application displays a typical IoT application by leveraging sensors, Bluetooth LE, the Renesas Synergy platform, and a smartphone. Data is acquired from an accelerometer, potentiometer, and temperature sensor, processed, and streamed through BLE to an iphone running a companion application. Additionally, the iphone can send commands to turn on and off LEDs on the Renesas Synergy platform development board. Figure 1 shows the architecture of the example application. Figure 1 Main components At the heart of the system is the Renesas Synergy development kits DK-S3A7 or DK-S7G2. The accelerometer (Digilent PmodACL2) leverages the Digilent Pmod interface for ease in connecting to the Renesas board. Both kits include an on-board CMAX BLE module. While the DK-S3A7 has an onboard accelerometer, we will use the Digilent PmodACL2 with this application note. DK-S3A7 Development Kit v Connect a USB cable from the computer to the J-Link port on the board (J15). The board is powered and programmed through this USB interface. 2. Verify that the PMODA port is powered at 3.3V as set by the jumper next to it. 3. Connect the external accelerometer module (Digilent PmodACL2) to the PMODA port. Make sure it is installed face up where the text PmodACL2 is visible. 4. Set the configuration switches (S5) to enable the following: A. JLOB (JTAG=ON) B. BLE (BLE=ON) C. PMODA (PMOD=ON) D. Pushbuttons (PBs=ON) R12AN0027EU0102 Rev.1.02 Page 3 of 16

4 Potentiometer DK-S7G2 Development Kit v3.0 Figure 2 DK-S3A7 Board Layout 1. Connect a USB cable from the computer to the J-Link port on the board, J Supply power to the board through the power jack. R12AN0027EU0102 Rev.1.02 Page 4 of 16

5 Potentiometer Figure 3 DK-S7G2 Board Layout 3. Verify that PMODA is powered at 3.3V as set by the jumper next to the PMODA Port. 4. Connect the accelerometer board (Digilent PmodACL2) to PMODA. Make sure it is installed face up where the text PmodACL2 is visible. 5. Set the configuration switches (S5) on the main board to enable the following: A. JLOB (JTAG=ON) B. PMODA port (PMOD=ON) C. Pushbuttons (PBs=ON) 6. Set the expansion configuration switches (S101) on the breakout board to enable the following: A. Internal BLE interface (BLE=ON) Running the embedded application Two versions of the embedded application are available: The e 2 studio version, and the IAR EW for Synergy version. e 2 studio To run the e 2 studio embedded application on a target kit, simply import the project into the appropriate ISDE, compile and run debug. Ensure that e 2 studio v and SSP v1.2.0 is installed and used. 1. Import the application project into e 2 studio v Click on compile. The project should compile without any errors. 3. Setup the development kit following the instructions in section 1.1 or 1.2 as is appropriate. 4. Run debug. 5. The on-board LED1 and LED2 will light up. 6. Press the Connect button on the ios application to establish a connection with the development kit. IAR EW for Synergy To run the embedded application using IAR EW for Synergy, make sure that IAR EW for Synergy v7.71 and Synergy Standalone Configurator (SSC) v are installed. Next, follow the steps as described below. R12AN0027EU0102 Rev.1.02 Page 5 of 16

6 1. Double click on the IAR IDE Workspace file (.eww file) 2. Right click on the Synergy level in the Workspace window, and click on Open Renesas Synergy Configurator (Figure 4) Figure 4 IAR EW for Synergy Project 3. In the Standalone Synergy Configurator that will open, click on Generate Project Content 4. Next, right click on the ALPW-BLESDKCM0_1_1_1 folder and select Options (Figure 5). This folder contains the Alpwise Libraries for Cortex-M0 devices. As the S3A7 and S7G2 are ARM Cortex-M4 devices, these library files are not needed, and should be excluded from build. This is required as files of the same name exist in both the folders for the Cortex-M0 and Cortex-M4 devices, resulting in Multiple tools write to the same file build errors. Figure 5 Alpwise Library Files R12AN0027EU0102 Rev.1.02 Page 6 of 16

7 5. In the Options window that pops up, check the Exclude from build box and select OK (Figure 6). Figure 6 Exclude ALPW_BLESDKCM0_1_1_1 from build 6. Next, compile the project. Click on Project > Make. 7. The project should compile without errors. 8. Setup the development kit following the instructions in section 1.1 or 1.2 as is appropriate. 9. To debug the project, click on the Download and Debug button. 10. The on-board LED1 and LED2 will light up. 11. Pressing the Connect button on the ios application to establish a connection with the development kit. There are some variations depending on the development kit used: If the DK-S3A7 development kit is used, there will be no Temperature ADC reading as only one ADC unit is available on the MCU. Loading the ios app The ios application (for iphone and ipads) is located in the Apple App Store and named Xaplos BLE. Running the application When run, the ios application displays a screen where the development kit sensors (accelerometer, temperature, and potentiometer) data can be monitored, and presents buttons which, when pressed, command LEDs on the development kit to light up. There are small differences in functionality between the various Synergy development kits and are detailed at the end of this section. Two additional screens show detailed connection diagnostics, log, and a real time graph of the acceleration values. These additional screens are accessible by clicking the version label in the upper right corner or on the acceleration values in the center of the screen respectively. Figure 7 shows the screens of this application: R12AN0027EU0102 Rev.1.02 Page 7 of 16

8 Figure 8 below shows the architecture of the application. Figure 7 iphone App Screens Figure 8 Application Concept Once connected, sensor data is streamed to the iphone application and presented on the main screen. Moving the potentiometer on the development board changes the value labeled Sensor on the iphone application. The Temperature ADC reading on the iphone application is updated with the reading of the on-chip temperature sensor. Pressing the user buttons S1, S2, and S3 on the development board causes the Button State labels to light up on the iphone application. Moving the development kit causes the X, Y and Z-axis accelerometer readings to vary on the iphone application. While the LED1 button on the application is pressed, the on-board user Led 1 will be lit up. Led 2 will be lit up in a similar way. Development of the embedded application The embedded side of the application was created with the Renesas Synergy development platform. The following sections describe the requirements and design process of this embedded application. R12AN0027EU0102 Rev.1.02 Page 8 of 16

9 Background The application had the following requirements: Collect accelerometer data (48 bytes) at 50 Hz and stream it over BLE. Read and report on-board potentiometer and temperature ADCs value. Pair with smartphone and support 2-way BLE communication. Work with available Synergy Software Package (SSP). Work initially with DK-S7 board (later with others), supporting both onboard CMAX BLE module, and external Alpwise Digilent Pmod Compatible BLE module. From a hardware perspective, the embedded application runs on a Renesas Synergy MCU, interfaced with the different board components according to Figure 9. Figure 9 Example application architecture & interfaces From a functionality perspective, the embedded application acts a server in a client-server architecture, providing the client (smartphone example application) with the accelerometer, potentiometer, temperature, and other data. The server provides this information following BLE s Generic Attribute Profile, which is used to present the client with the list and type of information and services available. Figure 10 BLE Client/Server Architecture BLE operates by frequency hopping in the 2.4 GHz ISM Band, transmitting short data packets at a bandwidth of 1Mbps. Communication latencies are a few ms, and distances can be in the range of 30ft (10m). The topology of the network can be one-to-one or one-to-many (star topology). R12AN0027EU0102 Rev.1.02 Page 9 of 16

10 Hardware interfaces The selected BLE module for this application is the CMAX CMM Figure 11 Onboard CMAX BLE Module Hardware Interface on DK-S7G2 Board Figure 12 Onboard CMAX BLE Module Hardware Interface on DK-S3A7 Board R12AN0027EU0102 Rev.1.02 Page 10 of 16

11 Software libraries All of the libraries necessary for all hardware interfaces (drivers) are included in the Renesas Synergy Software Package (SSP), with the exception of the BLE communications stack. The BLE stack used is from Alpwise. The following diagram shows the interfaces of the Alpwise BLE stack. Integrating the Alpwise BLE stack requires the following: Figure 13 Alpwise BLE Software Stack Implementing the system adapter interface (calling periodic maintenance functions of the BLE stack library at fixed periodic intervals). Populating the transport layer function tubs (equivalent to a read and write) with the appropriate hardware interface function calls, in this case the appropriate SPI send and receive functions from the SSP. Using the application interface (API) of the BLE stack to send and receive data and check the status of the BLE interface where appropriate in the application. Developing with Renesas Synergy e 2 studio ISDE Figure 14 summarizes all the blocks necessary for the embedded application to run in the Synergy Integrated Solution Development Environment (ISDE): Figure 14 BLE Block diagram R12AN0027EU0102 Rev.1.02 Page 11 of 16

12 The various sensors (accelerometers, buttons, temperature, ADC) have their own threads, which read data and post it to the main thread, which in turn posts it to the BLE stack attributes. Figure 15 shows this architecture. Figure 15 Embedded Application Sensors and Main Thread The BLE interface module is serviced by a specific thread, which handles reading data from its receive buffer when a data available interrupt is raised (through an external IRQ). Data is sent to the BLE module by the transmit function linked to the BLE stack. A specific thread is created to handle the periodic management of the BLE stack itself. Figure 16 shows this architecture. Figure 16 Embedded Application BLE Module and Stack Management Threads Finally, the appropriate BLE callback functions are populated to handle posted BLE services (like LEDs on/off functionality) and to handle BLE protocol events such as connection or disconnection. Figure 17 shows this architecture. Figure 17 Embedded Application BLE Services Callback Functions R12AN0027EU0102 Rev.1.02 Page 12 of 16

13 Implementing these blocks (threads or drivers) is simplified by using the Renesas Synergy ISDE. Instantiating device drivers, configuring MCU pins, even creating RTOS threads, are all direct menu choices of the ISDE tool. Each one of the items, after being created with the appropriate menu choice, can be configured in complete detail in its appropriate configuration dialog in the ISDE tool. With the exception of the content of the threads themselves, there is almost no need for any coding. The following diagrams show examples of these ISDE configuration dialogs for the clocks configuration, pins configuration, IRQs configuration, and interfaces configuration such as the SPI port used for handling the BLE module. Figure 18 Clocks Configuration Dialog in Renesas Synergy ISDE Figure 19 Pins Configuration Dialog in Renesas Synergy ISDE R12AN0027EU0102 Rev.1.02 Page 13 of 16

14 Figure 20 IRQ Configuration Dialog in Renesas Synergy ISDE Figure 21 SPI Interface Configuration Dialog in Renesas Synergy ISDE Besides creating components with menu options on the ISDE and configuring them with their appropriate configuration dialogs, other SSP library components are accessible by direct calls in the application code. This is necessary, for example, for read and write operations to peripheral drivers such as the SPI driver in this application. Application Code ADC In the application code, adc_unit.c, the control structure for ADC Unit 1 was modified before calling the SSP Figure 22 Code snippet for modifying ADC Unit 1 The control structure is modified in the application code to ensure that a value of 1 is passed as the p_ctrl->unit parameter. This is necessary as currently the SSP open driver effects a close in the ADC module (before re-opening it with the parameters set in the Synergy Configurator) without this parameter being configured. As a result, ADC0 module is closed unintentionally. This code snippet ensures that both ADC0 and ADC1 units work together. IAR Compiler The GCC compiler recognizes asm, while the IAR compiler recognizes asm for inline assembly. Thus, an #ifdef directive is added to define asm as asm when the IAR compiler is being used. The directive can be found in the files ble_profile.c, acc.c, exceptions.c, periph_detect.c and system_messages.c as shown in Figure 23. R12AN0027EU0102 Rev.1.02 Page 14 of 16

15 Summary Figure 23 #ifdef for asm for IAR compiler The Renesas Synergy Platform was used as the foundation for a Bluetooth Low Energy application that communicates sensor data to a smart phone. Project files have been included for programming the demonstration application onto the development kits. The application was developed using the DK-S7G2 or DK-S3A7 Development Kit, which holds the S7 series MCU. The development kit provides both on-board and Digilent Pmod Compatible options for connecting to BLE modules. The Synergy Software Package (SSP) provides core modules including ThreadX integration for building the application and the Renesas e 2 studio ISDE provides a GUI-based development environment for configuring the SSP modules and developing the application. R12AN0027EU0102 Rev.1.02 Page 15 of 16

16 Website and Support Support: Technical Contact Details: America: Europe: Japan: All trademarks and registered trademarks are the property of their respective owners. R12AN0027EU0102 Rev.1.02 Page 16 of 16

17 Revision History Rev. Date Description Page Summary /29/2016 All Initial version 1.01 Nov 3, Corrected name of app from Renesas BLE to Xaplos BLE All Minor format changes Added support for SSP v1.2.0

18 Notice 1. Descriptions of circuits, software and other related information in this document are provided only to illustrate the operation of semiconductor products and application examples. You are fully responsible for the incorporation or any other use of the circuits, software, and information in the design of your product or system. Renesas Electronics disclaims any and all liability for any losses and damages incurred by you or third parties arising from the use of these circuits, software, or information. 2. Renesas Electronics hereby expressly disclaims any warranties against and liability for infringement or any other disputes involving patents, copyrights, or other intellectual property rights of third parties, by or arising from the use of Renesas Electronics products or technical information described in this document, including but not limited to, the product data, drawing, chart, program, algorithm, application examples. 3. No license, express, implied or otherwise, is granted hereby under any patents, copyrights or other intellectual property rights of Renesas Electronics or others. 4. You shall not alter, modify, copy, or otherwise misappropriate any Renesas Electronics product, whether in whole or in part. Renesas Electronics disclaims any and all liability for any losses or damages incurred by you or third parties arising from such alteration, modification, copy or otherwise misappropriation of Renesas Electronics products. 5. Renesas Electronics products are classified according to the following two quality grades: "Standard" and "High Quality". The intended applications for each Renesas Electronics product depends on the product s quality grade, as indicated below. "Standard": Computers; office equipment; communications equipment; test and measurement equipment; audio and visual equipment; home electronic appliances; machine tools; personal electronic equipment; and industrial robots etc. "High Quality": Transportation equipment (automobiles, trains, ships, etc.); traffic control (traffic lights); large-scale communication equipment; key financial terminal systems; safety control equipment; etc. Renesas Electronics products are neither intended nor authorized for use in products or systems that may pose a direct threat to human life or bodily injury (artificial life support devices or systems, surgical implantations etc.), or may cause serious property damages (space and undersea repeaters; nuclear power control systems; aircraft control systems; key plant systems; military equipment; etc.). Renesas Electronics disclaims any and all liability for any damages or losses incurred by you or third parties arising from the use of any Renesas Electronics product for which the product is not intended by Renesas Electronics. 6. When using the Renesas Electronics products, refer to the latest product information (data sheets, user s manuals, application notes, "General Notes for Handling and Using Semiconductor Devices" in the reliability handbook, etc.), and ensure that usage conditions are within the ranges specified by Renesas Electronics with respect to maximum ratings, operating power supply voltage range, heat radiation characteristics, installation, etc. Renesas Electronics disclaims any and all liability for any malfunctions or failure or accident arising out of the use of Renesas Electronics products beyond such specified ranges. 7. Although Renesas Electronics endeavors to improve the quality and reliability of Renesas Electronics products, semiconductor products have specific characteristics such as the occurrence of failure at a certain rate and malfunctions under certain use conditions. Further, Renesas Electronics products are not subject to radiation resistance design. Please ensure to implement safety measures to guard them against the possibility of bodily injury, injury or damage caused by fire, and social damage in the event of failure or malfunction of Renesas Electronics products, such as safety design for hardware and software including but not limited to redundancy, fire control and malfunction prevention, appropriate treatment for aging degradation or any other appropriate measures by your own responsibility as warranty for your products/system. Because the evaluation of microcomputer software alone is very difficult and not practical, please evaluate the safety of the final products or systems manufactured by you. 8. Please contact a Renesas Electronics sales office for details as to environmental matters such as the environmental compatibility of each Renesas Electronics product. Please investigate applicable laws and regulations that regulate the inclusion or use of controlled substances, including without limitation, the EU RoHS Directive carefully and sufficiently and use Renesas Electronics products in compliance with all these applicable laws and regulations. Renesas Electronics disclaims any and all liability for damages or losses occurring as a result of your noncompliance with applicable laws and regulations. 9. Renesas Electronics products and technologies shall not be used for or incorporated into any products or systems whose manufacture, use, or sale is prohibited under any applicable domestic or foreign laws or regulations. You shall not use Renesas Electronics products or technologies for (1) any purpose relating to the development, design, manufacture, use, stockpiling, etc., of weapons of mass destruction, such as nuclear weapons, chemical weapons, or biological weapons, or missiles (including unmanned aerial vehicles (UAVs)) for delivering such weapons, (2) any purpose relating to the development, design, manufacture, or use of conventional weapons, or (3) any other purpose of disturbing international peace and security, and you shall not sell, export, lease, transfer, or release Renesas Electronics products or technologies to any third party whether directly or indirectly with knowledge or reason to know that the third party or any other party will engage in the activities described above. When exporting, selling, transferring, etc., Renesas Electronics products or technologies, you shall comply with any applicable export control laws and regulations promulgated and administered by the governments of the countries asserting jurisdiction over the parties or transactions. 10. Please acknowledge and agree that you shall bear all the losses and damages which are incurred from the misuse or violation of the terms and conditions described in this document, including this notice, and hold Renesas Electronics harmless, if such misuse or violation results from your resale or making Renesas Electronics products available any third party. 11. This document shall not be reprinted, reproduced or duplicated in any form, in whole or in part, without prior written consent of Renesas Electronics. 12. Please contact a Renesas Electronics sales office if you have any questions regarding the information contained in this document or Renesas Electronics products. (Note 1) (Note 2) "Renesas Electronics" as used in this document means Renesas Electronics Corporation and also includes its majority-owned subsidiaries. "Renesas Electronics product(s)" means any product developed or manufactured by or for Renesas Electronics. (Rev November 2016) SALES OFFICES Refer to " for the latest and detailed information. Renesas Electronics America Inc Scott Boulevard Santa Clara, CA , U.S.A. Tel: , Fax: Renesas Electronics Canada Limited 9251 Yonge Street, Suite 8309 Richmond Hill, Ontario Canada L4C 9T3 Tel: Renesas Electronics Europe Limited Dukes Meadow, Millboard Road, Bourne End, Buckinghamshire, SL8 5FH, U.K Tel: , Fax: Renesas Electronics Europe GmbH Arcadiastrasse 10, Düsseldorf, Germany Tel: , Fax: Renesas Electronics (China) Co., Ltd. Room 1709, Quantum Plaza, No.27 ZhiChunLu Haidian District, Beijing , P.R.China Tel: , Fax: Renesas Electronics (Shanghai) Co., Ltd. Unit 301, Tower A, Central Towers, 555 Langao Road, Putuo District, Shanghai, P. R. China Tel: , Fax: Renesas Electronics Hong Kong Limited Unit , 16/F., Tower 2, Grand Century Place, 193 Prince Edward Road West, Mongkok, Kowloon, Hong Kong Tel: , Fax: Renesas Electronics Taiwan Co., Ltd. 13F, No. 363, Fu Shing North Road, Taipei 10543, Taiwan Tel: , Fax: Renesas Electronics Singapore Pte. Ltd. 80 Bendemeer Road, Unit #06-02 Hyflux Innovation Centre, Singapore Tel: , Fax: Renesas Electronics Malaysia Sdn.Bhd. Unit 1207, Block B, Menara Amcorp, Amcorp Trade Centre, No. 18, Jln Persiaran Barat, Petaling Jaya, Selangor Darul Ehsan, Malaysia Tel: , Fax: Renesas Electronics India Pvt. Ltd. No.777C, 100 Feet Road, HAL II Stage, Indiranagar, Bangalore, India Tel: , Fax: Renesas Electronics Korea Co., Ltd. 12F., 234 Teheran-ro, Gangnam-Gu, Seoul, , Korea Tel: , Fax: Renesas Electronics Corporation. All rights reserved. Colophon 6.0