Package io.github.hapjava.characteristics

Interface EventableCharacteristic

All Superinterfaces:

Characteristic

All Known Implementing Classes:

AccessoryFlagsCharacteristic, ActiveCharacteristic, ActiveIdentifierCharacteristic, AirPlayEnableCharacteristic, AirQualityCharacteristic, BaseCharacteristic, BatteryLevelCharacteristic, BooleanCharacteristic, BrightnessCharacteristic, CarbonDioxideDetectedCharacteristic, CarbonDioxideLevelCharacteristic, CarbonDioxidePeakLevelCharacteristic, CarbonMonoxideDetectedCharacteristic, CarbonMonoxideLevelCharacteristic, CarbonMonoxidePeakLevelCharacteristic, ChargingStateCharacteristic, ClosedCaptionsCharacteristic, ColorTemperatureCharacteristic, ConfiguredNameCharacteristic, ContactSensorStateCharacteristic, CoolingThresholdTemperatureCharacteristic, CurrentAirPurifierCharacteristic, CurrentAmbientLightLevelCharacteristic, CurrentDoorStateCharacteristic, CurrentFanStateCharacteristic, CurrentHeaterCoolerStateCharacteristic, CurrentHeatingCoolingStateCharacteristic, CurrentHorizontalTiltAngleCharacteristic, CurrentHumidifierDehumidifierStateCharacteristic, CurrentMediaStateCharacteristic, CurrentPositionCharacteristic, CurrentRelativeHumidityCharacteristic, CurrentSecuritySystemStateCharacteristic, CurrentSlatStateCharacteristic, CurrentTemperatureCharacteristic, CurrentTiltAngleCharacteristic, CurrentVerticalTiltAngleCharacteristic, CurrentVisibilityStateCharacteristic, EnumCharacteristic, FilterChangeIndicationCharacteristic, FilterLifeLevelCharacteristic, FirmwareRevisionCharacteristic, FloatCharacteristic, HardwareRevisionCharacteristic, HeatingThresholdTemperatureCharacteristic, HoldPositionCharacteristic, HueCharacteristic, HumidityDehumidifierThresholdCharacteristic, HumidityHumidifierThresholdCharacteristic, IdentifierCharacteristic, IdentifyCharacteristic, InputDeviceTypeCharacteristic, InputSourceTypeCharacteristic, IntegerCharacteristic, InUseCharacteristic, IsConfiguredCharacteristic, LeakDetectedStateCharacteristic, LockCurrentStateCharacteristic, LockPhysicalControlsCharacteristic, LockTargetStateCharacteristic, ManufacturerCharacteristic, ModelCharacteristic, MotionDetectedCharacteristic, MuteCharacteristic, NameCharacteristic, NitrogenDioxideDensityCharacteristic, ObstructionDetectedCharacteristic, OccupancyDetectedCharacteristic, OnCharacteristic, OutletInUseCharacteristic, OzoneDensityCharacteristic, PictureModeCharacteristic, PM10DensityCharacteristic, PM25DensityCharacteristic, PositionStateCharacteristic, PowerModeCharacteristic, ProgrammableSwitchEventCharacteristic, ProgramModeCharacteristic, RemainingDurationCharacteristic, RemoteKeyCharacteristic, ResetFilterIndicationCharacteristic, RotationDirectionCharacteristic, RotationSpeedCharacteristic, SaturationCharacteristic, SecuritySystemAlarmTypeCharacteristic, SerialNumberCharacteristic, ServiceLabelIndexCharacteristic, ServiceLabelNamespaceCharacteristic, SetDurationCharacteristic, SlatTypeCharacteristic, SleepDiscoveryModeCharacteristic, SmokeDetectedCharacteristic, StaticStringCharacteristic, StatusActiveCharacteristic, StatusFaultCharacteristic, StatusLowBatteryCharacteristic, StatusTamperedCharacteristic, StringCharacteristic, SulphurDioxideDensityCharacteristic, SwingModeCharacteristic, TargetAirPurifierStateCharacteristic, TargetDoorStateCharacteristic, TargetFanStateCharacteristic, TargetHeaterCoolerStateCharacteristic, TargetHeatingCoolingStateCharacteristic, TargetHorizontalTiltAngleCharacteristic, TargetHumidifierDehumidifierStateCharacteristic, TargetMediaStateCharacteristic, TargetPositionCharacteristic, TargetRelativeHumidityCharacteristic, TargetSecuritySystemStateCharacteristic, TargetTemperatureCharacteristic, TargetTiltAngleCharacteristic, TargetVerticalTiltAngleCharacteristic, TargetVisibilityStateCharacteristic, TemperatureDisplayUnitCharacteristic, ValveTypeCharacteristic, VersionCharacteristic, VOCDensityCharacteristic, VolumeCharacteristic, VolumeControlTypeCharacteristic, VolumeSelectorCharacteristic, WaterLavelCharacteristic

public interface EventableCharacteristic
extends Characteristic

A characteristic that can be listened to by the connected iOS device.

Author:

Andy Lintner

Method Summary

Modifier and Type	Method	Description
void	subscribe(HomekitCharacteristicChangeCallback callback)	Begin listening to changes to this characteristic.
void	unsubscribe()	Stop listening to changes to this characteristic.

Methods inherited from interface io.github.hapjava.characteristics.Characteristic

getType, setValue, supplyValue, toJson

Method Detail

subscribe

void subscribe(HomekitCharacteristicChangeCallback callback)

Begin listening to changes to this characteristic. When a change is made, call the provided function.

Parameters:

callback - a function to call when a change is made to the characteristic value.

unsubscribe

void unsubscribe()

Stop listening to changes to this characteristic.