Crate objc2_home_kit 

Bindings to the HomeKit framework

See Apple’s docs and the general docs on framework crates for more information.

Structs

HMAccessControlHMAccessControl

The HMAccessControl class represents a generic access control.

HMAccessoryHMAccessory

Represent an accessory in the home.

HMAccessoryBrowserHMAccessoryBrowser

This class is used to discover new accessories in the home that have never been paired with and therefore not part of the home.

HMAccessoryCategoryHMAccessoryCategory

This class is used to represent an accessory category.

HMAccessoryOwnershipTokenHMAccessorySetupPayload

Apple’s documentation

HMAccessoryProfileHMAccessoryProfile

Represents a profile implemented by an accessory.

HMAccessorySetupManagerHMAccessorySetupManager

This class can be used to launch system UI that will allow the user to go through the process of adding one or more accessories to a particular home and follow up with additional setup. These APIs do not require that the current app has home data authorization

HMAccessorySetupPayloadHMAccessorySetupPayload

Apple’s documentation

HMAccessorySetupRequestHMAccessorySetupRequest

Apple’s documentation

HMAccessorySetupResultHMAccessorySetupResult

Apple’s documentation

HMActionHMAction

This class is used to represent a generic action.

HMActionSetHMActionSet

This class represents a collection of action objects that can be executed. The order of execution of these actions is undefined.

HMAddAccessoryRequestHMAddAccessoryRequest

Apple’s documentation

HMCalendarEventHMCalendarEvent and HMEvent and HMTimeEvent

A calendar event which fires at an absolute time. It can also be used to set up a recurring events which will fire at a scheduled time.

HMCameraAudioControlHMCameraAudioControl and HMCameraControl

Apple’s documentation

HMCameraAudioStreamSettingHMCameraDefines

This enumeration describes the setting for audio on the recipient of the camera stream.

HMCameraControlHMCameraControl

Represents a generic camera control.

HMCameraProfileHMAccessoryProfile and HMCameraProfile

Represents a camera profile the accessory implements.

HMCameraSettingsControlHMCameraControl and HMCameraSettingsControl

This class can be used to control the settings on a camera.

HMCameraSnapshotHMCameraSnapshot and HMCameraSource

Represents a camera snapshot.

HMCameraSnapshotControlHMCameraControl and HMCameraSnapshotControl

This class can be used to take an image snapshot from a camera.

HMCameraSourceHMCameraSource

Abstract class for source of data from a camera.

HMCameraStreamHMCameraSource and HMCameraStream

Represents a camera stream.

HMCameraStreamControlHMCameraControl and HMCameraStreamControl

This class can be used to control the stream from a camera.

HMCameraStreamStateHMCameraDefines

This enumeration describes the different states of a camera stream.

HMCameraViewHMCameraView and objc2-ui-kit

This view can render a camera source.

HMCharacteristicHMCharacteristic

Represent a characteristic on a service of an accessory.

HMCharacteristicEventHMCharacteristicEvent and HMEvent

This class represents an event that is evaluated based on the value of a characteristic set to a particular value.

HMCharacteristicMetadataHMCharacteristicMetadata

This class defines the metadata for a characteristic. Metadata provides further information about a characteristic’s value, which can be used for presentation purposes.

HMCharacteristicThresholdRangeEventHMCharacteristicThresholdRangeEvent and HMEvent

This class represents an event when a characteristic’s value falls within the specified number range.

HMCharacteristicValueActivationStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueAirParticulateSizeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueAirQualityHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueBatteryStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCarbonDioxideDetectionStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCarbonMonoxideDetectionStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueChargingStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueClosedCaptionsHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueConfigurationStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueContactStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentAirPurifierStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentFanStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentHeaterCoolerStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentHeatingCoolingHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentHumidifierDehumidifierStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentMediaStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentSecuritySystemStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentSlatStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueCurrentVisibilityStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueDoorStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueFilterChangeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueHeatingCoolingHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueInputDeviceTypeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueInputEventHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueInputSourceTypeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueJammedStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueLabelNamespaceHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueLeakStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueLockMechanismLastKnownActionHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueLockMechanismStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueLockPhysicalControlsStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueOccupancyStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValuePictureModeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValuePositionStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValuePowerModeSelectionHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueProgramModeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueRemoteKeyHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueRotationDirectionHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueRouterStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueSecuritySystemAlarmTypeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueSlatTypeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueSmokeDetectionStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueStatusFaultHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueSwingModeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTamperedStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetAirPurifierStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetDoorStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetFanStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetHeaterCoolerStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetHumidifierDehumidifierStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetLockMechanismStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetMediaStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetSecuritySystemStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTargetVisibilityStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueTemperatureUnitHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueUsageStateHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueValveTypeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueVolumeControlTypeHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueVolumeSelectorHMCharacteristicDefines

Apple’s documentation

HMCharacteristicValueWiFiSatelliteStatusHMCharacteristicDefines

Apple’s documentation

HMCharacteristicWriteActionHMAction and HMCharacteristicWriteAction

This class is used to represent an entry in an action set that writes a specific value to a characteristic.

HMDurationEventHMDurationEvent and HMEvent and HMTimeEvent

This class is used to represent a duration of time.

HMErrorCodeHMError

This enumeration describes the possible error constants that can be returned from the the HomeKit APIs.

HMEventHMEvent

This class is used to represent a generic HomeKit event.

HMEventTriggerHMEventTrigger and HMTrigger

Triggers based on events.

HMEventTriggerActivationStateHMEventTriggerActivationState

This enumeration describes the current activation state of the event trigger.

HMHomeHMHome

Represents a home.

HMHomeAccessControlHMAccessControl and HMHomeAccessControl

Represents the access control of a user associated with a home.

HMHomeHubStateHMHome

Apple’s documentation

HMHomeManagerHMHomeManager

Manages collection of one or more homes.

