## Lirc **Kind**: global class * [Lirc](#Lirc) * [new module.exports.Lirc([config])](#new_Lirc_new) * [.send()](#Lirc+send) ⇒ Promise.<array.<string>> * [.sendOnce(remote, button, [repeat])](#Lirc+sendOnce) ⇒ Promise.<array.<string>> * [.sendStart(remote, button)](#Lirc+sendStart) ⇒ Promise.<array.<string>> * [.sendStop(remote, button)](#Lirc+sendStop) ⇒ Promise.<array.<string>> * [.list([remote])](#Lirc+list) ⇒ Promise.<array.<string>> * [.version()](#Lirc+version) ⇒ Promise.<array.<string>> * [.connect()](#Lirc+connect) ⇒ Promise * [.disconnect()](#Lirc+disconnect) ⇒ Promise ### new module.exports.Lirc([config]) | Param | Type | Default | Description | | --- | --- | --- | --- | | [config] | object | | Configuration object. | | [config.autoconnect] | boolean | true | Automatically connect. | | [config.host] | string | "'127.0.0.1'" | Host running LIRC. | | [config.port] | number | 8765 | Port of running LIRC daemon. | | [config.path] | string | | Path to LIRC socket. | | [config.reconnect] | boolean | true | Automatically reconnect. | | [config.reconnect_delay] | number | 5000 | Delay when reconnecting. | ### lirc.send() ⇒ Promise.<array.<string>> Send a command. **Kind**: instance method of [Lirc](#Lirc) **Returns**: Promise.<array.<string>> - Resulting response from LIRC daemon. | Param | Type | Description | | --- | --- | --- | | ...args | string | Command to send, or individual parameters. | ### lirc.sendOnce(remote, button, [repeat]) ⇒ Promise.<array.<string>> Tell LIRC to emit a button press. **Kind**: instance method of [Lirc](#Lirc) **Returns**: Promise.<array.<string>> - Response from LIRC. | Param | Type | Description | | --- | --- | --- | | remote | string | Remote name. | | button | string | Button name. | | [repeat] | number | Number of times to repeat. | ### lirc.sendStart(remote, button) ⇒ Promise.<array.<string>> Tell LIRC to start emitting button presses. **Kind**: instance method of [Lirc](#Lirc) **Returns**: Promise.<array.<string>> - Response from LIRC. | Param | Type | Description | | --- | --- | --- | | remote | string | Remote name. | | button | string | Button name. | ### lirc.sendStop(remote, button) ⇒ Promise.<array.<string>> Tell LIRC to stop emitting a button press. **Kind**: instance method of [Lirc](#Lirc) **Returns**: Promise.<array.<string>> - Response from LIRC. | Param | Type | Description | | --- | --- | --- | | remote | string | Remote name. | | button | string | Button name. | ### lirc.list([remote]) ⇒ Promise.<array.<string>> If a remote is supplied, list available buttons for remote, otherwise return list of remotes. **Kind**: instance method of [Lirc](#Lirc) **Returns**: Promise.<array.<string>> - Response from LIRC. | Param | Type | Description | | --- | --- | --- | | [remote] | string | Remote name. | ### lirc.version() ⇒ Promise.<array.<string>> Get LIRC version from server. **Kind**: instance method of [Lirc](#Lirc) **Returns**: Promise.<array.<string>> - Response from LIRC. ### lirc.connect() ⇒ Promise Connect to a running LIRC daemon. **Kind**: instance method of [Lirc](#Lirc) **Returns**: Promise - Resolves upon connection to server. ### lirc.disconnect() ⇒ Promise Disconnect from LIRC daemon and clean up socket. **Kind**: instance method of [Lirc](#Lirc) **Returns**: Promise - Resolves upon disconnect.