Class HomeKit


  • public final class HomeKit
    extends java.lang.Object
    • Method Detail

      • HMUserFailedAccessoriesKey

        public static java.lang.String HMUserFailedAccessoriesKey()
        Key that provides more details on the accessories that failed during an addUser:completionHandler: or removeUser:completionHandler: call. The value associated with this key is an NSArray of NSDictionary objects. Each dictionary contains the UUID of the accessory that failed to the added/removed and the value corresponding to the dictionary key is an NSError that provides more details on the underlying error for that accessory.
      • HMServiceTypeLightbulb

        public static java.lang.String HMServiceTypeLightbulb()
        Service type for lightbulb.
      • HMServiceTypeSwitch

        public static java.lang.String HMServiceTypeSwitch()
        Service type for switch.
      • HMServiceTypeThermostat

        public static java.lang.String HMServiceTypeThermostat()
        Service type for thermostat.
      • HMServiceTypeGarageDoorOpener

        public static java.lang.String HMServiceTypeGarageDoorOpener()
        Service type for garage door opener.
      • HMServiceTypeAccessoryInformation

        public static java.lang.String HMServiceTypeAccessoryInformation()
        Service type for accessory information.
      • HMServiceTypeFan

        public static java.lang.String HMServiceTypeFan()
        Service type for fan.
      • HMServiceTypeOutlet

        public static java.lang.String HMServiceTypeOutlet()
        Service type for outlet.
      • HMServiceTypeLockMechanism

        public static java.lang.String HMServiceTypeLockMechanism()
        Service type for lock mechanism.
      • HMServiceTypeLockManagement

        public static java.lang.String HMServiceTypeLockManagement()
        Service type for lock management.
      • HMServiceTypeAirQualitySensor

        public static java.lang.String HMServiceTypeAirQualitySensor()
        Service type for air quality sensor.
      • HMServiceTypeBattery

        public static java.lang.String HMServiceTypeBattery()
        Service type for battery.
      • HMServiceTypeCarbonDioxideSensor

        public static java.lang.String HMServiceTypeCarbonDioxideSensor()
        Service type for carbon dioxide sensor.
      • HMServiceTypeCarbonMonoxideSensor

        public static java.lang.String HMServiceTypeCarbonMonoxideSensor()
        Service type for carbon monoxide sensor.
      • HMServiceTypeContactSensor

        public static java.lang.String HMServiceTypeContactSensor()
        Service type for contact sensor.
      • HMServiceTypeDoor

        public static java.lang.String HMServiceTypeDoor()
        Service type for door.
      • HMServiceTypeDoorbell

        public static java.lang.String HMServiceTypeDoorbell()
        Service type for doorbell.
      • HMServiceTypeHumiditySensor

        public static java.lang.String HMServiceTypeHumiditySensor()
        Service type for humidity sensor.
      • HMServiceTypeLeakSensor

        public static java.lang.String HMServiceTypeLeakSensor()
        Service type for leak sensor.
      • HMServiceTypeLightSensor

        public static java.lang.String HMServiceTypeLightSensor()
        Service type for light sensor.
      • HMServiceTypeMotionSensor

        public static java.lang.String HMServiceTypeMotionSensor()
        Service type for motion sensor.
      • HMServiceTypeOccupancySensor

        public static java.lang.String HMServiceTypeOccupancySensor()
        Service type for occupancy sensor.
      • HMServiceTypeSecuritySystem

        public static java.lang.String HMServiceTypeSecuritySystem()
        Service type for security system.
      • HMServiceTypeStatefulProgrammableSwitch

        public static java.lang.String HMServiceTypeStatefulProgrammableSwitch()
        Service type for stateful programmable switch.
      • HMServiceTypeStatelessProgrammableSwitch

        public static java.lang.String HMServiceTypeStatelessProgrammableSwitch()
        Service type for stateless programmable switch.
      • HMServiceTypeSmokeSensor

        public static java.lang.String HMServiceTypeSmokeSensor()
        Service type for smoke sensor.
      • HMServiceTypeTemperatureSensor

        public static java.lang.String HMServiceTypeTemperatureSensor()
        Service type for temperature sensor.
      • HMServiceTypeWindow

        public static java.lang.String HMServiceTypeWindow()
        Service type for window.
      • HMServiceTypeWindowCovering

        public static java.lang.String HMServiceTypeWindowCovering()
        Service type for window covering.
      • HMServiceTypeCameraRTPStreamManagement

        public static java.lang.String HMServiceTypeCameraRTPStreamManagement()
        Service type for stream management.
      • HMServiceTypeCameraControl

        public static java.lang.String HMServiceTypeCameraControl()
        Service type for camera control.
      • HMServiceTypeMicrophone

        public static java.lang.String HMServiceTypeMicrophone()
        Service type for microphone.
      • HMServiceTypeSpeaker

        public static java.lang.String HMServiceTypeSpeaker()
        Service type for speaker.
      • HMServiceTypeAirPurifier

        public static java.lang.String HMServiceTypeAirPurifier()
        Service type for air purifier.
      • HMServiceTypeVentilationFan

        public static java.lang.String HMServiceTypeVentilationFan()
        Service type for ventilation fan.
      • HMServiceTypeFilterMaintenance

        public static java.lang.String HMServiceTypeFilterMaintenance()
        Service type for filter maintenance.
      • HMServiceTypeHeaterCooler

        public static java.lang.String HMServiceTypeHeaterCooler()
        Service type for heater/cooler.
      • HMServiceTypeHumidifierDehumidifier

        public static java.lang.String HMServiceTypeHumidifierDehumidifier()
        Service type for humidifier-dehumidifier.
      • HMServiceTypeSlats

        public static java.lang.String HMServiceTypeSlats()
        Service type for slats.
      • HMCharacteristicPropertySupportsEventNotification

        public static java.lang.String HMCharacteristicPropertySupportsEventNotification()
        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.
      • HMCharacteristicPropertyReadable

        public static java.lang.String HMCharacteristicPropertyReadable()
        This constant specifies that the characteristic is readable.
      • HMCharacteristicPropertyWritable

        public static java.lang.String HMCharacteristicPropertyWritable()
        This constant specifies that the characteristic is writable.
      • HMCharacteristicPropertyHidden

        public static java.lang.String HMCharacteristicPropertyHidden()
        This constant specifies that the characteristic should be hidden from the user.
      • HMCharacteristicTypePowerState

        public static java.lang.String HMCharacteristicTypePowerState()
        Characteristic type for power state. The value of the characteristic is a boolean.
      • HMCharacteristicTypeHue

        public static java.lang.String HMCharacteristicTypeHue()
        Characteristic type for hue. The value of the characteristic is a float value in arc degrees.
      • HMCharacteristicTypeSaturation

        public static java.lang.String HMCharacteristicTypeSaturation()
        Characteristic type for saturation. The value of the characteristic is a float value in percent.
      • HMCharacteristicTypeBrightness

        public static java.lang.String HMCharacteristicTypeBrightness()
        Characteristic type for brightness. The value of the characteristic is an int value in percent.
      • HMCharacteristicTypeTemperatureUnits

        public static java.lang.String HMCharacteristicTypeTemperatureUnits()
        Characteristic type for temperature units. The value of the characteristic is one of the values defined for HMCharacteristicValueTemperatureUnit.
      • HMCharacteristicTypeCurrentTemperature

        public static java.lang.String HMCharacteristicTypeCurrentTemperature()
        Characteristic type for current temperature. The value of the characteristic is a float value in Celsius.
      • HMCharacteristicTypeTargetTemperature

        public static java.lang.String HMCharacteristicTypeTargetTemperature()
        Characteristic type for target temperature. The value of the characteristic is a float value in Celsius.
      • HMCharacteristicTypeCurrentHeatingCooling

        public static java.lang.String HMCharacteristicTypeCurrentHeatingCooling()
        Characteristic type for current heating/cooling. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentHeatingCooling.
      • HMCharacteristicTypeTargetHeatingCooling

        public static java.lang.String HMCharacteristicTypeTargetHeatingCooling()
        Characteristic type for target heating/cooling. The value of the characteristic is one of the values defined for HMCharacteristicValueHeatingCooling.
      • HMCharacteristicTypeCoolingThreshold

        public static java.lang.String HMCharacteristicTypeCoolingThreshold()
        Characteristic type for cooling threshold. The value of the characteristic is a float value in Celsius.
      • HMCharacteristicTypeHeatingThreshold

        public static java.lang.String HMCharacteristicTypeHeatingThreshold()
        Characteristic type for heating threshold. The value of the characteristic is a float value in Celsius.
      • HMCharacteristicTypeCurrentRelativeHumidity

        public static java.lang.String HMCharacteristicTypeCurrentRelativeHumidity()
        Characteristic type for current relative humidity. The value of the characteristic is a float value in percent.
      • HMCharacteristicTypeTargetRelativeHumidity

        public static java.lang.String HMCharacteristicTypeTargetRelativeHumidity()
        Characteristic type for target relative humidity. The value of the characteristic is a float value in percent.
      • HMCharacteristicTypeCurrentDoorState

        public static java.lang.String HMCharacteristicTypeCurrentDoorState()
        Characteristic type for current door state. The value of the characteristic is one of the values defined for HMCharacteristicValueDoorState.
      • HMCharacteristicTypeTargetDoorState

        public static java.lang.String HMCharacteristicTypeTargetDoorState()
        Characteristic type for target door state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetDoorState.
      • HMCharacteristicTypeObstructionDetected

        public static java.lang.String HMCharacteristicTypeObstructionDetected()
        Characteristic type for obstruction detected. The value of the characteristic is a boolean.
      • HMCharacteristicTypeName

        public static java.lang.String HMCharacteristicTypeName()
        Characteristic type for name. The value of the characteristic is a string.
      • HMCharacteristicTypeManufacturer

        public static java.lang.String HMCharacteristicTypeManufacturer()
        Characteristic type for manufacturer. The value of the characteristic is a string.
      • HMCharacteristicTypeModel

        public static java.lang.String HMCharacteristicTypeModel()
        Characteristic type for model. The value of the characteristic is a string.
      • HMCharacteristicTypeSerialNumber

        public static java.lang.String HMCharacteristicTypeSerialNumber()
        Characteristic type for serial number. The value of the characteristic is a string.
      • HMCharacteristicTypeIdentify

        public static java.lang.String HMCharacteristicTypeIdentify()
        Characteristic type for identify. The characteristic is write-only that takes a boolean.
      • HMCharacteristicTypeRotationDirection

        public static java.lang.String HMCharacteristicTypeRotationDirection()
        Characteristic type for rotation direction. The value of the characteristic is one of the values defined for HMCharacteristicValueRotationDirection.
      • HMCharacteristicTypeRotationSpeed

        public static java.lang.String HMCharacteristicTypeRotationSpeed()
        Characteristic type for rotation speed. The value of the characteristic is a float.
      • HMCharacteristicTypeOutletInUse

        public static java.lang.String HMCharacteristicTypeOutletInUse()
        Characteristic type for outlet in use. The value of the characteristic is a boolean, which is true if the outlet is in use.
      • HMCharacteristicTypeVersion

        public static java.lang.String HMCharacteristicTypeVersion()
        Characteristic type for version. The value of the characteristic is a string.
      • HMCharacteristicTypeLogs

        public static java.lang.String HMCharacteristicTypeLogs()
        Characteristic type for logs. The value of the characteristic is TLV8 data wrapped in an NSData.
      • HMCharacteristicTypeAudioFeedback

        public static java.lang.String HMCharacteristicTypeAudioFeedback()
        Characteristic type for audio feedback. The value of the characteristic is a boolean.
      • HMCharacteristicTypeAdminOnlyAccess

        public static java.lang.String HMCharacteristicTypeAdminOnlyAccess()
        Characteristic type for admin only access. The value of the characteristic is a boolean.
      • HMCharacteristicTypeSecuritySystemAlarmType

        public static java.lang.String HMCharacteristicTypeSecuritySystemAlarmType()
        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.
      • HMCharacteristicTypeMotionDetected

        public static java.lang.String HMCharacteristicTypeMotionDetected()
        Characteristic type for motion detected. The value of the characteristic is a boolean.
      • HMCharacteristicTypeCurrentLockMechanismState

        public static java.lang.String HMCharacteristicTypeCurrentLockMechanismState()
        Characteristic type for current lock mechanism state. The value of the characteristic is one of the values defined for HMCharacteristicValueLockMechanismState.
      • HMCharacteristicTypeTargetLockMechanismState

        public static java.lang.String HMCharacteristicTypeTargetLockMechanismState()
        Characteristic type for target lock mechanism state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetLockMechanismState.
      • HMCharacteristicTypeLockMechanismLastKnownAction

        public static java.lang.String HMCharacteristicTypeLockMechanismLastKnownAction()
        Characteristic type for the last known action for a lock mechanism. The value of the characteristic is one of the values defined for HMCharacteristicValueLockMechanismLastKnownAction.
      • HMCharacteristicTypeLockManagementControlPoint

        public static java.lang.String HMCharacteristicTypeLockManagementControlPoint()
        Characteristic type for the control point for lock management. The characteristic is write-only that takes TLV8 data wrapped in an NSData.
      • HMCharacteristicTypeLockManagementAutoSecureTimeout

        public static java.lang.String HMCharacteristicTypeLockManagementAutoSecureTimeout()
        * @brief 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.
      • HMCharacteristicTypeAirParticulateDensity

        public static java.lang.String HMCharacteristicTypeAirParticulateDensity()
        Characteristic type for density of air-particulate matter. The value of the characteristic is in units of micrograms/m^3.
      • HMCharacteristicTypeAirParticulateSize

        public static java.lang.String HMCharacteristicTypeAirParticulateSize()
        Characteristic type for size of air-particulate matter. The value of the characteristic is one of the values defined for HMCharacteristicValueAirParticulateSize.
      • HMCharacteristicTypeAirQuality

        public static java.lang.String HMCharacteristicTypeAirQuality()
        Characteristic type for air quality. The value of the characteristic is one of the values defined for HMCharacteristicValueAirQuality.
      • HMCharacteristicTypeBatteryLevel

        public static java.lang.String HMCharacteristicTypeBatteryLevel()
        Characteristic type for battery level. The value of the characteristic is a uint8 value in percent.
      • HMCharacteristicTypeCarbonDioxideDetected

        public static java.lang.String HMCharacteristicTypeCarbonDioxideDetected()
        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

        public static java.lang.String HMCharacteristicTypeCarbonDioxideLevel()
        Characteristic type for carbon dioxide level. The value of the characteristic is a float value in units of ppm.
      • HMCharacteristicTypeCarbonDioxidePeakLevel

        public static java.lang.String HMCharacteristicTypeCarbonDioxidePeakLevel()
        Characteristic type for carbon dioxide peak level. The value of the characteristic is a float value in units of ppm.
      • HMCharacteristicTypeCarbonMonoxideDetected

        public static java.lang.String HMCharacteristicTypeCarbonMonoxideDetected()
        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

        public static java.lang.String HMCharacteristicTypeCarbonMonoxideLevel()
        Characteristic type for carbon monoxide level. The value of the characteristic is a float value in units of ppm.
      • HMCharacteristicTypeCarbonMonoxidePeakLevel

        public static java.lang.String HMCharacteristicTypeCarbonMonoxidePeakLevel()
        Characteristic type for carbon monoxide peak level. The value of the characteristic is a float value in units of ppm.
      • HMCharacteristicTypeChargingState

        public static java.lang.String HMCharacteristicTypeChargingState()
        Characteristic type for charging state. The value of the characteristic is one of the values defined for HMCharacteristicValueChargingState.
      • HMCharacteristicTypeContactState

        public static java.lang.String HMCharacteristicTypeContactState()
        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.
      • HMCharacteristicTypeCurrentHorizontalTilt

        public static java.lang.String HMCharacteristicTypeCurrentHorizontalTilt()
        Characteristic type for current horizontal tilt angle. The value is a float representing the angle in arc degrees.
      • HMCharacteristicTypeCurrentLightLevel

        public static java.lang.String HMCharacteristicTypeCurrentLightLevel()
        Characteristic type for current light level. The value of the characteristic is a float value in lux.
      • HMCharacteristicTypeCurrentPosition

        public static java.lang.String HMCharacteristicTypeCurrentPosition()
        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.
      • HMCharacteristicTypeCurrentSecuritySystemState

        public static java.lang.String HMCharacteristicTypeCurrentSecuritySystemState()
        Characteristic type for current security system state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentSecuritySystemState.
      • HMCharacteristicTypeCurrentVerticalTilt

        public static java.lang.String HMCharacteristicTypeCurrentVerticalTilt()
        Characteristic type for current vertical tilt angle. The value is a float representing the angle in arc degrees.
      • HMCharacteristicTypeFirmwareVersion

        public static java.lang.String HMCharacteristicTypeFirmwareVersion()
        Characteristic type for firmware version. The value of the characteristic is a string value describing the firmware version of the accessory.
      • HMCharacteristicTypeHardwareVersion

        public static java.lang.String HMCharacteristicTypeHardwareVersion()
        Characteristic type for hardware version. The value of the characteristic is a string value describing the hardware version of the accessory.
      • HMCharacteristicTypeHoldPosition

        public static java.lang.String HMCharacteristicTypeHoldPosition()
        Characteristic type for Hold Position. The value of the characteristic is a boolean indicating that the current position should be held/maintained.
      • HMCharacteristicTypeInputEvent

        public static java.lang.String HMCharacteristicTypeInputEvent()
        Characteristic type for input event. The value of the characteristic is one of the values defined for HMCharacteristicValueInputEvent.
      • HMCharacteristicTypeLeakDetected

        public static java.lang.String HMCharacteristicTypeLeakDetected()
        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.
      • HMCharacteristicTypeOccupancyDetected

        public static java.lang.String HMCharacteristicTypeOccupancyDetected()
        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.
      • HMCharacteristicTypeOutputState

        public static java.lang.String HMCharacteristicTypeOutputState()
        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.
      • HMCharacteristicTypePositionState

        public static java.lang.String HMCharacteristicTypePositionState()
        Characteristic type for Position state. The value of the characteristic is one of the one of the values defined for HMCharacteristicValuePositionState.
      • HMCharacteristicTypeSmokeDetected

        public static java.lang.String HMCharacteristicTypeSmokeDetected()
        Characteristic type for smoke detected. The value of the characteristic is one of the values defined for HMCharacteristicValueSmokeDetectionStatus.
      • HMCharacteristicTypeSoftwareVersion

        public static java.lang.String HMCharacteristicTypeSoftwareVersion()
        Characteristic type for software version. The value of the characteristic is a string value describing the software version of the accessory.
      • HMCharacteristicTypeStatusActive

        public static java.lang.String HMCharacteristicTypeStatusActive()
        Characteristic type to indicate status of a service is active. The value of the characteristic is a boolean.
      • HMCharacteristicTypeStatusFault

        public static java.lang.String HMCharacteristicTypeStatusFault()
        Characteristic type to indicate status of a service is fault. The value of the characteristic is a uint8 value.
      • HMCharacteristicTypeStatusJammed

        public static java.lang.String HMCharacteristicTypeStatusJammed()
        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

        public static java.lang.String HMCharacteristicTypeStatusLowBattery()
        Characteristic type for status low battery. The value of the characteristic is one of the values defined for HMCharacteristicValueBatteryStatus.
      • HMCharacteristicTypeStatusTampered

        public static java.lang.String HMCharacteristicTypeStatusTampered()
        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.
      • HMCharacteristicTypeTargetHorizontalTilt

        public static java.lang.String HMCharacteristicTypeTargetHorizontalTilt()
        Characteristic type for target horizontal tilt angle. The value is a float representing the angle in arc degrees.
      • HMCharacteristicTypeTargetSecuritySystemState

        public static java.lang.String HMCharacteristicTypeTargetSecuritySystemState()
        Characteristic type for target security system state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetSecuritySystemState.
      • HMCharacteristicTypeTargetPosition

        public static java.lang.String HMCharacteristicTypeTargetPosition()
        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.
      • HMCharacteristicTypeTargetVerticalTilt

        public static java.lang.String HMCharacteristicTypeTargetVerticalTilt()
        Characteristic type for target vertical tilt angle. The value is a float representing the angle in arc degrees.
      • HMCharacteristicTypeStreamingStatus

        public static java.lang.String HMCharacteristicTypeStreamingStatus()
        Characteristic type for streaming status. The value is a tlv8 data.
      • HMCharacteristicTypeSetupStreamEndpoint

        public static java.lang.String HMCharacteristicTypeSetupStreamEndpoint()
        Characteristic type for setup stream endpoint. The value is a tlv8 data.
      • HMCharacteristicTypeSupportedVideoStreamConfiguration

        public static java.lang.String HMCharacteristicTypeSupportedVideoStreamConfiguration()
        Characteristic type for supported video stream configuration. The value is a tlv8 data.
      • HMCharacteristicTypeSupportedAudioStreamConfiguration

        public static java.lang.String HMCharacteristicTypeSupportedAudioStreamConfiguration()
        Characteristic type for supported audio stream configuration. The value of the characteristic is TLV8 encoded data.
      • HMCharacteristicTypeSupportedRTPConfiguration

        public static java.lang.String HMCharacteristicTypeSupportedRTPConfiguration()
        Characteristic type for supported RTP stream configuration. The value is a tlv8 data.
      • HMCharacteristicTypeSelectedStreamConfiguration

        public static java.lang.String HMCharacteristicTypeSelectedStreamConfiguration()
        Characteristic type for selected stream configuration. The value is a tlv8 data.
      • HMCharacteristicTypeVolume

        public static java.lang.String HMCharacteristicTypeVolume()
        Characteristic type for volume. The value of the characteristic is a uint8 value in percent.
      • HMCharacteristicTypeMute

        public static java.lang.String HMCharacteristicTypeMute()
        Characteristic type for mute. The value of the characteristic is a boolean.
      • HMCharacteristicTypeNightVision

        public static java.lang.String HMCharacteristicTypeNightVision()
        Characteristic type for night vision. The value of the characteristic is a boolean.
      • HMCharacteristicTypeOpticalZoom

        public static java.lang.String HMCharacteristicTypeOpticalZoom()
        Characteristic type for camera optical zoom. The value is float.
      • HMCharacteristicTypeDigitalZoom

        public static java.lang.String HMCharacteristicTypeDigitalZoom()
        Characteristic type for camera digital zoom. The value is float.
      • HMCharacteristicTypeImageRotation

        public static java.lang.String HMCharacteristicTypeImageRotation()
        Characteristic type for camera image rotation. The value is float with valid values: 0, 90, 180 and 270
      • HMCharacteristicTypeImageMirroring

        public static java.lang.String HMCharacteristicTypeImageMirroring()
        Characteristic type for image mirroring. The value is boolean.
      • HMCharacteristicTypeActive

        public static java.lang.String HMCharacteristicTypeActive()
        Characteristic type for active. The value of the characteristic is one of the values defined for HMCharacteristicValueActivationState.
      • HMCharacteristicTypeCurrentAirPurifierState

        public static java.lang.String HMCharacteristicTypeCurrentAirPurifierState()
        Characteristic type for air purifier current state. The value is one of the value defined for HMCharacteristicValueCurrentAirPurifierState.
      • HMCharacteristicTypeTargetAirPurifierState

        public static java.lang.String HMCharacteristicTypeTargetAirPurifierState()
        Characteristic type for air purifier target state. The value is one of the value defined for HMCharacteristicValueTargetAirPurifierState.
      • HMCharacteristicTypeCurrentFanState

        public static java.lang.String HMCharacteristicTypeCurrentFanState()
        Characteristic type for current fan state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentFanState.
      • HMCharacteristicTypeCurrentHeaterCoolerState

        public static java.lang.String HMCharacteristicTypeCurrentHeaterCoolerState()
        Characteristic type for current heater-cooler state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentHeaterCoolerState.
      • HMCharacteristicTypeCurrentHumidifierDehumidifierState

        public static java.lang.String HMCharacteristicTypeCurrentHumidifierDehumidifierState()
        Characteristic type for current humidifier-dehumidifier state. The value of the characteristic is one of the values defined for HMCharacteristicValueCurrentHumidifierDehumidifierState.
      • HMCharacteristicTypeCurrentSlatState

        public static java.lang.String HMCharacteristicTypeCurrentSlatState()
        Characteristic type for current slat state. The value is one of the values defined for HMCharacteristicValueCurrentSlatState.
      • HMCharacteristicTypeWaterLevel

        public static java.lang.String HMCharacteristicTypeWaterLevel()
        Characteristic type for water level. The value of the characteristic is a float value in percent.
      • HMCharacteristicTypeFilterChangeIndication

        public static java.lang.String HMCharacteristicTypeFilterChangeIndication()
        Characteristic type for filter change indication. The value is one of the values defined for HMCharacteristicValueFilterChange.
      • HMCharacteristicTypeFilterLifeLevel

        public static java.lang.String HMCharacteristicTypeFilterLifeLevel()
        Characteristic type for filter life level. The value is in percentage units.
      • HMCharacteristicTypeFilterResetChangeIndication

        public static java.lang.String HMCharacteristicTypeFilterResetChangeIndication()
        Characteristic type for resetting filter change indication. The characteristic is write-only that takes a boolean value of 1.
      • HMCharacteristicTypeLockPhysicalControls

        public static java.lang.String HMCharacteristicTypeLockPhysicalControls()
        Characteristic type for lock physical controls. The value of the characteristic is one of the values defined for HMCharacteristicValueLockPhysicalControlsState.
      • HMCharacteristicTypeSwingMode

        public static java.lang.String HMCharacteristicTypeSwingMode()
        Characteristic type for swing mode. The value of the characteristic is one of the values defined for HMCharacteristicValueSwingMode.
      • HMCharacteristicTypeTargetHeaterCoolerState

        public static java.lang.String HMCharacteristicTypeTargetHeaterCoolerState()
        Characteristic type for target heater-cooler state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetHeaterCoolerState.
      • HMCharacteristicTypeTargetHumidifierDehumidifierState

        public static java.lang.String HMCharacteristicTypeTargetHumidifierDehumidifierState()
        Characteristic type for target humidifier-dehumidifier state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetHumidifierDehumidifierState.
      • HMCharacteristicTypeTargetFanState

        public static java.lang.String HMCharacteristicTypeTargetFanState()
        Characteristic type for target fan state. The value of the characteristic is one of the values defined for HMCharacteristicValueTargetFanState.
      • HMCharacteristicTypeSlatType

        public static java.lang.String HMCharacteristicTypeSlatType()
        Characteristic type for slat type. The value is one of the values defined for HMCharacteristicValueSlatType.
      • HMCharacteristicTypeCurrentTilt

        public static java.lang.String HMCharacteristicTypeCurrentTilt()
        Characteristic type for current tilt angle. The value is a float representing the angle in arc degrees.
      • HMCharacteristicTypeTargetTilt

        public static java.lang.String HMCharacteristicTypeTargetTilt()
        Characteristic type for target tilt angle. The value is a float representing the angle in arc degrees.
      • HMCharacteristicTypeOzoneDensity

        public static java.lang.String HMCharacteristicTypeOzoneDensity()
        Characteristic type for density of ozone. The value of the characteristic is in units of micrograms/m^3.
      • HMCharacteristicTypeNitrogenDioxideDensity

        public static java.lang.String HMCharacteristicTypeNitrogenDioxideDensity()
        Characteristic type for density of nitrogen dioxide. The value of the characteristic is in units of micrograms/m^3.
      • HMCharacteristicTypeSulphurDioxideDensity

        public static java.lang.String HMCharacteristicTypeSulphurDioxideDensity()
        Characteristic type for density of sulphur dioxide. The value of the characteristic is in units of micrograms/m^3.
      • HMCharacteristicTypePM2_5Density

        public static java.lang.String HMCharacteristicTypePM2_5Density()
        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

        public static java.lang.String HMCharacteristicTypePM10Density()
        Characteristic type for density of air-particulate matter of size 10 micrograms. The value of the characteristic is in units of micrograms/m^3.
      • HMCharacteristicTypeVolatileOrganicCompoundDensity

        public static java.lang.String HMCharacteristicTypeVolatileOrganicCompoundDensity()
        Characteristic type for density of volatile organic compounds. The value of the characteristic is in units of micrograms/m^3.
      • HMCharacteristicTypeDehumidifierThreshold

        public static java.lang.String HMCharacteristicTypeDehumidifierThreshold()
        Characteristic type for dehumidifier threshold. The value of the characteristic is a float value in percent.
      • HMCharacteristicTypeHumidifierThreshold

        public static java.lang.String HMCharacteristicTypeHumidifierThreshold()
        Characteristic type for humidifier threshold. The value of the characteristic is a float value in percent.
      • HMCharacteristicMetadataFormatBool

        public static java.lang.String HMCharacteristicMetadataFormatBool()
        Describes that the value format is boolean. The value is an NSNumber containing the boolean value.
      • HMCharacteristicMetadataFormatInt

        public static java.lang.String HMCharacteristicMetadataFormatInt()
        Describes that the value format is an integer. The value is an NSNumber containing a signed 32-bit integer with a range [-2147483648, 2147483647].
      • HMCharacteristicMetadataFormatFloat

        public static java.lang.String HMCharacteristicMetadataFormatFloat()
        Describes that the value format is a float. The value is an NSNumber containing a 32-bit float.
      • HMCharacteristicMetadataFormatString

        public static java.lang.String HMCharacteristicMetadataFormatString()
        Describes that the value format is a string. The value is an NSString.
      • HMCharacteristicMetadataFormatArray

        public static java.lang.String HMCharacteristicMetadataFormatArray()
        Describes that the value format is an array. The value is an NSArray.
      • HMCharacteristicMetadataFormatDictionary

        public static java.lang.String HMCharacteristicMetadataFormatDictionary()
        Describes that the value format is a dictionary. The value is an NSDictionary.
      • HMCharacteristicMetadataFormatUInt8

        public static java.lang.String HMCharacteristicMetadataFormatUInt8()
        Describes that the value format is an unsigned 8-bit integer. The value is an NSNumber containing an unsigned 8-bit integer with a range [0, 255].
      • HMCharacteristicMetadataFormatUInt16

        public static java.lang.String HMCharacteristicMetadataFormatUInt16()
        Describes that the value format is an unsigned 16-bit integer. The value is an NSNumber containing an unsigned 16-bit integer with a range [0, 65535].
      • HMCharacteristicMetadataFormatUInt32

        public static java.lang.String HMCharacteristicMetadataFormatUInt32()
        Describes that the value format is an unsigned 32-bit integer. The value is an NSNumber containing an unsigned 32-bit integer with a range [0, 4294967295].
      • HMCharacteristicMetadataFormatUInt64

        public static java.lang.String HMCharacteristicMetadataFormatUInt64()
        Describes that the value format is an unsigned 64-bit integer. The value is an NSNumber containing an unsigned 64-bit integer with a range [0, 18446744073709551615].
      • HMCharacteristicMetadataFormatData

        public static java.lang.String HMCharacteristicMetadataFormatData()
        Describes that the value format is a data blob. The value is an NSData containing the bytes of data.
      • HMCharacteristicMetadataFormatTLV8

        public static java.lang.String HMCharacteristicMetadataFormatTLV8()
        Describes that the value format is a TLV8. The value is an NSData containing a set of one or more TLV8's, which are packed type-length-value items with an 8-bit type, 8-bit length, and N-byte value.
      • HMCharacteristicMetadataUnitsCelsius

        public static java.lang.String HMCharacteristicMetadataUnitsCelsius()
        Describes that the unit of the characteristic is in Celsius.
      • HMCharacteristicMetadataUnitsFahrenheit

        public static java.lang.String HMCharacteristicMetadataUnitsFahrenheit()
        Describes that the unit of the characteristic is in Fahrenheit.
      • HMCharacteristicMetadataUnitsPercentage

        public static java.lang.String HMCharacteristicMetadataUnitsPercentage()
        Describes that the unit of the characteristic is a percentage.
      • HMCharacteristicMetadataUnitsArcDegree

        public static java.lang.String HMCharacteristicMetadataUnitsArcDegree()
        Describes that the unit of the characteristic is arc degree.
      • HMCharacteristicMetadataUnitsSeconds

        public static java.lang.String HMCharacteristicMetadataUnitsSeconds()
        Describes that the unit of the characteristic is seconds.
      • HMCharacteristicMetadataUnitsLux

        public static java.lang.String HMCharacteristicMetadataUnitsLux()
        Describes that the unit of the characteristic is Lux (illuminance).
      • HMCharacteristicMetadataUnitsPartsPerMillion

        public static java.lang.String HMCharacteristicMetadataUnitsPartsPerMillion()
        Describes that the unit of the characteristic is parts per million.
      • HMCharacteristicMetadataUnitsMicrogramsPerCubicMeter

        public static java.lang.String HMCharacteristicMetadataUnitsMicrogramsPerCubicMeter()
        Describes that the unit of the characteristic is micrograms per cubic meter.
      • HMActionSetTypeWakeUp

        public static java.lang.String HMActionSetTypeWakeUp()
        Builtin action set type for WakeUp.
      • HMActionSetTypeSleep

        public static java.lang.String HMActionSetTypeSleep()
        Type for builtin action set Sleep.
      • HMActionSetTypeHomeDeparture

        public static java.lang.String HMActionSetTypeHomeDeparture()
        Type for builtin action set HomeDeparture.
      • HMActionSetTypeHomeArrival

        public static java.lang.String HMActionSetTypeHomeArrival()
        Type for builtin action set HomeArrival.
      • HMActionSetTypeUserDefined

        public static java.lang.String HMActionSetTypeUserDefined()
        Type for user-defined action sets.
      • HMActionSetTypeTriggerOwned

        public static java.lang.String HMActionSetTypeTriggerOwned()
        Type for trigger-owned action sets. An action set of this type is owned by a trigger and is not listed as part of the home. An action set of this type cannot be executed, renamed, or associated with a different trigger.
      • HMAccessoryCategoryTypeOther

        public static java.lang.String HMAccessoryCategoryTypeOther()
        Category type for Other.
      • HMAccessoryCategoryTypeSecuritySystem

        public static java.lang.String HMAccessoryCategoryTypeSecuritySystem()
        Category type for Security System.
      • HMAccessoryCategoryTypeBridge

        public static java.lang.String HMAccessoryCategoryTypeBridge()
        Category type for Bridge.
      • HMAccessoryCategoryTypeDoor

        public static java.lang.String HMAccessoryCategoryTypeDoor()
        Category type for Door.
      • HMAccessoryCategoryTypeDoorLock

        public static java.lang.String HMAccessoryCategoryTypeDoorLock()
        Category type for Door Lock.
      • HMAccessoryCategoryTypeFan

        public static java.lang.String HMAccessoryCategoryTypeFan()
        Category type for Fan.
      • HMAccessoryCategoryTypeGarageDoorOpener

        public static java.lang.String HMAccessoryCategoryTypeGarageDoorOpener()
        Category type for Garage Door Opener.
      • HMAccessoryCategoryTypeIPCamera

        public static java.lang.String HMAccessoryCategoryTypeIPCamera()
        Category type for IP Camera.
      • HMAccessoryCategoryTypeLightbulb

        public static java.lang.String HMAccessoryCategoryTypeLightbulb()
        Category type for Lightbulb.
      • HMAccessoryCategoryTypeOutlet

        public static java.lang.String HMAccessoryCategoryTypeOutlet()
        Category type for Outlet.
      • HMAccessoryCategoryTypeProgrammableSwitch

        public static java.lang.String HMAccessoryCategoryTypeProgrammableSwitch()
        Category type for Programmable Switch.
      • HMAccessoryCategoryTypeRangeExtender

        public static java.lang.String HMAccessoryCategoryTypeRangeExtender()
        Category type for Range Extender
      • HMAccessoryCategoryTypeSensor

        public static java.lang.String HMAccessoryCategoryTypeSensor()
        Category type for Sensor.
      • HMAccessoryCategoryTypeSwitch

        public static java.lang.String HMAccessoryCategoryTypeSwitch()
        Category type for Switch.
      • HMAccessoryCategoryTypeThermostat

        public static java.lang.String HMAccessoryCategoryTypeThermostat()
        Category type for Thermostat.
      • HMAccessoryCategoryTypeVideoDoorbell

        public static java.lang.String HMAccessoryCategoryTypeVideoDoorbell()
        Category type for Video Doorbell.
      • HMAccessoryCategoryTypeWindow

        public static java.lang.String HMAccessoryCategoryTypeWindow()
        Category type for Window.
      • HMAccessoryCategoryTypeWindowCovering

        public static java.lang.String HMAccessoryCategoryTypeWindowCovering()
        Category type for Window Covering.
      • HMAccessoryCategoryTypeAirPurifier

        public static java.lang.String HMAccessoryCategoryTypeAirPurifier()
        Category type for Air Purifier.
      • HMAccessoryCategoryTypeAirHeater

        public static java.lang.String HMAccessoryCategoryTypeAirHeater()
        Category type for Air Heater.
      • HMAccessoryCategoryTypeAirConditioner

        public static java.lang.String HMAccessoryCategoryTypeAirConditioner()
        Category type for Air Conditioner.
      • HMAccessoryCategoryTypeAirHumidifier

        public static java.lang.String HMAccessoryCategoryTypeAirHumidifier()
        Category type for Air Humidifier.
      • HMAccessoryCategoryTypeAirDehumidifier

        public static java.lang.String HMAccessoryCategoryTypeAirDehumidifier()
        Category type for Air Dehumidifier.
      • HMCharacteristicKeyPath

        public static java.lang.String HMCharacteristicKeyPath()
        Specifies the key path for a characteristic in a NSPredicate
      • HMCharacteristicValueKeyPath

        public static java.lang.String HMCharacteristicValueKeyPath()
        Specifies the key path for a characteristic value in a NSPredicate
      • HMErrorDomain

        public static java.lang.String HMErrorDomain()
      • HMSignificantEventSunrise

        public static java.lang.String HMSignificantEventSunrise()
        Event corresponding to sunrise
      • HMSignificantEventSunset

        public static java.lang.String HMSignificantEventSunset()
        Event corresponding to sunset
      • HMServiceTypeLabel

        public static java.lang.String HMServiceTypeLabel()
        Service type for label namespace when accessory supports multiple services of the same type.
      • HMCharacteristicTypeLabelNamespace

        public static java.lang.String HMCharacteristicTypeLabelNamespace()
        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.
      • HMCharacteristicTypeLabelIndex

        public static java.lang.String HMCharacteristicTypeLabelIndex()
        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.
      • HMCharacteristicTypeColorTemperature

        public static java.lang.String HMCharacteristicTypeColorTemperature()
        Characteristic type for color temperature. The value of the characteristic is an int.
      • HMPresenceKeyPath

        public static java.lang.String HMPresenceKeyPath()
        Specifies the key path for a presence event in a NSPredicate
      • HMServiceTypeIrrigationSystem

        public static java.lang.String HMServiceTypeIrrigationSystem()
        Service type for irrigation system.
      • HMServiceTypeValve

        public static java.lang.String HMServiceTypeValve()
        Service type for valve.
      • HMServiceTypeFaucet

        public static java.lang.String HMServiceTypeFaucet()
        Service type for faucet.
      • HMCharacteristicTypeProgramMode

        public static java.lang.String HMCharacteristicTypeProgramMode()
        Characteristic type for program mode. The value of the characteristic is one of the values defined for HMCharacteristicValueProgramMode.
      • HMCharacteristicTypeInUse

        public static java.lang.String HMCharacteristicTypeInUse()
        Characteristic type for in use. The value of the characteristic is one of the values defined for HMCharacteristicValueUsageState.
      • HMCharacteristicTypeSetDuration

        public static java.lang.String HMCharacteristicTypeSetDuration()
        Characteristic type for set duration. The value of the characteristic is an int value in seconds.
      • HMCharacteristicTypeRemainingDuration

        public static java.lang.String HMCharacteristicTypeRemainingDuration()
        Characteristic type for remaining duration. The value of the characteristic is an int value in seconds.
      • HMCharacteristicTypeValveType

        public static java.lang.String HMCharacteristicTypeValveType()
        Characteristic type for valve type. The value of the characteristic is one of the values defined for HMCharacteristicValueValveType.
      • HMCharacteristicTypeIsConfigured

        public static java.lang.String HMCharacteristicTypeIsConfigured()
        Characteristic type for is configured. The value of the characteristic is one of the values defined for HMCharacteristicValueConfigurationState.
      • HMAccessoryCategoryTypeSprinkler

        public static java.lang.String HMAccessoryCategoryTypeSprinkler()
        Category type for Sprinkler.
      • HMAccessoryCategoryTypeFaucet

        public static java.lang.String HMAccessoryCategoryTypeFaucet()
        Category type for Faucet.
      • HMAccessoryCategoryTypeShowerHead

        public static java.lang.String HMAccessoryCategoryTypeShowerHead()
        Category type for Shower Head.