Home Assistant

Node: homeAssistant · Full type: n8n-nodes-base.homeAssistant · Version: 1

Credentials

homeAssistantApi (alias: @home)

CREDENTIAL @home = homeAssistantApi "My Home Assistant"

Operations

Resource: cameraProxy

getScreenshot

Parameter	Type	Default	Details
cameraEntityId	options	""	required
binaryPropertyName	string	"data"	required

Resource: config

get

No additional parameters.

check

No additional parameters.

Resource: event

create

Parameter	Type	Default	Details
eventType	string	""	required
eventAttributes	fixedCollection	{}	groups: attributes

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50

Resource: log

getErroLogs

No additional parameters.

getLogbookEntries

Parameter	Type	Default	Details
additionalFields	collection	{}	keys: endTime, entityId, startTime

Resource: service

call

Parameter	Type	Default	Details
domain	options	""	required
service	options	""	required
serviceAttributes	fixedCollection	{}	groups: attributes

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50

Resource: state

upsert

Parameter	Type	Default	Details
entityId	options	""	required
state	string	""	required
stateAttributes	fixedCollection	{}	groups: attributes

get

Parameter	Type	Default	Details
entityId	options	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50

Resource: template

create

Parameter	Type	Default	Details
template	string	""	required

Parameter Details

eventAttributes children:

attributes group:

Parameter	Type	Default	Details
name	string	""
value	string	""

additionalFields children:

Parameter	Type	Default	Details
endTime	dateTime	""
entityIds	string	""
minimalResponse	boolean	false
significantChangesOnly	boolean	false
startTime	dateTime	""

serviceAttributes children:

attributes group:

Parameter	Type	Default	Details
name	string	""
value	string	""

stateAttributes children:

attributes group:

Parameter	Type	Default	Details
name	string	""
value	string	""

Example

NODE "homeAssistant" @home AS "Home Assistant" {
  resource: "cameraProxy",
  operation: "get",
  binaryPropertyName: {{ $json.binaryPropertyName }},
  eventType: {{ $json.eventType }},
  state: {{ $json.state }}
}