Arendi.BleLibrary  4.5.1.999
Core-Library (PCL)
Arendi.BleLibrary.Local.ICentral Interface Reference

Interface of the various central implementations on the different platforms. More...

Inheritance diagram for Arendi.BleLibrary.Local.ICentral:

Public Member Functions

void StartScan ()
 Scans for advertising packets from all devices. More...
 
void StartScan (string[] uuids)
 Scans for advertising packets from devices specified by there UUID. More...
 
void StartScan (Uuid[] uuids)
 Scans for advertising packets from devices specified by there UUID. More...
 
void StopScan ()
 Stops the scan for advertising packets. More...
 
bool IsEnabled ()
 Checks if the bluetooth hardware is enabled. More...
 
IPeripheral CreatePeripheralByUuid (Uuid uuid, string name=null)
 Create a peripheral based on it's UUID only. This can be necessairy if the device is known from earlier connections. More...
 

Properties

IAdapter Adapter [get]
 Bluetooth adapter used by this central. More...
 
BluetoothState BluetoothState [get]
 The state of the bluetooth adapter. More...
 
ISecurityManager SecurityManager [get]
 Gets an instance of the security manager. More...
 
IBondManager BondManager [get]
 Gets an instance of the bond manager. More...
 
IDictionary< string, string > SystemInformation [get]
 Dictionary with information over the bluetooth system. The dictionary is always available, but the content of the dictionary depends on the adapter implementation. More...
 

Events

EventHandler< PeripheralDiscoveredEventArgsPeripheralDiscovered
 Event triggered, when an advertisement has been received. More...
 
EventHandler< BluetoothStateChangedEventArgsBluetoothStateChanged
 Event triggered, when an the bluetooth hardware changes its state. More...
 
EventHandler< EventArgs > SystemInformationUpdated
 Event triggered, when system information was updated. More...
 
EventHandler< FatalErrorEventArgsFatalError
 Event triggered, when a fatal error occurs. More...
 

Detailed Description

Interface of the various central implementations on the different platforms.

Member Function Documentation

§ CreatePeripheralByUuid()

IPeripheral Arendi.BleLibrary.Local.ICentral.CreatePeripheralByUuid ( Uuid  uuid,
string  name = null 
)

Create a peripheral based on it's UUID only. This can be necessairy if the device is known from earlier connections.

Parameters
uuidUuid of the object to be instantiated.
nameOptional name of the created peripheral.
Returns
Returns a peripheral object that represents this Uuid.

§ IsEnabled()

bool Arendi.BleLibrary.Local.ICentral.IsEnabled ( )

Checks if the bluetooth hardware is enabled.

Returns
true if enabled, otherwise false.

§ StartScan() [1/3]

void Arendi.BleLibrary.Local.ICentral.StartScan ( )

Scans for advertising packets from all devices.

§ StartScan() [2/3]

void Arendi.BleLibrary.Local.ICentral.StartScan ( string []  uuids)

Scans for advertising packets from devices specified by there UUID.

Parameters
uuidsList of UUID's to accept in service list.

§ StartScan() [3/3]

void Arendi.BleLibrary.Local.ICentral.StartScan ( Uuid []  uuids)

Scans for advertising packets from devices specified by there UUID.

Parameters
uuidsList of UUID's to accept in service list.

§ StopScan()

void Arendi.BleLibrary.Local.ICentral.StopScan ( )

Stops the scan for advertising packets.

Property Documentation

§ Adapter

IAdapter Arendi.BleLibrary.Local.ICentral.Adapter
get

Bluetooth adapter used by this central.

§ BluetoothState

BluetoothState Arendi.BleLibrary.Local.ICentral.BluetoothState
get

The state of the bluetooth adapter.

§ BondManager

IBondManager Arendi.BleLibrary.Local.ICentral.BondManager
get

Gets an instance of the bond manager.

Not all architectures allow bond handling of the application. If the platform does,'t support the bond management by the application 'null' is returned.

Returns
The bond manager instance for this central, or null if the platform doesn't support bond management by the application.

§ SecurityManager

ISecurityManager Arendi.BleLibrary.Local.ICentral.SecurityManager
get

Gets an instance of the security manager.

Not all architectures allow security handling of the application. If the platform does,'t support the security management by the application 'null' is returned.

Returns
The security manager instance for this central, or null if the platform doesn't support security management by the application.

§ SystemInformation

IDictionary<string, string> Arendi.BleLibrary.Local.ICentral.SystemInformation
get

Dictionary with information over the bluetooth system. The dictionary is always available, but the content of the dictionary depends on the adapter implementation.

Event Documentation

§ BluetoothStateChanged

EventHandler<BluetoothStateChangedEventArgs> Arendi.BleLibrary.Local.ICentral.BluetoothStateChanged

Event triggered, when an the bluetooth hardware changes its state.

§ FatalError

EventHandler<FatalErrorEventArgs> Arendi.BleLibrary.Local.ICentral.FatalError

Event triggered, when a fatal error occurs.

§ PeripheralDiscovered

EventHandler<PeripheralDiscoveredEventArgs> Arendi.BleLibrary.Local.ICentral.PeripheralDiscovered

Event triggered, when an advertisement has been received.

§ SystemInformationUpdated

EventHandler<EventArgs> Arendi.BleLibrary.Local.ICentral.SystemInformationUpdated

Event triggered, when system information was updated.