{"action":"created","issue":{"url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged/issues/50","repository_url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged","labels_url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged/issues/50/labels{/name}","comments_url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged/issues/50/comments","events_url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged/issues/50/events","html_url":"https://github.com/NRCHKB/node-red-contrib-homekit-bridged/issues/50","id":416897134,"node_id":"MDU6SXNzdWU0MTY4OTcxMzQ=","number":50,"title":"Documentation","user":{"login":"crxporter","id":38265886,"node_id":"MDQ6VXNlcjM4MjY1ODg2","avatar_url":"https://avatars0.githubusercontent.com/u/38265886?v=4","gravatar_id":"","url":"https://api.github.com/users/crxporter","html_url":"https://github.com/crxporter","followers_url":"https://api.github.com/users/crxporter/followers","following_url":"https://api.github.com/users/crxporter/following{/other_user}","gists_url":"https://api.github.com/users/crxporter/gists{/gist_id}","starred_url":"https://api.github.com/users/crxporter/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/crxporter/subscriptions","organizations_url":"https://api.github.com/users/crxporter/orgs","repos_url":"https://api.github.com/users/crxporter/repos","events_url":"https://api.github.com/users/crxporter/events{/privacy}","received_events_url":"https://api.github.com/users/crxporter/received_events","type":"User","site_admin":false},"labels":[{"id":900361874,"node_id":"MDU6TGFiZWw5MDAzNjE4NzQ=","url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged/labels/good%20first%20issue","name":"good first issue","color":"7057ff","default":true},{"id":900361873,"node_id":"MDU6TGFiZWw5MDAzNjE4NzM=","url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged/labels/help%20wanted","name":"help wanted","color":"008672","default":true}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":109,"created_at":"2019-03-04T16:56:39Z","updated_at":"2019-05-28T18:19:08Z","closed_at":null,"author_association":"MEMBER","body":"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.\r\n\r\nI'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.\r\n\r\nI 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).\r\n\r\nA 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.\r\n\r\n![screen shot 2019-03-04 at 10 54 02 am](https://user-images.githubusercontent.com/38265886/53748875-d3f54480-3e6b-11e9-916f-6bd1fd2b8d8f.png)\r\n\r\n\r\n```\r\n[{\"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\"}]\r\n```\r\n\r\nI don't know about everyone else but something like this would have gotten me going much quicker when I first picked up this node. \r\n\r\nAny 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."},"comment":{"url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged/issues/comments/496631086","html_url":"https://github.com/NRCHKB/node-red-contrib-homekit-bridged/issues/50#issuecomment-496631086","issue_url":"https://api.github.com/repos/NRCHKB/node-red-contrib-homekit-bridged/issues/50","id":496631086,"node_id":"MDEyOklzc3VlQ29tbWVudDQ5NjYzMTA4Ng==","user":{"login":"radokristof","id":36210568,"node_id":"MDQ6VXNlcjM2MjEwNTY4","avatar_url":"https://avatars2.githubusercontent.com/u/36210568?v=4","gravatar_id":"","url":"https://api.github.com/users/radokristof","html_url":"https://github.com/radokristof","followers_url":"https://api.github.com/users/radokristof/followers","following_url":"https://api.github.com/users/radokristof/following{/other_user}","gists_url":"https://api.github.com/users/radokristof/gists{/gist_id}","starred_url":"https://api.github.com/users/radokristof/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/radokristof/subscriptions","organizations_url":"https://api.github.com/users/radokristof/orgs","repos_url":"https://api.github.com/users/radokristof/repos","events_url":"https://api.github.com/users/radokristof/events{/privacy}","received_events_url":"https://api.github.com/users/radokristof/received_events","type":"User","site_admin":false},"created_at":"2019-05-28T18:19:08Z","updated_at":"2019-05-28T18:19:08Z","author_association":"NONE","body":"Hmm, right now it seems that manually overviewing the code is easier than making sth for this... There are not so much accessory yet and most of them are already defined/explained here. Over the next weeks I will have some time to work with this, I will try to add every documentation I can (I also got working the TV accessory with inputs), so we can prepare for new device types (hope that Apple will add new ones in the upcoming iOS release)."}}
{"actor":{"display_login":"radokristof"}}