# LINE Beacon device specification
This LINE Beacon specification is for corporate users who wish to deploy beacon devices to use LINE Beacon. Your beacon devices must comply with this specification.
Unlike LINE Simple Beacon (opens new window) packets, LINE Beacon packets have the secure message field as a mechanism for security.
# Requirements for LINE Beacon compliant devices
A beacon device compliant with the LINE Beacon specification supports Bluetooth® Low Energy Version 4.0 and Apple's iBeacon (opens new window) and can advertise LINE Beacon packets. Specifically, the device must meet the following requirements:
- Advertise LINE Beacon packets.
- Generate a secure message from data hashed by SHA-256 and XOR (exclusive OR) operations.
- Update the secure message every 15 seconds.
- Have a unique HWID written to the device and displayed on the body of the device.
# LINE Beacon packets
For LINE to detect your beacon device quickly, control beacon devices according to the broadcaster role (BLUETOOTH SPECIFICATION Version 4.0 [Vol 3], Part C Section 2.2.2.1) specified in the generic access profile.
# Packet transmission interval
We strongly recommend that you send LINE Beacon packets at 152.5ms intervals.
# Advertising packet specification
Compose advertising packets with three AD structures, as illustrated below.
The advertising packet specification is as follows. The hexadecimal values in the value column are equivalent to the bracketed values in the description column.
| Octet | Field | Value | Description |
|---|---|---|---|
| 00 | Length | 0x02 | The data length of the first AD structure (2 bytes) |
| 01 | AD type | 0x01 | The AD type of the first AD structure (Flags) |
| 02 | AD data | 0x06 | The flags set (LE General Discoverable Mode, BR/EDR Not Supported) |
| 03 | Length | 0x03 | The data length of the second AD structure (3 bytes) |
| 04 | AD type | 0x03 | The AD type of the second AD structure (Complete list of 16-bit UUIDs available) |
| 05 | 16-bit UUID | 0x6F | The 16-bit UUID of LINE, when joined with the next byte (0xFE6F) |
| 06 | 16-bit UUID | 0xFE | The 16-bit UUID of LINE, when joined with the previous byte (0xFE6F) |
| 07 | Length | 0x11 | The data length of the third AD structure (17 bytes) |
| 08 | AD type | 0x16 | The AD type of the third AD structure (Service Data - 16-bit UUID) |
| 09 | 16-bit UUID | 0x6F | The 16-bit UUID of LINE, when joined with the next byte (0xFE6F) |
| 10 | 16-bit UUID | 0xFE | The 16-bit UUID of LINE, when joined with the previous byte (0xFE6F) |
| 11 | Frame type | 0x02 | The frame type (LINE Beacon) |
| 12-16 | HWID | Device-specific value | A 5-byte unique ID of the beacon device. For more information, see HWID. |
| 17 | Measured TxPower | Device-specific value | RSSI (Received Signal Strength Indicator) when the device with LINE installed and the beacon device is one meter apart. Set the same value as for the iBeacon packet. For more information, see the iBeacon documentation. Set this field to 0x7F if you don't use RSSI data. |
| 18-21 | Message authentication code | Variable | A 4-byte code for message authentication |
| 22-23 | Masked timestamp | Variable | A 2-byte masked timestamp |
| 24 | Battery level | Variable | Remaining battery level |
| 25-30 | Non-significant part | 0x00 | Unused. Set each byte to 0x00. |
# Generate a secure message
LINE requests you to send a secure message to prevent tampering of LINE Beacon packets and replay attacks. A secure message is 7-byte data that contains message authentication code, masked timestamp, and battery level. LINE passes the secure messages transmitted from beacon devices to the LINE Platform for verification.
To generate a secure message, perform XOR (exclusive OR) operation three times on a hash value computed with SHA-256, by the flow illustrated below. For more information about the required parameters, see Required parameters for secure messages.
Generate a secure message by the instructions below.
# 1. Generate a message authentication code
Concatenate these items in the order listed and generate a 32-byte hash value with SHA-256.
Perform XOR operation on the first 16 bytes and the second 16 bytes of the hash value.
Perform XOR operation on the first 8 bytes and second 8 bytes of the value computed in the previous step.
Perform XOR operation on the first 4 bytes and second 4 bytes of the value computed in the previous step.
Now you have a message authentication code.
# 2. Generate a masked timestamp
Mask 6 bytes from the beginning of the timestamp and leave the last 2 bytes. This is a masked timestamp.
# 3. Concatenate items
To generate a secure message, concatenate these items in the order listed:
- Message authentication code generated in step 1
- Masked timestamp generated in step 2
- Battery level
The result of concatenation is a secure message. See Sample code and data for generating secure messages to develop and test for your beacon device to generate secure messages.
# Required parameters for secure messages
To generate a secure message, you need these parameters:
LY Corporation generates and manages the HWID, lot key, and vendor key. To obtain these required parameters, contact the LY Corporation representative for your organization. Only after you (corporate users) submit an application form and get permission, the required parameters will be issued to you.
# Battery level
The battery level is the remaining battery capacity. Specify the level as guided below:
| Decimal value | Hexadecimal value | Description |
|---|---|---|
| 0 | 0x00 | Unknown or connected to an external power supply. |
| 1 | 0x01 | 0% left. The battery is fully discharged. |
| 2 | 0x02 | 10% left |
| … | … | … |
| 10 | 0x0A | 90% left |
| 11 | 0x0B | 100%. The battery is fully charged. |
| 12–255 | 0x0C–0xFF | Reserved for future use. Don't use. |
# HWID
The HWID is the hardware ID of a beacon device issued by LY Corporation. The ID is a 10-character string in hexadecimal notation. Convert the HWID to a byte array and write the byte array to the beacon device as 5-byte binary data. Also, mark the HWID on the beacon device.
# Lot key
A lot key is assigned to each lot, issued by LY Corporation. The keys are 16-character strings. Like HWID, convert the key to a byte array and write the byte array to the beacon device as 8-byte binary data.
# Timestamp
A timestamp is an unsigned 64-bit integer.
- Start incrementing the timestamp when the beacon device is switched on for the first time.
- Start the timestamp at zero and increment the value every 15 seconds. For example, the timestamp for a beacon device one minute after the beacon is switched on is 4.
- Don't reset the timestamp to zero when the beacon device is switched on again. Continue to increment the timestamp value at power-off.
- Reset the timestamp to start at zero again when you rewrite the HWID of the beacon device to the newly issued HWID.
# Vendor key
A vendor key is assigned to each vendor, issued by LY Corporation. The key is an 8-character string in hexadecimal notation. Like HWID, convert the key to a byte array and write the byte array to the beacon device as 4-byte binary data.
# iBeacon packets
To notify iOS devices that a LINE Beacon device is nearby, you must send iBeacon packets. Include these LINE Beacon specific parameters in the iBeacon packets.
| Parameter | Value |
|---|---|
| UUID | D0D2CE24-9EFC-11E5-82C4-1C6A7A17EF38 |
| Major | 0x4C49 |
| Minor | 0x4E45 |
For more information about the AD structure and transmission interval of iBeacon packets, see Apple's Proximity Beacon Specification document. You can download this document from the iBeacon section of the Apple Developer site (opens new window).