1.2.3 • Published 8 months ago

@lahoco/node-red-contrib-lahoco-core v1.2.3

Weekly downloads
-
License
GNU GPLv3
Repository
-
Last release
8 months ago

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)

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
powerbooleanin / outtrue switch the light on, false switch it off
toggleanyinToggles between switch on and off, depending on the previous status of the light

1.2 Dimmer light

Light with variable intensity (0-100%)

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
powerbooleanin / outtrue switch the light on, false switch it off
toggleanyinToggles between switch on and off, depending on the previous status of the light
brightnessintegerin / outSets the brightness of the light, from 0 to 100
incrementBrightnessintinPercentage value of the light brightness (0-100) to increase of current state
decrementBrightnessintinPercentage value of the light brightness (0-100) to decrease of current state
lightDimming{target,behavior}inDo 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"
releaseanyinRelease the pressButton

1.3 RGB light

Light with variable color r, g, b

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
powerbooleanin / outtrue switch the light on, false switch it off
toggleanyinToggles between switch on and off, depending on the previous status of the light
brightnessintegerin / outSets the brightness of the light, from 0 to 100
rgb{red, green, blue}in / outRGB value of the light separate in a json containing the value for each color (0-255) {red, green, blue}
incrementBrightnessintinPercentage value of the light brightness (0-100) to increase of current state
decrementBrightnessintinPercentage value of the light brightness (0-100) to decrease of current state
lightDimming{target,behavior}inDo 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"
releaseanyinRelease the pressButton

1.4 RGBW light

Light with variable color r, g, b and white

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
powerbooleanin / outtrue switch the light on, false switch it off
toggleanyinToggles between switch on and off, depending on the previous status of the light
brightnessintegerin / outSets the brightness of the light, from 0 to 100
rgb{red, green, blue}in / outRGB value of the light separate in a json containing the value for each color (0-255) {red, green, blue}
whiteanyinIf white property is given it will switch to white mode.
isWhitebooleanoutReturn true if in white mode and false if rgb mode.
incrementBrightnessintinPercentage value of the light brightness (0-100) to increase of current state
decrementBrightnessintinPercentage value of the light brightness (0-100) to decrease of current state
lightDimming{target,behavior}inDo 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"
releaseanyinRelease the pressButton
toWhiteanyinSwitch to white mode
toRgbanyinSwitch to rgb mode

1.5 Dimmer white light

Dimmer light with white temperature

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
powerbooleanin / outtrue switch the light on, false switch it off
toggleanyinToggles between switch on and off, depending on the previous status of the light
brightnessintegerin / outSets the brightness of the light, from 0 to 100
whiteTempintegerin / outPercentage value of the warmth of light (0-100) (0 = cold / 100 = warm)
incrementBrightnessintinPercentage value of the light brightness (0-100) to increase of current state
decrementBrightnessintinPercentage value of the light brightness (0-100) to decrease of current state
lightDimming{target,behavior}inDo 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"
releaseanyinRelease the pressButton

1.6 RGBW white temp

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

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
powerbooleanin / outtrue switch the light on, false switch it off
toggleanyinToggles between switch on and off, depending on the previous status of the light
brightnessintegerin / outSets the brightness of the light, from 0 to 100
rgb{red, green, blue}in / outRGB value of the light separate in a json containing the value for each color (0-255) {red, green, blue}
whiteTempintegerin / outPercentage value of the warmth of light (0-100) (0 = cold / 100 = warm)
isWhitebooleanoutReturn true if in white mode and false if rgb mode.
incrementBrightnessintinPercentage value of the light brightness (0-100) to increase of current state
decrementBrightnessintinPercentage value of the light brightness (0-100) to decrease of current state
lightDimming{target,behavior}inDo 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"
releaseanyinRelease the pressButton
toWhiteanyinSwitch to white mode
toRgbanyinSwitch to rgb mode

2 Shading

2.1 VB Blind / (AW2)

