search

recallfx / node-red-contrib-eufy-security

Eufy security node for Node RED
MIT License
6 stars 6 forks source link

readme

node-red-contrib-eufy-security

Description

Node-RED contribution package for Eufy security devices, based on eufy-security-client

Node RED plugin wrapper around eufy-security-client library to access and control by connecting to the Eufy cloud servers and local/remote stations over P2P.

Note

Not all events and commands have been added/tested, check list below. Full list can be found here.

Tested events:

Tested commands:

Tested commands with props:

Not tested commands:

Install

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

npm install node-red-contrib-eufy-security

How to use

  1. Find eufy-security node in network group and add it to the flow, connect with inject node as input and debug node as output;
  2. Configure eufy-config by providing your cloud credentials;
  3. (optional) Select events to track;
  4. Deploy flow;
  5. If all configured correctly you should see Connected under the node;
  6. This node will send events as objects to output:
{
  pyload: {
    event,
    station,
    device,
    result,
    currentMode,
    command,
    error,
  }
}

Suported events:

Also you can send commands to this node in this form:

{
  pyload: {
    command,
    stationSN,
    deviceSN,
    name,
    value,
    verifyCode,
    seconds,
    p2pConnectionType,
    channel,
  }
}

Supported commands with arguments (? means optional):