HMHomeManagerAuthorizationStatusHMHomeManager

The home data authorization status of the client process.

HMLocationEventHMEvent and HMLocationEvent

This class represents an event that is evaluated based on entry to and/or exit from a Region

HMMutableCalendarEventHMCalendarEvent and HMEvent and HMTimeEvent

This class is used to represent a calendar event.

HMMutableCharacteristicEventHMCharacteristicEvent and HMEvent

This class represents an event that is evaluated based on the value of a characteristic set to a particular value.

HMMutableCharacteristicThresholdRangeEventHMCharacteristicThresholdRangeEvent and HMEvent

This class represents an event when a characteristic’s value falls within the specified number range.

HMMutableDurationEventHMDurationEvent and HMEvent and HMTimeEvent

This class is used to represent a duration of time.

HMMutableLocationEventHMEvent and HMLocationEvent

This class represents an event that is evaluated based on entry to and/or exit from a Region

HMMutablePresenceEventHMEvent and HMPresenceEvent

This class is used to represent the presence of users in a home.

HMMutableSignificantTimeEventHMEvent and HMSignificantTimeEvent and HMTimeEvent

This class is used to represent a significant time event.

HMNetworkConfigurationProfileHMAccessoryProfile and HMNetworkConfigurationProfile

Apple’s documentation

HMNumberRangeHMNumberRange

This class describes a range of numbers: [min, max]

HMPresenceEventHMEvent and HMPresenceEvent

This class is used to represent the presence of users in a home.

HMPresenceEventTypeHMPresenceEventDefines

This enumeration describes the different types of presence events.

HMPresenceEventUserTypeHMPresenceEventDefines

This enumeration describes the different types of user sets in presence events.

HMRoomHMRoom

This class describes a room in the home.

HMServiceHMService

Represents a service provided by an accessory.

HMServiceGroupHMServiceGroup

Used to describe a collection of HMService objects

HMSignificantTimeEventHMEvent and HMSignificantTimeEvent and HMTimeEvent

This class is used to represent a significant time event.

HMTimeEventHMEvent and HMTimeEvent

This class is used to represent a generic time event.

HMTimerTriggerHMTimerTrigger and HMTrigger

Timer based trigger.

HMTriggerHMTrigger

Represents a trigger event.

HMUserHMUser

This class describes a user in the home.

HMZoneHMZone

Used to describe a collection of HMRoom objects

Statics

HMAccessoryCategoryTypeAirConditioner^⚠HMAccessoryCategoryTypes

Category type for Air Conditioner.

HMAccessoryCategoryTypeAirDehumidifier^⚠HMAccessoryCategoryTypes

Category type for Air Dehumidifier.

HMAccessoryCategoryTypeAirHeater^⚠HMAccessoryCategoryTypes

Category type for Air Heater.

HMAccessoryCategoryTypeAirHumidifier^⚠HMAccessoryCategoryTypes

Category type for Air Humidifier.

HMAccessoryCategoryTypeAirPort^⚠HMAccessoryCategoryTypes

Category type for AirPort accessories.

HMAccessoryCategoryTypeAirPurifier^⚠HMAccessoryCategoryTypes

Category type for Air Purifier.

HMAccessoryCategoryTypeAudioReceiver^⚠HMAccessoryCategoryTypes

Category type for an audio receiver that supports HAP and AirPlay2.

HMAccessoryCategoryTypeBridge^⚠HMAccessoryCategoryTypes

Category type for Bridge.

HMAccessoryCategoryTypeDoor^⚠HMAccessoryCategoryTypes

Category type for Door.

HMAccessoryCategoryTypeDoorLock^⚠HMAccessoryCategoryTypes

Category type for Door Lock.

HMAccessoryCategoryTypeFan^⚠HMAccessoryCategoryTypes

Category type for Fan.

HMAccessoryCategoryTypeFaucet^⚠HMAccessoryCategoryTypes

Category type for Faucet.

HMAccessoryCategoryTypeGarageDoorOpener^⚠HMAccessoryCategoryTypes

Category type for Garage Door Opener.

HMAccessoryCategoryTypeIPCamera^⚠HMAccessoryCategoryTypes

Apple’s documentation

HMAccessoryCategoryTypeLightbulb^⚠HMAccessoryCategoryTypes

Category type for Lightbulb.

HMAccessoryCategoryTypeOther^⚠HMAccessoryCategoryTypes

Category type for Other.

HMAccessoryCategoryTypeOutlet^⚠HMAccessoryCategoryTypes

Category type for Outlet.

HMAccessoryCategoryTypeProgrammableSwitch^⚠HMAccessoryCategoryTypes

Category type for Programmable Switch.

HMAccessoryCategoryTypeRangeExtender^⚠HMAccessoryCategoryTypes

Category type for Range Extender

HMAccessoryCategoryTypeSecuritySystem^⚠HMAccessoryCategoryTypes

Category type for Security System.

HMAccessoryCategoryTypeSensor^⚠HMAccessoryCategoryTypes

Category type for Sensor.

HMAccessoryCategoryTypeShowerHead^⚠HMAccessoryCategoryTypes

Category type for Shower Head.

HMAccessoryCategoryTypeSpeaker^⚠HMAccessoryCategoryTypes

Category type for Speakers.

HMAccessoryCategoryTypeSprinkler^⚠HMAccessoryCategoryTypes

Category type for Sprinkler.

HMAccessoryCategoryTypeSwitch^⚠HMAccessoryCategoryTypes

Category type for Switch.

HMAccessoryCategoryTypeTelevision^⚠HMAccessoryCategoryTypes

Category type for Television.

HMAccessoryCategoryTypeTelevisionSetTopBox^⚠HMAccessoryCategoryTypes

Category type for Television Set Top Box.

HMAccessoryCategoryTypeTelevisionStreamingStick^⚠HMAccessoryCategoryTypes

Category type for Television Streaming Stick.

HMAccessoryCategoryTypeThermostat^⚠HMAccessoryCategoryTypes

Category type for Thermostat.

