@epdoc/node-red-hassio

THIS PROJECT IS STILL IN DEVELOPMENT AND SHOULD NOT BE USED IN PRODUCTION. All APIs and documentation are subject to change.

Custom Nodes for Home Assistant in Node-RED

Developer Notes

Notes on developing and installation for Node-RED

npm install -g gulp-cli
git clone @epdoc/node-red-hassio
cd node-red-hassio
npm install
npm test
npm run build

Although these nodes are for use with Home Assistant, they do not interface with Home Assistant directly. This is because it was hard enough writing these nodes as is, and without proper documentation on talking to Home Assistant or communicating between Editor UI and underlying services, I wasn't ready to take on this task.

Standing up a Node-RED Instance

If Node-RED isn't installed, install it and get it running as follows:

sudo npm install -g --unsafe-perm node-red@latest

cd ~/.node-red
npm install

pm2 start node-red
pm2 stop node-red

You can add these scripts to package.json

  "scripts": {
    "start": "pm2 start node-red",
    "restart": "pm2 restart node-red",
    "stop": "pm2 stop node-red",
    "logstart": "pm2 stop node-red && pm2 flush node-red && pm2 start node-red && pm2 log node-red",
  }

Custom Nodes

Fan Control Node

A custom node for controlling a fan, includes the ability to set the speed of the fan after the fan has been turned on. This allows for a separate fan on/off switch and speed control service.

See the fan help page.

Ping Test Node

See the ping help page.

Location History Node

See the location history help page.

Appendix

TODO

• Learn how to communicate between the editor UI and underlying services to, for example, get the list of fans that is available in global context.
• Directly implement home assistant calls to do things like retrieve the list of fans