@lahoco/node-red-contrib-lahoco-core 1.2.3

Node-RED LAHOCO nodes bundle

npm install @lahoco/node-red-contrib-lahoco-core

LAHOCO Core - LAHOCO nodes for Node-RED

LAHOCO Core is made to control the devices of a LAHOCO installation. It allows you to create customized automation systems, interconnect with other systems and manage devices as desired.

Warning: This version only works with LAHOCO 5.3 or higher.

Nodes

This are all the nodes provided by this module to control :


Prerequisites

In order to use a node, the LAHOCO server must be up and running.

You must know the name or the ip of your LAHOCO server

Setup

  1. Open the configuration page of the node and select or create a LAHOCO server.

  2. Check if your server is listed in the drop-down menu.

  3. If it is not, select "Enter IP manually" and input the IP of your server in the field on the right.

  4. Specify a user login and password (The users can be set in the LAHOCO administrator page in tab "Users")

  5. Add other LAHOCO nodes to the flow to interact with the server.

WARNING

It is really recommended to put the server node in the first flow and put the other LAHOCO Nodes in other flows !

Usage

Several possibilities are available to you. You can give commands to the node (input) via a json object, view the status (status under the node) and get the status (output).

For the input, you need to give a JSON object with all the commands included. This JSON object must be set in the payload.msg. The commands are read and executed one after the other from top to bottom.

Here is an example for the Lighting node : First we set the brightness to 25%, and after we toggle the state to off (we set the brightness just before)

payload.msg = {
  "brightness": 25,
  "toggle": ""
}

Properties

In the next sections, you will see all the properties of each node

This are all the properties that each node supports. In some nodes like "Lighting" or "Shading" some properties are working only if the node is in the good category. If you give an option that is not in his capabilities it will be ignored.

Not all the properties can be readable (output) and writeable (input), therefore in the description of each property you can see in and/or out.

All the properties that are supported for the selected device in the node and that have the out property, are return to the output of the node as a JSON object like in the input.


1 Lighting

1.1 Simple light

Simple light (on | off)

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
power boolean in / out true switch the light on, false switch it off
toggle any in Toggles between switch on and off, depending on the previous status of the light

1.2 Dimmer light

Light with variable intensity (0-100%)

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
power boolean in / out true switch the light on, false switch it off
toggle any in Toggles between switch on and off, depending on the previous status of the light
brightness integer in / out Sets the brightness of the light, from 0 to 100
incrementBrightness int in Percentage value of the light brightness (0-100) to increase of current state
decrementBrightness int in Percentage value of the light brightness (0-100) to decrease of current state
lightDimming {target,behavior} in Do the actions passed in parameters until release is triggered. One param correspond to the action behavior, "UP_ON" or "DOWN_OFF". The second param is the action target "BRIGHT"
release any in Release the pressButton

1.3 RGB light

Light with variable color [r, g, b]

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
power boolean in / out true switch the light on, false switch it off
toggle any in Toggles between switch on and off, depending on the previous status of the light
brightness integer in / out Sets the brightness of the light, from 0 to 100
rgb {red, green, blue} in / out RGB value of the light separate in a json containing the value for each color (0-255) {red, green, blue}
incrementBrightness int in Percentage value of the light brightness (0-100) to increase of current state
decrementBrightness int in Percentage value of the light brightness (0-100) to decrease of current state
lightDimming {target,behavior} in Do the actions passed in parameters until release is triggered. One param correspond to the action behavior, "UP_ON" or "DOWN_OFF". The second param is the action target "BRIGHT" or "COLOR"
release any in Release the pressButton

1.4 RGBW light

Light with variable color [r, g, b] and white

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
power boolean in / out true switch the light on, false switch it off
toggle any in Toggles between switch on and off, depending on the previous status of the light
brightness integer in / out Sets the brightness of the light, from 0 to 100
rgb {red, green, blue} in / out RGB value of the light separate in a json containing the value for each color (0-255) {red, green, blue}
white any in If white property is given it will switch to white mode.
isWhite boolean out Return true if in white mode and false if rgb mode.
incrementBrightness int in Percentage value of the light brightness (0-100) to increase of current state
decrementBrightness int in Percentage value of the light brightness (0-100) to decrease of current state
lightDimming {target,behavior} in Do the actions passed in parameters until release is triggered. One param correspond to the action behavior, "UP_ON" or "DOWN_OFF". The second param is the action target "BRIGHT" or "COLOR"
release any in Release the pressButton
toWhite any in Switch to white mode
toRgb any in Switch to rgb mode

1.5 Dimmer white light

Dimmer light with white temperature

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
power boolean in / out true switch the light on, false switch it off
toggle any in Toggles between switch on and off, depending on the previous status of the light
brightness integer in / out Sets the brightness of the light, from 0 to 100
whiteTemp integer in / out Percentage value of the warmth of light (0-100) (0 = cold / 100 = warm)
incrementBrightness int in Percentage value of the light brightness (0-100) to increase of current state
decrementBrightness int in Percentage value of the light brightness (0-100) to decrease of current state
lightDimming {target,behavior} in Do the actions passed in parameters until release is triggered. One param correspond to the action behavior, "UP_ON" or "DOWN_OFF". The second param is the action target "BRIGHT" or "WHITE_TEMPERATURE"
release any in Release the pressButton

1.6 RGBW white temp

