node-red-contrib-shelly 1.10.1

Shelly nodes.

npm install node-red-contrib-shelly

Platform License NPM Known Vulnerabilities Downloads Total Downloads Package Quality Build Open Issues Closed Issues ...

This package contains nodes for controlling shelly devices

Warning

This package is under construction. Right now the following devices are supported

  • shelly switch 1 (PM), 2
  • shelly plug
  • shelly 2.5 (roller shutter)
  • shelly dimmer
  • shelly uni
  • shelly RGBW2
  • shelly motion
  • shelly emeasure (EM)

Others may work but are not really tested so far.

Thanks for your donation

If you want to support this free project. Any help is welcome. You can donate by clicking one of the following links:

Buy Me A Coffee

Credits

  • gerdemann for providing the roller shutter code
  • Gophlin for provider the Dimmer (SL) code
  • minuq for providing pull request for issue #7
  • Paul-Reed for enhancing the dimmer node see issue #21
  • Docjones for providing the skeleton for ShellyRGBW node see pull request #15

Changelog

Changes can be followed here

General

To check if the node is available in the network, a HTTP GET to /shelly is issued. This route returns a type string which is verified. You can configure an interval for the polling. The default is 5000ms. Most node will call HTTP GET to the /status route after a input is received from the node. This answer is directly available at the output via msg.status. The msg.payload property contains a lightweight version of this status object.

Shelly Switch Node

The node is able to turn on and turn off a shelly switch. It outputs the status of all relays after every interaction with the shelly device. Turning on is done by sending the following payload into the input. The relay number is optional and defaults to 0.

{
    relay : 0,
    on : true
}

or you can make use of the alternative notation:

{
    relay : 0,
    turn : "toggle"
}

turn can be one of the following: "toggle", "on", "off"

Right after having sent the request to the shelly device a status request is done. The relays property of the response is output on output 1.

If you only want to get the current status of the switch without turning on or off you should leave the msg.payload blank. This is useful, when you want to poll for the status cyclically.

The output of the node is an array of status objects for every relay of the switch:

[
    {
        ison : true,
        ...
    },
    {
        ison : true,
        ...
    },
]

Shelly Door Node

The node is able to poll a shelly door sensor. It outputs the sensor status together with battery and lux sensor values on every change of the door status. Note that the sensor sleeps when nothing is detected and is thus not accessible via REST.

The output of the node is as follows:

{
    sensor
    {
        state: "close",
        is_valid: true
    },

    lux
    {
        value: 150,
        illumination: "twilight",
        is_valid: true
    },

    bat
    {
        value: 100,
        voltage: 6.01
    }
}

Shelly Roller Shutter Node

A node that controls a shelly roller shutter device (Shelly 2.5). The relay number is optional and defaults to 0. The following object for open or close the roller shutter:

{
    roller : 0,
    go : "open"
}
{
    roller : 0,
    go : "close"
}
{
    roller : 0,
    go : "to_pos",
    roller_pos: 50
}

Right after having sent the request to the shelly device a status request is done. The roller property of the response is output on output 1.

If you only want to get the current status of the switch without turning on or off you should leave the msg.payload blank. This is useful, when you want to poll for the status cyclically.

The output of the node is an array of status objects for every roller of the roller shutter:

[
    {
        state : "open",
        ...
    }
]
[
    {
        state : "close",
        ...
    }
]
[
    {
        state : "open",
        current_pos: 50,
        ...
    }
]

Shelly Dimmer (SL) Node

The node is able to turn on and turn off a shelly dimmer and set its brightness. It outputs the status of all lights after every interaction with the shelly device. Turning on is done by sending the following payload into the input. The light number is optional and defaults to 0. The brightness can be set between 0 and 100.

{
    light : 0,
    on : true,
    brightness: 100
}

Like in the switch node you can replace on with turn and choose a value from the following: "toggle", "on", "off"

You can also control the shelly state and brightness independently.

