Enum AccessoryCategory
- All Implemented Interfaces:
Comparable<AccessoryCategory>
Roughly what an Accessory is, for picking an icon and grouping a list.
Do not branch capability on this. What an accessory can actually do is
its AccessoryServices and their Traits; a device that calls itself a
switch may well dim, and a light strip may report temperature. This is a
label for the user interface, and the two platforms' own categorizations
are only approximately alike.
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAn air purifier.A hub that other accessories sit behind.A camera.A video or audio doorbell.A fan.A garage door opener.A lamp, bulb or light strip.A door lock.Anything else, including a category one platform has and this API does not.A smart plug or socket.An alarm panel.A sensor of any kind -- motion, contact, temperature, leak, air quality.A speaker.A wall switch or relay.A television or set-top box.A thermostat.A blind, shade, curtain or shutter. -
Method Summary
Modifier and TypeMethodDescriptionstatic AccessoryCategoryReturns the enum constant of this type with the specified name.static AccessoryCategory[]values()Returns an array containing the constants of this enum type, in the order they are declared.Methods inherited from class Enum
clone, compareTo, equals, getDeclaringClass, getEnumValues, hashCode, name, ordinal, setEnumValues, toString, valueOf
-
Enum Constant Details
-
LIGHT
A lamp, bulb or light strip. -
SWITCH
A wall switch or relay. -
OUTLET
A smart plug or socket. -
THERMOSTAT
A thermostat. -
LOCK
A door lock. -
GARAGE_DOOR_OPENER
A garage door opener. -
WINDOW_COVERING
A blind, shade, curtain or shutter. -
SENSOR
A sensor of any kind -- motion, contact, temperature, leak, air quality. Read the services to find out which. -
FAN
A fan. -
AIR_PURIFIER
An air purifier. -
SPEAKER
A speaker. SeeTrait.VOLUMEfor why very few real devices land here. -
TELEVISION
A television or set-top box. -
CAMERA
A camera. This release exposes no stream, snapshot or recording API; the category exists so a camera is visible in the graph rather than missing from it. -
DOORBELL
A video or audio doorbell. -
BRIDGE
A hub that other accessories sit behind. Its children reportAccessory.isBridged()and name it throughAccessory.getBridgeAccessoryId(). -
SECURITY_SYSTEM
An alarm panel. This release exposes no arm or disarm API; a half-working alarm is a safety problem rather than a feature gap. -
OTHER
Anything else, including a category one platform has and this API does not.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-