Light with variable color [r, g, b] and white temperature

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
power boolean in / out true switch the light on, false switch it off
toggle any in Toggles between switch on and off, depending on the previous status of the light
brightness integer in / out Sets the brightness of the light, from 0 to 100
rgb {red, green, blue} in / out RGB value of the light separate in a json containing the value for each color (0-255) {red, green, blue}
whiteTemp integer in / out Percentage value of the warmth of light (0-100) (0 = cold / 100 = warm)
isWhite boolean out Return true if in white mode and false if rgb mode.
incrementBrightness int in Percentage value of the light brightness (0-100) to increase of current state
decrementBrightness int in Percentage value of the light brightness (0-100) to decrease of current state
lightDimming {target,behavior} in Do the actions passed in parameters until release is triggered. One param correspond to the action behavior, "UP_ON" or "DOWN_OFF". The second param is the action target "BRIGHT", "WHITE_TEMPERATURE" or "COLOR"
release any in Release the pressButton
toWhite any in Switch to white mode
toRgb any in Switch to rgb mode

2 Shading

2.1 VB Blind / (AW2)

Venetian blind

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
up any in Raise/open the blind to the top/all the way
upClick any in Raise/open the blind until release is triggered
release any in Ends the click event and stops the blind at the current location.
stop any in Ends the opening event and stops the blind at the current location.
downClick any in Lower/close the blind until release is triggered.
down any in Lower/close the blind all the way down
stopped boolean out True when the blind is stopped.
opening boolean out True when the blind is opening.
closing boolean out True when the blind is closing.
position int in / out Percentage value of the position (0-100) (0 = open / 100 = close)
orientation int in / out Percentage value of the orientation (0-100) (0 = the slats are horizontal / 100 = the slats are vertical)

2.2 RS Blind / (AW1) / Pergola / Pool Cover

Rolling Shutter blind

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
up any in Raise/open the blind to the top/all the way
upClick any in Raise/open the blind until release is triggered
release any in Ends the opening event and stops the blind at the current location.
stop any in Ends the opening event and stops the blind at the current location.
downClick any in Lower/close the blind until release is triggered.
down any in Lower/close the blind all the way down
stopped boolean out True when the blind is stopped.
opening boolean out True when the blind is opening.
closing boolean out True when the blind is closing.
position int in / out Percentage value of the position (0-100) (0 = open / 100 = close)

3 Heating

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
isHeating boolean out Current state of the heater (true = is heating / false = is not heating)
temperature float in / out Wanted temperature (8-25 °C) (Temperature to set to the heater)
currentTemperature float out Current temperature in the room (value of the temperature sensor)

4 Watering

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
on boolean in / out true switch the watering on (Duration of 255 minutes), false switch it off
duration int in / out Set the watering to ON for the given number of minutes (switch off after the end of the duration)

5 Scene

Properties Value Type Description
activate any in Activate the scene
activated boolean out On scene activated
updated boolean out On scene updated

6 Sensor

Here are all the properties of the sensor.

Window handle

Properties Value Type Description
isOpen boolean out True if the window is open, false if closed
tilted boolean out True if the window is open in tilted mode, false if open normally or closed

Window contact

Properties Value Type Description
isOpen boolean out True if the window is open, false if closed

Wind direction

Properties Value Type Description
windDrection number out The angle of the wind direction relative to the north

Wind speed

Properties Value Type Description
windSpeed number out Speed of wind
windSpeed_unit String out Unit of wind speed

Rain

Properties Value Type Description
isRaining boolean out True if it is raining, false if not. (If a drop of water fall on the sensor)

Night / Day

Properties Value Type Description
isDay boolean out True if it is day, false if night.

Temperature

Properties Value Type Description
temperature number out Temperature
temperature_unit String out Unit of temperature

Presence

Properties Value Type Description
presence boolean out True if the sensor is detecting a movement, false if not.

Humidity

Properties Value Type Description
humidity number out Humidity
humidity_unit String out Unit of humidity

Brightness

Properties Value Type Description
brightness number out Brightness
brightness_unit String out Unit of brightness

7 Control

Properties Value Type Description
on boolean / out true switch the control on, false switch it off

8 Alarms

Properties Value Type Description
active boolean out Current state of the alarm (true = is active / false = is not active)

9 Access

Sectional door

Properties Value Type Description
status any in Forces the request of the current status of the device (It also updates all other devices)
up any in Raise/open the blind to the top/all the way
upClick any in Raise/open the blind until release is triggered
release any in Ends the opening event and stops the blind at the current location.
stop any in Ends the opening event and stops the blind at the current location.
downClick any in Lower/close the blind until release is triggered.
down any in Lower/close the blind all the way down
stopped boolean out True when the blind is stopped.
opening boolean out True when the blind is opening.
closing boolean out True when the blind is closing.

10 Other

Outlet

Properties Value Type Description
power boolean in / out true switch the control on, false switch it off
toggle any in Toggles between switch on and off, depending on the previous status of the control

Node Info

Version: 1.2.3
Updated 2 months ago
License: GNU GPLv3
Rating: not yet rated

Categories

Actions

Rate:

Downloads

7 in the last week

Nodes

  • lahoco-server
  • lahoco-config
  • lahoco-lighting
  • lahoco-control
  • lahoco-shading
  • lahoco-heating
  • lahoco-watering
  • lahoco-scene
  • lahoco-sensor
  • lahoco-alarm
  • lahoco-other
  • lahoco-access

Keywords

  • lahoco
  • node-red
  • node-red-contrib
  • contrib
  • home-automation
  • iot
  • smart-home
  • api

Maintainers

Contributors

  • Baptiste Grand
  • Orlando Espin