HMAccessoryCategoryTypeVideoDoorbell^⚠HMAccessoryCategoryTypes

Category type for Video Doorbell.

HMAccessoryCategoryTypeWiFiRouter^⚠HMAccessoryCategoryTypes

Category type for Wi-Fi Router.

HMAccessoryCategoryTypeWindow^⚠HMAccessoryCategoryTypes

Category type for Window.

HMAccessoryCategoryTypeWindowCovering^⚠HMAccessoryCategoryTypes

Category type for Window Covering.

HMActionSetTypeHomeArrival^⚠HMActionSet

Type for builtin action set HomeArrival.

HMActionSetTypeHomeDeparture^⚠HMActionSet

Type for builtin action set HomeDeparture.

HMActionSetTypeSleep^⚠HMActionSet

Type for builtin action set Sleep.

HMActionSetTypeTriggerOwned^⚠HMActionSet

Type for trigger-owned action sets.

HMActionSetTypeUserDefined^⚠HMActionSet

Type for user-defined action sets.

HMActionSetTypeWakeUp^⚠HMActionSet

Builtin action set type for WakeUp.

HMCharacteristicKeyPath^⚠HMEventTrigger

Specifies the key path for a characteristic in a NSPredicate

HMCharacteristicMetadataFormatArray^⚠HMCharacteristicMetadata

Describes that the value format is an array.

HMCharacteristicMetadataFormatBool^⚠HMCharacteristicMetadata

Describes that the value format is boolean.

HMCharacteristicMetadataFormatData^⚠HMCharacteristicMetadata

Describes that the value format is a data blob.

HMCharacteristicMetadataFormatDictionary^⚠HMCharacteristicMetadata

Describes that the value format is a dictionary.

HMCharacteristicMetadataFormatFloat^⚠HMCharacteristicMetadata

Describes that the value format is a float.

HMCharacteristicMetadataFormatInt^⚠HMCharacteristicMetadata

Describes that the value format is an integer.

HMCharacteristicMetadataFormatString^⚠HMCharacteristicMetadata

Describes that the value format is a string.

HMCharacteristicMetadataFormatTLV8^⚠HMCharacteristicMetadata

Describes that the value format is a TLV8.

HMCharacteristicMetadataFormatUInt8^⚠HMCharacteristicMetadata

Describes that the value format is an unsigned 8-bit integer.

HMCharacteristicMetadataFormatUInt16^⚠HMCharacteristicMetadata

Describes that the value format is an unsigned 16-bit integer.

HMCharacteristicMetadataFormatUInt32^⚠HMCharacteristicMetadata

Describes that the value format is an unsigned 32-bit integer.

HMCharacteristicMetadataFormatUInt64^⚠HMCharacteristicMetadata

Describes that the value format is an unsigned 64-bit integer.

HMCharacteristicMetadataUnitsArcDegree^⚠HMCharacteristicMetadata

Describes that the unit of the characteristic is arc degree.

HMCharacteristicMetadataUnitsCelsius^⚠HMCharacteristicMetadata

Describes that the unit of the characteristic is in Celsius.

HMCharacteristicMetadataUnitsFahrenheit^⚠HMCharacteristicMetadata

Describes that the unit of the characteristic is in Fahrenheit.

HMCharacteristicMetadataUnitsLux^⚠HMCharacteristicMetadata

Describes that the unit of the characteristic is Lux (illuminance).

HMCharacteristicMetadataUnitsMicrogramsPerCubicMeter^⚠HMCharacteristicMetadata

Describes that the unit of the characteristic is micrograms per cubic meter.

HMCharacteristicMetadataUnitsPartsPerMillion^⚠HMCharacteristicMetadata

Describes that the unit of the characteristic is parts per million.

HMCharacteristicMetadataUnitsPercentage^⚠HMCharacteristicMetadata

Describes that the unit of the characteristic is a percentage.

HMCharacteristicMetadataUnitsSeconds^⚠HMCharacteristicMetadata

Describes that the unit of the characteristic is seconds.

HMCharacteristicPropertyHidden^⚠HMCharacteristicTypes

This constant specifies that the characteristic should be hidden from the user.

HMCharacteristicPropertyReadable^⚠HMCharacteristicTypes

This constant specifies that the characteristic is readable.

HMCharacteristicPropertyRequiresAuthorizationData^⚠HMCharacteristicTypes

This constant specifies that the characteristic requires authorization data for a write.

HMCharacteristicPropertySupportsEventNotification^⚠HMCharacteristicTypes

This constant specifies that the characteristic supports notifications using the event connection established by the controller. The event connection provides unidirectional communication from the accessory to the controller.

HMCharacteristicPropertyWritable^⚠HMCharacteristicTypes

This constant specifies that the characteristic is writable.

HMCharacteristicTypeActive^⚠HMCharacteristicTypes

Characteristic type for active. The value of the characteristic is one of the values defined for HMCharacteristicValueActivationState.

HMCharacteristicTypeActiveIdentifier^⚠HMCharacteristicTypes

Characteristic type for active identifier. The value of the characteristic is a uint32.

HMCharacteristicTypeAdminOnlyAccess^⚠HMCharacteristicTypes

Characteristic type for admin only access. The value of the characteristic is a boolean.

HMCharacteristicTypeAirParticulateDensity^⚠HMCharacteristicTypes

Characteristic type for density of air-particulate matter. The value of the characteristic is in units of micrograms/m^3.

HMCharacteristicTypeAirParticulateSize^⚠HMCharacteristicTypes

Characteristic type for size of air-particulate matter. The value of the characteristic is one of the values defined for HMCharacteristicValueAirParticulateSize.

HMCharacteristicTypeAirQuality^⚠HMCharacteristicTypes

Characteristic type for air quality. The value of the characteristic is one of the values defined for HMCharacteristicValueAirQuality.

HMCharacteristicTypeAudioFeedback^⚠HMCharacteristicTypes

Characteristic type for audio feedback. The value of the characteristic is a boolean.

HMCharacteristicTypeBatteryLevel^⚠HMCharacteristicTypes

