Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Eddystone Beacon Application

Introduction

**************************** Introduction ********************************* Eddystone beacon application demonstrates the Google's Eddystone proximity beacon messages on the Atmel BLE device. It is completely complaint with the Eddystone specification provided in the link https://github.com/google/eddystone and supports all the three Eddystone frames (UID, URL and TLM).

  • Supported Evaluation kits -
    • ATSAML21-XPRO-B + ATBTLC1000 XPRO
    • ATSAMD21-XPRO + ATBTLC1000 XPRO
    • ATSAMG55-XPRO + ATBTLC1000 XPRO
    • ATSAM4S-XPRO + ATBTLC1000 XPRO
  • Running the Demo -
    • 1. Build and flash the binary into one of the supported evaluation board.
    • 2. Open the EDBG COM port using TeraTerm or any serial port monitor application in the host PC.
    • 3. Press the Reset button on the board to restart the firmware.
    • 4. Wait for around 10 seconds for the BTLC1000 to be initialized with patches etc.
    • 5. The device will now start sending Eddystone beacons (URL or UID based on the APP_TYPE define).
    • 6. Use a BLE compatible Android or iPhoneŽ mobile device to run Atmel SmartConnect application.
    • 7. Enable Bluetooth from the settings page of the mobile device and open Atmel SmartConnect app.
    • 8. Click on the Beacons navigation pane to view the ranging screen. The Eddystone beacon will be scanned and displayed on the ranging screen with an Eddystone icon.
    • 9. Click on the Eddystone icon image to view the beacon information in a small pop-up window. Click on the pop-up window to view detailed information of the beacon.
    • 10. In case of Eddystone-URL, long press the SW0 button on the evaluation board to put the beacon device into configuration mode.
    • Click 'Configure' button in the detailed beacon information page of the mobile app to view the Eddystone devices in configuration mode.
    • Connect to the listed 'Atmel-Eddystone' device to configure the URL, beacon period, TX power mode etc.
    • Disconnect from the beacon device to see the beacon working with updated values.

features

********************** Application features ********************************* The application supports two different configuration which is controlled by the 'APP_TYPE' define. Setting 'APP_TYPE' to 'EDDYSTONE_UID_APP' demonstrates the Eddystone-UID frames along with TLM and setting the 'APP_TYPE' to 'EDDYSTONE_URL_APP' demonstrate the Eddystone-URL frames with TLM and the Eddystone-URL configuration service.

  • EDDYSTONE_UID_APP - In this app configuration, the Eddystone-UID frames are transmitted for every beacon interval and interleaved with TLM frames based on a ratio value(uid_to_tlm_frame_ratio). The UID frame fields like Namspace ID, Instance ID, Calibrated TX Power at 0 meter etc can be configured in the 'conf_eddystone.h' file. There are API functions available to configure these values at runtime too.
  • EDDYSTONE_URL_APP -
    • In this app configuration, the Eddystone-URL frames are transmitted for every beacon interval and interleaved with TLM frames based on a ratio value(url_to_tlm_frame_ratio). The URL frame fields like encoded URI data, advertised tx power at 0 meters etc can be configured at compile time in the 'conf_eddystone.h' file and at runtime using the available API functions.
    • In TLM frame, the beacon temperature value is obtained from the on-board temperature sensor of the evaluation board and the 0.1 seconds counter value from the hardware timer.
    • The Eddystone-URL configuration service is also supported in this application. The SW0 button on the evaluation board is used to toggle between configuration mode and beacon mode. The Configuration service provides characteristics to update the URL value, Advertised tx power level and beacon period etc.

Modules

************************* Used Modules ************************************ Following modules are used by the Eddystone application in the BluSDK.

  • BLE Manager -
    • The Event Manager handles generic BLE events triggered by BLE stack and also responsible for invoking all registered callbacks for respective events. BLE Manager handles all GAP related functionality. In addition to that it handles multiple connection instances, Pairing, Encryption, Scanning etc.

BLE Platform Services -

  • Interface Settings -
    • Connect ATBTLC1000 XPRO to SAML21-XPRO-B -> EXT1
    • Connect ATBTLC1000 XPRO to SAMD21-XPRO -> EXT1
    • Connect ATBTLC1000 XPRO to SAMG55-XPRO -> EXT1
    • Connect ATBTLC1000 XPRO to SAM4S-XPRO -> EXT1
  • Serial Console COM port settings -
    • Baudrate 115200
      • Parity None, Stop Bit 1, Start Bit 1
      • No Hardware Handshake

6-Wire Mode Connection Setup -

  • Pins are 1:1 match with SAML21/D21 XPRO EXT1 Header to BTLC1000 XPro Header
    • UART(No Flow Control)-SAM L21/D21 XPRO Pins (Rx-Pin13, Tx-Pin14)
    • UART(With Flow Control)-SAM G55 XPRO Pins (Rx-Pin13, Tx-Pin14, RTS-Pin5, CTS-Pin6, Rx-Pin16, Tx-Pin17)
    • BTLC1000 Wakeup Pin-SAM G55 XPRO Pins(Pin4)
    • BTLC1000 Chip Enable Pin-SAM G55 XPRO Pins(Pin10)
    • BTLC1000 Vcc Pin-SAM L21/D21/G55 XPRO Pins(Pin20)
    • BTLC1000 GND Pin-SAM L21/D21/G55 XPRO Pins(Pin19)

4-Wire Mode Connection setup -

  • UART(With Flow Control)-SAM L21/D21 XPRO Pins (Rx-Pin15, Tx-Pin17, RTS-Pin16, CTS-Pin18)
  • BTLC1000 Wakeup Pin-SAM L21/D21 XPRO Pins (Rx-Pin6)
  • BTLC1000 Chip Enable Pin-SAM L21/D21 XPRO Pins (Rx-Pin4)
  • UART(With Flow Control)-SAM G55/4S XPRO Pins (Rx-Pin13, Tx-Pin14, RTS-Pin5, CTS-Pin6)
  • BTLC1000 Wakeup Pin-SAM G55/4S XPRO Pins(Pin4)
  • BTLC1000 Chip Enable Pin-SAM G55/4S XPRO Pins(Pin10)
  • BTLC1000 Vcc Pin-SAM L21/D21/G55/4S XPRO Pins(Pin20)
  • BTLC1000 GND Pin-SAM L21/D21/G55/4S XPRO Pins(Pin19)

SDK and Evaluation kit

************************ BLE SDK and Evaluation kit ***********************

Generated on Fri Mar 4 2022 23:24:56 for Eddystone Beacon Application - SAM D21 Xplained Pro by   doxygen 1.8.5