https://github.com/hhromic/lirc-midi-node

A very simple LIRC to MIDI bridge program for Node.js
https://github.com/hhromic/lirc-midi-node

Last synced: 12 days ago
JSON representation

A very simple LIRC to MIDI bridge program for Node.js

• Host: GitHub
• URL: https://github.com/hhromic/lirc-midi-node
• Owner: hhromic
• License: apache-2.0
• Created: 2014-10-05T12:06:10.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-04-13T13:32:09.000Z (over 9 years ago)
• Last Synced: 2024-04-29T07:03:19.157Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 180 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
lirc-midi-node

==============

A very simple LIRC to MIDI bridge program for Node.JS.

Installation

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

To install, use ```npm```:

```shell

$ npm install -g lirc-midi-node

```

Usage

-----

This simple program maps LIRC remote/buttons into MIDI messages that are later sent to any compatible MIDI output port. The program accepts two arguments:

```shell

$ lircmidi -l  -o  -m 

```

* ```lircdSocketPath``` is the path to the UNIX socket that LIRCd is writing to.

* ```midiOutputPort``` is the MIDI output port index to use for MIDI messages output.

* ```mappingsConfig``` is the IR remotes to MIDI messages mappings configuration file in JSON format.

**Example:**

```shell

$ lircmidi -l /var/run/lirc/lircd -o 0 -m examples/mappings.json

[2015-04-08 02:31:14.099] [INFO] main - opened MIDI output: Midi Through 14:0

[2015-04-08 02:31:14.297] [INFO] main - connected to LIRCd: /var/run/lirc/lircd

```

IR remotes to MIDI messages Mappings Configuration

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

The LIRC remotes/buttons to MIDI messages mappings must be configured in a JSON file with the following format (see the included ```examples/mappings.json``` example file):

```json

{

  "REMOTE1_NAME": {

    "KEY1_NAME": [144, 60, 127],

    "KEY2_NAME": [193, 5]

  },

  "REMOTE2_NAME": {

    "KEY1_NAME": [145, 63, 64]

  }

}

```

All the remote and button names used in this file must be configured in the ```lircd.conf``` file of LIRC. MIDI messages are represented using variable-length arrays of bytes to send.