Characteristic type for battery level. The value of the characteristic is a uint8 value in percent.

HMCharacteristicTypeBrightness^⚠HMCharacteristicTypes

Characteristic type for brightness. The value of the characteristic is an int value in percent.

HMCharacteristicTypeCarbonDioxideDetected^⚠HMCharacteristicTypes

Characteristic type for carbon dioxide detected. The value of the characteristic is a uint8 value. A value of 0 indicates carbon dioxide levels are normal.

HMCharacteristicTypeCarbonDioxideLevel^⚠HMCharacteristicTypes

Characteristic type for carbon dioxide level. The value of the characteristic is a float value in units of ppm.

HMCharacteristicTypeCarbonDioxidePeakLevel^⚠HMCharacteristicTypes

Characteristic type for carbon dioxide peak level. The value of the characteristic is a float value in units of ppm.

HMCharacteristicTypeCarbonMonoxideDetected^⚠HMCharacteristicTypes

Characteristic type for carbon monoxide detected. The value of the characteristic is a uint8 value. A value of 0 indicates carbon monoxide levels are normal.

HMCharacteristicTypeCarbonMonoxideLevel^⚠HMCharacteristicTypes

Characteristic type for carbon monoxide level. The value of the characteristic is a float value in units of ppm.

HMCharacteristicTypeCarbonMonoxidePeakLevel^⚠HMCharacteristicTypes

Characteristic type for carbon monoxide peak level. The value of the characteristic is a float value in units of ppm.

HMCharacteristicTypeChargingState^⚠HMCharacteristicTypes

Characteristic type for charging state. The value of the characteristic is one of the values defined for HMCharacteristicValueChargingState.

HMCharacteristicTypeClosedCaptions^⚠HMCharacteristicTypes

Characteristic type for closed captions. The value of the characteristic is one of the values defined for HMCharacteristicValueClosedCaptions.

HMCharacteristicTypeColorTemperature^⚠HMCharacteristicTypes

Characteristic type for color temperature. The value of the characteristic is an int.

HMCharacteristicTypeConfiguredName^⚠HMCharacteristicTypes

Characteristic type for configured name. The value of the characteristic is a string.

HMCharacteristicTypeContactState^⚠HMCharacteristicTypes

Characteristic type for Contact sensor state. The value of the characteristic is a uint8 value. A value of 0 indicates that contact is detected; a value of 1 indicates no contact is detected.

HMCharacteristicTypeCoolingThreshold^⚠HMCharacteristicTypes

Characteristic type for cooling threshold. The value of the characteristic is a float value in Celsius.

HMCharacteristicTypeCurrentAirPurifierState^⚠HMCharacteristicTypes

Characteristic type for air purifier current state. The value is one of the value defined for HMCharacteristicValueCurrentAirPurifierState.

HMCharacteristicTypeCurrentDoorState^⚠HMCharacteristicTypes

Characteristic type for current door state. The value of the characteristic is one of the values defined for HMCharacteristicValueDoorState.

HMCharacteristicTypeCurrentFanState^⚠HMCharacteristicTypes

Characteristic type for current fan state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentFanState.

HMCharacteristicTypeCurrentHeaterCoolerState^⚠HMCharacteristicTypes

Characteristic type for current heater-cooler state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentHeaterCoolerState.

HMCharacteristicTypeCurrentHeatingCooling^⚠HMCharacteristicTypes

Characteristic type for current heating/cooling. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentHeatingCooling.

HMCharacteristicTypeCurrentHorizontalTilt^⚠HMCharacteristicTypes

Characteristic type for current horizontal tilt angle. The value is a float representing the angle in arc degrees.

HMCharacteristicTypeCurrentHumidifierDehumidifierState^⚠HMCharacteristicTypes

Characteristic type for current humidifier-dehumidifier state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentHumidifierDehumidifierState.

HMCharacteristicTypeCurrentLightLevel^⚠HMCharacteristicTypes

Characteristic type for current light level. The value of the characteristic is a float value in lux.

HMCharacteristicTypeCurrentLockMechanismState^⚠HMCharacteristicTypes

Characteristic type for current lock mechanism state. The value of the characteristic is one of the values defined for HMCharacteristicValueLockMechanismState.

HMCharacteristicTypeCurrentMediaState^⚠HMCharacteristicTypes

Characteristic type for current media state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentMediaState.

HMCharacteristicTypeCurrentPosition^⚠HMCharacteristicTypes

Characteristic type for current position of a door/window. The value of the characteristic is an uint8 value in percent. A value of 0 indicates closed/most shade/least light allowed state and a value of 100 indicates open/no shade/most light allowed state.

HMCharacteristicTypeCurrentRelativeHumidity^⚠HMCharacteristicTypes

Characteristic type for current relative humidity. The value of the characteristic is a float value in percent.

HMCharacteristicTypeCurrentSecuritySystemState^⚠HMCharacteristicTypes

Characteristic type for current security system state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentSecuritySystemState.

HMCharacteristicTypeCurrentSlatState^⚠HMCharacteristicTypes

Characteristic type for current slat state. The value is one of the values defined for HMCharacteristicValueCurrentSlatState.

HMCharacteristicTypeCurrentTemperature^⚠HMCharacteristicTypes

Characteristic type for current temperature. The value of the characteristic is a float value in Celsius.

HMCharacteristicTypeCurrentTilt^⚠HMCharacteristicTypes

Characteristic type for current tilt angle. The value is a float representing the angle in arc degrees.

HMCharacteristicTypeCurrentVerticalTilt^⚠HMCharacteristicTypes

Characteristic type for current vertical tilt angle. The value is a float representing the angle in arc degrees.

HMCharacteristicTypeCurrentVisibilityState^⚠HMCharacteristicTypes

Characteristic type for current visibility state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentVisibilityState.

HMCharacteristicTypeDehumidifierThreshold^⚠HMCharacteristicTypes

Characteristic type for dehumidifier threshold. The value of the characteristic is a float value in percent.

