The Bluetooth LE Beacon watcher. More...
#include <wclBluetooth.h>
Inheritance diagram for CwclBluetoothLeBeaconWatcher:
Public Member Functions | |
| CwclBluetoothLeBeaconWatcher () | |
| Creates new component. | |
| virtual | ~CwclBluetoothLeBeaconWatcher () |
| Frees the component. | |
| int | Start (CwclBluetoothRadio *const Radio, const wclBluetoothLeScanningMode ScanningMode=smActive, const unsigned short ScanInterval=189, const unsigned short ScanWindow=29) |
| Starts monitoring for Bluetooth LE Beacons. | |
| int | Stop () |
| Stops monitoring for Bluetooth LE Beacons. | |
| bool | GetMonitoring () const |
| Gets Beacon Monitoring state. | |
| __declspec (property(get=GetMonitoring)) bool Monitoring | |
| Gets Beacon Monitoring state. | |
| CwclBluetoothRadio * | GetRadio () const |
| Gets the watcher owner. | |
| __declspec (property(get=GetRadio)) CwclBluetoothRadio *Radio | |
| Gets the watcher owner. | |
| unsigned short | GetScanInterval () const |
| Gets the current scan interval value. | |
| __declspec (property(get=GetScanInterval)) unsigned short ScanInterval | |
| Gets the current scan interval value. | |
| wclBluetoothLeScanningMode | GetScanningMode () const |
| Gets the current scanning mode. | |
| __declspec (property(get=GetScanningMode)) wclBluetoothLeScanningMode ScanningMode | |
| Gets the current scanning mode. | |
| unsigned short | GetScanWindow () const |
| Gets the current scan window value. | |
| __declspec (property(get=GetScanWindow)) unsigned short ScanWindow | |
| Gets the current scan window value. | |
| __event void | OnAdvertisementAppearanceFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Appearance) |
| The event fires when an appearance advertisement frame received. | |
| __event void | OnAdvertisementFrameInformation (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const tstring &Name, const wclBluetoothLeAdvertisementType PacketType, const wclBluetoothLeAdvertisementFlags &Flags) |
| The event fires when new Bluetooth LE advertisement frame has been received and provides the common basic information about the frame. | |
| __event void | OnAdvertisementExtFrameInformation (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothAddressType AddressType, const char TxPower, const wclBluetoothLeExtendedFrameFlags &Flags) |
| The event fires when new Bluetooth LE advertisement extended frame has been received and provides the common basic information about the frame. | |
| __event void | OnAdvertisementRawFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned char DataType, const wclBluetoothLeAdvertisementFrameRawData &Data) |
The OnAdvertisementRawFrame event handler prototype. | |
| __event void | OnAdvertisementReceived (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothLeAdvertisementFrameRawData &Data) |
| The event fires when any Bluetooth LE advertisement frame received. | |
| __event void | OnAdvertisementService16DataFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data) |
| The event fires when a Bluetooth LE 16 bit Service Data advertisement frame received. | |
| __event void | OnAdvertisementService32DataFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data) |
| The event fires when a Bluetooth LE 32 bit Service Data advertisement frame received. | |
| __event void | OnAdvertisementService128DataFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data) |
| The event fires when a Bluetooth LE 128 bit Service Data advertisement frame received. | |
| __event void | OnAdvertisementServiceSol16Frame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Uuid) |
| The event fires when a Bluetooth LE 16 bit Service Solicitation advertisement frame received. | |
| __event void | OnAdvertisementServiceSol32Frame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long Uuid) |
| The event fires when a Bluetooth LE 32 bit Service Solicitation advertisement frame received. | |
| __event void | OnAdvertisementServiceSol128Frame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid) |
| The event fires when a Bluetooth LE 128 bit Service Solicitation advertisement frame received. | |
| __event void | OnAdvertisementTxPowerLevelFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxPower) |
| The event fires when a TX power level advertisement frame received. | |
| __event void | OnAdvertisementUuidFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid) |
| The event fires when an UUID advertisement frame has been received. | |
| __event void | OnAltBeaconFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const unsigned short Major, const unsigned short Minor, const GUID &Uuid, const char TxRssi, const unsigned char Reserved, const wclBluetoothLeAdvertisementFrameRawData &Data) |
| The event fires when a Bluetooth LE Alt beacon advertisement frame received. | |
| __event void | OnEddystoneTlmFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long AdvCnt, const unsigned short Batt, const unsigned long SecCnt, const double Temp, const wclBluetoothLeAdvertisementFrameRawData &Data) |
The OnEddystoneTlmFrame event handler prototype. | |
| __event void | OnEddystoneUidFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxRssi, const GUID &Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data) |
The OnEddystoneUidFrame event handler prototype. | |
| __event void | OnEddystoneUrlFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxRssi, const tstring &Url) |
The OnEddystoneUrlFrame event handler prototype. | |
| __event void | OnManufacturerRawFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const wclBluetoothLeAdvertisementFrameRawData &Data) |
The OnManufacturerRawFrame event handler prototype. | |
| __event void | OnProximityBeaconFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const unsigned short Major, const unsigned short Minor, const GUID &Uuid, const char TxRssi, const wclBluetoothLeAdvertisementFrameRawData &Data) |
The OnProximityBeaconFrame event handler prototype. | |
| __event void | OnStarted (void *Sender) |
| The event fires when the Bluetooth LE beacon monitoring started. | |
| __event void | OnStopped (void *Sender) |
| The event fires when the Bluetooth LE beacon monitoring stopped. | |
 Public Member Functions inherited from CwclBluetoothComponent | |
