API Reference HAP v0.1.1

HAP is an implementation of the HomeKit Accessory Protocol Specification. It allows for the creation of Elixir powered HomeKit accessories which can be controlled from a user's iOS device in a similar manner to commercially available HomeKit accessories such as smart light bulbs, window coverings and other smart home accessories.

Represents a single accessory object, containing a number of services

Represents a top-level HAP instance configuration

Represents a single characteristic optionally backed by an instance of ValueStore

Factory for the public.hap.characteristic.firmware.revision characteristic

Factory for the public.hap.characteristic.identify characteristic

Factory for the public.hap.characteristic.manufacturer characteristic

Factory for the public.hap.characteristic.model characteristic

Factory for the public.hap.characteristic.name characteristic

Factory for the public.hap.characteristic.on characteristic

Factory for the public.hap.characteristic.serial-number characteristic

Factory for the public.hap.characteristic.version characteristic

A behaviour which encapsulates all user-facing display concerns for an accessory. Applications which use HAP may provide their own implementation of this behaviour as an argument to HAP.build_accessory_server/1. If no such implementation is provided HAP uses a default console based implementation found at HAP.ConsoleDisplay

Represents a single service, containing a number of characteristics

Factory for the public.hap.service.accessory-information service

Factory for the public.hap.service.lightbulb service

Factory for the public.hap.service.protocol.information.service service

Defines the behaviour required of a module that wishes to act as the backing data store for a given HomeKit characteristic