API:System.Beacon
Contents
Units
| System.Beacon | Provides classes to use the Beacons capabilities of the device that is running your application. |
| System.Beacon.Components |
Classes
| EBeaconAdvertiserException | Type of exception raised for the beacon device objects TBeaconDevice and TCustomBeaconDevice. |
| EBeaconException | Type of exceptions raised in relation to Beacon objects. |
| EBeaconManagerException | Type of exceptions raised in relation to TBeaconManager objects. |
| IAltBeacon | Interface that holds information in relation to the AltBeacon format type. |
| IBeacon | Interface which holds the information regarding a detected beacon. |
| IEddystoneBeacon | Interface that holds information in relation to the Eddystone format type. |
| IiBeacon | Interface that holds information in relation to the iBeacon format type. |
| IStandardBeacon | Base interface for all the possible beacon formats. |
| TBeaconAdvertiser | This class is in charge of advertising proximity data for TCustomBeaconDevice. |
| TBeaconManager | Class in charge of managing the scanning of beacons. |
| TBeaconManufacturerDataHelper | Helper class for creating ManufacturerSpecificData as a TBytes. |
| TBeaconManufacturerDataParser | Base class you should inherit for creating custom parsers. |
| TBeaconManufacturerDataParserClass | |
| TBeaconManufacturerParsers | Class for managing different parsers. |
Types
| TAdvertiseDeviceFormat | Type used in order to specify the possible beacon formats that the TBeaconDevice can advertise. |
| TBeaconCalcDistanceEvent | The TBeaconCalcDistanceEvent is an event type that is fired just before the Distance is calculated. |
| TBeaconCalcMode | Indicates if the IBeacon uses either Raw or Stabilized for the Rssi and Distance. |
| TBeaconEddystoneTLMEvent | The TBeaconEddystoneTLMEvent is an event type that is fired when an EddystoneTLM beacon is detected. |
| TBeaconEddystoneURLEvent | The TBeaconEddystoneURLEvent is an event type that is fired when a new EddystoneURL beacon is detected. |
| TBeaconEnterExitEvent | The TBeaconEnterExitEvent is an event type for enter and exit events of beacons. |
| TBeaconError | TBeaconError defines a list of error types for beacon error events. |
| TBeaconErrorEvent | The TBeaconErrorEvent is an event type that is fired when an Beacon Error is detected. |
| TBeaconInfo | The TBeaconInfo record type holds the parsed information received from the beacon. |
| TBeaconList | The TBeaconList type is an array of IBeacon. |
| TBeaconProximity | The TBecaonProximity type indicates the current proximity level for a beacon. |
| TBeaconProximityEvent | The TBeaconProximityEvent is an event type that is fired when the Proximity value changes. |
| TBeaconRegionEvent | The TBeaconRegionEvent is an event type for enter and exit events of beacons on registered regions. |
| TBeaconsCalcDistancesEvent | |
| TBeaconScanMode | Mode of beacon scanning, which determines the beacon formats that beacon scanning can find. |
| TBeaconsRegion | Record that sets and stores general beacon regions. |
| TBeaconsRegionEvent | |
| TEddystoneBeaconInfo | The TEddystoneBeaconInfo record type holds the parsed information received from the Eddystone beacon. |
| TEddystoneTLM | Record type that stores the information associated with the EddystoneTLM beacon. |
| TEddystoneUID | Record type that stores the information associated with the EddystoneUID beacon. |
| TEddystoneURL | Record type that stores the information associated with the EddystoneURL beacon. |
| TEddysUIDRegion | Record that sets and stores an EddystoneUID region. |
| TiBAltBeaconRegion | Record that sets and stores either an iBeacon or an AltBeacon region. |
| TInstance | Type used to represent the Instance identifier of an EddystoneUID beacon. |
| TKindofBeacon | Type to represent the different beacon formats available. |
| TKindofBeacons | Set type for TKindofBeacon. |
| TKindofEddystone | Type to represent the different Eddystone beacon formats available. |
| TKindofEddystones | Set type for TKindofEddystone. |
| TKindofScanFilter | Type that indicates the kind of BLE scan filter. |
| TManufacturerRawData | Type used to represent the manufacturer data of a beacon. |
| TMeanCalculator | Record 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. |
| TNamespace | Type used to represent the Namespace identifier of an EddystoneUID beacon. |
| TNamespaceGeneratorMethod | Type used in order to specify the kind of generation for the Eddystone Namespace identifier. |
| TNewBLEScanFilterEvent | |
| TParseManufacturerDataEvent | Event type that is raised when new information data is received from a BLE device that broadcasts ManufacturerSpecificData. |
| TParseServiceDataEvent | The TParseServiceDataEvent is an event type that is fired every time new information for a BLE device with ServiceData is detected. |
Variables
| BEACON_AL_TYPE | Data received on the Data Type field for an Alternative Beacon. |
| BEACON_PREFIX | |
| BEACON_ST_TYPE | Data received on the Data Type field for an iBeacon. |
| EDDY_SIGNAL_LOSS_METER | Signal loss over 1 meter. |
Constants
| ACCUMMULATE_DIFF_START_VALUE | ACCUMMULATE_DIFF_START_VALUE: Extended = 3.5; |
| ALTERNATIVE_DATA_LENGTH | ALTERNATIVE_DATA_LENGTH: Integer = $1A; |
| APPLEINC | APPLEINC: Integer = $4C; |
| BEACON_MANUFACTURER_ID_POSITION | BEACON_MANUFACTURER_ID_POSITION: Integer = 0; |
| BEACON_TYPE_POS | BEACON_TYPE_POS: Integer = 2; |
| DEFAULT_TXPOWER | DEFAULT_TXPOWER: Integer = $7F; |
| DIFFERENTIAL_FILTER_BOUNDARY | DIFFERENTIAL_FILTER_BOUNDARY: Integer = 7; |
| DISTANCE_DECIMALS | DISTANCE_DECIMALS: Integer = $FFFFFFFE; |
| EDDY_ENCODED_URL_LEN | EDDY_ENCODED_URL_LEN: Integer = $11; |
| EDDY_FRAMETYPE_POS | EDDY_FRAMETYPE_POS: Integer = 0; |
| EDDY_MIN_URL_LEN | EDDY_MIN_URL_LEN: Integer = 3; |
| EDDY_RFU_DATA_LEN | EDDY_RFU_DATA_LEN: Integer = 2; |
| EDDY_RFU_DATA_POS | EDDY_RFU_DATA_POS: Integer = $12; |
| EDDY_TLM_ADVPDUCOUNT_POS | EDDY_TLM_ADVPDUCOUNT_POS: Integer = 6; |
| EDDY_TLM_BATTVOLTAGE_POS | EDDY_TLM_BATTVOLTAGE_POS: Integer = 2; |
| EDDY_TLM_BEACONTEMP_POS | EDDY_TLM_BEACONTEMP_POS: Integer = 4; |
| EDDY_TLM_LEN | EDDY_TLM_LEN: Integer = $E; |
| EDDY_TLM_TIMESINCEPOWERON_POS | EDDY_TLM_TIMESINCEPOWERON_POS: Integer = $A; |
| EDDY_TLM_VERSION_POS | EDDY_TLM_VERSION_POS: Integer = 1; |
| EDDY_TX_POS | EDDY_TX_POS: Integer = 1; |
| EDDY_UID_INSTANCE_LEN | EDDY_UID_INSTANCE_LEN: Integer = 6; |
| EDDY_UID_INSTANCE_POS | EDDY_UID_INSTANCE_POS: Integer = $C; |
| EDDY_UID_LEN | EDDY_UID_LEN: Integer = $14; |
| EDDY_UID_NAMESPACE_LEN | EDDY_UID_NAMESPACE_LEN: Integer = $A; |
| EDDY_UID_NAMESPACE_POS | EDDY_UID_NAMESPACE_POS: Integer = 2; |
| EDDY_URL_SCHEME_POS | EDDY_URL_SCHEME_POS: Integer = 2; |
| EDDYSTONE_TLM | EDDYSTONE_TLM: Integer = $20; |
| EDDYSTONE_UID | EDDYSTONE_UID: Integer = 0; |
| EDDYSTONE_URL | EDDYSTONE_URL: Integer = $10; |
| GUID_LENGTH | GUID_LENGTH: Integer = $10; |
| KBEACONDEATHTIME | KBEACONDEATHTIME: Integer = $14; |
| MAJOR_REGION_ALL | MAJOR_REGION_ALL: Integer = $FFFFFFFF; |
| MANUFATURER_ID_ALL | MANUFATURER_ID_ALL: Integer = $FFFFFFFF; |
| MARK_POSITION | MARK_POSITION: Integer = 9; |
| MINOR_REGION_ALL | MINOR_REGION_ALL: Integer = $FFFFFFFF; |
| PROXIMITY_FAR | PROXIMITY_FAR: Integer = $1E; |
| PROXIMITY_IMMEDIATE | PROXIMITY_IMMEDIATE: Comp = 0.5; |
| PROXIMITY_NEAR | PROXIMITY_NEAR: Integer = 3; |
| RSSI_MEAN_ITEMS | RSSI_MEAN_ITEMS: Integer = $A; |
| SCANNING_SLEEPINGTIME | SCANNING_SLEEPINGTIME: Integer = $FA; |
| SCANNING_TIME | SCANNING_TIME: Integer = $1F4; |
| SIGNAL_PROPAGATION_CONSTANT | SIGNAL_PROPAGATION_CONSTANT: Comp = 0.5; |
| STANDARD_DATA_LENGTH | STANDARD_DATA_LENGTH: Integer = $19; |
| TXPOWER_IDETERMINATED | TXPOWER_IDETERMINATED: Integer = $FFFFFFC1; |