Venetian blind

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
upanyinRaise/open the blind to the top/all the way
upClickanyinRaise/open the blind until release is triggered
releaseanyinEnds the click event and stops the blind at the current location.
stopanyinEnds the opening event and stops the blind at the current location.
downClickanyinLower/close the blind until release is triggered.
downanyinLower/close the blind all the way down
stoppedbooleanoutTrue when the blind is stopped./ new** ENOCEAN actuator)
openingbooleanoutTrue when the blind is opening.
closingbooleanoutTrue when the blind is closing.
positionintin / outPercentage value of the position (0-100) (0 = open / 100 = close)
orientationintin / outPercentage 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

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
upanyinRaise/open the blind to the top/all the way
upClickanyinRaise/open the blind until release is triggered
releaseanyinEnds the opening event and stops the blind at the current location.
stopanyinEnds the opening event and stops the blind at the current location.
downClickanyinLower/close the blind until release is triggered.
downanyinLower/close the blind all the way down
stoppedbooleanoutTrue when the blind is stopped./ new** ENOCEAN actuator)
openingbooleanoutTrue when the blind is opening.
closingbooleanoutTrue when the blind is closing.
positionintin / outPercentage value of the position (0-100) (0 = open / 100 = close)

3 Heating

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
isHeatingbooleanoutCurrent state of the heater (true = is heating / false = is not heating)
temperaturefloatin / outWanted temperature (8-25 °C) (Temperature to set to the heater)
currentTemperaturefloatoutCurrent temperature in the room (value of the temperature sensor)

4 Watering

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
onbooleanin / outtrue switch the watering on (Duration of 255 minutes), false switch it off
durationintin / outSet the watering to ON for the given number of minutes (switch off after the end of the duration)

5 Scene

PropertiesValueTypeDescription
activateanyinActivate the scene
activatedbooleanoutOn scene activated
updatedbooleanoutOn scene updated

6 Sensor

Here are all the properties of the sensor.

Window handle

PropertiesValueTypeDescription
isOpenbooleanoutTrue if the window is open, false if closed
tiltedbooleanoutTrue if the window is open in tilted mode, false if open normally or closed

Window contact

PropertiesValueTypeDescription
isOpenbooleanoutTrue if the window is open, false if closed

Wind direction

PropertiesValueTypeDescription
windDrectionnumberoutThe angle of the wind direction relative to the north

Wind speed

PropertiesValueTypeDescription
windSpeednumberoutSpeed of wind
windSpeed_unitStringoutUnit of wind speed

Rain

PropertiesValueTypeDescription
isRainingbooleanoutTrue if it is raining, false if not. (If a drop of water fall on the sensor)

Night / Day

PropertiesValueTypeDescription
isDaybooleanoutTrue if it is day, false if night.

Temperature

PropertiesValueTypeDescription
temperaturenumberoutTemperature
temperature_unitStringoutUnit of temperature

Presence

PropertiesValueTypeDescription
presencebooleanoutTrue if the sensor is detecting a movement, false if not.

Humidity

PropertiesValueTypeDescription
humiditynumberoutHumidity
humidity_unitStringoutUnit of humidity

Brightness

PropertiesValueTypeDescription
brightnessnumberoutBrightness
brightness_unitStringoutUnit of brightness

7 Control

PropertiesValueTypeDescription
onboolean/ outtrue switch the control on, false switch it off

8 Alarms

PropertiesValueTypeDescription
activebooleanoutCurrent state of the alarm (true = is active / false = is not active)

9 Access

Sectional door

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
upanyinRaise/open the blind to the top/all the way
upClickanyinRaise/open the blind until release is triggered
releaseanyinEnds the opening event and stops the blind at the current location.
stopanyinEnds the opening event and stops the blind at the current location.
downClickanyinLower/close the blind until release is triggered.
downanyinLower/close the blind all the way down
stoppedbooleanoutTrue when the blind is stopped./ new** ENOCEAN actuator)
openingbooleanoutTrue when the blind is opening.
closingbooleanoutTrue when the blind is closing.

10 Other

Outlet

PropertiesValueTypeDescription
powerbooleanin / outtrue switch the control on, false switch it off
toggleanyinToggles between switch on and off, depending on the previous status of the control
1.2.0

8 months ago

1.1.1

1 year ago

1.1.0

1 year ago

1.2.3

8 months ago

1.2.2

8 months ago

1.2.1

8 months ago

1.1.2

1 year ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.5

3 years ago

0.0.4

3 years ago

0.0.6

3 years ago

0.0.1

4 years ago