HMCharacteristicTypeDigitalZoom^⚠HMCharacteristicTypes

Characteristic type for camera digital zoom. The value is float.

HMCharacteristicTypeFilterChangeIndication^⚠HMCharacteristicTypes

Characteristic type for filter change indication. The value is one of the values defined for HMCharacteristicValueFilterChange.

HMCharacteristicTypeFilterLifeLevel^⚠HMCharacteristicTypes

Characteristic type for filter life level. The value is in percentage units.

HMCharacteristicTypeFilterResetChangeIndication^⚠HMCharacteristicTypes

Characteristic type for resetting filter change indication. The characteristic is write-only that takes a boolean value of 1.

HMCharacteristicTypeFirmwareVersion^⚠DeprecatedHMCharacteristicTypes

Characteristic type for firmware version. The value of the characteristic is a string.

HMCharacteristicTypeHardwareVersion^⚠HMCharacteristicTypes

Characteristic type for hardware version. The value of the characteristic is a string.

HMCharacteristicTypeHeatingThreshold^⚠HMCharacteristicTypes

Characteristic type for heating threshold. The value of the characteristic is a float value in Celsius.

HMCharacteristicTypeHoldPosition^⚠HMCharacteristicTypes

Characteristic type for Hold Position. The value of the characteristic is a boolean indicating that the current position should be held/maintained.

HMCharacteristicTypeHue^⚠HMCharacteristicTypes

Characteristic type for hue. The value of the characteristic is a float value in arc degrees.

HMCharacteristicTypeHumidifierThreshold^⚠HMCharacteristicTypes

Characteristic type for humidifier threshold. The value of the characteristic is a float value in percent.

HMCharacteristicTypeIdentifier^⚠HMCharacteristicTypes

Characteristic type for identifier. The value of the characteristic is a uint32.

HMCharacteristicTypeIdentify^⚠HMCharacteristicTypes

Characteristic type for identify. The value of the characteristic is a boolean.

HMCharacteristicTypeImageMirroring^⚠HMCharacteristicTypes

Characteristic type for image mirroring. The value is boolean.

HMCharacteristicTypeImageRotation^⚠HMCharacteristicTypes

Characteristic type for camera image rotation. The value is float with valid values: 0, 90, 180 and 270

HMCharacteristicTypeInUse^⚠HMCharacteristicTypes

Characteristic type for in use. The value of the characteristic is one of the values defined for HMCharacteristicValueUsageState.

HMCharacteristicTypeInputDeviceType^⚠HMCharacteristicTypes

Characteristic type for input device type. The value of the characteristic is one of the values defined for HMCharacteristicValueInputDeviceType.

HMCharacteristicTypeInputEvent^⚠HMCharacteristicTypes

Characteristic type for input event. The value of the characteristic is one of the values defined for HMCharacteristicValueInputEvent.

HMCharacteristicTypeInputSourceType^⚠HMCharacteristicTypes

Characteristic type for input source type. The value of the characteristic is one of the values defined for HMCharacteristicValueInputSourceType.

HMCharacteristicTypeIsConfigured^⚠HMCharacteristicTypes

Characteristic type for is configured. The value of the characteristic is one of the values defined for HMCharacteristicValueConfigurationState.

HMCharacteristicTypeLabelIndex^⚠HMCharacteristicTypes

Characteristic type describing the index of the label for the service on accessory with multiple instances of the same service. The value is an integer and starts from 1. For a label namespace of HMCharacteristicValueLabelNamespaceDot, label index indicates the number of dots - ., .., …, and so on. For a label namespace of HMCharacteristicValueLabelNamespaceNumeral, label index indicates the arabic numeral - 1, 2, 3, and so on.

HMCharacteristicTypeLabelNamespace^⚠HMCharacteristicTypes

Characteristic type for label namespace used to label the services on an accessory with multiple services of the same type. The value of the characteristic is one of the values defined for HMCharacteristicValueLabelNamespace.

HMCharacteristicTypeLeakDetected^⚠HMCharacteristicTypes

Characteristic type for leak detected. The value of the characteristic is a uint8 value. A value of 0 indicates no leak is detected; a value of 1 indicates that a leak is detected.

HMCharacteristicTypeLockManagementAutoSecureTimeout^⚠HMCharacteristicTypes

Characteristic type for the auto secure timeout for lock management. The value of the characteristic is an unsigned 32-bit integer representing the number of seconds.

HMCharacteristicTypeLockManagementControlPoint^⚠HMCharacteristicTypes

Characteristic type for the control point for lock management. The characteristic is write-only that takes TLV8 data wrapped in an NSData.

HMCharacteristicTypeLockMechanismLastKnownAction^⚠HMCharacteristicTypes

Characteristic type for the last known action for a lock mechanism. The value of the characteristic is one of the values defined for HMCharacteristicValueLockMechanismLastKnownAction.

HMCharacteristicTypeLockPhysicalControls^⚠HMCharacteristicTypes

Characteristic type for lock physical controls. The value of the characteristic is one of the values defined for HMCharacteristicValueLockPhysicalControlsState.

HMCharacteristicTypeLogs^⚠HMCharacteristicTypes

Characteristic type for logs. The value of the characteristic is TLV8 data wrapped in an NSData.

HMCharacteristicTypeManufacturer^⚠DeprecatedHMCharacteristicTypes

Characteristic type for manufacturer. The value of the characteristic is a string.

HMCharacteristicTypeModel^⚠DeprecatedHMCharacteristicTypes

Characteristic type for model. The value of the characteristic is a string.

HMCharacteristicTypeMotionDetected^⚠HMCharacteristicTypes

Characteristic type for motion detected. The value of the characteristic is a boolean.

HMCharacteristicTypeMute^⚠HMCharacteristicTypes

Characteristic type for mute. The value of the characteristic is a boolean.

HMCharacteristicTypeName^⚠HMCharacteristicTypes

Characteristic type for name. The value of the characteristic is a string.

HMCharacteristicTypeNightVision^⚠HMCharacteristicTypes

