search

cflurin / homebridge-mqtt

Homebridge-mqtt is a Plugin for Homebridge.
Apache License 2.0
229 stars 39 forks source link

Documentation update #30

Closed zieherf closed 7 years ago

zieherf commented 7 years ago

@cflurin homebridge-mqtt has come a long way and it is getting more popular on npm as well :-) There are a few points I would like to point out for the documentation:

get accessoy/accessories should read get accessory/accessories (missing 'r')

The response for get accessory/accessories is not correctly described. Instead of the described response in the documentation for homebridge/to/get {"name":"outdoor_temp"}

topic: homebridge/from/response
payload:
{
    "outdoor_temp": {
        "services": {"Temperature": "TemperatureSensor"}, 
        "characteristics": {"CurrentTemperature": "13.4"}
    }
}

it should read

topic: homebridge/from/response
payload:
{
    "outdoor_temp": {
        "services": {"Temperature": "TemperatureSensor"}, 
        "characteristics": {
            "Temperature": {CurrentTemperature": 13.4}
        }
    }
}

and for the response of all accessories 

topic: homebridge/from/response
payload:
{
    "node_switch":{
        "services":{"light":"Switch"},
        "characteristics": {
            "light": {"On":true}
        }
    },
    "office_lamp":{
        "services":{"office_light":"Lightbulb"},
        "characteristics":{
            "office_light": {
                "On":"blank",
                "Brightness":65
            }
        }
    },
    "living_temp":{
        "services":{"living_temperature":"TemperatureSensor"},
        "characteristics":{
            "living_temperature": {"CurrentTemperature":19.6}
        }
    }
}
cflurin commented 7 years ago

@zieherf: Thanks for reporting. I've just updated README on GitHub.