odig / homeeup

Use virtual devices in homee. <3

homeeUp

Use virtual devices in homee. <3

(C) 2018, Kevin Dietrich

homeeUp allows you to use virtual devices in the smart home hub homee by exposing them via a simulated Homematic CCU (don't worry - you don't need a physical CCU). homeeUp is based on plugins so feel free to add your own ones by providing pull requests.

Currently it is possible to simulate switches (HM-LC-Sw1-FM) and remote controls (HM-RC-4-2).

How-to

1. Install homeeUp: sudo npm install -g homeeup
2. Create a config.json file using the template below inside your user home: ~/.homeeup/config.json
3. Start it up: LOG=info homeeup
4. Add a new Homematic CCU to homee.

Sample config.js

{
        "hostAddress": "IP_OF_YOUR_DEVICE_RUNNING_HOMEEUP",
        "plugins": [
            {
                "deviceName": "HTTPSwitch",
                "type": "SimpleHTTPPlugin",
                "pluginParams": {
                    "onUrl": "http://www.google.de/on",
                    "offUrl": "http://www.google.de/off"
                }
            },
            {
                "deviceName": "CMDSwitch",
                "type": "SimpleCMDPlugin",
                "pluginParams": {
                    "onCmd": "touch /tmp/file",
                    "offCmd": "rm /tmp/file",
                    "statusCmd": "ls /tmp/file >> /dev/null; echo $?",
                    "checkInterval": 2000
                }
            }
        ]
}

This sample config exposes two switches to homee: HTTPSwitch and CMDSwitch. The former calls a http url when switched on or off. The latter one runs a cmd command when switched on or off. It also has a build in statusCmd that checks if the status has changed (outside of homee) and keeps it up-to-date.

Troubleshooting

Feel free to open an issue if you experience any issues. However please start homeeUp using LOG=debug homeeup to generate debug output and attach it to your issue.

Changes

v0.1.2 (2018-03-23)

• New: MQTT plugin
• New: FRITZ!Box plugin
• Config file is now in json format and stored in user home
• Bugfixes

v0.1.1 (2018-03-21)

• Installation made easier

v0.1.0 (2018-03-21)

• First version

License

The MIT License (MIT)

Copyright (c) 2018 Kevin Dietrich

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.