Add:6A-3CDE, Baoneng Science and Technology Park, Longhua district, Shenzhen 518109, Guangdong, China. Website: www.kkmcn.com KBeaconPro App Instruction Revision History Version Date Change Description Author V1.0 V1.1 2017/11/12 Initial draft for KBeaconTools 2018/02/23 Name updating V1.2 2018/03/08 Updating iBeacon/Eddystone URL/Eddystone UID/Eddystone TLM configuration V1.2 V2.0 2018/03/27 Updating RSSI value setting 2018/10/02 App Interface updating V3.0 2019/10/15 V4.0 2021/07/06 V4.1 2021/11/24 Name updating&App Interface updating Name updating&App Interface updating Adding Power off and Reset function Adam Adam Adam Adam Claire Claire Claire Claire V4.2 2022/06/15 Adding trigger and sensor function Elaine V4.3 2022/11/2 Adding Power Profiler function Elaine C O N F I D E N T I A L This document is the property of KKM Co.Ltd. KKM retains all rights pertaining to industrial is only for the recipient(s) which property including patent applications. This document authorized by KKM. information and any use, dissemination, distribution, or reproduction of this message by unintended recipients is not authorized and may be unlawful. It contains confidential Copyright by KKM Co.,Ltd confidential 1/
KKM Co.Ltd KBeaconPro App Instruction Contents 1. Download KBeaconPro App ............................................................................................................................ 3 2. How to connect KBeacon device to KBeaconPro App ................................................................................... 3 2.1 Turn on KBeacon ............................................................................................................................3 2.2 Connect KBeacon ........................................................................................................................... 5 3. How to configure KBeacon ............................................................................................................................. 7 3.1 SLOT Definition .............................................................................................................................7 3.2 How to configure iBeacon and Eddystone ..................................................................................... 8 3.3 How to configure KSensor and System ..........................................................................................9 3.4 How to configure Trigger Command ........................................................................................... 10 3.5 How to configure Sensor .............................................................................................................. 13 3.6 How to evaluate battery life ..........................................................................................................18 3.7 How to configure Adv Mode ........................................................................................................19 4. Other settings ..................................................................................................................................................20 4.1 Unconnectable mode .................................................................................................................... 20 4.2 Power Off ......................................................................................................................................21 4.3 Reset configuration .......................................................................................................................22 5. KBeacon payload ........................................................................................................................................... 23 Copyright by KKM Co.,Ltd confidential 2/
KKM Co.Ltd KBeaconPro App Instruction 1. Download KBeaconPro App Download the App KBeaconPro from iOS App Store or Android Google Play or scan the QR code below to down the App. iOS APP Minimum requirements Android APP A mobile phone with Bluetooth 4.0 support is needed. For Android devices, Android version 5.1 or newer. For iOS devices, iOS version 10.0 or newer. Reminder: This instruction uses Android App to demonstrate. The iOS App interface is slightly different from Android App. 2. How to connect KBeacon device to KBeaconPro App Kindly note: Please make sure your KBeacon device is with battery already. Enable your smart phone Bluetooth and run the App KBeaconPro. 2.1 Turn on KBeacon KBeacon with external or internal button (Including model K1/K11/K21/K23/K3/K4/K41/K4P/K5/K51/K5P/K6/K61/K6P/K7/K71/K8/K81/W59/F1/W3/W52/B1/B2
/S1/P2) The factory setting of KBeacon with button is OFF. Turn ON the device: Hold the button for 3 seconds, the LED starts flashing and the flashing lasts for 30 seconds. Turn OFF the device: Hold the button for 5 seconds, the LED starts flashing and flash 8 times. Copyright by KKM Co.,Ltd confidential 3/
KKM Co.Ltd KBeaconPro App Instruction KBeacon without button (Including model K12/K15/K15A/K15L/W4/U1/K9/K91/K9P/W7/S2/P1) The factory setting of KBeacon without button is ON. K12/K15/K9/ P1/W7 does not support turning off the power. K1/K11 K21/K23 K12 K3 K4/K41/K4P K5/51/K5p K61/K6P series K7/K71 K8/K81 K9/K91/K9P W4 W59 U1 F1 W51 W52 W3 W7 B1 B2 S1 S2 P1 W8 Copyright by KKM Co.,Ltd confidential 4/
KKM Co.Ltd KBeaconPro App Instruction K15/K15A/K15L P2 2.2 Connect KBeacon Lets use a K9P (MAC: DD3311000588) to demonstrate, the MAC ID is printed on the device:
Method 1: Scan QR code to connect Run KBeaconPro App, Find Scan QR code on the App, and then scan the QR code on the device to find this KBeacon device quickly. Reminder: iOS App filter the device by Device Name when use the Scan QR code method. If the device name is not KBPro, the device can not be found on iOS App when scan the QR code. Copyright by KKM Co.,Ltd confidential 5/
KKM Co.Ltd KBeaconPro App Instruction Method 2: Scan the Bluetooth signal to connect Run KBeaconPro App and tap SCAN in the top right corner, the App can scan the devices Bluetooth signal, then the Beacon device will be displayed on the scan page. Find the corresponding KBeacon device on the App according to its MAC ID, Tap it, it will start connecting and jump to the configuration page (see pictures below). If there are too many devices found , filter by RSSI to find a certain Beacon quickly. Put the KBeacon device close to your phone (within 10cm range). Slide the RSSI bar to set the RSSI value at -30~-
40dBm, tap the arrow on the top right corner, then the nearest KBeacon can be found. Copyright by KKM Co.,Ltd confidential 6/
KKM Co.Ltd KBeaconPro App Instruction 3. How to configure KBeacon 3.1 SLOT Definition KBeacon supports total 5 SLOTs (SLOT0 to SLOT4). Each SLOT is independent and configurable. The Beacon type can be set for each SLOT. Beacon parameters such as Adv interval, Tx Power, Connectable enable/disable etc can be configured separately for each SLOT. They are independent of each other. Each SLOT can be set to one Beacon type ONLY. For example, if you set SLOT0 to be iBeacon, set SLOT1 to be URL, set SLOT2 to be TLM, then the KBeacon device will broadcast iBeacon, URL and TLM simultaneously. KBeacon supports the following Beacon types:
iBeacon Eddystone URL Eddystone UID Eddystone TLM KSensor: KKM self-defined protocol, includes battery level and sensor information System:
Including the KBeacon device info such as System ID (ie.MAC ID), Model name. Copyright by KKM Co.,Ltd confidential 7/
KKM Co.Ltd KBeaconPro App Instruction 3.2 How to configure iBeacon and Eddystone
(Take iBeacon as an example) Tap: Beacon Type> iBeacon> Save> Return Copyright by KKM Co.,Ltd confidential 8/
KKM Co.Ltd KBeaconPro App Instruction iBeacon parameters (UUID, Major ID, Minor ID, Adv Interval, Tx power etc.) can also be configured in the App. Eddystone URL, UID, TLM, can be configured by the same steps above. Reminder: After the parameters are modified, you need to tap: UPLOAD > OK, then all the parameters configured can be loaded to the device successfully. 3.3 How to configure KSensor and System is KKM self-defined protocol, KSensor temperature&humidity sensor, acceleration sensor etc). it includes battery level and sensor information (for example Tap: Beacon Type> KSensor> Save> Return System can also be configured by the same steps above. Copyright by KKM Co.,Ltd confidential 9/
KKM Co.Ltd KBeaconPro App Instruction 3.4 How to configure Trigger Command Reminder: The Trigger Command function can be configured ONLY when the KBeacon device has a push button or has sensor such as accelerometer, temperature-humidity sensor. Tap: Trigger Command>Trigger Type
(Take Button single click as an example) Tap: Button single click> Save> Return Return to the trigger page, and then you can see the trigger parameters such as Trigger Action, Trigger Adv Slot, Advertisement Change, Trigger Adv Time can be configured. Copyright by KKM Co.,Ltd confidential 10/
KKM Co.Ltd KBeaconPro App Instruction Trigger Action: What the Beacon device would do when the trigger event happens If set Report to app, there will be a message notification displayed on the cell phone when the trigger event happens. Trigger Adv Slot: Which SLOT the Beacon device would broadcast when the trigger event happens. For example, SLOT0 is set to be iBeacon, if Trigger Adv Slot is set to be SLOT0, then when the Beacon button is single clicked, the Beacon will broadcast iBeacon. Copyright by KKM Co.,Ltd confidential 11/
KKM Co.Ltd KBeaconPro App Instruction Advertisement change: When this feature in ON, the UUID will change when trigger event happens Trigger Adv Time: The Advertisement duration when trigger event happens Trigger only advertisement: When this feature is set to be YES, this slot will be broadcasted only when the trigger happens. For example. If you set Trigger Adv Slotof Button single click to be SLOT0, and SLOT0 is then iBeacon will be broadcasted only when the button single click happens iBeacon, Copyright by KKM Co.,Ltd confidential 12/
KKM Co.Ltd 3.5 How to configure Sensor KBeaconPro App Instruction For some KBeacon models with sensor, parameters can be configured. Temperature & Humidity Sensor (K23/K6P/K6PS/K6PB/K6PT) T&H Logger: When this feature is on, the device will threshold you set. record when temperature/humidity change exceeds the Copyright by KKM Co.,Ltd confidential 13/
KKM Co.Ltd KBeaconPro App Instruction Measure interval: Time interval for measuring temperature and humidity. Temperature / Humidity change log threshold: If you set a value (take 5 as an example, it means 0.5 Celsius), the device will save the record if the difference between the current temperature / humidity and the last saved temperature / humidity greater or equal than 0.5 Celsius. History data: The data can be loaded or cleared. Copyright by KKM Co.,Ltd confidential 14/
KKM Co.Ltd KBeaconPro App Instruction Trigger Command: The feature and setting is same as 3.4 except Temperature threshold in Temperature/Humidity above/below. If you set a value (take 60 as an example, it means 6 Celsius), when the temperature is above 6 Celsius the trigger event happens. Copyright by KKM Co.,Ltd confidential 15/
KKM Co.Ltd KBeaconPro App Instruction Click Save and return, then click Upload. Cutoff Sensor (S1) Cutoff 0 means S1 is installing well and closed;
Cutoff 1 means S1 is installing well and opened;
Cutoff 2 means S1 is not installing well and closed, the black button (at the bottom of the device) didn't press down;
Cutoff 3 means S1 is installing well and opened, the black button didn't press down. Copyright by KKM Co.,Ltd confidential 16/
KKM Co.Ltd KBeaconPro App Instruction Disable Period: When this feature is on, you can set the time period of sleep mode by turning the hour hand and minute hand, or input the time through the keyboard. PIR Sensor (S2) The configuration is same as Cutoff Sensor. Copyright by KKM Co.,Ltd confidential 17/
KKM Co.Ltd KBeaconPro App Instruction 3.6 How to evaluate battery life KBeaconPro supports evaluating the battery life of beacon according to the configured parameters. Average current: The average current of the device is based on the calculated after the device is powered on for 30 seconds for current stabilizes. The average current does not include power consumption by trigger broadcasting. Also, it does not include the power consumption when the device was connected. current configuration parameters, and is Battery efficiency: Usually the battery capacity is based on the ideal 1mA discharge model at room temperature. In actual use, the capacity of the battery is related to temperature, current and self-discharge. We recommend 75%. Estimated battery life: Estimated battery life = Battery capacity * Battery efficiency/ Average current/24(hours)/30(days) Copyright by KKM Co.,Ltd confidential 18/
KKM Co.Ltd KBeaconPro App Instruction 3.7 How to configure Adv Mode For some KBeacon models that support BLE5.0 long range feature, Adv Mode can be configured. Legacy: BLE 4.0 advertisement PHY Code: BLE 5.0 long range feature PHY 2Mbps: BLE5.0 broadcasting at a rate of 2Mbps KBeaconPro App can detect which Adv Mode your phone support (Only supported on Android phones). Reminder:
Please make sure that your phone supports BLE 5.0 PHY Code(Long range) feature, otherwise you will not be able to scan the PHY code advertisement if the Beacon was set to PHY Code(Long range) Mode. If you set the Beacon to PHY code advertisement, and your phone doesnt support PHY Code broadcast, you can force the device to enter the Legacy mode for 30 seconds by single click the button of the device. Copyright by KKM Co.,Ltd confidential 19/
KKM Co.Ltd KBeaconPro App Instruction 4. Other settings 4.1 Unconnectable mode Each SLOT has two different advertising status, connectable mode and unconnectable mode. Only when the advertising status is connectable, the KBeacon is configurable. But the unconnectable mode saves about 10% -20%
power consumption than connectable mode. After the KBeacon is deployed, we battery power consumption and the Beacon also have better security performance. recommend setting the KBeacon to be unconnectable mode. This can lower How to set unconnectable mode:
Tap: Connectable> OFF> Save>Return >UPLOAD. Question: How can I configure KBeacon again if it was set to be unconnectable mode?
For KBeacon with button: click the button, the Beacon will enter a connectable mode for 30 seconds, users can connect the device within these 30s. Or re-install battery. For KBeacon without button: Re-install battery Reminder: For the KBeacon device that doesnt have button and whose battery can not be re-installed, once the device was set to unconnectable mode, it can not be confirgured any more!
Copyright by KKM Co.,Ltd confidential 20/
KKM Co.Ltd 4.2 Power Off KBeaconPro App Instruction For KBeacon device WITH BUTTON, you can use the App to turn off the device. Tap: Power Off> OK Copyright by KKM Co.,Ltd confidential 21/
KKM Co.Ltd KBeaconPro App Instruction 4.3 Reset configuration You can reset the KBeacons setting to factory default configuration on the App. Tap: Reset configuration> OK Copyright by KKM Co.,Ltd confidential 22/
KKM Co.Ltd KBeaconPro App Instruction 5. KBeacon payload iBeacon payload struct How to calculate distance from iBeacon signal:
Formula:
distance = 10^((abs(RSSI) - abs(Calibrated Power)) / (10 * n)) And RSSI: received rssi on phone Calibrated Power: Calibrated power at 1 meters n: environment factor, typical value is 2.0 Eddystone payload struct Copyright by KKM Co.,Ltd confidential 23/
KKM Co.Ltd KBeaconPro App Instruction KSensor payload struct 1. The advertising data packet of KSensor is defined by KKM. Please refer to the following table for details. Offset Length 0 1 4 8 9 10 12 13 14 15 17 19 21 23 25 27 28 1byte 3byte 4byte 1byte 1byte 2byte 1byte 1byte 1byte 2byte 2byte 2byte 2byte 2byte 2byte 1byte 1byte Type AdvA value 0x6 AdvFlags 0x020106 ID Length 0x0303AAFE Adv type 0x16 UUID 0xAAFE Frame Type Version tag Sensor mask 0x21 0x1 0bit: voltage;
1bit:temp 2bit: humidty 3bit: acc 4bit: cutoff 5bit: PIR indication 6~7bit: reserved Voltage big-endian battery voltage, unit is mV Temperature Exist if temp bit set 1. Temperature, Fixed Point 8.8 format Humidity Exist if humidty bit set 1. Temperature, Fixed Point 8.8 format Acc axis X pos Exist if acc bit was set 1. big-endian axis X, unit is mg Acc axis Y pos Exist if acc bit was set 1. big-endian axis Y, unit is mg Acc axis Z pos Exist if acc bit was set 1. big-endian axis Z, unit is mg cutoff flag Exist if cutoff bit was set 1. bit0: 1 device was cutoff bit1: 1 device was plug, 0 normal PIR flag Exist if PIR indication bit was set 1. 1: The human body is detected Remark:
The uint of battery is mV. For example, if the VBATT is 3270, it means the battery voltage is 3270mV;
Temperature. 2 bytes Fixed Point 8.8. The format is same as temperature in Eddystone TLM. Copyright by KKM Co.,Ltd confidential 24/
KKM Co.Ltd KBeaconPro App Instruction Humidity. 2 bytes Fixed Point 8.8. The format is same as temperature in Eddystone TLM. The Fixed Point 8.8 format:
http://people.ece.cornell.edu/land/courses/ece4760/
Example for KSensor Data. Android app: NRFConnect 2. System advertisement Data Format The advertising data packet of System is defined by KKM. Please refer to the following table for details. Offset Length 0 1 4 8 9 10 12 13 1byte 3byte 4byte 1byte 1byte 2byte 1byte 1byte Type AdvA value 0x6 AdvFlags 0x020106 ID Length 0x0303AAFE Adv type 0x16 UUID 0xAAFE Frame Type 0x22 Model ID Device model ID Copyright by KKM Co.,Ltd confidential 25/
KKM Co.Ltd 14 15 21 1byte 6byte 2byte KBeaconPro App Instruction Battery Battery Precent Mac address big-endian Software version big-endian format. For example if the value is 0x0632, then version is V6.49 Model ID define:
K1: 10 K11: 11 K12: 12 B1: 13 U1: 14 F1: 15 K18: 18 K15a: 16 K15:19 S1: 17 K21: 21 B2: 22 K21u:25 S2:26 K23: 23 K23p: 24 K3: 30 W3: 38 K4: 40 K41:41 K4u: 45 W4: 48 K4p: 47 K5: 50 K51: 51 W52: 52 K5p: 57 K5pt: 58 Copyright by KKM Co.,Ltd confidential 26/
KKM Co.Ltd KBeaconPro App Instruction K6: 60 K61: 61 K6p: 67 K6pb: 68 K6ps: 69 K7: 70 K71: 71 K7u: 75 W7: 78 K8: 80 K8u: 85 W8:86 W8u:87 K9: 90 K91: 91 K9P: 97 K9Pb: 98 P1:101 B1u:102 P2: 102 Copyright by KKM Co.,Ltd confidential 27/
FCC Caution:
This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Any changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. NOTE: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
-- Reorient or relocate the receiving antenna.
-- Increase the separation between the equipment and receiver.
-- Connect the equipment into an outlet on a circuit different from that to which the receiver is connected.
-- Consult the dealer or an experienced radio/TV technician for help. The device has been evaluated to meet general RF exposure requirement. The device can be used in portable exposure condition without restriction.