hub.gateway.added

This broadcast is sent when a gateway is newly registered on the hub. This usually occurs after a plugin has been installed which provides the gateway.

Result
Example

Edit

Field	Type	Required	Description
_id	string	+	A string of text which uniquely identifies the gateway on the network.
label	string	+	The public name of the gateway
name	string	+	a name specified within a plugin’s config which provides this gateway
pluginId	string	+	The name of the plugin that provided the gateway. This is not a database’s id.
reason	string	+	States why a device is not ready if ‘ready’= false.
ready	bool	+	States whether or not the gateway is available for work.
unreachableActions	object	–
unreachableReasons	object	–
operations	object	+	Actions from a gateway external API
settings	object	+	A section with custom setting templates for the gateway
setItemValueCommand	string	+

Edit

{
  "id": "ui_broadcast",
  "msg_subclass": "hub.gateway.added",
  "result": {
    "_id": "588b7eb528b12d03be86f36f",
    "label": "ZWave",
    "name": "zwave",
    "pluginId": "zwave",
    "reason": "Start bus"
    "ready": true,
    "unreachableActions": [],
    "unreachableReasons": [],
    "operations":{
        "deviceAdding":"ZWAVE:/start_include.template",
        "deviceRemoving":"ZWAVE:/start_exclude.template"
        "deviceSettings":[
            {
                "label":"Parameters",
                "template":"ZWAVE:/device/parameters_page.template"
            },
            {
                "label":"Advanced",
                "template":"ZWAVE:/device/advanced_page.template"
            }
        ],
    },
    "settings": [
        {
            "label":"General",
            "template":"ZWAVE:/settings/general_page.template"
        },
        {
            "label":"Advanced",
            "template":"ZWAVE:/settings/advanced_page.template"
        },
    ],
    "setItemValueCommand": "HUB:zwave/scripts/set_item_value"
  }
}JSON