hap-nodejs
_definitions
Services
Namespace Services
Classes
AccessCode
AccessControl
AccessoryInformation
AccessoryMetrics
AccessoryRuntimeInformation
AirPurifier
AirQualitySensor
AssetUpdate
Assistant
AudioStreamManagement
Battery
CameraOperatingMode
CameraRecordingManagement
CameraRTPStreamManagement
CarbonDioxideSensor
CarbonMonoxideSensor
CloudRelay
ContactSensor
DataStreamTransportManagement
Diagnostics
Door
Doorbell
Fan
Fanv2
Faucet
FilterMaintenance
FirmwareUpdate
GarageDoorOpener
HeaterCooler
HumidifierDehumidifier
HumiditySensor
InputSource
IrrigationSystem
LeakSensor
Lightbulb
LightSensor
LockManagement
LockMechanism
Microphone
MotionSensor
NFCAccess
OccupancySensor
Outlet
Pairing
PowerManagement
ProtocolInformation
SecuritySystem
ServiceLabel
Siri
SiriEndpoint
Slats
SmartSpeaker
SmokeSensor
Speaker
StatefulProgrammableSwitch
StatelessProgrammableSwitch
Switch
TapManagement
TargetControl
TargetControlManagement
Television
TelevisionSpeaker
TemperatureSensor
Thermostat
ThreadTransport
TransferTransportManagement
Tunnel
Valve
WiFiRouter
WiFiSatellite
WiFiTransport
Window
WindowCovering
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Classes
Access
Code
Access
Control
Accessory
Information
Accessory
Metrics
Accessory
Runtime
Information
Air
Purifier
Air
Quality
Sensor
Asset
Update
Assistant
Audio
Stream
Management
Battery
Camera
Operating
Mode
Camera
Recording
Management
Camera
RTP
Stream
Management
Carbon
Dioxide
Sensor
Carbon
Monoxide
Sensor
Cloud
Relay
Contact
Sensor
Data
Stream
Transport
Management
Diagnostics
Door
Doorbell
Fan
Fanv2
Faucet
Filter
Maintenance
Firmware
Update
Garage
Door
Opener
Heater
Cooler
Humidifier
Dehumidifier
Humidity
Sensor
Input
Source
Irrigation
System
Leak
Sensor
Lightbulb
Light
Sensor
Lock
Management
Lock
Mechanism
Microphone
Motion
Sensor
NFC
Access
Occupancy
Sensor
Outlet
Pairing
Power
Management
Protocol
Information
Security
System
Service
Label
Siri
Siri
Endpoint
Slats
Smart
Speaker
Smoke
Sensor
Speaker
Stateful
Programmable
Switch
Stateless
Programmable
Switch
Switch
Tap
Management
Target
Control
Target
Control
Management
Television
Television
Speaker
Temperature
Sensor
Thermostat
Thread
Transport
Transfer
Transport
Management
Tunnel
Valve
Wi
Fi
Router
Wi
Fi
Satellite
Wi
Fi
Transport
Window
Window
Covering
hap-nodejs
_
definitions
Characteristics
Access
Code
Control
Point
Access
Code
Supported
Configuration
Access
Control
Level
Accessory
Flags
Accessory
Identifier
Active
Active
Identifier
Activity
Interval
Administrator
Only
Access
Air
Particulate
Density
Air
Particulate
Size
Air
Play
Enable
Air
Quality
App
Matching
Identifier
Asset
Update
Readiness
Audio
Feedback
Battery
Level
Brightness
Button
Event
Camera
Operating
Mode
Indicator
Carbon
Dioxide
Detected
Carbon
Dioxide
Level
Carbon
Dioxide
Peak
Level
Carbon
Monoxide
Detected
Carbon
Monoxide
Level
Carbon
Monoxide
Peak
Level
CCA
Energy
Detect
Threshold
CCA
Signal
Detect
Threshold
Characteristic
Value
Active
Transition
Count
Characteristic
Value
Transition
Control
Charging
State
Closed
Captions
Color
Temperature
Configuration
State
Configured
Name
Contact
Sensor
State
Cooling
Threshold
Temperature
Crypto
Hash
Current
Air
Purifier
State
Current
Ambient
Light
Level
Current
Door
State
Current
Fan
State
Current
Heater
Cooler
State
Current
Heating
Cooling
State
Current
Horizontal
Tilt
Angle
Current
Humidifier
Dehumidifier
State
Current
Media
State
Current
Position
Current
Relative
Humidity
Current
Slat
State
Current
Temperature
Current
Tilt
Angle
Current
Transport
Current
Vertical
Tilt
Angle
Current
Visibility
State
Data
Stream
HAP
Transport
Data
Stream
HAP
Transport
Interrupt
Diagonal
Field
Of
View
Digital
Zoom
Display
Order
Event
Retransmission
Maximum
Event
Snapshots
Active
Event
Transmission
Counters
Filter
Change
Indication
Filter
Life
Level
Firmware
Revision
Firmware
Update
Readiness
Firmware
Update
Status
Hardware
Finish
Hardware
Revision
Heart
Beat
Heating
Threshold
Temperature
Hold
Position
Home
Kit
Camera
Active
Hue
Identifier
Identify
Image
Mirroring
Image
Rotation
Input
Device
Type
Input
Source
Type
In
Use
Is
Configured
Leak
Detected
List
Pairings
Lock
Control
Point
Lock
Current
State
Lock
Last
Known
Action
Lock
Management
Auto
Security
Timeout
Lock
Physical
Controls
Lock
Target
State
Logs
MAC
Retransmission
Maximum
MAC
Transmission
Counters
Managed
Network
Enable
Manually
Disabled
Manufacturer
Matter
Firmware
Revision
Number
Matter
Firmware
Update
Status
Maximum
Transmit
Power
Metrics
Buffer
Full
State
Model
Motion
Detected
Multifunction
Button
Mute
Name
Network
Access
Violation
Control
Network
Client
Profile
Control
Network
Client
Status
Control
NFC
Access
Control
Point
NFC
Access
Supported
Configuration
Night
Vision
Nitrogen
Dioxide
Density
Obstruction
Detected
Occupancy
Detected
On
Operating
State
Response
Optical
Zoom
Outlet
In
Use
Ozone
Density
Pairing
Features
Pair
Setup
Pair
Verify
Password
Setting
Periodic
Snapshots
Active
Picture
Mode
Ping
PM10
Density
PM2_
5
Density
Position
State
Power
Mode
Selection
Product
Data
Programmable
Switch
Event
Programmable
Switch
Output
State
Program
Mode
Received
Signal
Strength
Indication
Receiver
Sensitivity
Recording
Audio
Active
Relative
Humidity
Dehumidifier
Threshold
Relative
Humidity
Humidifier
Threshold
Relay
Control
Point
Relay
Enabled
Relay
State
Remaining
Duration
Remote
Key
Reset
Filter
Indication
Rotation
Direction
Rotation
Speed
Router
Status
Saturation
Security
System
Alarm
Type
Security
System
Current
State
Security
System
Target
State
Selected
Audio
Stream
Configuration
Selected
Camera
Recording
Configuration
Selected
Diagnostics
Modes
Selected
RTP
Stream
Configuration
Selected
Sleep
Configuration
Serial
Number
Service
Label
Index
Service
Label
Namespace
Set
Duration
Setup
Data
Stream
Transport
Setup
Endpoints
Setup
Transfer
Transport
Signal
To
Noise
Ratio
Siri
Enable
Siri
Endpoint
Session
Status
Siri
Engine
Version
Siri
Input
Type
Siri
Light
On
Use
Siri
Listening
Siri
Touch
To
Use
Slat
Type
Sleep
Discovery
Mode
Sleep
Interval
Smoke
Detected
Software
Revision
Staged
Firmware
Version
Status
Active
Status
Fault
Status
Jammed
Status
Low
Battery
Status
Tampered
Streaming
Status
Sulphur
Dioxide
Density
Supported
Asset
Types
Supported
Audio
Recording
Configuration
Supported
Audio
Stream
Configuration
Supported
Camera
Recording
Configuration
Supported
Characteristic
Value
Transition
Configuration
Supported
Data
Stream
Transport
Configuration
Supported
Diagnostics
Modes
Supported
Diagnostics
Snapshot
Supported
Firmware
Update
Configuration
Supported
Metrics
Supported
Router
Configuration
Supported
RTP
Configuration
Supported
Sleep
Configuration
Supported
Transfer
Transport
Configuration
Supported
Video
Recording
Configuration
Supported
Video
Stream
Configuration
Swing
Mode
Tap
Type
Target
Air
Purifier
State
Target
Control
List
Target
Control
Supported
Configuration
Target
Door
State
Target
Fan
State
Target
Heater
Cooler
State
Target
Heating
Cooling
State
Target
Horizontal
Tilt
Angle
Target
Humidifier
Dehumidifier
State
Target
Media
State
Target
Position
Target
Relative
Humidity
Target
Temperature
Target
Tilt
Angle
Target
Vertical
Tilt
Angle
Target
Visibility
State
Temperature
Display
Units
Third
Party
Camera
Active
Thread
Control
Point
Thread
Node
Capabilities
Thread
Open
Thread
Version
Thread
Status
Token
Transmit
Power
Tunnel
Connection
Timeout
Tunneled
Accessory
Advertising
Tunneled
Accessory
Connected
Tunneled
Accessory
State
Number
Valve
Type
Version
Video
Analysis
Active
VOC
Density
Volume
Volume
Control
Type
Volume
Selector
Wake
Configuration
WAN
Configuration
List
WAN
Status
List
Water
Level
Wi
Fi
Capabilities
Wi
Fi
Configuration
Control
Wi
Fi
Satellite
Status
Services
Access
Code
Access
Control
Accessory
Information
Accessory
Metrics
Accessory
Runtime
Information
Air
Purifier
Air
Quality
Sensor
Asset
Update
Assistant
Audio
Stream
Management
Battery
Camera
Operating
Mode
Camera
Recording
Management
Camera
RTP
Stream
Management
Carbon
Dioxide
Sensor
Carbon
Monoxide
Sensor
Cloud
Relay
Contact
Sensor
Data
Stream
Transport
Management
Diagnostics
Door
Doorbell
Fan
Fanv2
Faucet
Filter
Maintenance
Firmware
Update
Garage
Door
Opener
Heater
Cooler
Humidifier
Dehumidifier
Humidity
Sensor
Input
Source
Irrigation
System
Leak
Sensor
Lightbulb
Light
Sensor
Lock
Management
Lock
Mechanism
Microphone
Motion
Sensor
NFC
Access
Occupancy
Sensor
Outlet
Pairing
Power
Management
Protocol
Information
Security
System
Service
Label
Siri
Siri
Endpoint
Slats
Smart
Speaker
Smoke
Sensor
Speaker
Stateful
Programmable
Switch
Stateless
Programmable
Switch
Switch
Tap
Management
Target
Control
Target
Control
Management
Television
Television
Speaker
Temperature
Sensor
Thermostat
Thread
Transport
Transfer
Transport
Management
Tunnel
Valve
Wi
Fi
Router
Wi
Fi
Satellite
Wi
Fi
Transport
Window
Window
Covering
Legacy
Types
ACCESSORY_
INFORMATION_
STYPE
ADMIN_
ONLY_
ACCESS_
CTYPE
ALARM_
CURRENT_
STATE_
CTYPE
ALARM_
STYPE
ALARM_
SYSTEM_
TCTYPE
ALARM_
TARGET_
STATE_
CTYPE
AUDIO_
FEEDBACK_
CTYPE
BATTERY_
LEVEL_
CTYPE
BRIGHTNESS_
CTYPE
CONTACT_
SENSOR_
STATE_
CTYPE
CONTACT_
SENSOR_
STYPE
COOLING_
THRESHOLD_
CTYPE
CURRENT_
DOOR_
STATE_
CTYPE
CURRENT_
LOCK_
MECHANISM_
STATE_
CTYPE
CURRENT_
RELATIVE_
HUMIDITY_
CTYPE
CURRENT_
TEMPERATURE_
CTYPE
CURRENTHEATINGCOOLING_
CTYPE
DOOR_
LOCK_
TCTYPE
DOOR_
TCTYPE
FAN_
STYPE
FAN_
TCTYPE
FIRMWARE_
REVISION_
CTYPE
GARAGE_
DOOR_
OPENER_
STYPE
GARAGE_
DOOR_
OPENER_
TCTYPE
HEATING_
THRESHOLD_
CTYPE
HUE_
CTYPE
HUMIDITY_
SENSOR_
STYPE
IDENTIFY_
CTYPE
LIGHTBULB_
STYPE
LIGHTBULB_
TCTYPE
LOCK_
MANAGEMENT_
AUTO_
SECURE_
TIMEOUT_
CTYPE
LOCK_
MANAGEMENT_
CONTROL_
POINT_
CTYPE
LOCK_
MANAGEMENT_
STYPE
LOCK_
MECHANISM_
LAST_
KNOWN_
ACTION_
CTYPE
LOCK_
MECHANISM_
STYPE
LOGS_
CTYPE
MANUFACTURER_
CTYPE
MODEL_
CTYPE
MOTION_
DETECTED_
CTYPE
MOTION_
SENSOR_
STYPE
NAME_
CTYPE
OBSTRUCTION_
DETECTED_
CTYPE
OCCUPANCY_
DETECTED_
CTYPE
OCCUPANCY_
SENSOR_
STYPE
OTHER_
TCTYPE
OUTLET_
IN_
USE_
CTYPE
OUTLET_
STYPE
OUTLET_
TCTYPE
POWER_
STATE_
CTYPE
PROGRAMMABLE_
SWITCH_
OUTPUT_
STATE_
CTYPE
PROGRAMMABLE_
SWITCH_
SWITCH_
EVENT_
CTYPE
PROGRAMMABLE_
SWITCH_
TCTYPE
ROTATION_
DIRECTION_
CTYPE
ROTATION_
SPEED_
CTYPE
SATURATION_
CTYPE
SENSOR_
TCTYPE
SERIAL_
NUMBER_
CTYPE
STATUS_
FAULT_
CTYPE
STATUS_
LOW_
BATTERY_
CTYPE
SWITCH_
STYPE
SWITCH_
TCTYPE
TARGET_
DOORSTATE_
CTYPE
TARGET_
LOCK_
MECHANISM_
STATE_
CTYPE
TARGET_
RELATIVE_
HUMIDITY_
CTYPE
TARGET_
TEMPERATURE_
CTYPE
TARGETHEATINGCOOLING_
CTYPE
TEMPERATURE_
SENSOR_
STYPE
TEMPERATURE_
UNITS_
CTYPE
THERMOSTAT_
STYPE
THERMOSTAT_
TCTYPE
VERSION_
CTYPE
WINDOW_
COVERING_
CURRENT_
POSITION_
CTYPE
WINDOW_
COVERING_
OPERATION_
STATE_
CTYPE
WINDOW_
COVERING_
STYPE
WINDOW_
COVERING_
TARGET_
POSITION_
CTYPE
WINDOW_
COVERING_
TCTYPE
WINDOW_
TCTYPE
uuid
Binary
Binary
Like
BASE_
UUID
generate
is
Valid
to
Long
Form
to
Short
Form
unparse
write
Access
Access
Control
Event
Access
Level
Accessory
Event
Types
Adaptive
Lighting
Controller
Events
Adaptive
Lighting
Controller
Mode
Audio
Bitrate
Audio
Codec
Types
Audio
Recording
Codec
Type
Audio
Recording
Samplerate
Audio
Samplerate
Audio
Streaming
Codec
Type
Audio
Streaming
Samplerate
Button
State
Button
Type
Camera
Controller
Events
Categories
Change
Reason
Characteristic
Event
Types
Characteristic
Warning
Type
Data
Format
Tags
Data
Stream
Connection
Event
Data
Stream
Server
Event
Data
Stream
Status
Default
Controller
Type
Evented
HTTP
Server
Event
Event
Trigger
Option
Formats
H264
Level
H264
Profile
HAP
Connection
Event
HAPHTTP
Code
HAP
Pairing
HTTP
Code
HAP
Server
Event
Types
HAP
Status
HDS
Connection
Error
Type
HDS
Protocol
Specific
Error
Reason
HDS
Status
MDNS
Advertiser
Media
Container
Type
Message
Type
Packet
Data
Type
Permission
Types
Perms
Protocols
Remote
Controller
Events
Resource
Request
Reason
Resource
Request
Type
Service
Event
Types
Siri
Audio
Session
Events
SRTP
Crypto
Suites
Stream
Request
Types
Target
Category
Target
Updates
TLV
Error
Code
Topics
Units
Video
Codec
Packetization
Mode
Video
Codec
Type
Access
Control
Management
Accessory
Accessory
Info
Adaptive
Lighting
Controller
Bridge
Camera
Controller
Characteristic
Color
Utils
Data
Stream
Connection
Data
Stream
Management
Data
Stream
Parser
Data
Stream
Reader
Data
Stream
Server
Data
Stream
Writer
Doorbell
Controller
Evented
HTTP
Server
Float32
Float64
HAP
Connection
HAP
Encryption
HAP
Server
Hap
Status
Error
HAP
Storage
HDS
Connection
Error
HDS
Protocol
Error
Int16
Int32
Int64
Int8
Recording
Management
Remote
Controller
RTP
Stream
Management
Seconds
Since2001
Service
Siri
Audio
Session
UUID
Value
Wrapper
Accessories
Response
Accessory
Json
Object
Active
Adaptive
Lighting
Transition
Adaptive
Lighting
Controller
Update
Adaptive
Lighting
Options
Adaptive
Lighting
Transition
Curve
Entry
Adaptive
Lighting
Transition
Point
Brightness
Adjustment
Multiplier
Range
Camera
Controller
Options
Camera
Controller
Service
Map
Camera
Controller
State
Camera
Recording
Configuration
Camera
Recording
Delegate
Camera
Recording
Options
Camera
Streaming
Delegate
Camera
Streaming
Options
Base
Camera
Streaming
Options
Legacy
SRTP
Camera
Streaming
Options
Supported
Crypto
Suites
Characteristic
Id
Characteristic
Json
Object
Characteristic
Operation
Context
Characteristic
Props
Characteristic
Read
Data
Value
Characteristic
Read
Error
Characteristics
Read
Request
Characteristics
Read
Response
Characteristics
Write
Request
Characteristics
Write
Response
Characteristic
Warning
Characteristic
Write
Characteristic
Write
Data
Value
Characteristic
Write
Error
Controller
Controller
Constructor
Controller
Context
Controller
Service
Map
Data
Stream
Protocol
Handler
Doorbell
Options
H264
Codec
Parameters
Media
Container
Configuration
Pairing
Information
Partial
Characteristic
Read
Data
Value
Partial
Characteristic
Read
Error
Partial
Characteristic
Write
Data
Value
Partial
Characteristic
Write
Error
Proxied
Source
Response
Publish
Info
Recording
Management
Services
Recording
Management
State
Recording
Packet
Remote
Controller
Service
Map
Resource
Request
RTP
Proxy
Options
RTP
Stream
Management
State
Selected
H264
Codec
Parameters
Serializable
Controller
Serialized
Accessory
Serialized
Adaptive
Lighting
Controller
State
Serialized
Characteristic
Serialized
Controller
Context
Serialized
Controller
State
Serialized
Service
Service
Configuration
Change
Service
Json
Object
Siri
Audio
Stream
Producer
Siri
Audio
Stream
Producer
Constructor
Source
Response
Video
Recording
Options
Accessories
Callback
Accessory
Characteristic
Change
Additional
Authorization
Handler
Add
Pairing
Callback
Audio
Codec
Configuration
Audio
Codec
Parameters
Audio
Frame
Audio
Info
Audio
Recording
Codec
Audio
Recording
Options
Audio
Streaming
Codec
Audio
Streaming
Options
Button
Configuration
Camera
Streaming
Options
Characteristic
Change
Characteristic
Context
Characteristic
Get
Callback
Characteristic
Get
Handler
Characteristic
Read
Data
Characteristic
Set
Callback
Characteristic
Set
Handler
Characteristic
Value
Characteristic
Write
Data
Constructor
Args
Controller
Identifier
Controller
Type
Data
Stream
Message
Error
Handler
Event
Handler
Event
Name
Frame
Handler
Global
Event
Handler
Global
Request
Handler
HAP
Http
Error
HAP
Pincode
HAP
Username
HDS
Frame
Identification
Callback
Identify
Callback
Interface
Name
IP
Address
I
Pv4
Address
I
Pv6
Address
List
Pairings
Callback
Mac
Address
Node
Callback
Nullable
Pair
Callback
Pairings
Callback
Partial
Allowing
Null
Partial
Characteristic
Read
Data
Partial
Characteristic
Write
Data
Prepared
Data
Stream
Session
Prepare
Session
Callback
Prepare
Stream
Callback
Prepare
Stream
Request
Prepare
Stream
Response
Prepare
Write
Request
Primitive
Types
Read
Characteristics
Callback
Reconfigured
Video
Info
Reconfigure
Stream
Request
Remove
Pairing
Callback
Request
Handler
Resolution
Resource
Request
Callback
Response
Handler
RTP
Time
Serialized
Service
Map
Service
Characteristic
Change
Service
Id
Session
Identifier
Snapshot
Request
Snapshot
Request
Callback
Source
Start
Stream
Request
State
Change
Delegate
Stop
Stream
Request
Streaming
Request
Stream
Request
Callback
Stream
Session
Identifier
Supported
Button
Configuration
Supported
Configuration
Target
Configuration
TLV
Encodable
Video
Info
Video
Streaming
Options
Void
Callback
With
UUID
Write
Characteristics
Callback
clone
decode
decode
List
decode
With
Lists
encode
epoch
Millis
From
Millis
Since2001_
01_
01
epoch
Millis
From
Millis
Since2001_
01_
01
Buffer
HAP
Library
Version
Is
Known
HAP
Status
Error
is
Serializable
Controller
once
read
U
Int16
read
U
Int32
read
U
Int64
LE
read
Variable
U
Int
LE
write
Float32
LE
write
U
Int16
write
U
Int32
write
Variable
U
Int
LE
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R