node-red-contrib-home-assistant-websocket

# Call Service

Sends a request to home assistant for any domain and service available (light/turn_on, input_select/select_option, etc..)

Helpful Examples

Call Service Tips and Tricks

# Configuration

# Domain required

Service domain to call

# Service required

Service service to call

# Entity Id

A comma-delimited list of entity ids.

NOTICE

If entity_id exists in the data property it will have precedence over this value.

# Data

JSON object to pass along.

# Merge Context

  • Type: string

If defined will attempt to merge the global and flow context variable into the config

# Alternative Template Tags

  • Type: boolean

Will change the tags used for mustache template to <% and %>

# Output Location

  • Type: string
  • Default: None

Customizable location for the output of the node.

# Input

All properties need to be under msg.payload.

# Merging

If the incoming message has a payload property with domain, service set it will override any config values if set.

If the incoming message has a payload.data that is an object or parsable into an object these properties will be merged with any config values set.

If the node has a property value in its config for Merge Context then the flow and global contexts will be checked for this property which should be an object that will also be merged into the data payload.

# Merge Resolution

As seen above the data property has a lot going on in the way of data merging, in the end, all of these are optional and the rightmost will win if a property exists in multiple objects

Config Data, Global Data, Flow Data, Payload Data ( payload data property always wins if provided

# domain

  • Type: string

Service domain to call

# service

  • Type: string

Service service to call

# data

  • Type: Object

Service data to send with API call

# Output

All properties will be under what is defined in Output Location in the config.

# domain

  • Type: string

Service domain service was called with

# service

  • Type: string

Service service was called with

# data

  • Type: Object

Service data used in a call, if one was used

# Example of output:

{
  "domain": "light",
  "service": "turn_on",
  "data": {
    "entity_id": "light.kitchen"
  }
}

# Changelog

# Version 1

  • Entity ids are no longer merged with the data property on the front end
  • The data field does not have to be valid JSON until after templates are rendered. This change will allow you to assign numbers to properties as an actual number and not a string using templates.
  • entity_id in the data property will supersede the entity id field
  • Flows exported from version 0.14.0 will lose the entity id when imported into a previous version

← Config Server →