-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cc6c85b
commit b31eadb
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
66 changes: 66 additions & 0 deletions
66
Sources/BluetoothLinux/BluetoothLinux.docc/Documentation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# ``BluetoothLinux`` | ||
|
||
Pure Swift Bluetooth Stack for Linux. | ||
|
||
## Overview | ||
|
||
Provides a variety of APIs for interacting with different Sockets and IOCTL that Linux provides for Bluetooth. | ||
|
||
This library does not require the official [BlueZ](https://www.bluez.org) userland library, instead it communicates directly with the Linux kernel Bluetooth subsystem. | ||
|
||
## Topics | ||
|
||
### Bluetooth Linux subsystem | ||
|
||
- ``BluetoothSocketProtocol`` | ||
- ``BluetoothSocketAddress`` | ||
- ``BluetoothSocketOption`` | ||
- ``AddressType`` | ||
- ``LinkMode`` | ||
|
||
### Host Controller Interface | ||
|
||
- ``HostController`` | ||
- ``HostControllerIO`` | ||
- ``HCISocketAddress`` | ||
- ``HCISocketOption`` | ||
- ``HCIBusType`` | ||
- ``HCIControllerType`` | ||
- ``HCIChannel`` | ||
- ``HCIDeviceOptions`` | ||
- ``HCIDeviceEvent`` | ||
- ``HCIDeviceFlag`` | ||
- ``HCIPacketType`` | ||
|
||
### L2CAP | ||
|
||
- ``L2CAPSocket`` | ||
- ``L2CAPSocketAddress`` | ||
- ``L2CAPSocketOption`` | ||
|
||
### RFCOMM | ||
|
||
- ``RFCOMMIO`` | ||
- ``RFCOMMSocket`` | ||
- ``RFCOMMSocketAddress`` | ||
- ``RFCOMMSocketOption`` | ||
- ``RFCOMMDevice`` | ||
- ``RFCOMMState`` | ||
- ``RFCOMMFlag`` | ||
- ``RFCOMMLinkMode`` | ||
|
||
### SCO | ||
|
||
- ``SCOSocket`` | ||
|
||
### HIDP | ||
|
||
- ``HIDPIO`` | ||
|
||
### CMTP | ||
|
||
- ``CMTPIO`` | ||
|
||
### BNEP | ||
|
||
- ``BNEPIO`` |