CYALKIT-E02
Solar-Powered BLE Sensor Beacon
Reference Design Kit Guide
Doc. No. 002-11317 Rev. *C
Cypress Semiconductor
198 Champion Court
San Jose, CA 95134-1709
www.cypress.com
Page 1: ...CYALKIT E02 Solar Powered BLE Sensor Beacon Reference Design Kit Guide Doc No 002 11317 Rev C Cypress Semiconductor 198 Champion Court San Jose CA 95134 1709 www cypress com...
Page 2: ...S OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE To the extent permitted by applicable law Cypress reserves the right to make changes to this document without further notice Cypress does not...
Page 3: ...3 Uninstall Software 14 2 4 PSoC Creator 14 3 Getting Started 15 3 1 WSN Operation with PC 15 3 2 WSN Operation with Mobile Device 22 3 3 Configuring Solar BLE Sensor 26 3 4 Serial Command List 31 3 5...
Page 4: ...pics 82 A 1 Battery Input Operation 82 A 2 Charging the Supercapacitor 83 A 3 Equivalent Series Resistance of the Supercapacitor 84 A 4 Diode Connection Between Solar Cell and VDD 85 Appendix B Solar...
Page 5: ...on from the factory default may affect its performance and cause interference with other apparatus in the immediate vicinity If such interference is detected suitable mitigating measures should be tak...
Page 6: ...only at an ESD workstation If one is not available use appropriate ESD protection by wearing an antistatic wrist strap attached to chassis ground any unpainted metal surface on your board when handli...
Page 7: ...sed in a casing to automatically transmit temperature and humidity sensor data in an office lighting environment The Debug Board is based on Cypress s PRoC BLE and PSoC 5LP products It can be connecte...
Page 8: ...T E02 Solar Powered BLE Sensor Beacon Reference Design Kit Guide Doc No 002 11317 Rev C 8 1 2 Block Diagrams Figure 1 2 Block Diagram of Solar BLE Sensor PC based on Windows 7 8 1 10 iOS 8 or newer An...
Page 9: ...er Includes firmware that supports a BLE Beacon transmission with temperature and humidity data Energy harvesting PMIC S6AE103A that supports the following applications Demo mode transmitting sensor d...
Page 10: ...rd Connector for Solar BLE Sensor power SWD UART USB detect charging supercapacitor and GPIO Connector for programming PSoC 5LP KitProg Parameter setting of Solar BLE Sensor via USB to UART bridge on...
Page 11: ...is a complete package stored in a CD ROM image format that can be used to create a CD or extract using ISO extraction programs such as WinZip or WinRAR This file includes all the required software an...
Page 12: ...lation package contains the files related to the kit However it does not include the Windows Installer or Microsoft NET framework packages If these packages are not on your computer the installer dire...
Page 13: ...kage after successful installation 8 Click Finish to complete the CYALKIT E02 installation 9 Enter your contact information or select the Continue Without Contact Information check box Click Finish to...
Page 14: ...use integrated design environment IDE It is a revolutionary hardware and software co design environment powered by a library of preverified and precharacterized PSoC Components With PSoC Creator you c...
Page 15: ...rd your PC and your mobile device are operating properly 3 1 WSN Operation with PC In this section you will confirm that the Solar BLE Sensor is operating as a WSN by using the software provided on yo...
Page 16: ...1 2 USB Driver Installation Failed 5 After successful device driver installation confirm that a new COM port called KitProg USB UART was added Open the Device Manager Windows 7 Start Control Panel De...
Page 17: ...g USB UART appears in the Device Manager 1 Open the Device Manager Windows 7 Start Control Panel Device Manager Windows 8 8 1 10 Right click the Start button and select Device Manager 2 Under Other de...
Page 18: ...ws 7 64 bit C Program Files x86 Cypress Programmer drivers 32 bit C Program Files Cypress Programmer drivers If there is no folder for PSoC Programmer please download and install it from PSoC Programm...
Page 19: ...OM port called KitProg USB UART was added A Open the Device Manager B Under Ports COM LPT confirm that a COM port called KitProg USB UART was added Note the COM number COMxx 3 1 3 Establishing BLE Con...
Page 20: ...00 lx Under street lighting 50 s 200 lx 400 lx At museum 30 s 50 s 400 lx 500 lx Office lighting 15 s 30 s 1000 lx Shopping mall rainy day 3 s 15 s 1 The time interval of the sensor is three seconds i...
Page 21: ...BLE Sensor Beacon Reference Design Kit Guide Doc No 002 11317 Rev C 21 5 Find the ID2 number initial value is 0x0001 of the Solar BLE Sensor in the Cypress BLE Beacon software Refer to 3 3 Configuring...
Page 22: ...ity changes 3 2 1 Mobile Apps Installation The Cypress BLE Beacon app is available on Google Play and in the Apple Store for free To install the app follow these instructions 3 2 1 1 Installing the An...
Page 23: ...eference Design Kit Guide Doc No 002 11317 Rev C 23 7 The BLE Beacon app performs device discovery by default when the app is opened Select the mode as Graph to display the sensor data Refer to Cypres...
Page 24: ...tion 4 Launch the BLE Beacon app A splash screen is displayed for a few seconds before the app displays the Device List screen If Bluetooth is turned OFF in the iOS device iOS will display a message b...
Page 25: ...oc No 002 11317 Rev C 25 Note that if the sensor data has not appeared on the BLE Beacon of iOS you need to confirm that the Location setting is set to While Using the App iOS Home screen Settings BLE...
Page 26: ...ething like tweezers not included in the kit and take out the Solar BLE Sensor Board Refer to B 2 How to Install the Board in the Enclosure for how to install the board in the enclosure 2 Set the slid...
Page 27: ...Open the Device Manager Under Ports COM LPT confirm that a KitProg USB UART was added Note the COM number COMxxx 2 Install Tera Term from the following location Install directory Cypress BLE Beacon t...
Page 28: ...Doc No 002 11317 Rev C 28 5 Configure the terminal setting Setup Terminal as follows Then click OK Receive AUTO Transmit CR LF Local echo Select Other settings Default 6 Configure the serial port sett...
Page 29: ...r board is ready to receive commands 9 For example this step will set the Major ID to 0x000a Hexadecimal to receive another Solar BLE Sensor ID On Tera Term type major 000A The Solar BLE Sensor respon...
Page 30: ...l on apps when using USB bus power initial time interval is 1 5 s when using USB bus power 12 Disconnect the Debug Board from the PC and then disconnect the Solar BLE Sensor from the Debug Board Set t...
Page 31: ...bugging section for instructions on how to program the firmware Table 3 2 Command List No Command Name Command Use Description Default 1 UUID For BLE Beacon Mode Read Write of UUID1 00050001 0000 1000...
Page 32: ...th Modes Read Write mode BLE Beacon 19 INIT Default all parameters 20 EXIT Exit the UART command waiting mode and Eddystone URL Configuration Service then start BLE advertisements 21 VER Display Firmw...
Page 33: ...Read Power Strength Default 3 dBm Example TXPWR echo TXPWR output TX power in dBm 3 3 2 Write Set Power Strength Set Value 18 12 6 3 2 1 0 3 Example TXPWR 18 echo TXPWR 18 output New TX power in dBm...
Page 34: ...utput New Company ID 0059 6 Read Write NID 6 1 Read Read NID data Default CB6F15CEC02A41F76AB1 Example EDNID echo EDNID output Eddystone UID NID CB6F15CEC02A41F76AB1 6 2 Write Write NID data Example E...
Page 35: ...adio TX Power Levels 18 12 0 3 8 2 Write Set Power Strength levels Set Value 18 12 6 3 2 1 0 3 Writing is not allowed if Eddystone URL Configuration Service is locked The four Levels correspond to TX_...
Page 36: ...ddystone URL Configuration Service with lock code set by EDLOCK command If user forgets the code user needs send the DEFAULT command to change the lock state to unlocked Example EDUNLOCK EEEEDDDD CCCC...
Page 37: ...0 14 2 Write Set RSSI Levels Set Value 100 20 dBm This operation is not allowed if Eddystone URL Configuration Service is locked The four levels correspond to TX_POWER_MODE_LOWEST TX_POWER_MODE_LOW TX...
Page 38: ...figuration Service is locked Example EDITRVL 10240 echo EDITRVL 10240 output New Eddystone Advertise Interval in msec 10240 17 EDRESET Set Eddystone parameters to their initial values except EDNID EDB...
Page 39: ...ements Example EXIT echo EXIT output 21 VER Display Firmware Version Example VER echo VER output CYALKIT E02 Sample Firmware Version 1 2 00 22 HELP Display Command List Example HELP echo HELP output G...
Page 40: ...5 URI Flags Reads writes the flags 0 6 Advertised Tx Power Levels Reads writes the Advertised Power Levels array Functions in the same way as the EDADPWR command 41 35 23 20 dBm 7 Tx Power Mode Reads...
Page 41: ...L Tests with eddystone url config validator a new mode is provided to replace these operations Ensure that you have set the mode as EDTest before starting the tests If testing a write characteristic o...
Page 42: ...on the Debug Board or EZ BLE module on the Solar BLE Sensor over SWD I 2 C and UART pins KitProg communicates with PSoC Programmer and PSoC Creator software to program debug the target PRoC BLE or EZ...
Page 43: ...opy the BLE folder to your local folder Note that the following warning message appears when the folder is in C Program Files or C Program Files x86 The BLE folder is located in the Firmware folder th...
Page 44: ...ith EZ BLE Module or AN94020 Getting Started with PRoC BLE 4 2 3 Programming Using PSoC Programmer PSoC Programmer 3 24 or later can be used to program existing hex files into both PSoC BLE and the EZ...
Page 45: ...Program and Debug CYALKIT E02 Solar Powered BLE Sensor Beacon Reference Design Kit Guide Doc No 002 11317 Rev C 45...
Page 46: ...programming the kit with the selected file Note If the hex file does not match the device selected then PSoC Programmer will throw an error of device mismatch and terminate programming 5 When program...
Page 47: ...47 4 3 Updating KitProg Firmware The KitProg firmware normally does not require any updating If an update is required then PSoC Programmer will display a warning message when the kit is connected to i...
Page 48: ...he Solar BLE Sensor This section details the information for S6AE103A Note When the Solar BLE Sensor is in the enclosure use the sharp end of something like tweezers not included in the kit to change...
Page 49: ...pins for internal LDO comparator and interrupt input Table 5 1 Pin Description of Power Input Block Pin Name Description VBAT Connect TP1 Primary battery input pin Extra battery input VDD Connect the...
Page 50: ...ematic The VOUT1 and VOUT2 output voltage of S6AE103A can be set by changing the resistors connected to the SET_VOUTH and SET_VOUTL pins because the VOUT upper limit voltage VVOUTH and VOUT lower limi...
Page 51: ...1 Supply energy to BLE and sensor VOUT2 Open Output voltage pin 2 Not used for this kit VSTORE1 Connect 400 F capacitor Storage output pin 1 For startup storage VSTORE1 Connect 200 mF capacitor Stora...
Page 52: ...ges to VSTORE2 2 Solar input is stopped 3 The voltage decreases slowly due to load current 4 When the VSTORE1 voltage achieves VOUTL 1 62 V the VOUT1 turns off 5 Solar input is started 6 When the VSTO...
Page 53: ...4 2 Setting of Timer for detailed calculation formulas 5 1 4 1 Waveform of Demo Mode and Timer Mode The following are the details of the Demo mode DM operation and waveform Case1 VSTORE2 is empty 1 T...
Page 54: ...ed VOUT1 START START STOP RESET VSTORE1 VSTORE2 T2 ON ON T0 T1 START START STOP RESET T2 ON ON T0 T1 START START STOP RESET T2 ON ON T0 T1 START START STOP RESET T2 ON ON T0 T1 START START STOP RESET...
Page 55: ...of timer 0 T0 timer 1 T1 and timer 2 T2 can be calculated using the following formulas T0 s 0 5455 C F 10 9 0 01327 s 0 5455 220 10 12 10 9 0 01327 s 0 13 s T1 s 0 5455 3 77 10 9 10 9 0 01327 s 2 07...
Page 56: ...nce design except energy harvesting 5 2 1 Flow Diagram Figure 5 1 is the flow diagram for the example project of the kit firmware Figure 5 1 Example Project Flow Chart Power up Perform Low Power start...
Page 57: ...the part into the deep sleep state CySysWdtEnable Enables the specified WDT counters CySysWdtDisable Disables the specified WDT counters ConfigRW_CheckSFlash Checks whether there is configuration data...
Page 58: ...p and Software Reset The code from the Solar_BLE_Sensor PSoC Creator project is started This code begins with low power startup functions This allows the system to conserve power during clock startup...
Page 59: ...O will be used as source when IMO is switched off to save power to drive the HFCLK CySysClkWriteEcoDiv CY_SYS_CLK_ECO_DIV8 Start WCO ECO in low power mode LowPower_WCO_ECO_Start If USB connector is pl...
Page 60: ...system is set with the IMO at 12 MHz and the ECO at 3 MHz The user flash read is done at every start to read the stored beacon data in SFLASH and then use it for broadcasting The flash read is done i...
Page 61: ...ata is read and the system goes back to deep sleep again Upon WDT interrupt the system wakes up and the ADV packet is updated with the new data Also the GAP advertisement is started so that the new AD...
Page 62: ...nsor Beacon Reference Design Kit Guide Doc No 002 11317 Rev C 62 VSTORE1 400 F VSTORE2 200 mF VOUT1 BLE Current Humidity data request Humidity data read I 2 C Start Temperatur e data request Temperatu...
Page 63: ...expected time elapsed if wdt_trigger_on_flag CYBLE_API_RESULT_T apiResult switch i2c_state case I2C_START I2CM_Start I2C_buffer 0 SI7020_WRITE_USER_REG I2C_buffer 1 USER_REG_SETTING void I2CM_I2CMast...
Page 64: ...020 case I2C_READ_HUMIDITY_RECV Read RH data from I2C Sensor void I2CM_I2CMasterReadBuf SI7020_SLAVE_ADDR I2C_buffer I2C_BUFFER_HUM_OFFSET_DATA SI7020_MEASURE_RH_RECV_LEN I2CM_I2C_MODE_COMPLETE_XFER U...
Page 65: ...ata advData ADDR_TEM_OFFSET I2C_buffer I2C_BUFFER_TEM_OFFSET_DATA void I2CM_I2CMasterClearStatus When sensor used advertise interval is fixed to 10 24s apiResult Beacon_GappStartAdvertisement ITRVL_SE...
Page 66: ...11111011010110b 0x8E89BED6 PDU includes Header and Payload The BLE Beacon packet structure belongs to Advertising Data in Payload Preamble 8 Access Address 32 PDU Protocol Data Unit 16 to 312 Header 1...
Page 67: ...al sensor data 4 Received signal strength indication This is used to determine proximity to distance from the beacon The kit uses the ReadAndApplyConfig function in main c to update the BLE Beacon pac...
Page 68: ...ce UUID Length2 0x03 AdvData Advertising Data 31 means Byte Service UUID 4 Eddystone UID 24 Flags 3 Len gth2 1 AD type 2 1 Len gth1 1 AD type 1 1 AD data 1 Eddystone UUID 2 Len gth3 1 AD type 3 1 BID...
Page 69: ...dBm NID CB6F15CEC02A41F76AB1 hex BID 000000010001 hex RFU 0x0000 Eddystone URL Length3 0x0E AD type3 0x16 Eddystone UUID 0xFEAA Frame type 0x10 URL Ranging data 0xDD 35dBm URL 006379707265737300 hex h...
Page 70: ...ocks shown in Figure 6 1 Figure 6 1 Solar BLE Sensor Block Diagram Note that the Solar BLE Sensor is not printed the silk screen of all components due to tiny size To identify the components refer to...
Page 71: ...71 Figure 6 2 Solar BLE Sensor Assembly Drawing 6 1 1 15 x 15 mm Solar Cell The solar cell connects to the VDD pin of S6AE103A via a diode for reverse current protection and via a 10 F capacitor as s...
Page 72: ...02 11317 Rev C 72 Table 6 1 lists the specifications of the solar cell AM 1606C Table 6 1 Specifications of Solar Cell AM 1606C Items Specifications Size 15 0mm 15 0mm 0 7mm Open Circuit Voltage VOC T...
Page 73: ...3 Storage and VOUT Control Block for detailed specifications 6 1 4 0 2 F Supercapacitor Refer to 5 1 3 Storage and VOUT Control Block for detailed specifications 6 1 5 Slide Switch for S6AE103A Mode...
Page 74: ...Board P5 0 I O Connect U4 of temperature and humidity sensor SDA for I2 C connection P5 1 I O Connect U4 of temperature and humidity sensor SCL for I2 C connection XRES I Connect CN1 5 pin XRES to pr...
Page 75: ...ct power of Solar BLE Sensor 3 3 V power from Debug Board 2 GND Ground connection 3 SWDCLK Connect P0 7 of EZ BLE SWDCLK to program debug via KitProg 4 SWDIO Connect P0 6 of EZ BLE SWDIO to program de...
Page 76: ...6 3 Debug Board Block Diagram Status LED 3 3 V LDO MB39C022G PSoC 5LP KitProg CY8C5868LTI User Switch User LED PRoC BLE Device CYBL10162 56LQXI Power LED Reset Switch Slide Switch for Target Device S...
Page 77: ...WD I 2 C and UART pins The KitProg communicates with the PSoC Programmer and PSoC Creator software to program debug the target PRoC 4 BLE or EZ BLE module over the SWD interface The main advantage of...
Page 78: ...vide a 3 3 V output for each device A supercapacitor SC1 on the Solar BLE Sensor is charged via diode when the Solar BLE Sensor connects The following is the block diagram for the power system Solar C...
Page 79: ...tch is set to PRoC BLE Program mode the PSoC 5LP XRES pin connects the PRoC BLE device and the XRES of the EZ BLE module connects to ground When the switch is set to EZ BLE Program mode the PSoC 5LP X...
Page 80: ...3 V output of the LDO 3 3 V power to Solar BLE Sensor 2 GND Ground connection 3 SWDCLK Connect P12 3 of PSoC 5LP SWDCLK to program debug via KitProg 4 SWDIO Connect P12 2 of PSoC 5LP SWDIO to program...
Page 81: ...s the sample waveform Note that this sample waveform is for the power gating operation mode of S6AE103A is in an Energy Driven Mode Refer to the S6AE103A datasheet for detailed operation modes 1 The s...
Page 82: ...VOUTL 1 62V CHRGE CHRGE Solar Input is stopped Solar Input is started Solar Battery Solar A 2 Charging the Supercapacitor The supercapacitor SC1 on the Solar BLE Sensor is charged when the Solar BLE...
Page 83: ...is 5 mA the voltage drop will be 1000 mV V IR To resolve such a problem the S6AE103A has two storage pins VSTORE1 and VSTORE2 VSTORE1 connects the low ESR capacitor such as a ceramic capacitor VSTORE...
Page 84: ...V or reaches 1 62 V due to voltage drop S6AE103A turns the voltage OFF and stops the BLE transmission A 4 Diode Connection Between Solar Cell and VDD A diode is needed between the VDD pin and the sola...
Page 85: ...ference Design Kit Guide Doc No 002 11317 Rev C 85 Solar Cell PMIC Charging Time Voltage Time Voltage Solar Cell PMIC Bright Dark Time Voltage Time Voltage Solar Cell PMIC Add the diode to protect aga...
Page 86: ...ndix B Solar BLE Sensor Enclosure B 1 Solar BLE Sensor Enclosure The kit includes an enclosure for the Solar BLE Sensor shown in the following image It contains three parts a top cover a bottom cover...
Page 87: ...the following steps to install the Solar BLE Sensor board in the enclosure 1 Set the transparent sheet to the top cover as shown below 2 Adjust the position of the circle mark on the bottom cover and...
Page 88: ...CYALKIT E02 Solar Powered BLE Sensor Beacon Reference Design Kit Guide Doc No 002 11317 Rev C 88 3 Adjust the position of the circle mark on the top cover and SW1 on Solar BLE Sensor Install the top...
Page 89: ...016 EIFU Initial release A 06 01 2016 EIFU Changed the order of Install Cypress BLE Beacon Software Changed the file location path of the Cypress BLE Beacon Added the copy step of the BLE folder in 4...
Page 90: ...Mouser Electronics Authorized Distributor Click to View Pricing Inventory Delivery Lifecycle Information Cypress Semiconductor CYALKIT E02...
