├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── config.js
├── index.js
├── package.json
└── test.js


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | .idea
3 | .nyc_output
4 | coverage


--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | test.js
2 | .travis.yml
3 | .gitignore
4 | .nyc_output
5 | coverage
6 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 |   - '6'
4 | before_install:
5 |   - sudo apt-add-repository ppa:mosquitto-dev/mosquitto-ppa -y
6 |   - sudo apt-get update -y
7 |   - sudo apt-get install mosquitto -y
8 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) Sebastian Raff <hq@ccu.io> (https://hobbyquaker.github.io)
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # lirc2mqtt
 2 | 
 3 | [![mqtt-smarthome](https://img.shields.io/badge/mqtt-smarthome-blue.svg)](https://github.com/mqtt-smarthome/mqtt-smarthome)
 4 | [![NPM version](https://badge.fury.io/js/lirc2mqtt.svg)](http://badge.fury.io/js/lirc2mqtt)
 5 | [![Dependency Status](https://img.shields.io/gemnasium/hobbyquaker/lirc2mqtt.svg)](https://gemnasium.com/github.com/hobbyquaker/lirc2mqtt)
 6 | [![Build Status](https://travis-ci.org/hobbyquaker/lirc2mqtt.svg?branch=master)](https://travis-ci.org/hobbyquaker/lirc2mqtt)
 7 | [![Coverage Status](https://coveralls.io/repos/github/hobbyquaker/lirc2mqtt/badge.svg?branch=master)](https://coveralls.io/github/hobbyquaker/lirc2mqtt?branch=master)
 8 | [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
 9 | [![License][mit-badge]][mit-url]
10 | 
11 | This is an interface that connects [LIRC](www.lirc.org) to MQTT.
12 | 
13 | 
14 | ## Getting started
15 | 
16 | * Prerequisites
17 |     * [Node.js](www.nodejs.org) >= 6. 
18 |     * lircd started with --listen option.
19 | 
20 | * Install    
21 | `sudo npm install -g lirc2mqtt`
22 | 
23 | 
24 | * Start    
25 | `lirc2mqtt --help`
26 | 
27 | 
28 | ## Topics and Payloads
29 | 
30 | ### Receive
31 | 
32 | `lirc/status/<remote>/<button>`
33 | 
34 | Payload is the repeat counter.
35 | 
36 | 
37 | ### Send
38 | 
39 | `lirc/set/<remote>/<button>`
40 | 
41 | Payload can be one of:
42 | 
43 | * Empty (single button press)
44 | * `START` or `STOP` (start/stop continuous button press)
45 | * An integer number (repeat count)
46 | 
47 | 
48 | ## License
49 | 
50 | MIT © [Sebastian Raff](https://github.com/hobbyquaker)
51 | 
52 | [mit-badge]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat
53 | [mit-url]: LICENSE
54 | 


--------------------------------------------------------------------------------
/config.js:
--------------------------------------------------------------------------------
 1 | const config = require('yargs')
 2 |     .usage('Usage: $0 [options]')
 3 |     .describe('v', 'possible values: "error", "warn", "info", "debug"')
 4 |     .describe('n', 'instance name. used as mqtt client id and as prefix for connected topic')
 5 |     .describe('u', 'mqtt broker url. See https://github.com/mqttjs/MQTT.js#connect-using-a-url')
 6 |     .describe('l', 'lircd host')
 7 |     .describe('p', 'lircd port')
 8 |     .describe('h', 'show help')
 9 |     .alias({
10 |         h: 'help',
11 |         n: 'name',
12 |         u: 'url',
13 |         v: 'verbosity',
14 |         l: 'lirc-host',
15 |         p: 'lirc-port'
16 |     })
17 |     .default({
18 |         u: 'mqtt://127.0.0.1',
19 |         n: 'lirc',
20 |         v: 'info',
21 |         l: '127.0.0.1',
22 |         p: 8765,
23 |         i: 60
24 |     })
25 |     .version()
26 |     .help('help')
27 |     .argv;
28 | 
29 | module.exports = config;
30 | 


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env node
  2 | 
  3 | const Mqtt = require('mqtt');
  4 | const Lirc = require('lirc-client');
  5 | const log = require('yalm');
  6 | const pkg = require('./package.json');
  7 | const config = require('./config.js');
  8 | 
  9 | log.setLevel(config.v);
 10 | 
 11 | log.info(pkg.name + ' ' + pkg.version + ' starting');
 12 | 
 13 | let lircConnected;
 14 | 
 15 | log.info('lirc trying to connect on ' + config.lircHost + ':' + config.lircPort);
 16 | 
 17 | const lirc = new Lirc({
 18 |     host: config.lircHost,
 19 |     port: config.lircPort
 20 | });
 21 | 
 22 | if (typeof config.topic !== 'string') {
 23 |     config.topic = '';
 24 | }
 25 | if (config.topic !== '' && !config.topic.match(/\/$/)) {
 26 |     config.topic += '/';
 27 | }
 28 | 
 29 | let mqttConnected;
 30 | 
 31 | log.info('mqtt trying to connect', config.url);
 32 | const mqtt = Mqtt.connect(config.url, {will: {topic: config.name + '/connected', payload: '0'}});
 33 | 
 34 | mqtt.on('connect', () => {
 35 |     mqttConnected = true;
 36 |     log.info('mqtt connected ' + config.url);
 37 |     mqtt.publish(config.name + '/connected', lircConnected ? '2' : '1');
 38 |     log.info('mqtt subscribe', config.name + '/set/#');
 39 |     mqtt.subscribe(config.name + '/set/+/+');
 40 | });
 41 | 
 42 | mqtt.on('close', () => {
 43 |     if (mqttConnected) {
 44 |         mqttConnected = false;
 45 |         log.info('mqtt closed ' + config.url);
 46 |     }
 47 | });
 48 | 
 49 | mqtt.on('error', err => {
 50 |     log.error('mqtt', err);
 51 | });
 52 | 
 53 | lirc.on('connect', () => {
 54 |     log.info('lirc connected');
 55 |     lircConnected = true;
 56 |     mqtt.publish(config.name + '/connected', '2');
 57 | });
 58 | 
 59 | lirc.on('disconnect', () => {
 60 |     if (lircConnected) {
 61 |         log.info('lirc connection closed');
 62 |         lircConnected = false;
 63 |         mqtt.publish(config.name + '/connected', '1');
 64 |     }
 65 | });
 66 | 
 67 | lirc.on('error', err => {
 68 |     log.error('lirc', err);
 69 | });
 70 | 
 71 | lirc.on('receive', (remote, command, repeats) => {
 72 |     log.debug('receive', remote, command, repeats);
 73 |     const topic = config.n + '/status/' + remote + '/' + command;
 74 |     let payload;
 75 |     if (config.json) {
 76 |         payload = JSON.stringify({
 77 |             val: parseInt(repeats, 10)
 78 |         });
 79 |     } else {
 80 |         payload = String(parseInt(repeats, 10));
 81 |     }
 82 |     log.debug('mqtt >', topic, payload);
 83 |     mqtt.publish(topic, payload);
 84 | });
 85 | 
 86 | mqtt.on('message', (topic, payload) => {
 87 |     payload = payload.toString();
 88 |     log.debug('mqtt <', topic, payload);
 89 | 
 90 |     if (!lircConnected) {
 91 |         log.error('lirc disconnected. can\'t send command.');
 92 |         return;
 93 |     }
 94 | 
 95 |     const [, , remote, key] = topic.split('/');
 96 |     let repeats = 0;
 97 |     let cmd = 'SEND_ONCE';
 98 | 
 99 |     if (payload.toUpperCase() === 'START') {
100 |         cmd = 'SEND_START';
101 |     } else if (payload.toUpperCase() === 'STOP') {
102 |         cmd = 'SEND_STOP';
103 |     } else if (payload) {
104 |         repeats = parseInt(payload, 10) || 0;
105 |     }
106 | 
107 |     if (repeats) {
108 |         lirc.cmd(cmd, remote, key, repeats, () => {
109 |             log.debug('lirc >', cmd, remote, key, repeats);
110 |         });
111 |     } else {
112 |         lirc.cmd(cmd, remote, key, () => {
113 |             log.debug('lirc >', cmd, remote, key);
114 |         });
115 |     }
116 | });
117 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "lirc2mqtt",
 3 |   "description": "Connect LIRC to MQTT",
 4 |   "author": "Sebastian Raff <hq@ccu.io> (https://github.com/hobbyquaker)",
 5 |   "license": "MIT",
 6 |   "version": "1.1.1",
 7 |   "engines": {
 8 |     "node": ">=6.0.0"
 9 |   },
10 |   "engineStrict": true,
11 |   "preferGlobal": true,
12 |   "bin": "./index.js",
13 |   "dependencies": {
14 |     "lirc-client": "^1.0.0",
15 |     "mqtt": "^2.8.2",
16 |     "yalm": "^4.0.2",
17 |     "yargs": "^8.0.2"
18 |   },
19 |   "keywords": [
20 |     "mqtt",
21 |     "smarthome",
22 |     "iot",
23 |     "lirc",
24 |     "infrared",
25 |     "remote",
26 |     "control"
27 |   ],
28 |   "repository": "https://github.com/hobbyquaker/lirc2mqtt",
29 |   "scripts": {
30 |     "test": "camo-purge ; xo --space 4 --ignore test.js && nyc mocha test.js && nyc report --reporter=text-lcov | coveralls --force"
31 |   },
32 |   "devDependencies": {
33 |     "camo-purge": "latest",
34 |     "coveralls": "latest",
35 |     "lirc-simulator": "latest",
36 |     "mocha": "latest",
37 |     "nyc": "latest",
38 |     "should": "latest",
39 |     "stream-splitter": "latest",
40 |     "xo": "latest"
41 |   }
42 | }
43 | 


--------------------------------------------------------------------------------
/test.js:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env node
  2 | 
  3 | require('should');
  4 | 
  5 | const cp = require('child_process');
  6 | const path = require('path');
  7 | const streamSplitter = require('stream-splitter');
  8 | const Mqtt = require('mqtt');
  9 | mqtt = Mqtt.connect('mqtt://127.0.0.1');
 10 | 
 11 | const simCmd = path.join(__dirname, '/node_modules/lirc-simulator/index.js');
 12 | const simArgs = [];
 13 | let sim;
 14 | let simPipeOut;
 15 | let simPipeErr;
 16 | const simSubscriptions = {};
 17 | const simBuffer = [];
 18 | 
 19 | const lircCmd = path.join(__dirname, '/index.js');
 20 | const lircArgs = ['-v', 'debug'];
 21 | let lirc;
 22 | let lircPipeOut;
 23 | let lircPipeErr;
 24 | const lircSubscriptions = {};
 25 | const lircBuffer = [];
 26 | 
 27 | let subIndex = 0;
 28 | 
 29 | const mqttSubscriptions = {};
 30 | function mqttSubscribe(topic, callback) {
 31 |     if (mqttSubscriptions[topic]) {
 32 |         mqttSubscriptions[topic].push(callback);
 33 |     } else {
 34 |         mqttSubscriptions[topic] = [callback];
 35 |         mqtt.subscribe(topic);
 36 |     }
 37 | }
 38 | mqtt.on('message', (topic, payload) => {
 39 |     if (mqttSubscriptions[topic]) {
 40 |         mqttSubscriptions[topic].forEach(callback => {
 41 |             callback(payload.toString());
 42 |         });
 43 |     }
 44 | });
 45 | 
 46 | function subscribe(type, rx, cb) {
 47 |     subIndex += 1;
 48 |     if (type === 'sim') {
 49 |         simSubscriptions[subIndex] = {rx, cb};
 50 |     } else if (type === 'lirc') {
 51 |         lircSubscriptions[subIndex] = {rx, cb};
 52 |     }
 53 |     matchSubscriptions(type);
 54 |     return subIndex;
 55 | }
 56 | 
 57 | function unsubscribe(type, subIndex) {
 58 |     if (type === 'sim') {
 59 |         delete simSubscriptions[subIndex];
 60 |     } else if (type === 'lirc') {
 61 |         delete lircSubscriptions[subIndex];
 62 |     }
 63 | }
 64 | 
 65 | function matchSubscriptions(type, data) {
 66 |     let subs;
 67 |     let buf;
 68 |     if (type === 'sim') {
 69 |         subs = simSubscriptions;
 70 |         buf = simBuffer;
 71 |     } else if (type === 'lirc') {
 72 |         subs = lircSubscriptions;
 73 |         buf = lircBuffer;
 74 |     }
 75 |     if (data) {
 76 |         buf.push(data);
 77 |     }
 78 |     buf.forEach((line, index) => {
 79 |         Object.keys(subs).forEach(key => {
 80 |             const sub = subs[key];
 81 |             if (line.match(sub.rx)) {
 82 |                 sub.cb(line);
 83 |                 delete subs[key];
 84 |                 buf.splice(index, 1);
 85 |             }
 86 |         });
 87 |     });
 88 | }
 89 | 
 90 | function startLirc() {
 91 |     lirc = cp.spawn(lircCmd, lircArgs);
 92 |     lircPipeOut = lirc.stdout.pipe(streamSplitter('\n'));
 93 |     lircPipeErr = lirc.stderr.pipe(streamSplitter('\n'));
 94 |     lircPipeOut.on('token', data => {
 95 |         console.log('lirc', data.toString());
 96 |         matchSubscriptions('lirc', data.toString());
 97 |     });
 98 |     lircPipeErr.on('token', data => {
 99 |         console.log('lirc', data.toString());
100 |         matchSubscriptions('lirc', data.toString());
101 |     });
102 | }
103 | 
104 | function startSim() {
105 |     sim = cp.spawn(simCmd, simArgs);
106 |     simPipeOut = sim.stdout.pipe(streamSplitter('\n'));
107 |     simPipeErr = sim.stderr.pipe(streamSplitter('\n'));
108 |     simPipeOut.on('token', data => {
109 |         console.log('sim', data.toString());
110 |         matchSubscriptions('sim', data.toString());
111 |     });
112 |     simPipeErr.on('token', data => {
113 |         console.log('sim', data.toString());
114 |         matchSubscriptions('sim', data.toString());
115 |     });
116 | }
117 | 
118 | function end(code) {
119 |     if (lirc.kill) {
120 |         lirc.kill();
121 |     }
122 |     if (sim.kill) {
123 |         sim.kill();
124 |     }
125 |     if (typeof code !== 'undefined') {
126 |         process.exit(code);
127 |     }
128 | }
129 | 
130 | process.on('SIGINT', () => {
131 |     end(1);
132 | });
133 | 
134 | process.on('exit', () => {
135 |     end();
136 | });
137 | 
138 | describe('start daemons', () => {
139 |     it('lirc-simulator should start without error', function (done)  {
140 |         this.timeout(20000);
141 |         subscribe('sim', /listening on 127.0.0.1:8765/, () => {
142 |             done();
143 |         });
144 |         startSim();
145 | 
146 |     });
147 |     it('lirc2mqtt should start without error', function (done) {
148 |         this.timeout(20000);
149 |         subscribe('lirc', /lirc2mqtt [0-9.]+ starting/, () => {
150 |             done();
151 |         });
152 |         startLirc();
153 |     });
154 | });
155 | 
156 | describe('lirc2mqtt - mqtt connection', () => {
157 |     it('lirc2mqtt should connect to the mqtt broker', function (done) {
158 |         this.timeout(12000);
159 |         subscribe('lirc', /mqtt connected/, () => {
160 |             done();
161 |         });
162 |     });
163 | });
164 | 
165 | describe('lirc2mqtt - lirc-simulator connection', () => {
166 |     it('lirc2mqtt should connect to the lirc-simulator', function (done) {
167 |         subscribe('lirc', /lirc connected/, () => {
168 |             done();
169 |         });
170 |     });
171 |     it('lirc-simulator should log the connection from lirc2mqtt', function (done) {
172 |         subscribe('sim', /connect/, () => {
173 |             done();
174 |         });
175 |     });
176 | });
177 | 
178 | describe('lirc-simulator - lirc2mqtt - mqtt', function () {
179 |     this.timeout(15000);
180 |     it('lirc2mqtt should publish on lirc/status/remote1/button1', function (done) {
181 |         mqttSubscribe('lirc/status/remote1/button1', payload => {
182 |             done();
183 |         });
184 |     });
185 |     it('lirc2mqtt should publish 3 times on lirc/status/remote1/button2', function (done) {
186 |         let counter = 0;
187 |         mqttSubscribe('lirc/status/remote1/button2', payload => {
188 |             counter += 1;
189 |             if (counter === 3) {
190 |                 done();
191 |             }
192 |         });
193 |     });
194 | });
195 | 
196 | describe('mqtt - lirc2mqtt - lirc-simulator', function () {
197 |     this.timeout(15000);
198 |     it('lirc-simulator should receive a SEND_ONCE', function (done) {
199 |         subscribe('sim', /SEND_ONCE remote1 button1/, () => {
200 |             done();
201 |         });
202 |         mqtt.publish('lirc/set/remote1/button1', '');
203 |     });
204 |     it('lirc-simulator should receive a SEND_START', function (done) {
205 |         subscribe('sim', /SEND_START remote1 button2/, () => {
206 |             done();
207 |         });
208 |         mqtt.publish('lirc/set/remote1/button2', 'START');
209 |     });
210 |     it('lirc-simulator should receive a SEND_STOP', function (done) {
211 |         subscribe('sim', /SEND_STOP remote1 button2/, () => {
212 |             done();
213 |         });
214 |         mqtt.publish('lirc/set/remote1/button2', 'STOP');
215 |     });
216 |     it('lirc-simulator should receive a SEND_ONCE with repeat count', function (done) {
217 |         subscribe('sim', /SEND_ONCE remote1 button3 3/, () => {
218 |             done();
219 |         });
220 |         mqtt.publish('lirc/set/remote1/button3', '3');
221 |     });
222 | 
223 | });
224 | 
225 | 
226 | describe('disconnect lirc2mqtt - lirc-simulator', () => {
227 |     it('should kill lirc-simulator', () => {
228 |         sim.kill();
229 |     });
230 |     it('should log disconnect', done => {
231 |         subscribe('lirc', /lirc connection closed/, () => {
232 |             done();
233 |         });
234 |     });
235 |     it('lirc2mqtt should log an error when trying to send while disconnected', function (done) {
236 |         subscribe('lirc', /lirc disconnected/, () => {
237 |             done();
238 |         });
239 |         mqtt.publish('lirc/set/remote1/button4', '');
240 |     });
241 | });
242 | 
243 | /* TODO this breaks istanbul. why?
244 | describe('reconnect lirc2mqtt - lirc-simulator', function () {
245 |     this.timeout(7000);
246 |     it('should reconnect after lirc-simulator is restarted', function (done) {
247 |         subscribe('lirc', /lirc connected/, () => {
248 |             done();
249 |         });
250 |         startSim();
251 |     });
252 | });
253 | 
254 | 
255 | describe('cleanup', () => {
256 |     it('should kill lirc2mqtt', () => {
257 |         lirc.kill();
258 |     });
259 | });
260 |  */
261 | 
262 | setTimeout(() => {
263 |     lirc.kill();
264 |     sim.kill();
265 |     process.exit(1);
266 | }, 30000);


--------------------------------------------------------------------------------