Uses of Class
io.github.hapjava.characteristics.impl.base.BaseCharacteristic
-
-
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.accessoryinformation
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.accessoryinformation Modifier and Type Class Description class
AccessoryFlagsCharacteristic
This characteristic indicates whether accessory requires additional setup.class
FirmwareRevisionCharacteristic
This characteristic describes a firmware revision stringclass
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 accessoryclass
ModelCharacteristic
This characteristic contains the manufacturer-specific model of the accessoryclass
SerialNumberCharacteristic
This characteristic contains the manufacturer-specific serial number of the accessory. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.airpurifier
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.airpurifier 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.airquality
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.airquality 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.audio
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.audio 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.base
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.base Modifier and Type Class Description 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.battery
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.battery 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.carbondioxidesensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.carbondioxidesensor 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.carbonmonoxidesensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.carbonmonoxidesensor 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.common
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.common 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 toServiceLabelNamespaceCharacteristic
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 BaseCharacteristic in io.github.hapjava.characteristics.impl.contactsensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.contactsensor Modifier and Type Class Description class
ContactSensorStateCharacteristic
This characteristic describes the state of a door/window contact sensor. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.fan
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.fan 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.filtermaintenance
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.filtermaintenance Modifier and Type Class Description class
FilterChangeIndicationCharacteristic
class
FilterLifeLevelCharacteristic
class
ResetFilterIndicationCharacteristic
-
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.garagedoor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.garagedoor 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.heatercooler
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.heatercooler 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.humidifier
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.humidifier 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.humiditysensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.humiditysensor 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.inputsource
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.inputsource 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.leaksensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.leaksensor Modifier and Type Class Description class
LeakDetectedStateCharacteristic
This characteristic indicates if a sensor detected a leak (e.g. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.lightbulb
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.lightbulb 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 miredsclass
HueCharacteristic
This characteristic describes hue or color.class
SaturationCharacteristic
This characteristic describes color saturation. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.lightsensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.lightsensor Modifier and Type Class Description class
CurrentAmbientLightLevelCharacteristic
This characteristic indicates the current light level in Lux -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.lock
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.lock 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.motionsensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.motionsensor Modifier and Type Class Description class
MotionDetectedCharacteristic
This characteristic indicates if motion (e.g. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.occupancysensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.occupancysensor Modifier and Type Class Description class
OccupancyDetectedCharacteristic
This characteristic indicates if occupancy was detected (e.g. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.outlet
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.outlet Modifier and Type Class Description class
OutletInUseCharacteristic
This characteristic describes if the power outlet has an appliance physically plugged in. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.securitysystem
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.securitysystem Modifier and Type Class Description class
CurrentSecuritySystemStateCharacteristic
This characteristic describes the state of a security systemclass
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 BaseCharacteristic in io.github.hapjava.characteristics.impl.slat
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.slat 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.smokesensor
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.smokesensor Modifier and Type Class Description class
SmokeDetectedCharacteristic
This characteristic indicates if a sensor detects smoke. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.television
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.television 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.televisionspeaker
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.televisionspeaker Modifier and Type Class Description class
VolumeControlTypeCharacteristic
This characteristic indicates volume control type.class
VolumeSelectorCharacteristic
This characteristic sends information about volume changes. -
Uses of BaseCharacteristic in io.github.hapjava.characteristics.impl.thermostat
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.thermostat 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 heatingclass
CurrentTemperatureCharacteristic
characteristic describes the current temperature of the environment in Celsiusclass
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 BaseCharacteristic in io.github.hapjava.characteristics.impl.valve
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.valve 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 BaseCharacteristic in io.github.hapjava.characteristics.impl.windowcovering
Subclasses of BaseCharacteristic in io.github.hapjava.characteristics.impl.windowcovering 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 currentclass
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.
-