Show: Delphi C++
Display Preferences

System.Beacon

From RAD Studio API Documentation
Jump to: navigation, search

Provides classes to use the Beacons capabilities of the device that is running your application.

To use beacons in your application, as explained in Using Beacons, use the following classes:

Package rtl.bpl

Units

System.BeaconProvides classes to use the Beacons capabilities of the device that is running your application.
System.Beacon.Components


Classes

EBeaconAdvertiserExceptionType of exception raised for the beacon device objects TBeaconDevice and TCustomBeaconDevice.
EBeaconExceptionType of exceptions raised in relation to Beacon objects.
EBeaconManagerExceptionType of exceptions raised in relation to TBeaconManager objects.
IAltBeaconInterface that holds information in relation to the AltBeacon format type.
IBeaconInterface which holds the information regarding a detected beacon.
IEddystoneBeaconInterface that holds information in relation to the Eddystone format type.
IiBeaconInterface that holds information in relation to the iBeacon format type.
IStandardBeaconBase interface for all the possible beacon formats.
TBeaconAdvertiserThis class is in charge of advertising proximity data for TCustomBeaconDevice.
TBeaconManagerClass in charge of managing the scanning of beacons.
TBeaconManufacturerDataHelperHelper class for creating ManufacturerSpecificData as a TBytes.
TBeaconManufacturerDataParserBase class you should inherit for creating custom parsers.
TBeaconManufacturerDataParserClass
TBeaconManufacturerParsersClass for managing different parsers.

Types

TAdvertiseDeviceFormatType used in order to specify the possible beacon formats that the TBeaconDevice can advertise.
TBeaconCalcDistanceEventThe TBeaconCalcDistanceEvent is an event type that is fired just before the Distance is calculated.
TBeaconCalcModeIndicates if the IBeacon uses either Raw or Stabilized for the Rssi and Distance.
TBeaconEddystoneTLMEventThe TBeaconEddystoneTLMEvent is an event type that is fired when an EddystoneTLM beacon is detected.
TBeaconEddystoneURLEventThe TBeaconEddystoneURLEvent is an event type that is fired when a new EddystoneURL beacon is detected.
TBeaconEnterExitEventThe TBeaconEnterExitEvent is an event type for enter and exit events of beacons.
TBeaconErrorTBeaconError defines a list of error types for beacon error events.
TBeaconErrorEventThe TBeaconErrorEvent is an event type that is fired when an Beacon Error is detected.
TBeaconInfoThe TBeaconInfo record type holds the parsed information received from the beacon.
TBeaconListThe TBeaconList type is an array of IBeacon.
TBeaconProximityThe TBecaonProximity type indicates the current proximity level for a beacon.
TBeaconProximityEventThe TBeaconProximityEvent is an event type that is fired when the Proximity value changes.
TBeaconRegionEventThe TBeaconRegionEvent is an event type for enter and exit events of beacons on registered regions.
TBeaconsCalcDistancesEvent
TBeaconScanModeMode of beacon scanning, which determines the beacon formats that beacon scanning can find.
TBeaconsRegionRecord that sets and stores general beacon regions.
TBeaconsRegionEvent
TEddystoneBeaconInfoThe TEddystoneBeaconInfo record type holds the parsed information received from the Eddystone beacon.
TEddystoneTLMRecord type that stores the information associated with the EddystoneTLM beacon.
TEddystoneUIDRecord type that stores the information associated with the EddystoneUID beacon.
TEddystoneURLRecord type that stores the information associated with the EddystoneURL beacon.
TEddysUIDRegionRecord that sets and stores an EddystoneUID region.
TiBAltBeaconRegionRecord that sets and stores either an iBeacon or an AltBeacon region.
TInstanceType used to represent the Instance identifier of an EddystoneUID beacon.
TKindofBeaconType to represent the different beacon formats available.
TKindofBeaconsSet type for TKindofBeacon.
TKindofEddystoneType to represent the different Eddystone beacon formats available.
TKindofEddystonesSet type for TKindofEddystone.
TKindofScanFilterType that indicates the kind of BLE scan filter.
TManufacturerRawDataType used to represent the manufacturer data of a beacon.
TMeanCalculatorRecord that provides methods that you can use to get stabilized values for Rssi. TMeanCalculator is a template record that accepts an Integer or a Double as T.
TNamespaceType used to represent the Namespace identifier of an EddystoneUID beacon.
TNamespaceGeneratorMethodType used in order to specify the kind of generation for the Eddystone Namespace identifier.
TNewBLEScanFilterEvent
TParseManufacturerDataEventEvent type that is raised when new information data is received from a BLE device that broadcasts ManufacturerSpecificData.
TParseServiceDataEventThe TParseServiceDataEvent is an event type that is fired every time new information for a BLE device with ServiceData is detected.

