Contents
Display Legacy Contents

 Print
    Beacon Scanner Initialize  
Beacons are a class of BLE devices. Kalipso Supports Eddystone and iBeacon. Nomenclature from Eddystone to iBeacon may vary. Please read notes.
This action initializes the beacon scanner engine.

Parameters

Monitor
 

Monitor Events Mode <numeric>
1-Top Form
2-First Form
3-Topest Form With Event
4-Top or First
5-All 
(See Post App Notification for details on the different options)

 

Region Exit Period <numeric>
   Time period after which if a becon from this region is not seen it will be considered to have left the region

 

Target Monitor Region Code <Variable or Control>

 Target to set the region code that was entered or left
   
Ranging
 

Ranging Events Mode <numeric>
1-Top Form
2-First Form
3-Topest Form With Event
4-Top or First
5-All 
(See Post App Notification for details on the different options)

 

Ranging Distance Sample Period <numeric>

 See notes for details on this parameter
   

Target Region Code <Variable or Control>

  Target to set the region code that the beacon belongs to
   

Target Beacon ID 1 <Variable or Control>

 For Eddystone it is the beacon NameSpace, for iBeacon it is the beacon UUID
   

Target Beacon ID 2 <Variable or Control>

 For Eddystone it is the beacon Instance, for iBeacon it is the beacon Major
   

Target Beacon ID 3 <Variable or Control>

 For Eddystone it will not be used, for iBeacon it is the beacon Minor
   

Target Beacon Address <Variable or Control>

 On iOS it is an internally generated ID by the O.S., it is not possible to retrieve the Bluetooth MAC address of the beacons in iOS
   On Android and Windows it is the Bluetooth MAC address of the beacon
   
  Target Beacon Filtered RSSI <Variable or Control>
    See notes for details on this parameter
   

Target Beacon RSSI <Variable or Control>

 The received signal strength of the beacon.
   

Target Beacon Transmit RSSI <Variable or Control>

 The signal strength of transmission by the beacon
   

Target Beacon Filtered Distance <Variable or Control>

 See notes for details on this parameter
   

Target Beacon Distance <Variable or Control>

 The estimated distance in meters to the beacon. The error rate is very high for this distance, and it is higher, the higher the distance.
 It will be influenced by many factors like being in direct line of sight or having obstacles.
 The main use case for this value is to determine if you are in imediate proximity to the beacon, somewhere near the beacon or far away from the beacon.
   

Target Beacon URL <Variable or Control>

 For Eddystone beacons only that transmit the URL frame, it will contain the advertised URL.
   

Target Beacon TLM Data <Variable or Control>

 For Eddystone beacons only that transmit the Telemetry frame, it will contain the advertised Telemetry.
   Telemetry values are returned separated by ;
 Currently for Version 0 it is: telemetryVersion;batteryMilliVolts;temperatureCelsius;pduCount;uptime
 See: https://github.com/google/eddystone/blob/master/eddystone-tlm/tlm-plain.md
 In case another version is reported the Base64 content will be returned
   

     
  • iBeacons on iOS have the following specifics, because Apple does not allow direct interaction with iBeacons, they can only be used through their exposed APIs.
    • It does not return FilteredRSSI so it is the same as RSSI
    • It does not report distance, so Distance is 0.3 for Immediate, 2 for Near, 10 for Far, and FilteredDistance returns the accuracy parameter from iOS SDK that can be used as an approximation of filtered distance
    • It does not report transmit RSSI
    • It does not return any address, so the address parameter will be empty
  • Filtered RSSI and Filtered Distance use a Running Average filter over the duration specified at Ranging Distance Sample Period. This will make something similar to an average of the values received in that period of time, the objective is that if for a short amount of time, there was an obstacle between the device and the beacon, like a person walking that temporarily got in between, the Distance and RSSI measurements do not get immediately affected.
  • For more information about beacon monitoring and ranging see Beacon Start Monitoring and Beacon Start Ranging actions.

See also
Synchronize
Update Project
Translate Internal Text
Set Comm. Profile Parameter
Get Comm. Profile Parameter
Set Synchro.Parameter
Get Synchro.Parameter
Set Synchronization File Copy
Bluetooth Start Device Discovery
Bluetooth Stop Device Discovery
Bluetooth Is Device Paired
Bluetooth Pair Device
Bluetooth Unpair Device
Bluetooth Connect Headset
Bluetooth Disconnect Headset
Bluetooth LE Start Scanning
Bluetooth LE Stop Scanning
Bluetooth LE Connect to Device
Bluetooth LE Disconnect from Device
Bluetooth LE Service Get List
Bluetooth LE Characteristic Get List
Bluetooth LE Characteristic Write
Bluetooth LE Characteristic Read
Bluetooth LE Descriptor Get List
Bluetooth LE Descriptor Write
Bluetooth LE Descriptor Read
Beacon Scanner Uninitialize
Beacon Scanner Start Monitoring
Beacon Scanner Stop Monitoring
Beacon Scanner Start Ranging
Beacon Scanner Stop Ranging
Activate Connection
Is Connection Active
Deactivate Connection
Serial Open
Serial Write
Serial Read
Serial Flush
Serial Close
Socket Connect
Socket Write
Socket Read
Socket Close
Socket Accept
Ping
Activate Monitor
Deactivate Monitor
Web Service Run
XML Get Child Element
XML Get Child Element List
XML Get Element Attribute
XML Get Element Content
XML Get Element’s Attribute List
XML Get Elements Name
XML Get Root Element
XML Get Root Element List
HTTP Request
XML Export from Table
XML Import to Table
JSON Get Value
JSON Get Array Item
JSON Get Array Item Count
JSON Get Name List
JSON Import to Table
JSON Export from Table
FTP Connect
FTP Set Current Dir
FTP Get File
FTP Put File
FTP File Exists
FTP Disconnect
FTP Create Dir
FTP Delete File/Folder
FTP Rename File
FTP List Files
Run Process on PC
Send File to PC
Get File from PC
List Files from PC
Kill Process on PC
Is Process Running on PC
Activate MIS Remote Controller
Stop MIS Remote Controller
Ping MIS Communicator
Get MIS Communicator Server Info
Shell Execute On Pc
Validade Active Directory Credentials On PC
Hardlock List Keys
Hardlock Read
Hardlock Write
Hardlock Check license
Push Notification Get Client ID
Push Notification Get Message
Push Notification Get Lost Message ID List
Push Notification Get Lost Message
Push Notification Delete Lost Message
Make Phone Call
SMS Send Message
Get SMS Verification Code
Get Cell Tower Info
Samples

 
 
Updated: 10/11/2019 3:47 PM