node-red-contrib-domotz

A collection of Node-Red nodes to access the Domotz public API

Usage no npm install needed!

<script type="module">
  import nodeRedContribDomotz from 'https://cdn.skypack.dev/node-red-contrib-domotz';
</script>

README

Node Red Domotz

This node helps performing API calls to the Domotz Public API. API parameters can be set in the configuration section or via node's input. The node automatically converts url and query parameters.

Inputs

An optional payload with the operation's parameters, e.g.:

{"params": {"agent_id": "xyz"}}

Static parameters can be alternatively defined in the configuration of the node. Required parameters are marked with an *. Using the "Browse" option you can select agents, devices and sensors by name (note that this feature will use some of your API budged to retrieve the necessary resources).

Outputs

  • Output:
    • payload.code: The HTTP code
    • payload.message: the payload of the HTTP response
    • payload.headers: the HTTP response headers
    • payload.configParams: the configuration parameters of the node
    • payload.inputParams: the input parameters of the node
  • Errors:
    • payload.code: The HTTP error code
    • payload.message: The HTTP response content

References

Domotz Developers - Domotz API Documentation

Domotz Portal - subscribe and get an API-Key

Domotz Website

Screenshots

Node configuration

Flow example

Visualization (with node red dashboard)