Uses of Interface
io.github.hapjava.characteristics.Characteristic

Packages that use Characteristic

Package	Description
io.github.hapjava.characteristics	Contains the basic characteristic types that can be supplied over the HomeKit Accessory Protocol.
io.github.hapjava.characteristics.impl.accessoryinformation
io.github.hapjava.characteristics.impl.airpurifier
io.github.hapjava.characteristics.impl.airquality
io.github.hapjava.characteristics.impl.audio
io.github.hapjava.characteristics.impl.base
io.github.hapjava.characteristics.impl.battery
io.github.hapjava.characteristics.impl.carbondioxidesensor
io.github.hapjava.characteristics.impl.carbonmonoxidesensor
io.github.hapjava.characteristics.impl.common
io.github.hapjava.characteristics.impl.contactsensor
io.github.hapjava.characteristics.impl.fan
io.github.hapjava.characteristics.impl.filtermaintenance
io.github.hapjava.characteristics.impl.garagedoor
io.github.hapjava.characteristics.impl.heatercooler
io.github.hapjava.characteristics.impl.humidifier
io.github.hapjava.characteristics.impl.humiditysensor
io.github.hapjava.characteristics.impl.inputsource
io.github.hapjava.characteristics.impl.leaksensor
io.github.hapjava.characteristics.impl.lightbulb
io.github.hapjava.characteristics.impl.lightsensor
io.github.hapjava.characteristics.impl.lock
io.github.hapjava.characteristics.impl.motionsensor
io.github.hapjava.characteristics.impl.occupancysensor
io.github.hapjava.characteristics.impl.outlet
io.github.hapjava.characteristics.impl.securitysystem
io.github.hapjava.characteristics.impl.slat
io.github.hapjava.characteristics.impl.smokesensor
io.github.hapjava.characteristics.impl.television
io.github.hapjava.characteristics.impl.televisionspeaker
io.github.hapjava.characteristics.impl.thermostat
io.github.hapjava.characteristics.impl.valve
io.github.hapjava.characteristics.impl.windowcovering
io.github.hapjava.services

Uses of Characteristic in io.github.hapjava.characteristics

Subinterfaces of Characteristic in io.github.hapjava.characteristics

Modifier and Type	Interface	Description
interface	EventableCharacteristic	A characteristic that can be listened to by the connected iOS device.

Uses of Characteristic in io.github.hapjava.characteristics.impl.accessoryinformation

Classes in io.github.hapjava.characteristics.impl.accessoryinformation that implement Characteristic

