1.0.2 • Published 2 years ago

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

Weekly downloads
-
License
GNU GPLv3
Repository
-
Last release
2 years 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.

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 ip address and the port (generally it is 8887 for the websocket and 80 for the API) of the Lahoco server used.

Setup

  1. Add the Lahoco Server node.

  2. Open the configuration page of it and select / modify / add a server configuration.

  3. Specify the ip address and the ports used for the Lahoco server.

  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 Light 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 "Lights" or "Blinds" 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 Lights

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)
onbooleanin / outtrue switches the light on, false switches it off
toggleanyinToggles between switching 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)
onbooleanin / outtrue switches the light on, false switches it off
toggleanyinToggles between switching 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

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)
onbooleanin / outtrue switches the light on, false switches it off
toggleanyinToggles between switching on and off, depending on the previous status of the light
brightnessintegerin / outSets the brightness of the light, from 0 to 100
rgbr,g,bin / outRGB value of the light separate in a tab of 3 values (0-255) r, g, b
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

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)
onbooleanin / outtrue switches the light on, false switches it off
toggleanyinToggles between switching on and off, depending on the previous status of the light
brightnessintegerin / outSets the brightness of the light, from 0 to 100
rgbr,g,bin / outRGB value of the light separate in a tab of 3 values (0-255) r, g, b
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

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)
onbooleanin / outtrue switches the light on, false switches it off
toggleanyinToggles between switching 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

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)
onbooleanin / outtrue switches the light on, false switches it off
toggleanyinToggles between switching on and off, depending on the previous status of the light
brightnessintegerin / outSets the brightness of the light, from 0 to 100
rgbr,g,bin / outRGB value of the light separate in a tab of 3 values (0-255) r, g, b
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

2 Blinds

2.1 VB Blinds

Vertical blind (Slat blind with orientation)

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
topanyinRaise/open the blind to the top/all the way
upClickanyinRaise/open the blind until upRelease is triggered
upReleaseanyinEnds the opening event and stops the blind at the current location. (Works only with blind linked to Lahoco with KNX technologies)
stopanyinEnds the opening event and stops the blind at the current location.
downClickanyinLower/close the blind until downRelease is triggered.
downReleaseanyinEnds the closing event and stops the blind at the current location. (Works only with blind linked to Lahoco with KNX technologies)
bottomanyinLower/close the blind all the way down
stoppedbooleanoutTrue when the blind is stopped. (Only on KNX and new ENOCEAN actuators)/ new** ENOCEAN actuators)
openingbooleanoutTrue when the blind is opening. (Only on KNX and new ENOCEAN actuators)
closingbooleanoutTrue when the blind is closing. (Only on KNX and new ENOCEAN actuators)
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 Blinds

Rolling shutter blind

PropertiesValueTypeDescription
statusanyinForces the request of the current status of the device (It also updates all other devices)
topanyinRaise/open the blind to the top/all the way
upClickanyinRaise/open the blind until upRelease is triggered
upReleaseanyinEnds the opening event and stops the blind at the current location. (Works only with blind linked to Lahoco with KNX technologies)
stopanyinEnds the opening event and stops the blind at the current location.
downClickanyinLower/close the blind until downRelease is triggered.
downReleaseanyinEnds the closing event and stops the blind at the current location. (Works only with blind linked to Lahoco with KNX technologies)
bottomanyinLower/close the blind all the way down
stoppedbooleanoutTrue when the blind is stopped. (Only on KNX and new ENOCEAN actuators)/ new** ENOCEAN actuators)
openingbooleanoutTrue when the blind is opening. (Only on KNX and new ENOCEAN actuators)
closingbooleanoutTrue when the blind is closing. (Only on KNX and new ENOCEAN actuators)
positionintin / outPercentage value of the position (0-100) (0 = open / 100 = close)

3 Heaters

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 switches the watering on (Duration of 255 minutes), false switches it off
durationintin / outSet the watering to ON for the given number of minutes (switch off after the end of the duration)

5 Scenes

PropertiesValueTypeDescription
activateanyinActivate the scene
activatedbooleanoutOn scene activated
updatedbooleanoutOn scene updated

6 Sensors

Here are all the properties of the sensors.

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

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 Switches

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

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.6

2 years ago

0.0.1

2 years ago