Interface of the various central implementations on the different platforms. More...
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 necessary 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... | |
| ILog | Log [get] |
| Logger instance. More... | |
Events | |
| EventHandler< PeripheralDiscoveredEventArgs > | PeripheralDiscovered |
| Event triggered, when an advertisement has been received. More... | |
| EventHandler< BluetoothStateChangedEventArgs > | BluetoothStateChanged |
| Event triggered, when an the bluetooth hardware changes its state. More... | |
| EventHandler< EventArgs > | SystemInformationUpdated |
| Event triggered, when system information was updated. More... | |
| EventHandler< FatalErrorEventArgs > | FatalError |
| 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 necessary if the device is known from earlier connections.
- Parameters
-
uuid Uuid of the object to be instantiated. name Optional name of the created peripheral.
- Returns
- Returns a peripheral object that represents this Uuid.
Implemented in OnSemi.RSL10.Adapter.Local.Central.
◆ IsEnabled()
| bool Arendi.BleLibrary.Local.ICentral.IsEnabled | ( | ) |
Checks if the bluetooth hardware is enabled.
- Returns
trueif enabled, otherwisefalse.
Implemented in OnSemi.RSL10.Adapter.Local.Central.
◆ StartScan() [1/3]
| void Arendi.BleLibrary.Local.ICentral.StartScan | ( | ) |
Scans for advertising packets from all devices.
Implemented in OnSemi.RSL10.Adapter.Local.Central.
◆ StartScan() [2/3]
| void Arendi.BleLibrary.Local.ICentral.StartScan | ( | string [] | uuids | ) |
Scans for advertising packets from devices specified by there UUID.
- Parameters
-
uuids List of UUID's to accept in service list.
Implemented in OnSemi.RSL10.Adapter.Local.Central.
◆ StartScan() [3/3]
| void Arendi.BleLibrary.Local.ICentral.StartScan | ( | Uuid [] | uuids | ) |
Scans for advertising packets from devices specified by there UUID.
- Parameters
-
uuids List of UUID's to accept in service list.
Implemented in OnSemi.RSL10.Adapter.Local.Central.
◆ StopScan()
| void Arendi.BleLibrary.Local.ICentral.StopScan | ( | ) |
Stops the scan for advertising packets.
Implemented in OnSemi.RSL10.Adapter.Local.Central.
Property Documentation
◆ Adapter
|
get |
Bluetooth adapter used by this central.
◆ BluetoothState
|
get |
The state of the bluetooth adapter.
◆ 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.
◆ Log
|
get |
Logger instance.
◆ 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
|
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.