Modifier and Type	Class	Description
class	AccessoryFlagsCharacteristic	This characteristic indicates whether accessory requires additional setup.
class	FirmwareRevisionCharacteristic	This characteristic describes a firmware revision string
class	HardwareRevisionCharacteristic	This characteristic describes a hardware revision in a form x[.y[.z]] (e.g.
class	IdentifyCharacteristic	This characteristic enables accessory to run its identify routine.
class	ManufacturerCharacteristic	This characteristic contains the name of the company whose brand will appear on the accessory
class	ModelCharacteristic	This characteristic contains the manufacturer-specific model of the accessory
class	SerialNumberCharacteristic	This characteristic contains the manufacturer-specific serial number of the accessory.

Uses of Characteristic in io.github.hapjava.characteristics.impl.airpurifier

Classes in io.github.hapjava.characteristics.impl.airpurifier that implement Characteristic

Modifier and Type	Class	Description
class	CurrentAirPurifierCharacteristic	This characteristic describes the current state of the air purifier.
class	TargetAirPurifierStateCharacteristic	This characteristic describes the target state of the air purifier.

Uses of Characteristic in io.github.hapjava.characteristics.impl.airquality

Classes in io.github.hapjava.characteristics.impl.airquality that implement Characteristic

Modifier and Type	Class	Description
class	AirQualityCharacteristic	This characteristic describes the air quality.
class	NitrogenDioxideDensityCharacteristic	This characteristic contains the current NO2 density in micrograms/m3.
class	OzoneDensityCharacteristic	This characteristic contains the current ozone density in micrograms/m3.
class	PM10DensityCharacteristic	This characteristic contains the current PM10 micrometer particulate density in micrograms/m3.
class	PM25DensityCharacteristic	This characteristic contains the current PM2.5 micrometer particulate density in micrograms/m3.
class	SulphurDioxideDensityCharacteristic	This characteristic contains the current SO2 density in micrograms/m3.
class	VOCDensityCharacteristic	This characteristic indicates the current volatile organic compound (VOC) density in micrograms/m3.

Uses of Characteristic in io.github.hapjava.characteristics.impl.audio

Classes in io.github.hapjava.characteristics.impl.audio that implement Characteristic

Modifier and Type	Class	Description
class	MuteCharacteristic	Mute characteristic to control audio input or output accessory.
class	VolumeCharacteristic	Volume characteristic to control audio volume.

Uses of Characteristic in io.github.hapjava.characteristics.impl.base

Classes in io.github.hapjava.characteristics.impl.base that implement Characteristic

Modifier and Type	Class	Description
class	BaseCharacteristic<T>	Base class for implementing Characteristic.
class	BooleanCharacteristic	Characteristic that exposes a Boolean value.
class	EnumCharacteristic<T extends CharacteristicEnum>	Characteristic that exposes an Enum value.
class	FloatCharacteristic	A characteristic that provides a Float value type.
class	IntegerCharacteristic	A characteristic that provides an Integer data type.
class	StaticStringCharacteristic	A characteristic that provides an immutable String value.
class	StringCharacteristic	A characteristic that provides an string value.

Uses of Characteristic in io.github.hapjava.characteristics.impl.battery

Classes in io.github.hapjava.characteristics.impl.battery that implement Characteristic

Modifier and Type	Class	Description
class	BatteryLevelCharacteristic	This characteristic describes the current level of the battery.
class	ChargingStateCharacteristic	This characteristic describes the charging state of a battery or an accessory.
class	StatusLowBatteryCharacteristic	This characteristic describes an accessory battery status.

Uses of Characteristic in io.github.hapjava.characteristics.impl.carbondioxidesensor

Classes in io.github.hapjava.characteristics.impl.carbondioxidesensor that implement Characteristic

Modifier and Type	Class	Description
class	CarbonDioxideDetectedCharacteristic	This characteristic indicates the levels of Carbon Dioxide.
class	CarbonDioxideLevelCharacteristic	This characteristic indicates the detected level of Carbon Dioxide in parts per million (ppm).
class	CarbonDioxidePeakLevelCharacteristic	This characteristic indicates the highest detected level (ppm) of carbon dioxide.

Uses of Characteristic in io.github.hapjava.characteristics.impl.carbonmonoxidesensor

Classes in io.github.hapjava.characteristics.impl.carbonmonoxidesensor that implement Characteristic

Modifier and Type	Class	Description
class	CarbonMonoxideDetectedCharacteristic	This characteristic indicates the levels of Carbon Monoxide.
class	CarbonMonoxideLevelCharacteristic	This characteristic contains the Carbon Monoxide levels in parts per million (ppm).
class	CarbonMonoxidePeakLevelCharacteristic	This characteristic indicates the highest detected level (ppm) of Carbon Monoxide.

Uses of Characteristic in io.github.hapjava.characteristics.impl.common

Classes in io.github.hapjava.characteristics.impl.common that implement Characteristic

Modifier and Type	Class	Description
class	ActiveCharacteristic	Active characteristic indicates whether the service is currently active.
class	ActiveIdentifierCharacteristic
class	AirPlayEnableCharacteristic	characteristic to control air play.
class	ConfiguredNameCharacteristic	This characteristic describes a configured name.
class	IdentifierCharacteristic
class	InUseCharacteristic	This characteristic indicates whether the service is in use.
class	IsConfiguredCharacteristic	This characteristic describes whether the service is configured for use.
class	NameCharacteristic	This characteristic describes a name and must not be a null value.
class	ObstructionDetectedCharacteristic	This characteristic describes the current state of an obstruction sensor.
class	OnCharacteristic	This characteristic represents the states for “on” and “off”.
class	ProgrammableSwitchEventCharacteristic	This characteristic describes an event generated by a programmable switch.
class	ProgramModeCharacteristic	This characteristic describes if there are programs scheduled on the accessory.
class	ServiceLabelIndexCharacteristic	This characteristic is used to identify the index of the label according to ServiceLabelNamespaceCharacteristic
class	ServiceLabelNamespaceCharacteristic	This characteristic describes the naming schema for an accessory.
class	StatusActiveCharacteristic	This characteristic describes current working (active and functional) status of accessory.
class	StatusFaultCharacteristic	This characteristic describes fault status.
class	StatusTamperedCharacteristic	This characteristic describes tampered status.
class	VersionCharacteristic	This characteristic describes HAP version.
class	WaterLavelCharacteristic	This characteristic describes the water level.

Uses of Characteristic in io.github.hapjava.characteristics.impl.contactsensor

Classes in io.github.hapjava.characteristics.impl.contactsensor that implement Characteristic

Modifier and Type	Class	Description
class	ContactSensorStateCharacteristic	This characteristic describes the state of a door/window contact sensor.

Uses of Characteristic in io.github.hapjava.characteristics.impl.fan

Classes in io.github.hapjava.characteristics.impl.fan that implement Characteristic

Modifier and Type	Class	Description
class	CurrentFanStateCharacteristic	This characteristic describes the current state of the fan.
class	LockPhysicalControlsCharacteristic	This characteristic describes physical controls on an accessory (eg.
class	RotationDirectionCharacteristic	This characteristic describes the direction of rotation of a fan.
class	RotationSpeedCharacteristic	This characteristic describes the rotation speed of a fan.
class	SwingModeCharacteristic	This characteristic describes if swing mode is enabled.
class	TargetFanStateCharacteristic	This characteristic describes the target state of the fan.

Uses of Characteristic in io.github.hapjava.characteristics.impl.filtermaintenance

Classes in io.github.hapjava.characteristics.impl.filtermaintenance that implement Characteristic

Modifier and Type	Class	Description
class	FilterChangeIndicationCharacteristic
class	FilterLifeLevelCharacteristic
class	ResetFilterIndicationCharacteristic

Uses of Characteristic in io.github.hapjava.characteristics.impl.garagedoor

Classes in io.github.hapjava.characteristics.impl.garagedoor that implement Characteristic

Modifier and Type	Class	Description
class	CurrentDoorStateCharacteristic	This characteristic describes the current state of a door.
class	TargetDoorStateCharacteristic	This characteristic describes the target state of a door.

Uses of Characteristic in io.github.hapjava.characteristics.impl.heatercooler

Classes in io.github.hapjava.characteristics.impl.heatercooler that implement Characteristic

Modifier and Type	Class	Description
class	CurrentHeaterCoolerStateCharacteristic	This characteristic describes the current state of a heater cooler.
class	TargetHeaterCoolerStateCharacteristic	This characteristic describes the target state of heater cooler.

Uses of Characteristic in io.github.hapjava.characteristics.impl.humidifier

Classes in io.github.hapjava.characteristics.impl.humidifier that implement Characteristic

Modifier and Type	Class	Description
class	CurrentHumidifierDehumidifierStateCharacteristic	This characteristic describes the current state of a humidifier or/and a dehumidifier.
class	HumidityDehumidifierThresholdCharacteristic	This characteristic describes the relative humidity dehumidifier threshold on which dehumidifier turns on.
class	HumidityHumidifierThresholdCharacteristic	This characteristic describes the relative humidity humidifier threshold on which humidifier turns on.
class	TargetHumidifierDehumidifierStateCharacteristic	This characteristic describes the target state of a humidifier or/and a dehumidifier..

Uses of Characteristic in io.github.hapjava.characteristics.impl.humiditysensor

Classes in io.github.hapjava.characteristics.impl.humiditysensor that implement Characteristic

Modifier and Type	Class	Description
class	CurrentRelativeHumidityCharacteristic	This characteristic describes the current relative humidity.
class	TargetRelativeHumidityCharacteristic	This characteristic describes the target relative humidity.

Uses of Characteristic in io.github.hapjava.characteristics.impl.inputsource

Classes in io.github.hapjava.characteristics.impl.inputsource that implement Characteristic

Modifier and Type	Class	Description
class	CurrentVisibilityStateCharacteristic	This characteristic describes current visibility state.
class	InputDeviceTypeCharacteristic	This characteristic describes input device type.
class	InputSourceTypeCharacteristic	This characteristic describes input source type.
class	TargetVisibilityStateCharacteristic	This characteristic describes target visibility state.

Uses of Characteristic in io.github.hapjava.characteristics.impl.leaksensor

Classes in io.github.hapjava.characteristics.impl.leaksensor that implement Characteristic

Modifier and Type	Class	Description
class	LeakDetectedStateCharacteristic	This characteristic indicates if a sensor detected a leak (e.g.

Uses of Characteristic in io.github.hapjava.characteristics.impl.lightbulb

Classes in io.github.hapjava.characteristics.impl.lightbulb that implement Characteristic

Modifier and Type	Class	Description
class	BrightnessCharacteristic	This characteristic describes a perceived level of brightness, The value is a percentage (%) of the maximum level of supported brightness.
class	ColorTemperatureCharacteristic	This characteristic describes color temperature in mireds
class	HueCharacteristic	This characteristic describes hue or color.
class	SaturationCharacteristic	This characteristic describes color saturation.

Uses of Characteristic in io.github.hapjava.characteristics.impl.lightsensor

Classes in io.github.hapjava.characteristics.impl.lightsensor that implement Characteristic

Modifier and Type	Class	Description
class	CurrentAmbientLightLevelCharacteristic	This characteristic indicates the current light level in Lux

Uses of Characteristic in io.github.hapjava.characteristics.impl.lock

Classes in io.github.hapjava.characteristics.impl.lock that implement Characteristic

Modifier and Type	Class	Description
class	LockCurrentStateCharacteristic	The current state of the physical security mechanism (e.g.
class	LockTargetStateCharacteristic	The target state of the physical security mechanism (e.g.

Uses of Characteristic in io.github.hapjava.characteristics.impl.motionsensor

Classes in io.github.hapjava.characteristics.impl.motionsensor that implement Characteristic

Modifier and Type	Class	Description
class	MotionDetectedCharacteristic	This characteristic indicates if motion (e.g.

Uses of Characteristic in io.github.hapjava.characteristics.impl.occupancysensor

Classes in io.github.hapjava.characteristics.impl.occupancysensor that implement Characteristic

Modifier and Type	Class	Description
class	OccupancyDetectedCharacteristic	This characteristic indicates if occupancy was detected (e.g.

Uses of Characteristic in io.github.hapjava.characteristics.impl.outlet

Classes in io.github.hapjava.characteristics.impl.outlet that implement Characteristic

Modifier and Type	Class	Description
class	OutletInUseCharacteristic	This characteristic describes if the power outlet has an appliance physically plugged in.

Uses of Characteristic in io.github.hapjava.characteristics.impl.securitysystem

Classes in io.github.hapjava.characteristics.impl.securitysystem that implement Characteristic

Modifier and Type	Class	Description
class	CurrentSecuritySystemStateCharacteristic	This characteristic describes the state of a security system
class	SecuritySystemAlarmTypeCharacteristic	This characteristic describes the type of alarm triggered by a security system.
class	TargetSecuritySystemStateCharacteristic	This characteristic describes the target state of the security system.

Uses of Characteristic in io.github.hapjava.characteristics.impl.slat

Classes in io.github.hapjava.characteristics.impl.slat that implement Characteristic

Modifier and Type	Class	Description
class	CurrentSlatStateCharacteristic	This characteristic describes the current state of the slats.
class	CurrentTiltAngleCharacteristic	This characteristic describe current tilt angle (between -90 and 90)
class	SlatTypeCharacteristic	This characteristic describes the type of the slats.
class	TargetTiltAngleCharacteristic	This characteristic describes the target angle of slats.

Uses of Characteristic in io.github.hapjava.characteristics.impl.smokesensor

Classes in io.github.hapjava.characteristics.impl.smokesensor that implement Characteristic

Modifier and Type	Class	Description
class	SmokeDetectedCharacteristic	This characteristic indicates if a sensor detects smoke.

Uses of Characteristic in io.github.hapjava.characteristics.impl.television

Classes in io.github.hapjava.characteristics.impl.television that implement Characteristic

Modifier and Type	Class	Description
class	ClosedCaptionsCharacteristic	Characteristic indicates whether the service provides closed captions.
class	CurrentMediaStateCharacteristic	This characteristic indicates current media state.
class	PictureModeCharacteristic	This characteristic retrieves / sets picture mode.
class	PowerModeCharacteristic	characteristic sets power mode.
class	RemoteKeyCharacteristic	This characteristic sends information about pressed key on tv remote.
class	SleepDiscoveryModeCharacteristic	This characteristic indicates whether the service can be discovered.
class	TargetMediaStateCharacteristic	This characteristic sets media state.

Uses of Characteristic in io.github.hapjava.characteristics.impl.televisionspeaker

Classes in io.github.hapjava.characteristics.impl.televisionspeaker that implement Characteristic

Modifier and Type	Class	Description
class	VolumeControlTypeCharacteristic	This characteristic indicates volume control type.
class	VolumeSelectorCharacteristic	This characteristic sends information about volume changes.

Uses of Characteristic in io.github.hapjava.characteristics.impl.thermostat

Classes in io.github.hapjava.characteristics.impl.thermostat that implement Characteristic

Modifier and Type	Class	Description
class	CoolingThresholdTemperatureCharacteristic	This characteristic describes the cooling threshold on which accessories turns on the cooling.
class	CurrentHeatingCoolingStateCharacteristic	This characteristic describes the current mode of an accessory that supports cooling or heating
class	CurrentTemperatureCharacteristic	characteristic describes the current temperature of the environment in Celsius
class	HeatingThresholdTemperatureCharacteristic	This characteristic describes the heating threshold on which heating get turned on.
class	TargetHeatingCoolingStateCharacteristic	This characteristic describes the target mode of an accessory that supports heating/cooling,
class	TargetTemperatureCharacteristic	This characteristic describes the target temperature in Celsius that the accessory is actively attempting to reach.
class	TemperatureDisplayUnitCharacteristic	This characteristic describes units of temperature used for presentation purposes (e.g.

Uses of Characteristic in io.github.hapjava.characteristics.impl.valve

Classes in io.github.hapjava.characteristics.impl.valve that implement Characteristic

Modifier and Type	Class	Description
class	RemainingDurationCharacteristic	This characteristic describes the remaining duration of the active status of an accessory, e.g.
class	SetDurationCharacteristic	This characteristic describes the duration, how long an accessory should be set to "InUse".
class	ValveTypeCharacteristic	This characteristic describes the type of valve.

Uses of Characteristic in io.github.hapjava.characteristics.impl.windowcovering

Classes in io.github.hapjava.characteristics.impl.windowcovering that implement Characteristic

Modifier and Type	Class	Description
class	CurrentHorizontalTiltAngleCharacteristic	This characteristic describes the current angle of horizontal slats.
class	CurrentPositionCharacteristic	This characteristic describes the current position of accessories.
class	CurrentVerticalTiltAngleCharacteristic	This characteristic describes the current angle of vertical slats for accessory.
class	HoldPositionCharacteristic	This characteristic causes the accessories like window covering to stop at its current
class	PositionStateCharacteristic	This characteristic describes the state of the position of accessories.
class	TargetHorizontalTiltAngleCharacteristic	This characteristic describes the target angle of horizontal slats for accessories.
class	TargetPositionCharacteristic	This characteristic describes the target position of accessories like door, window, blinds.
class	TargetVerticalTiltAngleCharacteristic	This characteristic describes the target angle of vertical slats.

Uses of Characteristic in io.github.hapjava.services

Methods in io.github.hapjava.services that return types with arguments of type Characteristic

Modifier and Type	Method	Description
java.util.List<Characteristic>	Service.getCharacteristics()	Characteristics are the variables offered for reading, updating, and eventing by the Service over the HomeKit protocol.