Quick Start

Welcome to the NRCHKB wiki!

This wiki will be used to share examples so that users may see how this plugin functions and to get started more easily with copyable flows for each HomeKit service. This page will assume you are familiar with Node-RED basics.

For new users, please start with the official Node-RED docs before continuing.

Nodes#

A Node is the basic building block of a flow. Nodes are triggered by either receiving a message from the previous node in a flow or by waiting for some external event, such as state change of the light or some automated logic. They process that message, or event, and then may send a message to the next nodes in the flow.

A node can have at most one input port and as many output ports as it requires.

Currently, we have two nodes:

Service Node#

Service Node mostly represents Service which will appear in Apple Home.app. It is our main building block for creating interaction between house, application, and our other systems.

Host Node#

Host Node is our configuration node. It is either Bridge or Standalone Accessory. It will be used to pair (connect) our virtual device in Apple Home.app.

Demo Setup#

Once you have Node-RED running, head over to the Demo Setup page for the easiest demo setup we can provide. This is the setup we use for testing new releases - the demos can be copied directly into Node-RED and added to HomeKit.

How to Install#

If you want to install the NRCHKB node, follow the steps below.

1. In the Node-RED UI, click on the menu at the top right.
2. Go to Manage Palette and click on Install.
3. Research node-red-contrib-homekit-bridged and click Install.

Contribution#

If you wish to contribute to our wiki then head here and read our guidelines.

Edit this page on GitHub