Documentation

I’ve been thinking of ways I can contribute to this project - and I’m wondering if there would be much benefit to have a place to keep examples.

I’m thinking to create some example flows to share either in the docs or on the wiki page. These would include an example of each service type with inject and debug nodes on either side so users can easily see how things can be put together and what the format is for things.

I know that sending {“foo”:“bar”} will list options in the debug but it’s not always straightforward from there to see how things actually work. Additionally there is little information on how to use characteristic properties. Eventually this will likely be helpful for the coming combined services (I.e. adding battery level to another item).

A quick example of what I’m thinking is here - I would include a screenshot and a copyable flow for the user to then adapt to their setup.

[{"id":"ed2d8340.e1d5d8","type":"homekit-service","z":"7b43483c.39305","bridge":"d334490b.40dac","name":"Example Switch","serviceName":"Switch","topic":"","manufacturer":"Default Manufacturer","model":"Default Model","serialNo":"Default Serial Number","characteristicProperties":"{}","x":360,"y":160,"wires":[["5844674e.178708"]]},{"id":"8db975bc.c2e9d","type":"inject","z":"7b43483c.39305","name":"On","topic":"","payload":"{\"On\":\"true\"}","payloadType":"json","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":130,"y":120,"wires":[["ed2d8340.e1d5d8"]]},{"id":"5844674e.178708","type":"debug","z":"7b43483c.39305","name":"HomeKit Out","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":550,"y":160,"wires":[]},{"id":"629771.da7c409","type":"inject","z":"7b43483c.39305","name":"Off","topic":"","payload":"{\"On\":\"false\"}","payloadType":"json","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":130,"y":180,"wires":[["ed2d8340.e1d5d8"]]},{"id":"d334490b.40dac","type":"homekit-bridge","z":"","bridgeName":"Example Bridge","pinCode":"111-11-111","port":"","allowInsecureRequest":false,"manufacturer":"Default Manufacturer","model":"Default Model","serialNo":"Default Serial Number"}]

I don’t know about everyone else but something like this would have gotten me going much quicker when I first picked up this node.

Any input about where to put this documentation or what could be added will be helpful, I’ll be working on it in the coming weeks. We can use this issue as a discussion of how things should look.

[crxporter]

Hello all. I discovered something interesting today.

For a long time I’ve been scaling insteon values (brightness range 1-255) over to homekit values (brightness 0-100) and back.

I learned today that if your characteristic properties looks like:

{
    "Brightness": {
        "maxValue":255
    }
}

That homekit will use the 0-255 values.

Similarly for my new zwave devices, the scale is 0-99 where 0 is off and 99 is full bright.

Properties look like:

{
    "Brightness": {
        "maxValue":99
    }
}

This also works for minvalue. Hopefully this will be useful to someone, my next examples in the wiki page will include this once I’ve got things settled on my zwave setup.

[caitken-com]

I wrote this, http://auto.caitken.com/posts/2018/09/09/nodered-homekit-reference, last year for the original node-red homekit plugin. It documents Services and their required or optional Characteristics. I’d be happy to contribute the missing docs here?