generated from StanfordBDHG/SwiftPackageTemplate
-
-
Notifications
You must be signed in to change notification settings - Fork 4
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
Showing
7 changed files
with
94 additions
and
38 deletions.
There are no files selected for viewing
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
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
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
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
44 changes: 44 additions & 0 deletions
44
Sources/SpeziBluetooth/SpeziBluetooth.docc/AccessorySetupKit-Framework.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,44 @@ | ||
# AccessorySetupKit | ||
|
||
Integration with Apple's AccessorySetupKit. | ||
|
||
<!-- | ||
# | ||
# This source file is part of the Stanford Spezi open source project | ||
# | ||
# SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
# | ||
# SPDX-License-Identifier: MIT | ||
# | ||
--> | ||
|
||
## Overview | ||
|
||
Apple's [AccessorySetupKit](https://developer.apple.com/documentation/accessorysetupkit) enables | ||
privacy-preserving discovery and configuration of accessories. | ||
SpeziBluetooth integrates with | ||
|
||
## Topics | ||
|
||
|
||
### Interact with AccessorySetupKit | ||
|
||
- ``AccessorySetupKit-swift.class`` | ||
- ``AccessorySetupKitError`` | ||
|
||
### Observe Accessory Changes | ||
- ``AccessorySetupKit-swift.class/AccessoryEvent`` | ||
- ``AccessoryEventRegistration`` | ||
|
||
### Discovery Descriptor | ||
|
||
Convert a SpeziBluetooth ``DiscoveryCriteria`` into its AccessorySetupKit `ASDiscoveryDescriptor` representation. | ||
|
||
- ``DiscoveryCriteria/discoveryDescriptor`` | ||
- ``DiscoveryCriteria/matches(descriptor:)`` | ||
|
||
### Company Identifier | ||
|
||
Convert a SpeziBluetooth ``ManufacturerIdentifier`` into its AccessorySetupKit `ASBluetoothCompanyIdentifier` representation. | ||
|
||
- ``ManufacturerIdentifier/bluetoothCompanyIdentifier`` |
45 changes: 45 additions & 0 deletions
45
Sources/SpeziBluetooth/SpeziBluetooth.docc/CoreBluetooth-Framework.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,45 @@ | ||
# CoreBluetooth | ||
|
||
<!-- | ||
# | ||
# This source file is part of the Stanford Spezi open source project | ||
# | ||
# SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
# | ||
# SPDX-License-Identifier: MIT | ||
# | ||
--> | ||
|
||
Interact with CoreBluetooth through modern programming language paradigms. | ||
|
||
## Overview | ||
|
||
[CoreBluetooth](https://developer.apple.com/documentation/corebluetooth) is Apple's framework to interact with Bluetooth and Bluetooth Low-Energy | ||
devices on Apple platforms. | ||
SpeziBluetooth provides easy-to-use mechanisms to perform operations on a Bluetooth central. | ||
|
||
## Topics | ||
|
||
### Central | ||
|
||
- ``BluetoothManager`` | ||
- ``BluetoothState`` | ||
- ``BluetoothError`` | ||
|
||
### Configuration | ||
|
||
- ``DiscoveryDescription`` | ||
- ``DeviceDescription`` | ||
- ``ServiceDescription`` | ||
- ``CharacteristicDescription`` | ||
|
||
### Peripheral | ||
|
||
- ``BluetoothPeripheral`` | ||
- ``PeripheralState`` | ||
- ``GATTService`` | ||
- ``GATTCharacteristic`` | ||
- ``AdvertisementData`` | ||
- ``ManufacturerIdentifier`` | ||
- ``WriteType`` | ||
- ``BTUUID`` |
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