# HAP Client [](https://www.npmjs.com/package/@homebridge/hap-client) [](https://www.npmjs.com/package/@homebridge/hap-client)
[](https://discord.com/channels/432663330281226270/742733745743855627) A client for an insecure HAP-NodeJS instance. Provides a Typescript based interface based on the homekit accessory protocol, allowing the creation of clients able to connect to and control Homebridge devices. # API ``` const { HapClient } = require('@homebridge/hap-client'); this.hapClient = new HapClient({ config: { debug: true }, pin: config.username, logger: this.log, }); this.monitor = await this.hapClient.monitorCharacteristics(services?: ServiceType[]); // Creates event monitors for all event capabable Homebridge services. If a list of services is, this list is used rather than all ``` The discovery timeout can be configured by setting the `discoveryTimeout` property in the `config` object. ``` const { HapClient } = require('@homebridge/hap-client'); this.hapClient = new HapClient({ config: { debug: true, discoveryTimeout: 5000 }, pin: config.username, logger: this.log, }); // the discovery process will auto-start now with the timeout of 5 seconds ``` It's possible to control the discovery process manually, by settings the `autoStartDiscovery` property to `false` and then calling `this.hapClient.startDiscovery(discoveryTimeout?: number)` when ready. If no timeout is provided to the function, the `discoveryTimeout` property will be used from the `config` object, and if that is not provided either, the default discovery timeout (60 seconds) will be used. It's also possible to stop the discovery process manually by calling `stopDiscovery()` ``` const { HapClient } = require('@homebridge/hap-client'); this.hapClient = new HapClient({ config: { debug: true, autoStartDiscovery: false, discoveryTimeout: 10000 }, pin: config.username, logger: this.log, }); this.hapClient.startDiscovery(); // use the timeout provided in the config, 10000 ms this.hapClient.startDiscovery(5000); // use the argument as timeout, 5000 ms this.hapClient.stopDiscovery(); // stop the discovery process manually ``` ## hap-client Events ``` this.hapClient.on('instance-discovered', this.instanceDiscovered(instance: HapInstance)); // Emitted during discovery for each HB instance discovered this.hapClient.on('instance-configuration-changed', this.instanceChanged(instance: HapInstance)); // Emitted during discovery for each HB instance change this.hapClient.on('discovery-terminated', this.discoveryTerminated()); // Instance discovery was terminated this.hapClient.on('discovery-ended', this.discoveryEnded()); // Emitted when discovery has ended ( 60 Seconds ) this.hapClient.on('discovery-stopped', this.discoveryStopped()); // Emitted when discovery has been stopped manually this.monitor.on('service-update', this.serviceUpdate(services)); // Emitted when a characteristic change is received from a homebridge service this.monitor.on('monitor-close', this.monitorClose(instance, hadError)); // Emitted when the connection to a homebridge service is closed ( likely a restart ) this.monitor.on('monitor-error', this.monitorError(instance, error)); // Emitted when the connection to a homebridge service has an error ( likely a restart ) this.monitor.on('monitor-refresh', this.monitorRefresh(instance, error)); // Emitted when the connection to a homebridge instance has been refreshed ( Triggered when an instance is discovered and its port, configuration number or name has changed) ``` # Dependant Applications - homebridge-config-ui-x - homebridge-gsh - node-red-contrib-homebridge-automation - [NPM Dependants](https://www.npmjs.com/package/@homebridge/hap-client?activeTab=dependents) ## Credits - HAP Client was originally created by [oznu](https://github.com/oznu).