node-red-contrib-tplink
Advanced tools
TP-Link Smart Home Node-Red Nodes
This is a collection of Node-RED nodes that allow you control smart plugs and bulbs from the TP-Link smart home ecosystem.
This is a fork of so inspiring node-red-contrib-tplink-smarthome with added functionality.
Under the hood, each node uses the awesome TP-Link Smart Home API.
Run the following command in the root directory of your Node-RED install
$ npm install node-red-contrib-tplink
or you can use the Palette Manager in Node-RED.
Name - Type in the name of the host manually or keep the default device name
Device IP - Type in the Device IP address manually or press the button to retrieve all locally available plug devices
Poll interval - Interval that is used to poll availability of devices (>500ms / Recommended 5000-10000ms)
Event poll interval - Interval that is used to poll active devices for events (>500ms / Recommended 1000-3000ms)
Payload - The output payload. Types are info, none, string, number, boolean, JSON, and timestamp. Default type is info with a value of getInfo. If set to info, the selected payload command will be fired after completion, and the payload set accordingly. Payload is ignored if the node input is a command or an event.
Debug - If enabled, will output device information to the flow editor debug tab.
payload: Object | string | boolean | array
{
"state": true // true is "on", false is "off", "toggle" or "switch" sets the opposite power state
}
true - Turn on the device.
false - Turn off the device.
toggle - Toggle opposite power state of the device.
switch - Toggle opposite power state of the device. (deprecated)
{
"plug": 1 // whole number corresponding to "Plug" number on power strip. Optional.
"state": true // true is "on", false is "off", "toggle" or "switch" sets the opposite power state
}
{
"brightness": [value 1-100]
}
{
"led": true // true is "on", false is "off"
}
temperature:[value 2700-6500]
Example: Send payload as temperature:5000 to set temperature of the bulb to 5000k.
Hue, Saturation, and Brightness (HSB) support for multicolor bulbs.
{
"hsb": {
"hue": 240,
"saturation": 15,
"brightness": 100
}
}
getInfo - Fetch the device information.
getCloudInfo - Fetch the device information from the cloud.
getQuickInfo - Fetch most popular proprieties, such as username, device consumption, mode, lighting state, and many more. Supports multi-plug.
getMeterInfo - Fetch the current device consumption. Supports multi-plug.
clearEvents - Unsubscribe events.
eraseStats - Clear all the meter statistics. Supports multi-plug.
getMeterEvents - Subscribe to meter information events. Event emits on event polling interval.
getInfoEvents - Subscribe to information events.
getPowerEvents - Subscribe to power on/off events. Event emits on device/plug change.
getPowerUpdateEvents - Subscribe to power on/off events. Event emits on event polling interval.
getInUseEvents - Subscribe to device usage events. Event emits on device/plug change.
getInUseUpdateEvents - Subscribe to device usage events. Event emits on event polling interval.
getOnlineEvents - Subscribe to online/offline events. Event emits on poll interval.
Multiple events can be used as an array via the events property or string separated by "|"..
{
"events": ["getMeterUpdateEvents", "getPowerEvents"]
}
or
"getMeterUpdateEvents|getPowerEvents"
This repo. is (mainly) coded on Node 10.3.0 with Node-RED 0.18.7 on Windows 10 Home Build 17134.81. Runs succesfully in a Raspberry Pi 3 Model B+ on standard Raspbian Stretch's Node 0.10.29 and matching Node-RED.
0.4.3 (2020-06-08)
FAQs
A collection of Node-RED nodes for TP-Link smart-home devices.
We found that node-red-contrib-tplink demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.