DeviceDelegate

public protocol DeviceDelegate : AnyObject

The HAP Device calls the methods of this delegate to report HAP related events. Implement this protocol in an app-specific object and use the methods to update your app. For example, you might want to show the device’s pairing state, or the value of certain characteristics.

Show on GitHub


                    
                    
                    characteristicListenerDidSubscribe(_:service:characteristic:)

Default implementation

Tells the delegate that a controller subscribed for updates.

Default Implementation

Declaration

Swift

func characteristicListenerDidSubscribe(
    _ accessory: Accessory,
    service: Service,
    characteristic: AnyCharacteristic)

Parameters

`accessory`	the accessory to which the characteristic’s service belongs
`service`	the service to which the characteristic belongs
`characteristic`	the characteristic that was subscribed to

Show on GitHub


                    
                    
                    characteristicListenerDidUnsubscribe(_:service:characteristic:)

Default implementation

Tells the delegate that a controller unsubscribed from updates.

Default Implementation

Declaration

Swift

func characteristicListenerDidUnsubscribe(
    _ accessory: Accessory,
    service: Service,
    characteristic: AnyCharacteristic)

Parameters

`accessory`	the accessory to which the characteristic’s service belongs
`service`	the service to which the characteristic belongs
`characteristic`	the characteristic that was unsubscribed from

Show on GitHub

didRequestIdentification() Default implementation
Tells the delegate that identification of the device was requested.

When the user configures a device, there might be multiple similar devices. In order to identify the individual device, HAP accommodates for an identification event. When possible, you should make the physical device emit sound and/or light for the user to be able to identify the device.

Default Implementation
Declaration
Swift

func didRequestIdentification()
Show on GitHub


                    
                    
                    didRequestIdentificationOf(_:)

Default implementation

Tells the delegate that identification of an accessory was requested.

When the user configures an accessory, there might be multiple similar accessories. In order to identify the individual accessory, HAP accommodates for an identification event. When possible, you should make the physical accessory emit sound and/or light for the user to be able to identify the accessory.

Default Implementation

Declaration

Swift

func didRequestIdentificationOf(_ accessory: Accessory)

Parameters


                                accessory

accessory to be identified

Show on GitHub

didChangePairingState(from:to:) Default implementation
Tells the delegate that the Device PairingState has changed.

Default Implementation
Declaration
Swift

func didChangePairingState(from: PairingState, to: PairingState)
Show on GitHub


                    
                    
                    characteristic(_:ofService:ofAccessory:didChangeValue:)

Default implementation

Tells the delegate that the value of a characteristic has changed.

Default Implementation

Declaration

Swift

func characteristic<T>(
    _ characteristic: GenericCharacteristic<T>,
    ofService: Service,
    ofAccessory: Accessory,
    didChangeValue: T?)

Parameters

`accessory`	the accessory to which the characteristic’s service belongs
`service`	the service to which the characteristic belongs
`characteristic`	the characteristic that was changed
`newValue`	the new value of the characteristic

Show on GitHub