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 classAccessoryFlagsCharacteristicThis characteristic indicates whether accessory requires additional setup.classFirmwareRevisionCharacteristicThis characteristic describes a firmware revision stringclassHardwareRevisionCharacteristicThis characteristic describes a hardware revision in a form x[.y[.z]] (e.g.classIdentifyCharacteristicThis characteristic enables accessory to run its identify routine.classManufacturerCharacteristicThis characteristic contains the name of the company whose brand will appear on the accessoryclassModelCharacteristicThis characteristic contains the manufacturer-specific model of the accessoryclassSerialNumberCharacteristicThis 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 classCurrentAirPurifierCharacteristicThis characteristic describes the current state of the air purifier.classTargetAirPurifierStateCharacteristicThis 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 classAirQualityCharacteristicThis characteristic describes the air quality.classNitrogenDioxideDensityCharacteristicThis characteristic contains the current NO2 density in micrograms/m3.classOzoneDensityCharacteristicThis characteristic contains the current ozone density in micrograms/m3.classPM10DensityCharacteristicThis characteristic contains the current PM10 micrometer particulate density in micrograms/m3.classPM25DensityCharacteristicThis characteristic contains the current PM2.5 micrometer particulate density in micrograms/m3.classSulphurDioxideDensityCharacteristicThis characteristic contains the current SO2 density in micrograms/m3.classVOCDensityCharacteristicThis 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 classMuteCharacteristicMute characteristic to control audio input or output accessory.classVolumeCharacteristicVolume 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 classBooleanCharacteristicCharacteristic that exposes a Boolean value.classEnumCharacteristic<T extends CharacteristicEnum>Characteristic that exposes an Enum value.classFloatCharacteristicA characteristic that provides a Float value type.classIntegerCharacteristicA characteristic that provides an Integer data type.classStaticStringCharacteristicA characteristic that provides an immutable String value.classStringCharacteristicA 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 classBatteryLevelCharacteristicThis characteristic describes the current level of the battery.classChargingStateCharacteristicThis characteristic describes the charging state of a battery or an accessory.classStatusLowBatteryCharacteristicThis 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 classCarbonDioxideDetectedCharacteristicThis characteristic indicates the levels of Carbon Dioxide.classCarbonDioxideLevelCharacteristicThis characteristic indicates the detected level of Carbon Dioxide in parts per million (ppm).classCarbonDioxidePeakLevelCharacteristicThis 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 classCarbonMonoxideDetectedCharacteristicThis characteristic indicates the levels of Carbon Monoxide.classCarbonMonoxideLevelCharacteristicThis characteristic contains the Carbon Monoxide levels in parts per million (ppm).classCarbonMonoxidePeakLevelCharacteristicThis 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 classActiveCharacteristicActive characteristic indicates whether the service is currently active.classActiveIdentifierCharacteristicclassAirPlayEnableCharacteristiccharacteristic to control air play.classConfiguredNameCharacteristicThis characteristic describes a configured name.classIdentifierCharacteristicclassInUseCharacteristicThis characteristic indicates whether the service is in use.classIsConfiguredCharacteristicThis characteristic describes whether the service is configured for use.classNameCharacteristicThis characteristic describes a name and must not be a null value.classObstructionDetectedCharacteristicThis characteristic describes the current state of an obstruction sensor.classOnCharacteristicThis characteristic represents the states for “on” and “off”.classProgrammableSwitchEventCharacteristicThis characteristic describes an event generated by a programmable switch.classProgramModeCharacteristicThis characteristic describes if there are programs scheduled on the accessory.classServiceLabelIndexCharacteristicThis characteristic is used to identify the index of the label according toServiceLabelNamespaceCharacteristicclassServiceLabelNamespaceCharacteristicThis characteristic describes the naming schema for an accessory.classStatusActiveCharacteristicThis characteristic describes current working (active and functional) status of accessory.classStatusFaultCharacteristicThis characteristic describes fault status.classStatusTamperedCharacteristicThis characteristic describes tampered status.classVersionCharacteristicThis characteristic describes HAP version.classWaterLavelCharacteristicThis 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 classContactSensorStateCharacteristicThis 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 classCurrentFanStateCharacteristicThis characteristic describes the current state of the fan.classLockPhysicalControlsCharacteristicThis characteristic describes physical controls on an accessory (eg.classRotationDirectionCharacteristicThis characteristic describes the direction of rotation of a fan.classRotationSpeedCharacteristicThis characteristic describes the rotation speed of a fan.classSwingModeCharacteristicThis characteristic describes if swing mode is enabled.classTargetFanStateCharacteristicThis 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 classFilterChangeIndicationCharacteristicclassFilterLifeLevelCharacteristicclassResetFilterIndicationCharacteristic -
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 classCurrentDoorStateCharacteristicThis characteristic describes the current state of a door.classTargetDoorStateCharacteristicThis 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 classCurrentHeaterCoolerStateCharacteristicThis characteristic describes the current state of a heater cooler.classTargetHeaterCoolerStateCharacteristicThis 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 classCurrentHumidifierDehumidifierStateCharacteristicThis characteristic describes the current state of a humidifier or/and a dehumidifier.classHumidityDehumidifierThresholdCharacteristicThis characteristic describes the relative humidity dehumidifier threshold on which dehumidifier turns on.classHumidityHumidifierThresholdCharacteristicThis characteristic describes the relative humidity humidifier threshold on which humidifier turns on.classTargetHumidifierDehumidifierStateCharacteristicThis 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 classCurrentRelativeHumidityCharacteristicThis characteristic describes the current relative humidity.classTargetRelativeHumidityCharacteristicThis 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 classCurrentVisibilityStateCharacteristicThis characteristic describes current visibility state.classInputDeviceTypeCharacteristicThis characteristic describes input device type.classInputSourceTypeCharacteristicThis characteristic describes input source type.classTargetVisibilityStateCharacteristicThis 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 classLeakDetectedStateCharacteristicThis 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 classBrightnessCharacteristicThis characteristic describes a perceived level of brightness, The value is a percentage (%) of the maximum level of supported brightness.classColorTemperatureCharacteristicThis characteristic describes color temperature in miredsclassHueCharacteristicThis characteristic describes hue or color.classSaturationCharacteristicThis 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 classCurrentAmbientLightLevelCharacteristicThis 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 classLockCurrentStateCharacteristicThe current state of the physical security mechanism (e.g.classLockTargetStateCharacteristicThe 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 classMotionDetectedCharacteristicThis 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 classOccupancyDetectedCharacteristicThis 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 classOutletInUseCharacteristicThis 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 classCurrentSecuritySystemStateCharacteristicThis characteristic describes the state of a security systemclassSecuritySystemAlarmTypeCharacteristicThis characteristic describes the type of alarm triggered by a security system.classTargetSecuritySystemStateCharacteristicThis 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 classCurrentSlatStateCharacteristicThis characteristic describes the current state of the slats.classCurrentTiltAngleCharacteristicThis characteristic describe current tilt angle (between -90 and 90)classSlatTypeCharacteristicThis characteristic describes the type of the slats.classTargetTiltAngleCharacteristicThis 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 classSmokeDetectedCharacteristicThis 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 classClosedCaptionsCharacteristicCharacteristic indicates whether the service provides closed captions.classCurrentMediaStateCharacteristicThis characteristic indicates current media state.classPictureModeCharacteristicThis characteristic retrieves / sets picture mode.classPowerModeCharacteristiccharacteristic sets power mode.classRemoteKeyCharacteristicThis characteristic sends information about pressed key on tv remote.classSleepDiscoveryModeCharacteristicThis characteristic indicates whether the service can be discovered.classTargetMediaStateCharacteristicThis 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 classVolumeControlTypeCharacteristicThis characteristic indicates volume control type.classVolumeSelectorCharacteristicThis 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 classCoolingThresholdTemperatureCharacteristicThis characteristic describes the cooling threshold on which accessories turns on the cooling.classCurrentHeatingCoolingStateCharacteristicThis characteristic describes the current mode of an accessory that supports cooling or heatingclassCurrentTemperatureCharacteristiccharacteristic describes the current temperature of the environment in CelsiusclassHeatingThresholdTemperatureCharacteristicThis characteristic describes the heating threshold on which heating get turned on.classTargetHeatingCoolingStateCharacteristicThis characteristic describes the target mode of an accessory that supports heating/cooling,classTargetTemperatureCharacteristicThis characteristic describes the target temperature in Celsius that the accessory is actively attempting to reach.classTemperatureDisplayUnitCharacteristicThis 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 classRemainingDurationCharacteristicThis characteristic describes the remaining duration of the active status of an accessory, e.g.classSetDurationCharacteristicThis characteristic describes the duration, how long an accessory should be set to "InUse".classValveTypeCharacteristicThis 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 classCurrentHorizontalTiltAngleCharacteristicThis characteristic describes the current angle of horizontal slats.classCurrentPositionCharacteristicThis characteristic describes the current position of accessories.classCurrentVerticalTiltAngleCharacteristicThis characteristic describes the current angle of vertical slats for accessory.classHoldPositionCharacteristicThis characteristic causes the accessories like window covering to stop at its currentclassPositionStateCharacteristicThis characteristic describes the state of the position of accessories.classTargetHorizontalTiltAngleCharacteristicThis characteristic describes the target angle of horizontal slats for accessories.classTargetPositionCharacteristicThis characteristic describes the target position of accessories like door, window, blinds.classTargetVerticalTiltAngleCharacteristicThis characteristic describes the target angle of vertical slats.
-