View Source API Reference HAP v0.6.0
Modules
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 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
Functions to aid in the manipulation of characteristics tuples
A behaviour which encapsulates the functinos required to define a characteristic.
At runtime, characteristics are modeled via the HAP.Characteristic struct which
contains the runtime values for the characteristic itself, as well as metadata about
the characteristic. A HAP.CharacteristicDefinition is used to provide the template
values for these fields. HAP contains definitions for many common HomeKit characteristics
already, and users may define other characteristics by providing an implementation of
this behaviour as the first value in the characteristic definition tuple in a service.
Definition of the public.hap.characteristic.active characteristic
Definition of the public.hap.characteristic.air-quality characteristic
Definition of the public.hap.characteristic.brightness characteristic
Definition of the public.hap.characteristic.carbon-dioxide.detected characteristic
Definition of the public.hap.characteristic.carbon-dioxide.level characteristic
Definition of the public.hap.characteristic.carbon-dioxide.peak-level characteristic
Definition of the public.hap.characteristic.carbon-monoxide.detected characteristic
Definition of the public.hap.characteristic.carbon-monoxide.level characteristic
Definition of the public.hap.characteristic.carbon-monoxide.peak-level characteristic
Definition of the public.hap.characteristic.color-temperature characteristic
Definition of the public.hap.characteristic.contact-state characteristic
Definition of the public.hap.characteristic.temperature.cooling-threshold characteristic
Definition of the public.hap.characteristic.air-purifier.state.current characteristic
Definition of the public.hap.characteristic.light-level.current characteristic
Definition of the public.hap.characteristic.door-state.current characteristic
Definition of the public.hap.characteristic.fan.state.current characteristic
Definition of the public.hap.characteristic.heater-cooler.state.current characteristic
Definition of the public.hap.characteristic.heating-cooling.state.current characteristic
Definition of the public.hap.characteristic.horizontal-tilt.current characteristic
Definition of the public.hap.characteristic.position.current characteristic
Definition of the public.hap.characteristic.relative-humidity.current characteristic
Definition of the public.hap.characteristic.slat.state.current characteristic
Definition of the public.hap.characteristic.temperature.current characteristic
Definition of the public.hap.characteristic.tilt.current characteristic
Definition of the public.hap.characteristic.vertical-tilt.current characteristic
Definition of the public.hap.characteristic.firmware.revision characteristic
Definition of the public.hap.characteristic.temperature.heating-threshold characteristic
Definition of the public.hap.characteristic.position.hold characteristic
Definition of the public.hap.characteristic.hue characteristic
Definition of the public.hap.characteristic.identify characteristic
Definition of the public.hap.characteristic.input-event characteristic
Definition of the public.hap.characteristic.leak-detected characteristic
Definition of the public.hap.characteristic.lock-mechanism.current-state characteristic
Definition of the public.hap.characteristic.lock-physical-controls characteristic
Definition of the public.hap.characteristic.lock-mechanism.target-state characteristic
Definition of the public.hap.characteristic.manufacturer characteristic
Definition of the public.hap.characteristic.model characteristic
Definition of the public.hap.characteristic.motion-detected characteristic
Definition of the public.hap.characteristic.mute characteristic
Definition of the public.hap.characteristic.name characteristic
Definition of the public.hap.characteristic.density.no2 characteristic
Definition of the public.hap.characteristic.obstruction-detected characteristic
Definition of the public.hap.characteristic.occupancy-detected characteristic
Definition of the public.hap.characteristic.on characteristic
Definition of the public.hap.characteristic.outlet-in-use characteristic
Definition of the public.hap.characteristic.density.ozone characteristic
Definition of the public.hap.characteristic.density.pm10 characteristic
Definition of the public.hap.characteristic.density.pm2_5 characteristic
Definition of the public.hap.characteristic.position.state characteristic
Definition of the public.hap.characteristic.rotation.direction characteristic
Definition of the public.hap.characteristic.rotation.speed characteristic
Definition of the public.hap.characteristic.saturation characteristic
Definition of the public.hap.characteristic.serial-number characteristic
Definition of the public.hap.characteristic.service-label-index characteristic
Definition of the public.hap.characteristic.service-label-namespace characteristic
Definition of the public.hap.characteristic.type.slat characteristic
Definition of the public.hap.characteristic.smoke-detected characteristic
Definition of the public.hap.characteristic.status-active characteristic
Definition of the public.hap.characteristic.status-fault characteristic
Definition of the public.hap.characteristic.status-lo-batt characteristic
Definition of the public.hap.characteristic.status-tampered characteristic
Definition of the public.hap.characteristic.density.so2 characteristic
Definition of the public.hap.characteristic.swing-mode characteristic
Definition of the public.hap.characteristic.air-purifier.state.target characteristic
Definition of the public.hap.characteristic.door-state.target characteristic
Definition of the public.hap.characteristic.fan.state.target characteristic
Definition of the public.hap.characteristic.heater-cooler.target characteristic
Definition of the public.hap.characteristic.horizontal-tilt.target characteristic
Definition of the public.hap.characteristic.position.target characteristic
Definition of the public.hap.characteristic.relative.humidity.target characteristic
Definition of the public.hap.characteristic.temperature.target characteristic
Definition of the public.hap.characteristic.tilt.target characteristic
Definition of the public.hap.characteristic.vertical-tilt.target characteristic
Definition of the public.hap.characteristic.temperature.units characteristic
Definition of the public.hap.characteristic.density.voc characteristic
Definition of the public.hap.characteristic.version characteristic
Definition of the public.hap.characteristic.volume characteristic
Definition of the public.hap.characteristic.water-level 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 a field in a HAP.AccessoryServer. If no such
implementation is provided HAP uses a default console based implementation
Represents a single service, containing a number of characteristics
A protocol which allows for arbitrary service definitions to compile themselves into HAP.Service structs
for use within HAP. This protocol allows HAP to expose pre-defined services such as HAP.Services.Lightbulb
with fields reflecting the domain of the service, while allowing HAP to work internally with a service tree
close to that defined in the HomeKit specification
Struct representing an instance of the public.hap.service.accessory-information service
Struct representing an instance of the public.hap.service.air-purifier service
Struct representing an instance of the public.hap.service.sensor.air-quality service
Struct representing an instance of the public.hap.service.sensor.carbon-dioxide service
Struct representing an instance of the public.hap.service.sensor.carbon-monoxide service
Struct representing an instance of the public.hap.service.sensor.contact service
Struct representing an instance of the public.hap.service.door service
Struct representing an instance of the public.hap.service.doorbell service
Struct representing an instance of the public.hap.service.fanv2 service
Struct representing an instance of the public.hap.service.faucet service
Struct representing an instance of 'public.hap.service.garage_door.opener' service
Struct representing an instance of the public.hap.service.heater-cooler service
Struct representing an instance of the public.hap.service.sensor.humidity service
Struct representing an instance of the public.hap.service.sensor.leak service
Struct representing an instance of the public.hap.service.lightbulb service
Struct representing an instance of the public.hap.service.sensor.light service
Struct representing an instance of the public.hap.service.microphone service
Struct representing an instance of the public.hap.service.sensor.motion service
Struct representing an instance of the public.hap.service.sensor.occupancy service
Struct representing an instance of the public.hap.service.outlet service
Struct representing an instance of the public.hap.service.protocol.information.service service
Struct representing an instance of the public.hap.service.service-label service
Struct representing an instance of the public.hap.service.vertical-slat service
Struct representing an instance of the public.hap.service.sensor.smoke service
Struct representing an instance of the public.hap.service.speaker service
Struct representing an instance of the public.hap.service.stateless-programmable-switch service
Struct representing an instance of the public.hap.service.switch service
Struct representing an instance of the public.hap.service.sensor.temperature service
Struct representing an instance of the public.hap.service.thermostat service
Struct representing an instance of the public.hap.service.window service
Struct representing an instance of the public.hap.service.window-covering service
Defines the behaviour required of a module that wishes to act as the backing data store for a given HomeKit characteristic