Characteristic type for night vision. The value of the characteristic is a boolean.

HMCharacteristicTypeNitrogenDioxideDensity^⚠HMCharacteristicTypes

Characteristic type for density of nitrogen dioxide. The value of the characteristic is in units of micrograms/m^3.

HMCharacteristicTypeObstructionDetected^⚠HMCharacteristicTypes

Characteristic type for obstruction detected. The value of the characteristic is a boolean.

HMCharacteristicTypeOccupancyDetected^⚠HMCharacteristicTypes

Characteristic type for Occupancy Detected. The value of the characteristic is a uint8 value. A value of 0 indicates no occupancy is detected; a value of 1 indicates that occupancy is detected.

HMCharacteristicTypeOpticalZoom^⚠HMCharacteristicTypes

Characteristic type for camera optical zoom. The value is float.

HMCharacteristicTypeOutletInUse^⚠HMCharacteristicTypes

Characteristic type for outlet in use. The value of the characteristic is a boolean, which is true if the outlet is in use.

HMCharacteristicTypeOutputState^⚠HMCharacteristicTypes

Characteristic type for programmable switch output state. This value is to be used for presentation purposes. For a binary programmable switch, a value of 1 can be used to present a state of ON.

HMCharacteristicTypeOzoneDensity^⚠HMCharacteristicTypes

Characteristic type for density of ozone. The value of the characteristic is in units of micrograms/m^3.

HMCharacteristicTypePM2_5Density^⚠HMCharacteristicTypes

Characteristic type for density of air-particulate matter of size 2.5 micrograms. The value of the characteristic is in units of micrograms/m^3.

HMCharacteristicTypePM10Density^⚠HMCharacteristicTypes

Characteristic type for density of air-particulate matter of size 10 micrograms. The value of the characteristic is in units of micrograms/m^3.

HMCharacteristicTypePictureMode^⚠HMCharacteristicTypes

Characteristic type for picture mode. The value of the characteristic is one of the values defined for HMCharacteristicValuePictureMode.

HMCharacteristicTypePositionState^⚠HMCharacteristicTypes

Characteristic type for Position state. The value of the characteristic is one of the one of the values defined for HMCharacteristicValuePositionState.

HMCharacteristicTypePowerModeSelection^⚠HMCharacteristicTypes

Characteristic type for power mode selection. The value of the characteristic is one of the values defined for HMCharacteristicValuePowerModeSelection.

HMCharacteristicTypePowerState^⚠HMCharacteristicTypes

Characteristic type for power state. The value of the characteristic is a boolean.

HMCharacteristicTypeProgramMode^⚠HMCharacteristicTypes

Characteristic type for program mode. The value of the characteristic is one of the values defined for HMCharacteristicValueProgramMode.

HMCharacteristicTypeRemainingDuration^⚠HMCharacteristicTypes

Characteristic type for remaining duration. The value of the characteristic is an int value in seconds.

HMCharacteristicTypeRemoteKey^⚠HMCharacteristicTypes

Characteristic type for remote key. The value of the characteristic is one of the values defined for HMCharacteristicValueRemoteKey.

HMCharacteristicTypeRotationDirection^⚠HMCharacteristicTypes

Characteristic type for rotation direction. The value of the characteristic is one of the values defined for HMCharacteristicValueRotationDirection.

HMCharacteristicTypeRotationSpeed^⚠HMCharacteristicTypes

Characteristic type for rotation speed. The value of the characteristic is a float.

HMCharacteristicTypeRouterStatus^⚠HMCharacteristicTypes

Characteristic type for router status. The value of the characteristic is one of the values defined for HMCharacteristicValueRouterStatus.

HMCharacteristicTypeSaturation^⚠HMCharacteristicTypes

Characteristic type for saturation. The value of the characteristic is a float value in percent.

HMCharacteristicTypeSecuritySystemAlarmType^⚠HMCharacteristicTypes

Characteristic type for Security System Alarm Type. The value of the characteristic is a uint8. indicating the type of alarm triggered by a security system service. This characteristic has a value of 1 when the alarm type is not known and a value of 0 indicates that the alarm conditions are cleared.

HMCharacteristicTypeSelectedStreamConfiguration^⚠HMCharacteristicTypes

Characteristic type for selected stream configuration. The value is a tlv8 data.

HMCharacteristicTypeSerialNumber^⚠DeprecatedHMCharacteristicTypes

Characteristic type for serial number. The value of the characteristic is a string.

HMCharacteristicTypeSetDuration^⚠HMCharacteristicTypes

Characteristic type for set duration. The value of the characteristic is an int value in seconds.

HMCharacteristicTypeSetupStreamEndpoint^⚠HMCharacteristicTypes

Characteristic type for setup stream endpoint. The value is a tlv8 data.

HMCharacteristicTypeSlatType^⚠HMCharacteristicTypes

Characteristic type for slat type. The value is one of the values defined for HMCharacteristicValueSlatType.

HMCharacteristicTypeSmokeDetected^⚠HMCharacteristicTypes

Characteristic type for smoke detected. The value of the characteristic is one of the values defined for HMCharacteristicValueSmokeDetectionStatus.

HMCharacteristicTypeSoftwareVersion^⚠HMCharacteristicTypes

Characteristic type for software version. The value of the characteristic is a string.

HMCharacteristicTypeStatusActive^⚠HMCharacteristicTypes

Characteristic type to indicate status of a service is active. The value of the characteristic is a boolean.

HMCharacteristicTypeStatusFault^⚠HMCharacteristicTypes

Characteristic type to indicate status of a service is fault. The value of the characteristic is a uint8 value.

HMCharacteristicTypeStatusJammed^⚠HMCharacteristicTypes

Characteristic type to indicate status of a service is jammed. The value of the characteristic is a uint8 value. A value of 0 indicates that the service is not jammed; a value of 1 indicates that the service is jammed.

HMCharacteristicTypeStatusLowBattery^⚠HMCharacteristicTypes

Characteristic type for status low battery. The value of the characteristic is one of the values defined for HMCharacteristicValueBatteryStatus.

