Package io.github.hapjava.services.impl

Class FaucetService

java.lang.Object

io.github.hapjava.services.impl.FaucetService

All Implemented Interfaces:

Service

public class FaucetService
extends java.lang.Object

This service describes accessories like faucets or shower heads and must only be included when an accessory has either a linked HeaterCoolerService, single linked ValveService or multiple linked ValveService (with/without HeaterCoolerService to describe water outlets. This service serves as a top level service for such accessories.

Constructor Summary

Constructors

Constructor	Description
FaucetService(FaucetAccessory accessory)
FaucetService(ActiveCharacteristic active)

Method Summary

Modifier and Type	Method	Description
void	addCharacteristic(Characteristic characteristic)
void	addLinkedService(Service service)	Add linked services
void	addOptionalCharacteristic(NameCharacteristic name)
void	addOptionalCharacteristic(StatusFaultCharacteristic statusFault)
java.util.List<Characteristic>	getCharacteristics()	Characteristics are the variables offered for reading, updating, and eventing by the Service over the HomeKit protocol.
java.util.List<Service>	getLinkedServices()	List of all the services to which the service links
java.lang.String	getType()	The type is a UUID that uniquely identifies the type of Service offered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaucetService

public FaucetService(ActiveCharacteristic active)

FaucetService

public FaucetService(FaucetAccessory accessory)

Method Detail

addOptionalCharacteristic

public void addOptionalCharacteristic(NameCharacteristic name)

addOptionalCharacteristic

public void addOptionalCharacteristic(StatusFaultCharacteristic statusFault)

getCharacteristics

public java.util.List<Characteristic> getCharacteristics()

Description copied from interface: Service

Characteristics are the variables offered for reading, updating, and eventing by the Service over the HomeKit protocol.

It is important to maintain the order of this list and not change its contents between invocations, or a pairing error will result.

Specified by:

getCharacteristics in interface Service

Returns:

the list of Characteristics.

getType

public java.lang.String getType()

Description copied from interface: Service

The type is a UUID that uniquely identifies the type of Service offered. Apple defines several types for standard Services, however UUIDs outside this range are allowed for custom Services.

Specified by:

getType in interface Service

Returns:

A string representation of the UUID, with hexadecimal digits in the format ########-####-####-####-############.

getLinkedServices

public java.util.List<Service> getLinkedServices()

Description copied from interface: Service

List of all the services to which the service links

Specified by:

getLinkedServices in interface Service

Returns:

the list of linked services.

addCharacteristic

public void addCharacteristic(Characteristic characteristic)

addLinkedService

public void addLinkedService(Service service)

Description copied from interface: Service

Add linked services

Specified by:

addLinkedService in interface Service

Parameters:

service - linked service