Skip to contentpackage
lirc-client
v2.0.0Connect to LIRC Daemon (Infrared)
node >=6.12.00 depscjsopen source
- license
- MIT
- deps
- 0
- unpacked
- Unknown
- files
- Unknown
- node
- >=6.12.0
$npm install lirc-client@2.0.0 README
GitHub-flavored package documentation.
downloads
Across all versions, last 30 days.
14weekly+0.0%
75 in 30 days
Oct 16 → Nov 14hover or arrows
compatibility
Runtime metadata.
keywords
Tagged topics.
lirclircdinfraredremotecontrolclient
versions
Latest published Dec 8, 2017
maintainers
Registry package owners.
Node.js module to connect to a LIRC daemon.
BREAKING CHANGE in v2.0 - Promises instead of Callbacks
If you prefer using callbacks or want to use Node < 6.12 you can still install the "old" v1.0:
npm install lirc-client@1.0.0.
Usage
$ npm install lirc-client
const lirc = require('lirc-client')({
host: '127.0.0.1',
port: 8765
});
lirc.on('connect', () => {
lirc.send('VERSION').then(res => {
console.log('LIRC Version', res);
});
lirc.sendOnce('Remote1', 'Key1').catch(error => {
if (error) console.log(error);
});
});
lirc.on('receive', function (remote, button, repeat) {
console.log('button ' + button + ' on remote ' + remote + ' was pressed!');
});
you can also connect to a unix domain socket via path option:
const lirc = require('lirc-client')({
path: '/var/run/lirc/lircd'
});
API
Lirc
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>>
Kind: instance method of Lirc
Returns: Promise.<array.<string>> - Resulting response from LIRC daemon.
| Param | Type | Description |
|---|
| ...args | string | Command to send, or individual parameters. |
Tell LIRC to emit a button press.
Kind: instance method of 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. |
Tell LIRC to start emitting button presses.
Kind: instance method of Lirc
Returns: Promise.<array.<string>> - Response from LIRC.
| Param | Type | Description |
|---|
| remote | string | Remote name. |
| button | string | Button name. |
Tell LIRC to stop emitting a button press.
Kind: instance method of 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
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
Returns: Promise.<array.<string>> - Response from LIRC.
lirc.connect() ⇒ Promise
Connect to a running LIRC daemon.
Kind: instance method of Lirc
Returns: Promise - Resolves upon connection to server.
lirc.disconnect() ⇒ Promise
Disconnect from LIRC daemon and clean up socket.
Kind: instance method of Lirc
Returns: Promise - Resolves upon disconnect.
License