HMCharacteristicTypeStatusTampered^⚠HMCharacteristicTypes

Characteristic type to indicate status of a service is tampered. The value of the characteristic is a uint8 value. A value of 0 indicates no tampering has been detected; a value of 1 indicates that a tampering has been detected.

HMCharacteristicTypeStreamingStatus^⚠HMCharacteristicTypes

Characteristic type for streaming status. The value is a tlv8 data.

HMCharacteristicTypeSulphurDioxideDensity^⚠HMCharacteristicTypes

Characteristic type for density of sulphur dioxide. The value of the characteristic is in units of micrograms/m^3.

HMCharacteristicTypeSupportedAudioStreamConfiguration^⚠HMCharacteristicTypes

Characteristic type for supported audio stream configuration. The value of the characteristic is TLV8 encoded data.

HMCharacteristicTypeSupportedRTPConfiguration^⚠HMCharacteristicTypes

Characteristic type for supported RTP stream configuration. The value is a tlv8 data.

HMCharacteristicTypeSupportedVideoStreamConfiguration^⚠HMCharacteristicTypes

Characteristic type for supported video stream configuration. The value is a tlv8 data.

HMCharacteristicTypeSwingMode^⚠HMCharacteristicTypes

Characteristic type for swing mode. The value of the characteristic is one of the values defined for HMCharacteristicValueSwingMode.

HMCharacteristicTypeTargetAirPurifierState^⚠HMCharacteristicTypes

Characteristic type for air purifier target state. The value is one of the value defined for HMCharacteristicValueTargetAirPurifierState.

HMCharacteristicTypeTargetDoorState^⚠HMCharacteristicTypes

Characteristic type for target door state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetDoorState.

HMCharacteristicTypeTargetFanState^⚠HMCharacteristicTypes

Characteristic type for target fan state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetFanState.

HMCharacteristicTypeTargetHeaterCoolerState^⚠HMCharacteristicTypes

Characteristic type for target heater-cooler state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetHeaterCoolerState.

HMCharacteristicTypeTargetHeatingCooling^⚠HMCharacteristicTypes

Characteristic type for target heating/cooling. The value of the characteristic is one of the values defined for HMCharacteristicValueHeatingCooling.

HMCharacteristicTypeTargetHorizontalTilt^⚠HMCharacteristicTypes

Characteristic type for target horizontal tilt angle. The value is a float representing the angle in arc degrees.

HMCharacteristicTypeTargetHumidifierDehumidifierState^⚠HMCharacteristicTypes

Characteristic type for target humidifier-dehumidifier state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetHumidifierDehumidifierState.

HMCharacteristicTypeTargetLockMechanismState^⚠HMCharacteristicTypes

Characteristic type for target lock mechanism state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetLockMechanismState.

HMCharacteristicTypeTargetMediaState^⚠HMCharacteristicTypes

Characteristic type for target media state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetMediaState.

HMCharacteristicTypeTargetPosition^⚠HMCharacteristicTypes

Characteristic type for target position of a door/window/window covering. The value of the characteristic is an uint8 value in percent. A value of 0 indicates closed/most shade/least light allowed state and a value of 100 indicates open/no shade/most light allowed state.

HMCharacteristicTypeTargetRelativeHumidity^⚠HMCharacteristicTypes

Characteristic type for target relative humidity. The value of the characteristic is a float value in percent.

HMCharacteristicTypeTargetSecuritySystemState^⚠HMCharacteristicTypes

Characteristic type for target security system state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetSecuritySystemState.

HMCharacteristicTypeTargetTemperature^⚠HMCharacteristicTypes

Characteristic type for target temperature. The value of the characteristic is a float value in Celsius.

HMCharacteristicTypeTargetTilt^⚠HMCharacteristicTypes

Characteristic type for target tilt angle. The value is a float representing the angle in arc degrees.

HMCharacteristicTypeTargetVerticalTilt^⚠HMCharacteristicTypes

Characteristic type for target vertical tilt angle. The value is a float representing the angle in arc degrees.

HMCharacteristicTypeTargetVisibilityState^⚠HMCharacteristicTypes

Characteristic type for target visibility state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetVisibilityState.

HMCharacteristicTypeTemperatureUnits^⚠HMCharacteristicTypes

Characteristic type for temperature units. The value of the characteristic is one of the values defined for HMCharacteristicValueTemperatureUnit.

HMCharacteristicTypeValveType^⚠HMCharacteristicTypes

Characteristic type for valve type. The value of the characteristic is one of the values defined for HMCharacteristicValueValveType.

HMCharacteristicTypeVersion^⚠HMCharacteristicTypes

Characteristic type for version. The value of the characteristic is a string.

HMCharacteristicTypeVolatileOrganicCompoundDensity^⚠HMCharacteristicTypes

Characteristic type for density of volatile organic compounds. The value of the characteristic is in units of micrograms/m^3.

HMCharacteristicTypeVolume^⚠HMCharacteristicTypes

Characteristic type for volume. The value of the characteristic is a uint8 value in percent.

HMCharacteristicTypeVolumeControlType^⚠HMCharacteristicTypes

Characteristic type for volume control type. The value of the characteristic is one of the values defined for HMCharacteristicValueVolumeControlType.

HMCharacteristicTypeVolumeSelector^⚠HMCharacteristicTypes

Characteristic type for volume selector. The value of the characteristic is one of the values defined for HMCharacteristicValueVolumeSelector.

HMCharacteristicTypeWANStatusList^⚠HMCharacteristicTypes

Characteristic type for wan status list. The value of the characteristic is TLV8 encoded data.

HMCharacteristicTypeWaterLevel^⚠HMCharacteristicTypes

Characteristic type for water level. The value of the characteristic is a float value in percent.

HMCharacteristicTypeWiFiSatelliteStatus^⚠HMCharacteristicTypes

Characteristic type for Wi-Fi satellite status. The value of the characteristic is one of the values defined for HMCharacteristicValueWiFiSatelliteStatus.

