HAP.Characteristic (HAP v0.1.0) View Source

Represents a single characteristic optionally backed by an instance of ValueStore

Link to this section Summary

Types

The format of a characteristic as defined in Table 6.5 of Apple's HomeKit Accessory Protocol Specification. One of bool, uint8, uint16, uint32, uint64, int, float, string, tlv8, or data

A permission of a characteristic as defined in Table 6.4 of Apple's HomeKit Accessory Protocol Specification. One of pr, pw, ev, aa, tw, hd, or wr

t()

Represents a single characteristic optionally backed by an instance of ValueStore

The type of a characteristic as defined in Section 6.6.1 of Apple's HomeKit Accessory Protocol Specification.

The value of a characrteristic

Link to this section Types

Specs

format() :: String.t()

The format of a characteristic as defined in Table 6.5 of Apple's HomeKit Accessory Protocol Specification. One of bool, uint8, uint16, uint32, uint64, int, float, string, tlv8, or data

Specs

perm() :: String.t()

A permission of a characteristic as defined in Table 6.4 of Apple's HomeKit Accessory Protocol Specification. One of pr, pw, ev, aa, tw, hd, or wr

Specs

t() :: %HAP.Characteristic{
  format: format(),
  perms: [perm()],
  type: type(),
  value: value(),
  value_mod: HAP.ValueStore.t(),
  value_opts: HAP.ValueStore.opts()
}

Represents a single characteristic optionally backed by an instance of ValueStore

Specs

type() :: String.t()

The type of a characteristic as defined in Section 6.6.1 of Apple's HomeKit Accessory Protocol Specification.

Specs

value() :: any()

The value of a characrteristic