| CwclBluetoothComponent () | |
| Creates a new component. | |
| virtual | ~CwclBluetoothComponent () |
| Frees the component. | |
Protected Member Functions | |
| virtual void | DoAdvertisementAppearanceFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Appearance) |
Fires the OnAdvertisementAppearanceFrame event. | |
| virtual void | DoAdvertisementFrameInformation (const __int64 Address, const __int64 Timestamp, const char Rssi, const tstring &Name, const wclBluetoothLeAdvertisementType PacketType, const wclBluetoothLeAdvertisementFlags &Flags) |
Fires the OnAdvertisementFrameInformation event. | |
| virtual void | DoAdvertisementExtFrameInformation (const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothAddressType AddressType, const char TxPower, const wclBluetoothLeExtendedFrameFlags &Flags) |
Fires the OnAdvertisementExtFrameInformation event. | |
| virtual void | DoAdvertisementRawFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned char DataType, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnAdvertisementRawFrame event. | |
| virtual void | DoAdvertisementReceived (const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnAdvertisementReceived event. | |
| virtual void | DoAdvertisementService16DataFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnService16DataFrame event. | |
| virtual void | DoAdvertisementService32DataFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnService32DataFrame event. | |
| virtual void | DoAdvertisementService128DataFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnService128DataFrame event. | |
| virtual void | DoAdvertisementServiceSol16Frame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Uuid) |
Fires the OnServiceSol16Frame event. | |
| virtual void | DoAdvertisementServiceSol32Frame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long Uuid) |
Fires the OnServiceSol32Frame event. | |
| virtual void | DoAdvertisementServiceSol128Frame (const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid) |
Fires the OnServiceSol128Frame event. | |
| virtual void | DoAdvertisementTxPowerLevelFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxPower) |
Fires the OnAdvertisementTxPowerLevelFrame event. | |
| virtual void | DoAdvertisementUuidFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid) |
Fires the OnAdvertisementUuidFrame event. | |
| virtual void | DoAltBeaconFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const unsigned short Major, const unsigned short Minor, const GUID &Uuid, const char TxRssi, const unsigned char Reserved, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnAltBeaconFrame event. | |
| virtual void | DoEddystoneTlmFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long AdvCnt, const unsigned short Batt, const unsigned long SecCnt, const double Temp, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnEddystoneTlmFrame event. | |
| virtual void | DoEddystoneUidFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxRssi, const GUID &Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnEddystoneUidFrame event. | |
| virtual void | DoEddystoneUrlFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxRssi, const tstring &Url) |
Fires the OnEddystoneUrlFrame event. | |
| virtual void | DoManufacturerRawFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnManufacturerRawFrame event. | |
| virtual void | DoProximityBeaconFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const unsigned short Major, const unsigned short Minor, const GUID &Uuid, const char TxRssi, const wclBluetoothLeAdvertisementFrameRawData &Data) |
Fires the OnProximityBeaconFrame event. | |
| virtual void | DoStarted () |
Fires the OnStarted event. | |
| virtual void | DoStopped () |
Fires the OnStopped event. | |
| Protected Member Functions inherited from CwclBluetoothComponent | |
| void | SetCopy (CwclCustomConnection *const NewConnection) |
| The method sets new copy of the current connection. | |
| void | Enter () const |
| Enters the Bluetooth component protection critical section. | |
| void | Leave () const |
| Leaves the Bluetooth component protection critical section. | |
Detailed Description
The Bluetooth LE Beacon watcher.
The component allows to monitor Bluetooth LE Beacon advertisement packets.
- See also
- CwclBluetoothComponent