HMCharacteristicValueKeyPath^⚠HMEventTrigger

Specifies the key path for a characteristic value in a NSPredicate

HMErrorDomain^⚠HMError

Apple’s documentation

HMPresenceKeyPath^⚠HMEventTrigger

Specifies the key path for a presence event in a NSPredicate

HMServiceTypeAccessoryInformation^⚠HMServiceTypes

Service type for accessory information.

HMServiceTypeAirPurifier^⚠HMServiceTypes

Service type for air purifier.

HMServiceTypeAirQualitySensor^⚠HMServiceTypes

Service type for air quality sensor.

HMServiceTypeBattery^⚠HMServiceTypes

Service type for battery.

HMServiceTypeCameraControl^⚠HMServiceTypes

Service type for camera control.

HMServiceTypeCameraRTPStreamManagement^⚠HMServiceTypes

Service type for stream management.

HMServiceTypeCarbonDioxideSensor^⚠HMServiceTypes

Service type for carbon dioxide sensor.

HMServiceTypeCarbonMonoxideSensor^⚠HMServiceTypes

Service type for carbon monoxide sensor.

HMServiceTypeContactSensor^⚠HMServiceTypes

Service type for contact sensor.

HMServiceTypeDoor^⚠HMServiceTypes

Service type for door.

HMServiceTypeDoorbell^⚠HMServiceTypes

Service type for doorbell.

HMServiceTypeFan^⚠HMServiceTypes

Service type for fan.

HMServiceTypeFaucet^⚠HMServiceTypes

Service type for faucet.

HMServiceTypeFilterMaintenance^⚠HMServiceTypes

Service type for filter maintenance.

HMServiceTypeGarageDoorOpener^⚠HMServiceTypes

Service type for garage door opener.

HMServiceTypeHeaterCooler^⚠HMServiceTypes

Service type for heater/cooler.

HMServiceTypeHumidifierDehumidifier^⚠HMServiceTypes

Service type for humidifier-dehumidifier.

HMServiceTypeHumiditySensor^⚠HMServiceTypes

Service type for humidity sensor.

HMServiceTypeInputSource^⚠HMServiceTypes

Service type for input source.

HMServiceTypeIrrigationSystem^⚠HMServiceTypes

Service type for irrigation system.

HMServiceTypeLabel^⚠HMServiceTypes

Service type for label namespace when accessory supports multiple services of the same type.

HMServiceTypeLeakSensor^⚠HMServiceTypes

Service type for leak sensor.

HMServiceTypeLightSensor^⚠HMServiceTypes

Service type for light sensor.

HMServiceTypeLightbulb^⚠HMServiceTypes

Service type for lightbulb.

HMServiceTypeLockManagement^⚠HMServiceTypes

Service type for lock management.

HMServiceTypeLockMechanism^⚠HMServiceTypes

Service type for lock mechanism.

HMServiceTypeMicrophone^⚠HMServiceTypes

Service type for microphone.

HMServiceTypeMotionSensor^⚠HMServiceTypes

Service type for motion sensor.

HMServiceTypeOccupancySensor^⚠HMServiceTypes

Service type for occupancy sensor.

HMServiceTypeOutlet^⚠HMServiceTypes

Service type for outlet.

HMServiceTypeSecuritySystem^⚠HMServiceTypes

Service type for security system.

HMServiceTypeSlats^⚠HMServiceTypes

Service type for slats.

HMServiceTypeSmokeSensor^⚠HMServiceTypes

Service type for smoke sensor.

HMServiceTypeSpeaker^⚠HMServiceTypes

Service type for speaker.

HMServiceTypeStatefulProgrammableSwitch^⚠HMServiceTypes

Service type for stateful programmable switch.

HMServiceTypeStatelessProgrammableSwitch^⚠HMServiceTypes

Service type for stateless programmable switch.

HMServiceTypeSwitch^⚠HMServiceTypes

Service type for switch.

HMServiceTypeTelevision^⚠HMServiceTypes

Service type for television.

HMServiceTypeTemperatureSensor^⚠HMServiceTypes

Service type for temperature sensor.

HMServiceTypeThermostat^⚠HMServiceTypes

Service type for thermostat.

HMServiceTypeValve^⚠HMServiceTypes

Service type for valve.

HMServiceTypeVentilationFan^⚠HMServiceTypes

Service type for ventilation fan.

HMServiceTypeWiFiRouter^⚠HMServiceTypes

Service type for Wi-Fi router.

HMServiceTypeWiFiSatellite^⚠HMServiceTypes

Service type for Wi-Fi satellite.

HMServiceTypeWindow^⚠HMServiceTypes

Service type for window.

HMServiceTypeWindowCovering^⚠HMServiceTypes

Service type for window covering.

HMSignificantEventSunrise^⚠HMSignificantEvents

Event corresponding to sunrise

HMSignificantEventSunset^⚠HMSignificantEvents

Event corresponding to sunset

HMUserFailedAccessoriesKey^⚠HMHome

Key that provides more details on the accessories that failed during an addUser:completionHandler: or removeUser:completionHandler: call.

Traits

HMAccessoryBrowserDelegateHMAccessoryBrowser

This delegate receives updates about new accessories in the home.

HMAccessoryDelegateHMAccessory

This defines the protocol for a delegate to receive updates about different aspects of an accessory

HMCameraSnapshotControlDelegateHMCameraSnapshotControl

This delegate receives updates on the camera snapshot.

HMCameraStreamControlDelegateHMCameraStreamControl

This delegate receives updates on the camera stream.

HMHomeDelegateHMHome

This delegate receives update on the various accessories, action sets, groups and triggers managed in the home.

HMHomeManagerDelegateHMHomeManager

This delegate receives updates on homes being managed via the home manager.

HMNetworkConfigurationProfileDelegateHMNetworkConfigurationProfile

Apple’s documentation

Type Aliases

HMErrorBlockHMDefines and block2

A generic handler for callbacks containing a single error parameter.

HMSignificantEventHMSignificantEvents

Type corresponding to significant events.