README.markdown

homebridge-jmri

A Homebridge plugin for controlling a model railroad through JMRI.

Requirements

• A DCC equipped model railroad.
• JMRI
• Requires the JMRI JSON Servlet websocket server to be running.
• JMRI requires a DCC "command station" to control the train state. I used a SPROG DCC Programmer and Command Station.

Some background on this project

I am not a model train guy.

So, why do this?

• I enjoy creating software to make things do what you would not expect possible.
• I ran across the Homebridge project one day.
• I thought it would be interesting to control a model train with Siri.
  • "Hey Siri, turn on my railroad."
  • "Hey Siri, set my railroad speed to 38%."
  • "Hey Siri, turn on the inside track."
  • and many other fun commands.

Example Homebridge Configuration

"accessories": [
         {
           "accessory": "JMRI",
           "name": "Railroad",
           "host": "jmri.local.net:12080",
           "EngineLongName": "Yellow Train",
		   "EngineAddress": "3",
           "Turnouts": [{"id":"ST1","state":0},{"id":"ST2","state":0}]
         }
       ]