{
on: true
}

and

{
brightness: 100
}

Right after having sent the request to the shelly device a status request is done. The relays property of the response is output on output 1.
This feature can optionally be disabled by unticking the status checkbox in the node configuration options.

If you only want to get the current status of the dimmer without turning on or off you should leave the msg.payload blank. This is useful, when you want to poll for the status cyclically.

The output of the node is an array of status objects for every light of the dimmer:

[
    {
        ison : true,
        brightness: 100
        ...
    },
    {
        ison : true,
        brightness: 100
        ...
    },
]

Shelly RGBW2 Node

The node is able to control a RGBW LED light strip.

If you only want to get the current status of the dimmer without turning on or off you should leave the msg.payload blank. This is useful, when you want to poll for the status cyclically.

The node accepts the following input

{
    red : 0,
    green : 0,
    blue : 0,
    white : 0,
    gain : 0,
    effect : 1,
    on : true,
    timer : 0
}

red, green, blue, white can be between 0 and 255. gain can be a value between 0 and 100. effect = 0 means no effect. timer can be a value in seconds to flip back on/off

{
    light : 0,
    on : true,
    brightness: 100,
    timer : 0
}

light 0 .. 3 is the number of the strip. brightness can be a value between 0 and 100. timer can be a value in seconds to flip back on/off

Shelly Motion Node

The node is able to poll a shelly motion sensor. It outputs the sensor status together with battery and lux sensor values on every change of the motion status. You can enable two extra outputs which are triggered exclusively only when either motion or vibration is detected.

The output of the node is as follows:

{
    sensor
    {
        motion: true,
        vibration: true,
        timestamp: 12345,
        active: true,
        is_valid: true
    },

    lux
    {
        value: 150,
        illumination: "twilight",
        is_valid: true
    },

    bat
    {
        value: 100,
        voltage: 6.01
    }
}

Shelly EM Node

The node is able to turn on and turn off a relay in a shelly EM node. It outputs the status of all measuring devices and the status of the relay after every interaction with the shelly device. Turning on is done by sending the following payload into the input. The relay number is optional and defaults to 0.

{
    relay : 0,
    on : true
}

or you can make use of the alternative notation:

{
    relay : 0,
    turn : "toggle"
}

turn can be one of the following: "toggle", "on", "off"

Right after having sent the request to the shelly device a status request is done. The relays property of the response is output on output 1.

If you only want to get the current status of the switch without turning on or off you should leave the msg.payload blank. This is useful, when you want to poll for the status cyclically.

The output of the node is an array of status objects for every relay of the switch:

[
    {
        ison : true,
        ...
    },
    {
        ison : true,
        ...
    },
]

The output of the node is as follows:

{
    "relays": [
        {
            "ison": false,
            "has_timer": false,
            "timer_started": 0,
            "timer_duration": 0,
            "timer_remaining": 0,
            "overpower": false,
            "is_valid": true,
            "source": "http"
        }
    ],
    "emeters": [
        {
            "power": 0,
            "reactive": 0,
            "voltage": 0,
            "is_valid": true,
            "total": 0,
            "total_returned": 0
        },
        {
            "power": 0,
            "reactive": 0,
            "voltage": 0,
            "is_valid": true,
            "total": 0,
            "total_returned": 0
        }
    ]
}

Shelly REST API

For a complete documentation see also https://shelly-api-docs.shelly.cloud/#common-http-api

License

Author: Karl-Heinz Wind

The MIT License (MIT) Copyright (c) 2019 by Karl-Heinz Wind

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Node Info

Version: 1.10.1
Updated 1 week, 6 days ago
License: MIT
Rating: 5.0 1

Downloads

276 in the last week

Nodes

  • shelly-switch
  • shelly-door
  • shelly-roller-shutter
  • shelly-dimmer
  • shelly-rgbw2
  • shelly-motion
  • shelly-emeasure

Keywords

  • node-red
  • shelly

Maintainers