Variables

BEACON_AL_TYPEData received on the Data Type field for an Alternative Beacon.
BEACON_PREFIX
BEACON_ST_TYPEData received on the Data Type field for an iBeacon.
EDDY_SIGNAL_LOSS_METERSignal loss over 1 meter.

Constants

ACCUMMULATE_DIFF_START_VALUEACCUMMULATE_DIFF_START_VALUE: Extended = 3.5;
ALTERNATIVE_DATA_LENGTHALTERNATIVE_DATA_LENGTH: Integer = $1A;
APPLEINCAPPLEINC: Integer = $4C;
BEACON_MANUFACTURER_ID_POSITIONBEACON_MANUFACTURER_ID_POSITION: Integer = 0;
BEACON_TYPE_POSBEACON_TYPE_POS: Integer = 2;
DEFAULT_TXPOWERDEFAULT_TXPOWER: Integer = $7F;
DIFFERENTIAL_FILTER_BOUNDARYDIFFERENTIAL_FILTER_BOUNDARY: Integer = 7;
DISTANCE_DECIMALSDISTANCE_DECIMALS: Integer = $FFFFFFFE;
EDDY_ENCODED_URL_LENEDDY_ENCODED_URL_LEN: Integer = $11;
EDDY_FRAMETYPE_POSEDDY_FRAMETYPE_POS: Integer = 0;
EDDY_MIN_URL_LENEDDY_MIN_URL_LEN: Integer = 3;
EDDY_RFU_DATA_LENEDDY_RFU_DATA_LEN: Integer = 2;
EDDY_RFU_DATA_POSEDDY_RFU_DATA_POS: Integer = $12;
EDDY_TLM_ADVPDUCOUNT_POSEDDY_TLM_ADVPDUCOUNT_POS: Integer = 6;
EDDY_TLM_BATTVOLTAGE_POSEDDY_TLM_BATTVOLTAGE_POS: Integer = 2;
EDDY_TLM_BEACONTEMP_POSEDDY_TLM_BEACONTEMP_POS: Integer = 4;
EDDY_TLM_LENEDDY_TLM_LEN: Integer = $E;
EDDY_TLM_TIMESINCEPOWERON_POSEDDY_TLM_TIMESINCEPOWERON_POS: Integer = $A;
EDDY_TLM_VERSION_POSEDDY_TLM_VERSION_POS: Integer = 1;
EDDY_TX_POSEDDY_TX_POS: Integer = 1;
EDDY_UID_INSTANCE_LENEDDY_UID_INSTANCE_LEN: Integer = 6;
EDDY_UID_INSTANCE_POSEDDY_UID_INSTANCE_POS: Integer = $C;
EDDY_UID_LENEDDY_UID_LEN: Integer = $14;
EDDY_UID_NAMESPACE_LENEDDY_UID_NAMESPACE_LEN: Integer = $A;
EDDY_UID_NAMESPACE_POSEDDY_UID_NAMESPACE_POS: Integer = 2;
EDDY_URL_SCHEME_POSEDDY_URL_SCHEME_POS: Integer = 2;
EDDYSTONE_TLMEDDYSTONE_TLM: Integer = $20;
EDDYSTONE_UIDEDDYSTONE_UID: Integer = 0;
EDDYSTONE_URLEDDYSTONE_URL: Integer = $10;
GUID_LENGTHGUID_LENGTH: Integer = $10;
KBEACONDEATHTIMEKBEACONDEATHTIME: Integer = $14;
MAJOR_REGION_ALLMAJOR_REGION_ALL: Integer = $FFFFFFFF;
MANUFATURER_ID_ALLMANUFATURER_ID_ALL: Integer = $FFFFFFFF;
MARK_POSITIONMARK_POSITION: Integer = 9;
MINOR_REGION_ALLMINOR_REGION_ALL: Integer = $FFFFFFFF;
PROXIMITY_FARPROXIMITY_FAR: Integer = $1E;
PROXIMITY_IMMEDIATEPROXIMITY_IMMEDIATE: Comp = 0.5;
PROXIMITY_NEARPROXIMITY_NEAR: Integer = 3;
RSSI_MEAN_ITEMSRSSI_MEAN_ITEMS: Integer = $A;
SCANNING_SLEEPINGTIMESCANNING_SLEEPINGTIME: Integer = $FA;
SCANNING_TIMESCANNING_TIME: Integer = $1F4;
SIGNAL_PROPAGATION_CONSTANTSIGNAL_PROPAGATION_CONSTANT: Comp = 0.5;
STANDARD_DATA_LENGTHSTANDARD_DATA_LENGTH: Integer = $19;
TXPOWER_IDETERMINATEDTXPOWER_IDETERMINATED: Integer = $FFFFFFC1;


Personal tools
In Other Languages
Previous Versions
Assistance