homeAssistant.json•8.97 kB
{
"nodeType": "n8n-nodes-base.homeAssistant",
"displayName": "Home Assistant",
"description": "Consume Home Assistant API",
"version": 1,
"properties": [
{
"name": "cameraEntityId",
"displayName": "Camera Entity Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"operation": [
"getScreenshot"
],
"resource": [
"cameraProxy"
]
}
}
},
{
"name": "binaryPropertyName",
"displayName": "Put Output File in Field",
"type": "string",
"default": "data",
"required": true,
"displayOptions": {
"show": {
"operation": [
"getScreenshot"
],
"resource": [
"cameraProxy"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "getScreenshot",
"description": "Get the camera screenshot",
"options": [
{
"name": "Get Screenshot",
"value": "getScreenshot",
"description": "Get the camera screenshot"
}
],
"displayOptions": {
"show": {
"resource": [
"cameraProxy"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"operation": [
"getAll"
],
"resource": [
"event"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 50,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 100
},
"displayOptions": {
"show": {
"operation": [
"getAll"
],
"resource": [
"event"
],
"returnAll": [
false
]
}
}
},
{
"name": "eventType",
"displayName": "Event Type",
"type": "string",
"default": "",
"description": "The Entity ID for which an event will be created",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"event"
]
}
}
},
{
"name": "eventAttributes",
"displayName": "Event Attributes",
"type": "fixedCollection",
"default": {},
"description": "Name of the attribute",
"placeholder": "Add Attribute",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"event"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "The end of the period",
"placeholder": "Add Field",
"options": [
{
"name": "endTime",
"displayName": "End Time",
"type": "dateTime",
"default": "",
"description": "The end of the period"
},
{
"name": "entityIds",
"displayName": "Entity IDs",
"type": "string",
"default": "",
"description": "The entities IDs separated by comma"
},
{
"name": "minimalResponse",
"displayName": "Minimal Response",
"type": "boolean",
"default": false,
"description": "Whether to only return <code>last_changed</code> and state for states"
},
{
"name": "significantChangesOnly",
"displayName": "Significant Changes Only",
"type": "boolean",
"default": false,
"description": "Whether to only return significant state changes"
},
{
"name": "startTime",
"displayName": "Start Time",
"type": "dateTime",
"default": "",
"description": "The beginning of the period"
}
],
"displayOptions": {
"show": {
"resource": [
"history"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "domain",
"displayName": "Domain Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"resource": [
"service"
],
"operation": [
"call"
]
}
}
},
{
"name": "service",
"displayName": "Service Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"resource": [
"service"
],
"operation": [
"call"
]
}
}
},
{
"name": "serviceAttributes",
"displayName": "Service Attributes",
"type": "fixedCollection",
"default": {},
"description": "Name of the field",
"placeholder": "Add Attribute",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"service"
],
"operation": [
"call"
]
}
}
},
{
"name": "entityId",
"displayName": "Entity Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"operation": [
"get"
],
"resource": [
"state"
]
}
}
},
{
"name": "state",
"displayName": "State",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"state"
],
"operation": [
"upsert"
]
}
}
},
{
"name": "stateAttributes",
"displayName": "State Attributes",
"type": "fixedCollection",
"default": {},
"description": "Name of the attribute",
"placeholder": "Add Attribute",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"state"
],
"operation": [
"upsert"
]
}
}
},
{
"name": "template",
"displayName": "Template",
"type": "string",
"default": "",
"description": "Render a Home Assistant template. <a href=\"https://www.home-assistant.io/docs/configuration/templating/\">See template docs for more information.</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"template"
],
"operation": [
"create"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "config",
"options": [
{
"name": "Camera Proxy",
"value": "cameraProxy"
},
{
"name": "Config",
"value": "config"
},
{
"name": "Event",
"value": "event"
},
{
"name": "Log",
"value": "log"
},
{
"name": "Service",
"value": "service"
},
{
"name": "State",
"value": "state"
},
{
"name": "Template",
"value": "template"
}
]
}
],
"credentialsConfig": [
{
"name": "homeAssistantApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}