Skip to content

Commit

Permalink
Update docs catalog
Browse files Browse the repository at this point in the history
  • Loading branch information
Supereg committed Nov 7, 2024
1 parent cb7d1bc commit 0b2225b
Show file tree
Hide file tree
Showing 7 changed files with 94 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ import Spezi
/// ### Discovered Accessories
/// - ``accessories``
///
/// ### Observe Accessory Changes
/// - ``AccessoryEvent``
/// - ``AccessoryChangeHandler``
///
/// ### Displaying an accessory picker
/// - ``showPicker(for:)``
/// - ``pickerPresented``
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ import OSLog
/// - ``state``
/// - ``isScanning``
/// - ``stateSubscription``
/// - ``StateRegistration``
///
/// ### Discovering nearby Peripherals
/// - ``nearbyPeripherals``
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,6 @@ import SpeziFoundation
/// - ``accessory(manufacturer:manufacturerData:nameSubstring:advertising:)-5xdh2``
/// - ``accessory(manufacturer:manufacturerData:nameSubstring:advertising:)-1j9zn``
/// - ``accessory(manufacturer:manufacturerData:nameSubstring:advertising:_:)``
///
/// ### AccessorySetupKit
/// - ``discoveryDescriptor``
/// - ``matches(descriptor:)``
public struct DiscoveryCriteria {
let aspects: [DescriptorAspect]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@ import NIOCore
/// Bluetooth SIG-assigned Manufacturer Identifier.
///
/// Refer to Assigned Numbers 7. Company Identifiers.
///
/// ## Topics
///
/// ### AccessorySetupKit
/// - ``bluetoothCompanyIdentifier``
public struct ManufacturerIdentifier {
/// The raw manufacturer identifier.
public let rawValue: UInt16
Expand Down
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``
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``
29 changes: 4 additions & 25 deletions Sources/SpeziBluetooth/SpeziBluetooth.docc/SpeziBluetooth.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,32 +289,11 @@ due to their async nature.
- ``DeviceState``
- ``DeviceAction``

### AccessorySetupKit Integration

- ``AccessorySetupKit-swift.class``
- ``AccessorySetupKitError``

### Concurrency

- ``SpeziBluetooth/SpeziBluetooth``

### Core Bluetooth

- ``BluetoothManager``
- ``BluetoothPeripheral``
- ``GATTService``
- ``GATTCharacteristic``
- ``BluetoothState``
- ``PeripheralState``
- ``BluetoothError``
- ``AdvertisementData``
- ``ManufacturerIdentifier``
- ``WriteType``
- ``BTUUID``

### Configuring Core Bluetooth

- ``DiscoveryDescription``
- ``DeviceDescription``
- ``ServiceDescription``
- ``CharacteristicDescription``
### Frameworks

- <doc:CoreBluetooth-Framework>
- <doc:AccessorySetupKit-Framework>

0 comments on commit 0b2225b

Please sign in to comment.