Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 2.51 KB

README.md

File metadata and controls

70 lines (46 loc) · 2.51 KB
Raw

Green Beacon ESP32 Library

A BLE beacon library for ESP32 boards on Arduino environment.

This is unofficial library conforming to LINE Simple Beacon (Official).

Getting Started

  1. Web: Create your LINE official account.
    https://manager.line.biz/
  2. App: Add your official account as friend.
  3. App: Make available LINE Beacon on your smartphone.
    LINE app > Settings > Privacy > Provide usage data > fill checkbox at LINE Beacon
  4. PC: Issue "LINE Simple Beacon Hardware ID" from below.
    https://manager.line.biz/beacon/register
  5. Arduino IDE: Set the issued ID to variable "hwid" in sample sketches.
  6. Arduino IDE: Upload the sketch to your ESP32 based board.
  7. Programming: Develop your backend (server-side) script using LINE messaging API to handle beacon event.
    https://developers.line.biz/en/reference/messaging-api/#beacon-event

Example

// Set your hardware ID
const String hwid = "0123456789";
// Create beacon instance
GreenBeacon beacon = GreenBeacon(hwid);
// Set advertise message & Start advertising 
beacon.start("hey");

Dependency

No need additional installation if you installed Arduino core for the ESP32 from boards manager on Arduino IDE.

API

GreenBeacon(const String hwid, const String device_name = "Green Beacon")

hwid : Issued LINE Simple Beacon hardware ID. It must be 10 chars of hex string.
device_name : (optional) BLE Device name.

void init(const String device_name = "Green Beacon")

NEEDLESS TO USE IN USER SKETCH (run in constructor)
Initialize BLEDevice instance.

void setHwid(const String hwid)

Set issued LINE Simple Beacon's Hardware ID.
Deprecation: use constructor to set Hardware ID instead.

void setMessage(const String message)

message : The payload message (Max length: 13 bytes). This string will be set to beacon.dm on LINE Messaging API's beacon event. See Beacon event.

void start(const String message = "")

Start advertising.
The message argument is optional.

void stop()

Stop advertising.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.