Skip to content

friendsincode/node-red-contrib-tplink-smarthome

 
 

Repository files navigation

node-red-contrib-tplink-smarthome

NPM Version

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.

Under the hood, each node uses the awesome TP-Link Smart Home API.

Installation

Run the following command in the root directory of your Node-RED install

$ npm install node-red-contrib-tplink-smarthome

or you can use the Palette Manager in Node-RED.

Parameters

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 retreive all locally available plug devices

Poll interval: Interval that is used to poll availability of devices (min 500ms / recommended between 5000ms and 10000ms)

Event poll interval: Interval that is used to poll active devices for events (min 500ms / recommended between 1000ms and 3000ms)

Inputs

payload: string | boolean

On/Off

true: Turn on the device.

false: Turn off the device.

Brightness

brightness:[value 1-100]

Example: Send payload as brightness:25 to set brightness of the bulb to 25%.

Commands

getInfo: Fetch the device information.

getMeterInfo: Fetch the current device consumption.

clearEvents: Unsubscribe events.

eraseStats: Clear all the meter statistics.

Events

getMeterEvents: Subscribe to meter information events.

getInfoEvents: Subscribe to information events.

getPowerUpdateEvents: Subscribe to power on/off events.

getInUseEvents: Subscribe to device usage events.

getOnlineEvents: Subscribe to online/offline events.

Multiple events can be used as a list separated with the | character.

Become my patron

About

A collection of node-red nodes for TP-Link Smart Home devices

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 61.2%
  • HTML 38.8%