From 0906095c54e275d434432616c9dac3e94c4c14c2 Mon Sep 17 00:00:00 2001 From: Raoul Hecky Date: Thu, 18 Jan 2024 20:50:41 +0000 Subject: [PATCH] remove build doc --- .gitignore | 1 + build_doc/en/io_doc.json | 14357 ------------------------------------- build_doc/en/io_doc.md | 3676 ---------- build_doc/fr/io_doc.json | 14357 ------------------------------------- build_doc/fr/io_doc.md | 3676 ---------- 5 files changed, 1 insertion(+), 36066 deletions(-) delete mode 100644 build_doc/en/io_doc.json delete mode 100644 build_doc/en/io_doc.md delete mode 100644 build_doc/fr/io_doc.json delete mode 100644 build_doc/fr/io_doc.md diff --git a/.gitignore b/.gitignore index e13d649b..4e2ba056 100644 --- a/.gitignore +++ b/.gitignore @@ -102,3 +102,4 @@ GTAGS _build build +build_doc \ No newline at end of file diff --git a/build_doc/en/io_doc.json b/build_doc/en/io_doc.json deleted file mode 100644 index af0f3c38..00000000 --- a/build_doc/en/io_doc.json +++ /dev/null @@ -1,14357 +0,0 @@ -{ - "AVReceiver": { - "description": "AVReceiver object to control network amplifier", - "alias": [], - "parameters": [ - { - "description": "AVReceiver model. Supported: pioneer, denon, onkyo, marantz, yamaha", - "mandatory": "true", - "name": "model", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Zone of the amplifier (if supported)", - "mandatory": "false", - "max": "10", - "min": "0", - "name": "zone", - "readonly": "false", - "type": "int" - }, - { - "description": "IP address of the device", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Port to use for connection", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [ - { - "description": "Send a custom command to receiver (if you know the protocol)", - "name": "custom XXXXXX" - }, - { - "description": "Change current input source", - "name": "source X" - }, - { - "description": "Set current volume", - "name": "volume 50" - }, - { - "description": "Switch receiver off", - "name": "power off" - }, - { - "description": "Switch receiver on", - "name": "power on" - } - ] - }, - "Axis": { - "description": " Axis IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Resolution to use", - "mandatory": "false", - "name": "resolution", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "", - "mandatory": "false", - "name": "tilt_framesize", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "description": "", - "mandatory": "false", - "name": "pan_framesize", - "readonly": "false", - "type": "string" - }, - { - "description": "Camera model/chanel to use", - "mandatory": "true", - "name": "model", - "readonly": "false", - "type": "string" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "Set to true if camera has PTZ support", - "mandatory": "false", - "name": "ptz", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "", - "mandatory": "false", - "name": "zoom_step", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "BlinkstickOutputLightRGB": { - "description": "RGB Light dimmer using a Blinkstick RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "default": "1", - "description": "Number of LEDs to control with the blinkstick", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "nb_leds", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Blinkstick serial to control", - "mandatory": "true", - "name": "serial", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "Foscam": { - "description": " Foscam IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password for user", - "mandatory": "true", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP Address", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "88", - "description": "Port number", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "Set to true if camera has PTZ support", - "mandatory": "false", - "name": "ptz", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "", - "mandatory": "false", - "name": "zoom_step", - "readonly": "false", - "type": "string" - }, - { - "description": "Username for accessing the camera", - "mandatory": "true", - "name": "username", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "Gadspot": { - "description": " Gadspot IP Camera. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "GpioInputSwitch": { - "description": "Input switch with a GPIO Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "GPIO ID on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Set this if your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "GpioInputSwitchLongPress": { - "description": "Input switch with a GPIO Long press switch. This switch supports single press and long press. User has 500ms to perform the long press.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "GPIO ID on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is pressed at least for 500ms (long press)", - "name": "2" - }, - { - "description": "Event triggered when switch is pressed quickly", - "name": "1" - } - ], - "actions": [] - }, - "GpioInputSwitchTriple": { - "description": "Input switch with a GPIO Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "GPIO ID on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is double clicked", - "name": "2" - }, - { - "description": "Event triggered when switch is triple clicked", - "name": "3" - }, - { - "description": "Event triggered when switch is single clicked", - "name": "1" - } - ], - "actions": [] - }, - "GpioOutputShutter": { - "description": "Shutter with 2 GPIOs Simple shutter. This shutter supports open/close states, as well as impulse shutters.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low_up", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low_down", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "GPIO ID for closing on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio_down", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to open or close", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "GPIO ID for opening on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio_up", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "GpioOutputShutterSmart": { - "description": "Shutter with 2 GPIOs Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low_up", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "GPIO ID for closing on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio_down", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low_down", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "60", - "description": "Time in sec for shutter to be fully open. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_up", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to fully closed. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_down", - "readonly": "false", - "type": "int" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "GPIO ID for opening on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio_up", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open the shutter by X percent", - "name": "up 5" - }, - { - "description": "Set shutter at position X in percent", - "name": "set 50" - }, - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close the shutter by X percent", - "name": "down 5" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost.", - "name": "calibrate" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "GpioOutputSwitch": { - "description": "Light with a GPIO Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "GPIO ID on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low", - "readonly": "false", - "type": "bool" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "HueOutputLightRGB": { - "description": "RGB Light dimmer using a Philips Hue RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "description": "API key return by Hue bridge when assciation has been made. Use Hue Wizard in calaos_installer to get this value automatically.", - "mandatory": "true", - "name": "api", - "readonly": "false", - "type": "string" - }, - { - "description": "Hue bridge IP address", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Unique ID describing the Hue Light. This value is returned by the Hue Wizard.", - "mandatory": "true", - "name": "id_hue", - "readonly": "false", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "InputTime": { - "description": "Basic time input. An event is triggered when the current time equals the configured time. A specific date can also be set.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A time object can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "0", - "description": "Year for this time input", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "year", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "Minutes for this time input", - "mandatory": "true", - "max": "59", - "min": "0", - "name": "min", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Day for this time input", - "mandatory": "false", - "max": "31", - "min": "1", - "name": "day", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Hour for this time input", - "mandatory": "true", - "max": "23", - "min": "0", - "name": "hour", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Seconds for this time input", - "mandatory": "true", - "max": "59", - "min": "0", - "name": "sec", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Month for this time input", - "mandatory": "false", - "max": "12", - "min": "1", - "name": "month", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event on any change of time", - "name": "changed" - }, - { - "description": "Event triggered when current time is not equal", - "name": "false" - }, - { - "description": "Event triggered when current time equals", - "name": "true" - } - ], - "actions": [] - }, - "InputTimer": { - "description": "Timer object. trigger an event after the configured time has expired.", - "alias": [], - "parameters": [ - { - "description": "Auto restart the timer when time expires", - "mandatory": "true", - "name": "autorestart", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A timer object can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "0", - "description": "Miliseconds for the timer interval", - "mandatory": "true", - "max": "999", - "min": "0", - "name": "msec", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "Minutes for the timer interval", - "mandatory": "true", - "max": "59", - "min": "0", - "name": "min", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Hour for the timer interval", - "mandatory": "true", - "max": "23", - "min": "0", - "name": "hour", - "readonly": "false", - "type": "int" - }, - { - "description": "Auto start the timer when calaos starts", - "mandatory": "true", - "name": "autostart", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Seconds for the timer interval", - "mandatory": "true", - "max": "59", - "min": "0", - "name": "sec", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event triggered on any change", - "name": "change" - }, - { - "description": "Event triggered when timer starts", - "name": "false" - }, - { - "description": "Event triggered when timer expires", - "name": "true" - } - ], - "actions": [ - { - "description": "Reset the configured time to a value. Format is h:m:s:ms", - "name": "00:00:00:200" - }, - { - "description": "Stop the timer", - "name": "stop" - }, - { - "description": "Start the timer", - "name": "start" - } - ] - }, - "InternalBool": { - "description": "Internal boolean object. This object is useful for doing internal programing in rules, like keeping boolean states, or displaying boolean values", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false", - "mandatory": "false", - "name": "rw", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false", - "mandatory": "false", - "name": "save", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event when value is false", - "name": "false" - }, - { - "description": "Event when value is true", - "name": "true" - } - ], - "actions": [ - { - "description": "Do an impulse on boolean value. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Do an impulse on boolean value with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert boolean value", - "name": "toggle" - }, - { - "description": "Set a value to false", - "name": "false" - }, - { - "description": "Set a value to true", - "name": "true" - } - ] - }, - "InternalInt": { - "description": "Internal number object. This object is useful for doing internal programing in rules, like counters, of displaying values.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false", - "mandatory": "false", - "name": "rw", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false", - "mandatory": "false", - "name": "save", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific number value", - "name": "0" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "InternalString": { - "description": "Internal string object. This object is useful for doing internal programing in rules or displaying text values on user interfaces.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false", - "mandatory": "false", - "name": "rw", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false", - "mandatory": "false", - "name": "save", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific string value", - "name": "value" - } - ], - "actions": [ - { - "description": "Set a specific string value", - "name": "value" - } - ] - }, - "KNXInputAnalog": { - "description": "Input analog with KNX and eibnetmux An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "KNXInputSwitch": { - "description": "Input switch with KNX and eibnetmux Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "KNXInputSwitchLongPress": { - "description": "Input switch long press with KNX and eibnetmux Long press switch. This switch supports single press and long press. User has 500ms to perform the long press.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is pressed at least for 500ms (long press)", - "name": "2" - }, - { - "description": "Event triggered when switch is pressed quickly", - "name": "1" - } - ], - "actions": [] - }, - "KNXInputSwitchTriple": { - "description": "Input switch triple with KNX and eibnetmux Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is double clicked", - "name": "2" - }, - { - "description": "Event triggered when switch is triple clicked", - "name": "3" - }, - { - "description": "Event triggered when switch is single clicked", - "name": "1" - } - ], - "actions": [] - }, - "KNXInputTemp": { - "description": "Input temperature with KNX and eibnetmux Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "KNXOutputAnalog": { - "description": "Analog output with KNX and eibnetmux Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "KNXOutputLight": { - "description": "Light output with KNX and eibnetmux Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "KNXOutputLightDimmer": { - "description": "Light dimmer with KNX and eibnetmux Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "KNXOutputLightRGB": { - "description": "Light RGB with KNX and eibnetmux RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "Blue Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group_blue", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Green Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group_green", - "readonly": "false", - "type": "string" - }, - { - "description": "Red channel KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_red", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Green channel KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_green", - "readonly": "false", - "type": "string" - }, - { - "description": "Red Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group_red", - "readonly": "false", - "type": "string" - }, - { - "description": "Blue channel KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_blue", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "KNXOutputShutter": { - "description": "Shutter with with KNX and eibnetmux Simple shutter. This shutter supports open/close states, as well as impulse shutters.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to open or close", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time", - "readonly": "false", - "type": "int" - }, - { - "description": "Down KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_down", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Up KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_up", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "KNXOutputShutterSmart": { - "description": "Shutter with with KNX and eibnetmux Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "Down KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_down", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "60", - "description": "Time in sec for shutter to be fully open. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_up", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to fully closed. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_down", - "readonly": "false", - "type": "int" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Up KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_up", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open the shutter by X percent", - "name": "up 5" - }, - { - "description": "Set shutter at position X in percent", - "name": "set 50" - }, - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close the shutter by X percent", - "name": "down 5" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost.", - "name": "calibrate" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "MilightOutputLightRGB": { - "description": "RGB light support for Limitless/Milight RGB bulbs. RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "Zone to control. Each gateway supports 4 zones.", - "mandatory": "true", - "max": "4", - "min": "0", - "name": "zone", - "readonly": "false", - "type": "int" - }, - { - "description": "Milight wifi gateway IP address", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Gateway port, default to 8899", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "MqttInputAnalog": { - "description": "Analog value read from a mqtt broker An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "MqttInputString": { - "description": "String value read from a mqtt broker", - "alias": [], - "parameters": [ - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "MqttInputSwitch": { - "description": "Switch value read from a mqtt broker Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "description": "Value to interpret as ON value", - "mandatory": "true", - "name": "on_value", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Value to interpret as OFF value", - "mandatory": "true", - "name": "off_value", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "MqttInputTemp": { - "description": "Temperature read from a mqtt broker Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "MqttOutputAnalog": { - "description": "Control analog output through mqtt broker Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "description": "The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with the state (float value) to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "MqttOutputLight": { - "description": "Control lights through mqtt broker Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with with the state (on_value, off_value) to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "Value to interpret as ON value", - "mandatory": "true", - "name": "on_value", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "description": "Value to interpret as OFF value", - "mandatory": "true", - "name": "off_value", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "MqttOutputLightDimmer": { - "description": "Control lights through mqtt broker Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "description": "The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with the state (integer value) to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "MqttOutputLightRGB": { - "description": "Control RGB lights through mqtt broker RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "description": "The path where to found the brightness value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example 'brightness'", - "mandatory": "true", - "name": "path_brightness", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the Y (X/Y Color space) value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example color.y, try to read the x value from the color object.", - "mandatory": "true", - "name": "path_y", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the X (X/Y Color space) value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example color.x, try to read the x value from the color object.", - "mandatory": "true", - "name": "path_x", - "readonly": "false", - "type": "string" - }, - { - "description": "The data sent when publishing color to topic. The __##VALUE_R##__ __##VALUE_G##__ __##VALUE_B##__ or __##VALUE_HEX##__ or __##VALUE_X##__ __##VALUE_Y##__ __##VALUE_BRIGHTNESS##__ contained in data is substituted with the color (integer value or #RRGGBB string value) to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "MySensorsInputAnalog": { - "description": "Analog measurement with MySensors node An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "MySensorsInputString": { - "description": "Display string from MySensors node", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "MySensorsInputSwitch": { - "description": "Input switch with MySensors node Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "MySensorsInputSwitchLongPress": { - "description": "Input long press switch with MySensors node Long press switch. This switch supports single press and long press. User has 500ms to perform the long press.", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is pressed at least for 500ms (long press)", - "name": "2" - }, - { - "description": "Event triggered when switch is pressed quickly", - "name": "1" - } - ], - "actions": [] - }, - "MySensorsInputSwitchTriple": { - "description": "Input triple click switch with MySensors node Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click.", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is double clicked", - "name": "2" - }, - { - "description": "Event triggered when switch is triple clicked", - "name": "3" - }, - { - "description": "Event triggered when switch is single clicked", - "name": "1" - } - ], - "actions": [] - }, - "MySensorsInputTemp": { - "description": "Temperature sensor with MySensors node Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "MySensorsOutputAnalog": { - "description": "Analog output with MySensors node Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "MySensorsOutputDimmer": { - "description": "Light dimmer with MySensors node Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "MySensorsOutputLight": { - "description": "Light/relay with MySensors node Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "MySensorsOutputLightRGB": { - "description": "RGB Light dimmer with MySensors node RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID for green channel, as set in your network", - "mandatory": "true", - "name": "node_id_green", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sensor ID green red channel, as set in your node", - "mandatory": "true", - "name": "sensor_id_green", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID blue red channel, as set in your node", - "mandatory": "true", - "name": "sensor_id_blue", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID for blue channel, as set in your network", - "mandatory": "true", - "name": "node_id_blue", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID for red channel, as set in your network", - "mandatory": "true", - "name": "node_id_red", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID for red channel, as set in your node", - "mandatory": "true", - "name": "sensor_id_red", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "MySensorsOutputShutter": { - "description": "Shutter with MySensors node Simple shutter. This shutter supports open/close states, as well as impulse shutters.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID for closing shutter, as set in your node", - "mandatory": "true", - "name": "sensor_id_down", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID for opening shutter, as set in your network", - "mandatory": "true", - "name": "node_id_up", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Node ID for closing shutter, as set in your network", - "mandatory": "true", - "name": "node_id_down", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sensor ID for opening shutter, as set in your node", - "mandatory": "true", - "name": "sensor_id_up", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to open or close", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "MySensorsOutputShutterSmart": { - "description": "Smart shutter with MySensors node Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID for closing shutter, as set in your node", - "mandatory": "true", - "name": "sensor_id_down", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID for opening shutter, as set in your network", - "mandatory": "true", - "name": "node_id_up", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Node ID for closing shutter, as set in your network", - "mandatory": "true", - "name": "node_id_down", - "readonly": "false", - "type": "string" - }, - { - "default": "60", - "description": "Time in sec for shutter to be fully open. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_up", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sensor ID for opening shutter, as set in your node", - "mandatory": "true", - "name": "sensor_id_up", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to fully closed. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_down", - "readonly": "false", - "type": "int" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open the shutter by X percent", - "name": "up 5" - }, - { - "description": "Set shutter at position X in percent", - "name": "set 50" - }, - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close the shutter by X percent", - "name": "down 5" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost.", - "name": "calibrate" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "MySensorsOutputString": { - "description": "String output with MySensors node", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_VAR1, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "OLAOutputLightDimmer": { - "description": "DMX Light dimmer using OLA (Open Lighting Architecture) Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "DMX channel to control", - "mandatory": "true", - "max": "512", - "min": "0", - "name": "channel", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "OLA universe to control", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "universe", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "OLAOutputLightRGB": { - "description": "RGB Light dimmer using 3 DMX channels with OLA (Open Lighting Architecture) RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "DMX channel for blue to control", - "mandatory": "true", - "max": "512", - "min": "0", - "name": "channel_blue", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "DMX channel for red to control", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "channel_red", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "DMX channel for green to control", - "mandatory": "true", - "max": "512", - "min": "0", - "name": "channel_green", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "OLA universe to control", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "universe", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "OutputFake": { - "description": "Fake test output. Do nothing. Do not use.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "OWTemp": { - "description": "Temperature measurement with DS18B20 Onewire Sensor Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "description": "Force the use of w1 kernel driver instead of OneWire driver", - "mandatory": "false", - "name": "use_w1", - "readonly": "false", - "type": "bool" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID of sensor on OneWire bus.", - "mandatory": "true", - "name": "ow_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Additional parameter used for owfs initialization.For example you can use -u to use the USB owfs drivers", - "mandatory": "true", - "name": "ow_args", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "PingInputSwitch": { - "description": "A switch input based on the result of a ping command. Useful to detect presence of a host on the network. Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "default": "15000", - "description": "Interval between pings in ms. Default to 15 sec", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "int" - }, - { - "description": "Timeout of the ping request in ms", - "mandatory": "false", - "name": "timeout", - "readonly": "false", - "type": "int" - }, - { - "description": "IP address or host where to send the ping", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "The host is offline and/or does not respond to the ping", - "name": "false" - }, - { - "description": "The host is online and respond to the ping", - "name": "true" - } - ], - "actions": [] - }, - "Planet": { - "description": " Planet IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Password for user", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "description": "Username for accessing the camera", - "mandatory": "false", - "name": "username", - "readonly": "false", - "type": "string" - }, - { - "description": "Camera model (ICA-210, ICA-210W, ICA-300, ICA-302, ICA-500) to use", - "mandatory": "true", - "name": "model", - "readonly": "false", - "type": "string" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "Scenario": { - "description": "A scenario variable. Use this like a virtual button to start a scenario (list of actions)", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Internal use only for Auto Scenario. read only.", - "mandatory": "false", - "name": "auto_scenario", - "readonly": "true", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event triggered when scenario is started", - "name": "true" - } - ], - "actions": [ - { - "description": "Event triggered on any change", - "name": "changed" - }, - { - "description": "Stop the scenario (only for special looping scenarios)", - "name": "false" - }, - { - "description": "Start the scenario", - "name": "true" - } - ] - }, - "Squeezebox": { - "description": "Squeezebox audio player allows control of a Squeezebox from Calaos", - "alias": [ - "slim" - ], - "parameters": [ - { - "default": "9090", - "description": "CLI port of LMS, default to 9090", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port_cli", - "readonly": "false", - "type": "int" - }, - { - "description": "Logitech media server IP address", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "9000", - "description": "Web interface port of LMS, default to 9000.", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port_web", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Audio players are not displayed in rooms", - "mandatory": "true", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID of squeezebox in LMS", - "mandatory": "true", - "name": "id", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when a change in the current playlist happens", - "name": "onplaylistchange" - }, - { - "description": "Event when a change of volume happens", - "name": "onvolumechange" - }, - { - "description": "Event when stopping player", - "name": "onstop" - }, - { - "description": "Event when a new song is being played", - "name": "onsongchange" - }, - { - "description": "Event when pausing player", - "name": "onpause" - }, - { - "description": "Event when play is started", - "name": "onplay" - } - ], - "actions": [ - { - "description": "Add tracks to playlist. can be any of album_id:XX artist_id:XX playlist_id:XX, ...", - "name": "add " - }, - { - "description": "Clear playlist and play argument. can be any of album_id:XX artist_id:XX playlist_id:XX, ...", - "name": "play " - }, - { - "description": "Pause player", - "name": "pause" - }, - { - "description": "Sync this player with an other", - "name": "sync " - }, - { - "description": "Stop player", - "name": "stop" - }, - { - "description": "Increase volume by a value", - "name": "volume up 1" - }, - { - "description": "Set current volume", - "name": "volume set 50" - }, - { - "description": "Play previous song in playlist", - "name": "previous" - }, - { - "description": "Decrease volume by a value", - "name": "volume down 1" - }, - { - "description": "Start playing", - "name": "play" - }, - { - "description": "Play next song in playlist", - "name": "next" - }, - { - "description": "Switch player on", - "name": "power on" - }, - { - "description": "Start sleep mode with X seconds", - "name": "sleep 10" - }, - { - "description": "Switch player off", - "name": "power off" - }, - { - "description": "Stop sync of this player with an other", - "name": "unsync " - } - ] - }, - "standard_mjpeg": { - "description": " MJPEG/Jpeg IP Camera. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Set to true if camera has PTZ support", - "mandatory": "false", - "name": "ptz", - "readonly": "false", - "type": "bool" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "URL for mjpeg stream support", - "mandatory": "false", - "name": "url_mjpeg", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "URL for snapshot in jpeg format", - "mandatory": "true", - "name": "url_jpeg", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "StandardMjpeg": { - "description": " MJPEG/Jpeg IP Camera. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Set to true if camera has PTZ support", - "mandatory": "false", - "name": "ptz", - "readonly": "false", - "type": "bool" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "URL for mjpeg stream support", - "mandatory": "false", - "name": "url_mjpeg", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "URL for snapshot in jpeg format", - "mandatory": "true", - "name": "url_jpeg", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "SynoSurveillanceStation": { - "description": " Synology Surveillance Station IP Camera. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "default": "1", - "description": "Profile to use for snapshot. 0- High quality, 1- Balanced, 2- Low bandwidth", - "mandatory": "false", - "max": "2", - "min": "0", - "name": "camera_profile", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Full url to Synology nas. Ex: https://192.168.0.22:5000", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "description": "Username which can access Surveillance Station", - "mandatory": "true", - "name": "username", - "readonly": "false", - "type": "string" - }, - { - "description": "ID of the camera", - "mandatory": "true", - "name": "camera_id", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password for user", - "mandatory": "true", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "TeleinfoInputAnalog": { - "description": "Analog measurement retrieved from Teleinfo informations. An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "PAPP", - "description": "All theses values are reported by the Teleinfo equipment as double.", - "mandatory": "true", - "name": "value", - "readonly": "false", - "type": "list", - "list_value": { - "BASE": "Index if optione BASE is subscribed. (in Watt-hour)", - "BBRHCJB": "Index \"Heures creuses jours bleues\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHCJR": "Index \"Heures creuses jours rouges\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHCJW": "Index \"Heures creuses jours blancs\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHPJB": "Index \"Heures pleines jours bleues\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHPJR": "Index \"Heures pleines jours rouges\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHPJW": "Index \"Heures pleines jours blancs\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "EJPHN": "Index \"Heures Normales\" if otion \"EJP\" is subscribed. (in Watt-hour)", - "EJPHPM": "Index \"Heures de pointe mobile\" if otion \"EJP\" is subscribed. (in Watt-hour)", - "HCHC": "Index \"Heures Creuses\" if this option is subscribed. (in Watt-hour)", - "HCHP": "Index \"Heures Pleine\" if option \"Heures Creuses\" is subscribed. (in Watt-hour)", - "IINST": "Instant intensity. (in Ampere)", - "IMAX": "Maximal intensity. (in Ampere)", - "ISOUSC": "Subscribed intensity. (in Ampere)", - "PAPP": "Apparent power. (in Volt-ampere)" - } - }, - { - "description": "port on which to get Teleinfo information usually a serial port like /dev/ttyS0 or /dev/ttyAMA0", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "TimeRange": { - "description": "Represent a time range object. A time range is true if current time is in one of the included range, false otherwise. The time range also support weekdays and months.", - "alias": [ - "InPlageHoraire" - ], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A time range can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of range", - "name": "changed" - }, - { - "description": "Event triggered when exiting the range", - "name": "false" - }, - { - "description": "Event triggered when entering the range", - "name": "true" - } - ], - "actions": [] - }, - "WebInputAnalog": { - "description": "Analog input read from a web document An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "URL where to download the document from\nIf URL begins with / or with file:// the data is read from the local file", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "WebInputString": { - "description": "String input providing from a web document", - "alias": [], - "parameters": [ - { - "description": "URL where to download the document from\nIf URL begins with / or with file:// the data is read from the local file", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "WebInputTemp": { - "description": "Temperature input read from a web document Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "URL where to download the document from\nIf URL begins with / or with file:// the data is read from the local file", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "WebOutputAnalog": { - "description": "Analog output in a web request Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "description": "URL where to download the document from\nIf URL begins with / or with file:// the data is read from the local file", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "WebOutputLight": { - "description": "Bool output written to a web document or URL Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be :\nhttp://example.com/api?value=20.3\nThe url is encoded before being sent.\nIf the URL begins with / or file:// the data is written to a file.", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values.", - "mandatory": "true", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "WebOutputLightRGB": { - "description": "RGB value written to a web document or URL RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "description": "URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be :\nhttp://example.com/api?value=20.3\nThe url is encoded before being sent.\nIf the URL begins with / or file:// the data is written to a file.", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values.", - "mandatory": "true", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "RGB value has #RRGGBB. Sometimes some web api take only RRGGBBformat. If raw_value is true, the # in front of the line isremoved. The default value for this parameter is false.", - "mandatory": "false", - "name": "raw_value", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "WebOutputString": { - "description": "String output written to a web document or URL", - "alias": [], - "parameters": [ - { - "description": "URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be :\nhttp://example.com/api?value=20.3\nThe url is encoded before being sent.\nIf the URL begins with / or file:// the data is written to a file.", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values.", - "mandatory": "true", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "WIAnalog": { - "description": "Analog measurement with Wago module (like 0-10V, 4-20mA, ...) An analog input can be used to read analog values to display them and use them in rules.", - "alias": [ - "WagoInputAnalog" - ], - "parameters": [ - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "PLC address of the input sensor", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "WIDigitalBP": { - "description": "Switch with digital input Wago modules (like 750-1405, ...) Basic switch with press/release states.", - "alias": [ - "WIDigital", - "WagoInputSwitch" - ], - "parameters": [ - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "PLC address of the digital input", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "WIDigitalLong": { - "description": "Switch long press with digital input Wago modules (like 750-1405, ...) Long press switch. This switch supports single press and long press. User has 500ms to perform the long press.", - "alias": [ - "WagoInputSwitchLongPress" - ], - "parameters": [ - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "PLC address of the digital input", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is pressed at least for 500ms (long press)", - "name": "2" - }, - { - "description": "Event triggered when switch is pressed quickly", - "name": "1" - } - ], - "actions": [] - }, - "WIDigitalTriple": { - "description": "Switch triple click with digital input Wago modules (like 750-1405, ...) Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click.", - "alias": [ - "WagoInputSwitchTriple" - ], - "parameters": [ - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "PLC address of the digital input", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is double clicked", - "name": "2" - }, - { - "description": "Event triggered when switch is triple clicked", - "name": "3" - }, - { - "description": "Event triggered when switch is single clicked", - "name": "1" - } - ], - "actions": [] - }, - "WITemp": { - "description": "Temperature measurement with Wago temperature module (like 750-460) Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [ - "WagoInputTemp" - ], - "parameters": [ - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "PLC address of the input sensor", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "WOAnalog": { - "description": "Analog output with Wago module (like 0-10V, 4-20mA, ...) Analog output. Useful to control analog output devices connected to calaos.", - "alias": [ - "WagoOutputAnalog" - ], - "parameters": [ - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "PLC address of the output", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "WODali": { - "description": "Light using DALI or DMX. For DALI you need a 750-641 wago module. For DMX, a DMX4ALL-LAN device connected to the Wago PLC. Light with dimming control. Light intensity can be changed for this light.", - "alias": [ - "WagoOutputDimmer" - ], - "parameters": [ - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "DALI fade time. value is between 1-10", - "mandatory": "false", - "max": "10", - "min": "1", - "name": "fade_time", - "readonly": "false", - "type": "int" - }, - { - "default": "1", - "description": "DALI bus line, usually 1", - "mandatory": "false", - "name": "line", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "Device address. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105", - "mandatory": "true", - "max": "612", - "min": "1", - "name": "address", - "readonly": "false", - "type": "int" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Set to 1 if address is a DALI group address, set to 0 otherwise.", - "mandatory": "false", - "max": "1", - "min": "0", - "name": "group", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "WODaliRVB": { - "description": "RGB Light using DALI or DMX. To work you need 3 DALI/DMX channels. For DALI you need a 750-641 wago module. For DMX, a DMX4ALL-LAN device connected to the Wago PLC. RGB light. Choose a color to be set for this light.", - "alias": [ - "WagoOutputDimmerRGB" - ], - "parameters": [ - { - "default": "0", - "description": "DALI fade time for blue channel. value is between 1-10", - "mandatory": "false", - "max": "10", - "min": "1", - "name": "bfade_time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Set to 1 if address for blue channel is a DALI group address, set to 0 otherwise.", - "mandatory": "false", - "max": "1", - "min": "0", - "name": "bgroup", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Set to 1 if address for green channel is a DALI group address, set to 0 otherwise.", - "mandatory": "false", - "max": "1", - "min": "0", - "name": "ggroup", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Device address for green channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105", - "mandatory": "true", - "max": "612", - "min": "1", - "name": "gaddress", - "readonly": "false", - "type": "int" - }, - { - "default": "1", - "description": "DALI bus line for green channel, usually 1", - "mandatory": "false", - "name": "gline", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "DALI fade time for red channel. value is between 1-10", - "mandatory": "false", - "max": "10", - "min": "1", - "name": "rfade_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Device address for blue channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105", - "mandatory": "true", - "max": "612", - "min": "1", - "name": "baddress", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "DALI fade time for green channel. value is between 1-10", - "mandatory": "false", - "max": "10", - "min": "1", - "name": "gfade_time", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "1", - "description": "DALI bus line for blue channel, usually 1", - "mandatory": "false", - "name": "bline", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "DALI bus line for red channel, usually 1", - "mandatory": "false", - "name": "rline", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Device address for red channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105", - "mandatory": "true", - "max": "612", - "min": "1", - "name": "raddress", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Set to 1 if address for red channel is a DALI group address, set to 0 otherwise.", - "mandatory": "false", - "max": "1", - "min": "0", - "name": "rgroup", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "WODigital": { - "description": "Simple light or relay control using wago digital output modules (like 750-1504, ...) Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [ - "WagoOutputLight" - ], - "parameters": [ - { - "description": "Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module)", - "mandatory": "false", - "name": "knx", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "PLC address of the output", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Should be false if PLC is 750-842, true otherwise", - "mandatory": "true", - "name": "wago_841", - "readonly": "false", - "type": "bool" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "WOLOutputBool": { - "description": "Wake On Lan output object. Send wake-on-lan packet to a device on the network.", - "alias": [], - "parameters": [ - { - "default": "15000", - "description": "Interval between pings in ms. Default to 15 sec", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Ethernet MAC address of the host to wake up", - "mandatory": "true", - "name": "address", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [ - { - "description": "Send wake on lan packet to the configured device", - "name": "true" - } - ] - }, - "WOVolet": { - "description": "Simple shutter using wago digital output modules (like 750-1504, ...) Simple shutter. This shutter supports open/close states, as well as impulse shutters.", - "alias": [ - "WagoOutputShutter" - ], - "parameters": [ - { - "description": "Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module)", - "mandatory": "false", - "name": "knx", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Should be false if PLC is 750-842, true otherwise", - "mandatory": "true", - "name": "wago_841", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Digital output address on the PLC for closing the shutter", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var_down", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Digital output address on the PLC for opening the shutter", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var_up", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to open or close", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "WOVoletSmart": { - "description": "Smart shutter using wago digital output modules (like 750-1504, ...) Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position.", - "alias": [ - "WagoOutputShutterSmart" - ], - "parameters": [ - { - "description": "Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module)", - "mandatory": "false", - "name": "knx", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Should be false if PLC is 750-842, true otherwise", - "mandatory": "true", - "name": "wago_841", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Digital output address on the PLC for closing the shutter", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var_down", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Digital output address on the PLC for opening the shutter", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var_up", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "60", - "description": "Time in sec for shutter to be fully open. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_up", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to fully closed. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_down", - "readonly": "false", - "type": "int" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open the shutter by X percent", - "name": "up 5" - }, - { - "description": "Set shutter at position X in percent", - "name": "set 50" - }, - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close the shutter by X percent", - "name": "down 5" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost.", - "name": "calibrate" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "X10Output": { - "description": "Light dimmer using X10 and heyu. Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "House code of the X10 light device", - "mandatory": "true", - "name": "code", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "xPLInputAnalog": { - "description": "xPL analog sensor An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Sensor ID, as set in your xPL network", - "mandatory": "true", - "name": "sensor", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "xPLInputString": { - "description": "xPL string sensor", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Sensor ID, as set in your xPL network", - "mandatory": "true", - "name": "sensor", - "readonly": "false", - "type": "string" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "xPLInputSwitch": { - "description": "xPL input switch Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "description": "Sensor ID, as set in your xPL network", - "mandatory": "true", - "name": "sensor", - "readonly": "false", - "type": "string" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "xPLInputTemp": { - "description": "xPL temperature sensor Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Sensor ID, as set in your xPL network", - "mandatory": "true", - "name": "sensor", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "xPLOutputAnalog": { - "description": "Analog output controlled by xPL Protocol Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "description": "Actuator ID, as set in your xPL network", - "mandatory": "true", - "name": "actuator", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "xPLOutputString": { - "description": "Analog output controlled by xPL Protocol", - "alias": [], - "parameters": [ - { - "description": "Actuator ID, as set in your xPL network", - "mandatory": "true", - "name": "actuator", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "xPLOutputSwitch": { - "description": "Light/relay controlled by xPL Protocol Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "Actuator ID, as set in your xPL network", - "mandatory": "true", - "name": "actuator", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "ZibaseAnalogIn": { - "description": "Zibase analog input. This object can read value from devices like Energy monitor sensors, Lux sensors, ... An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "energy", - "description": "Type of sensor", - "mandatory": "true", - "name": "zibase_sensor", - "readonly": "false", - "type": "list", - "list_value": { - "energy": "Energy monitor sensor", - "lux": "Lux sensor", - "t_rain": "Total rain sensor", - "wind": "Wind sensor" - } - }, - { - "description": "Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id", - "readonly": "false", - "type": "string" - }, - { - "default": "17100", - "description": "Zibase ethernet port, default to 17100", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "Zibase IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "ZibaseDigitalIn": { - "description": "Zibase digital input. This object acts as a switch Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "description": "Second Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id2", - "readonly": "false", - "type": "string" - }, - { - "description": "Zibase IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "detect", - "description": "Type of sensor", - "mandatory": "true", - "name": "zibase_sensor", - "readonly": "false", - "type": "list", - "list_value": { - "detect": "Door/Window sensor", - "inter": "Switch/Remote control" - } - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "First Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "17100", - "description": "Zibase ethernet port, default to 17100", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "ZibaseDigitalOut": { - "description": "Zibase digital output. This object controls Zibase devices Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "17100", - "description": "Zibase ethernet port, default to 17100", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Number of burst to send to the device", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "nbburst", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Zibase IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Protocol to use", - "mandatory": "true", - "name": "protocol", - "readonly": "false", - "type": "list", - "list_value": { - "0": "DEFAULT_PROTOCOL", - "1": "VISONIC433", - "10": "XDD868shutter", - "11": "XDD868pilot", - "12": "XDD868boiler", - "2": "VISONIC868", - "3": "CHACON", - "4": "DOMIA", - "5": "RFX10", - "6": "ZWAVE", - "7": "RFSTS10", - "8": "XDD433alrm", - "9": "XDD868alrmn" - } - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "ZibaseTemp": { - "description": "Zibase temperature sensor Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "default": "temp", - "description": "Type of sensor", - "mandatory": "true", - "name": "zibase_sensor", - "readonly": "false", - "type": "list", - "list_value": { - "temp": "Temperature sensor" - } - }, - { - "description": "Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id", - "readonly": "false", - "type": "string" - }, - { - "default": "17100", - "description": "Zibase ethernet port, default to 17100", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "Zibase IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - } -} \ No newline at end of file diff --git a/build_doc/en/io_doc.md b/build_doc/en/io_doc.md deleted file mode 100644 index 6739d1b5..00000000 --- a/build_doc/en/io_doc.md +++ /dev/null @@ -1,3676 +0,0 @@ - -# AVReceiver -AVReceiver object to control network amplifier - -## Parameters of AVReceiver -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -model | string | yes | AVReceiver model. Supported: pioneer, denon, onkyo, marantz, yamaha -zone | int | no | Zone of the amplifier (if supported) -host | string | yes | IP address of the device -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -port | int | no | Port to use for connection -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Actions of AVReceiver -Name | Description ----- | ----------- -custom XXXXXX | Send a custom command to receiver (if you know the protocol) - source X | Change current input source - volume 50 | Set current volume - power off | Switch receiver off - power on | Switch receiver on - -# Axis - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Axis IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of Axis -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -resolution | string | no | Resolution to use -name | string | yes | Name of Input/Output. -tilt_framesize | string | no | -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -pan_framesize | string | no | -model | string | yes | Camera model/chanel to use -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -ptz | bool | no | Set to true if camera has PTZ support -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -zoom_step | string | no | - - -# BlinkstickOutputLightRGB -RGB Light dimmer using a Blinkstick - - -RGB light. Choose a color to be set for this light. - -## Parameters of BlinkstickOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -nb_leds | int | yes | Number of LEDs to control with the blinkstick -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -serial | string | yes | Blinkstick serial to control -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of BlinkstickOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of BlinkstickOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* OLA: http://www.blinkstick.com - -# Foscam - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Foscam IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of Foscam -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -password | string | yes | Password for user -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP Address -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -port | string | yes | Port number -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -ptz | bool | no | Set to true if camera has PTZ support -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -zoom_step | string | no | -username | string | yes | Username for accessing the camera - -# Gadspot - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Gadspot IP Camera. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of Gadspot -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# GpioInputSwitch -Input switch with a GPIO - - -Basic switch with press/release states. - -## Parameters of GpioInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -gpio | int | yes | GPIO ID on your hardware -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -active_low | bool | no | Set this if your GPIO has an inverted level -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of GpioInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - - -# GpioInputSwitchLongPress -Input switch with a GPIO - - -Long press switch. This switch supports single press and long press. User has 500ms to perform the long press. - -## Parameters of GpioInputSwitchLongPress -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -gpio | int | yes | GPIO ID on your hardware -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -active_low | bool | no | Set this is your GPIO has an inverted level -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of GpioInputSwitchLongPress -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is pressed at least for 500ms (long press) - 1 | Event triggered when switch is pressed quickly - - -# GpioInputSwitchTriple -Input switch with a GPIO - - -Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click. - -## Parameters of GpioInputSwitchTriple -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -gpio | int | yes | GPIO ID on your hardware -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -active_low | bool | no | Set this is your GPIO has an inverted level -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of GpioInputSwitchTriple -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is double clicked - 3 | Event triggered when switch is triple clicked - 1 | Event triggered when switch is single clicked - - -# GpioOutputShutter -Shutter with 2 GPIOs - - -Simple shutter. This shutter supports open/close states, as well as impulse shutters. - -## Parameters of GpioOutputShutter -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -active_low_up | bool | no | Set this is your GPIO has an inverted level -active_low_down | bool | no | Set this is your GPIO has an inverted level -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -gpio_down | int | yes | GPIO ID for closing on your hardware -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -time | int | yes | Time in sec for shutter to open or close -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -gpio_up | int | yes | GPIO ID for opening on your hardware - -## Conditions of GpioOutputShutter -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of GpioOutputShutter -Name | Description ----- | ----------- -impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - - -# GpioOutputShutterSmart -Shutter with 2 GPIOs - - -Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position. - -## Parameters of GpioOutputShutterSmart -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -active_low_up | bool | no | Set this is your GPIO has an inverted level -gpio_down | int | yes | GPIO ID for closing on your hardware -active_low_down | bool | no | Set this is your GPIO has an inverted level -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -time_up | int | yes | Time in sec for shutter to be fully open. The more accurate, the better it will work -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -time_down | int | yes | Time in sec for shutter to fully closed. The more accurate, the better it will work -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -gpio_up | int | yes | GPIO ID for opening on your hardware - -## Conditions of GpioOutputShutterSmart -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of GpioOutputShutterSmart -Name | Description ----- | ----------- -up 5 | Open the shutter by X percent - set 50 | Set shutter at position X in percent - impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - down 5 | Close the shutter by X percent - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - calibrate | Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - - -# GpioOutputSwitch -Light with a GPIO - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of GpioOutputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -gpio | int | yes | GPIO ID on your hardware -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -active_low | bool | no | Set this is your GPIO has an inverted level -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of GpioOutputSwitch -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of GpioOutputSwitch -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# HueOutputLightRGB -RGB Light dimmer using a Philips Hue - - -RGB light. Choose a color to be set for this light. - -## Parameters of HueOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -api | string | yes | API key return by Hue bridge when assciation has been made. Use Hue Wizard in calaos_installer to get this value automatically. -host | string | yes | Hue bridge IP address -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -id_hue | string | yes | Unique ID describing the Hue Light. This value is returned by the Hue Wizard. -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of HueOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of HueOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* Meet Hue: http://www.meethue.com - - -# InputTime -Basic time input. An event is triggered when the current time equals the configured time. A specific date can also be set. - -## Parameters of InputTime -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | A time object can't be visible. Always false. -year | int | no | Year for this time input -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -min | int | yes | Minutes for this time input -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -day | int | no | Day for this time input -hour | int | yes | Hour for this time input -sec | int | yes | Seconds for this time input -name | string | yes | Name of Input/Output. -month | int | no | Month for this time input - -## Conditions of InputTime -Name | Description ----- | ----------- -changed | Event on any change of time - false | Event triggered when current time is not equal - true | Event triggered when current time equals - - -# InputTimer -Timer object. trigger an event after the configured time has expired. - -## Parameters of InputTimer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -autorestart | bool | yes | Auto restart the timer when time expires -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A timer object can't be visible. Always false. -msec | int | yes | Miliseconds for the timer interval -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -min | int | yes | Minutes for the timer interval -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -hour | int | yes | Hour for the timer interval -autostart | bool | yes | Auto start the timer when calaos starts -sec | int | yes | Seconds for the timer interval - -## Conditions of InputTimer -Name | Description ----- | ----------- -change | Event triggered on any change - false | Event triggered when timer starts - true | Event triggered when timer expires - -## Actions of InputTimer -Name | Description ----- | ----------- -00:00:00:200 | Reset the configured time to a value. Format is h:m:s:ms - stop | Stop the timer - start | Start the timer - - -# InternalBool -Internal boolean object. This object is useful for doing internal programing in rules, like keeping boolean states, or displaying boolean values - -## Parameters of InternalBool -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -rw | bool | no | Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -save | bool | no | Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of InternalBool -Name | Description ----- | ----------- -changed | Event on any change of value - false | Event when value is false - true | Event when value is true - -## Actions of InternalBool -Name | Description ----- | ----------- -impulse 200 | Do an impulse on boolean value. Set to true for X ms then reset to false - impulse 500 200 500 200 | Do an impulse on boolean value with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert boolean value - false | Set a value to false - true | Set a value to true - - -# InternalInt -Internal number object. This object is useful for doing internal programing in rules, like counters, of displaying values. - -## Parameters of InternalInt -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -rw | bool | no | Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false -unit | string | no | Unit which will be displayed on the UI as a suffix. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -save | bool | no | Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false -step | float | no | Set a step for increment/decrement value. Default is 1.0 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of InternalInt -Name | Description ----- | ----------- -changed | Event on any change of value - 0 | Event on a specific number value - -## Actions of InternalInt -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - - -# InternalString -Internal string object. This object is useful for doing internal programing in rules or displaying text values on user interfaces. - -## Parameters of InternalString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -rw | bool | no | Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -save | bool | no | Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of InternalString -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific string value - -## Actions of InternalString -Name | Description ----- | ----------- -value | Set a specific string value - - -# KNXInputAnalog -Input analog with KNX and eibnetmux - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of KNXInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -knx_group | string | yes | KNX Group address, Ex: x/y/z -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Hostname of knxd, default to localhost -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of KNXInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXInputSwitch -Input switch with KNX and eibnetmux - - -Basic switch with press/release states. - -## Parameters of KNXInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group | string | yes | KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -eis | int | no | KNX EIS (Data type) -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of KNXInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXInputSwitchLongPress -Input switch long press with KNX and eibnetmux - - -Long press switch. This switch supports single press and long press. User has 500ms to perform the long press. - -## Parameters of KNXInputSwitchLongPress -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group | string | yes | KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -eis | int | no | KNX EIS (Data type) -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of KNXInputSwitchLongPress -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is pressed at least for 500ms (long press) - 1 | Event triggered when switch is pressed quickly - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXInputSwitchTriple -Input switch triple with KNX and eibnetmux - - -Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click. - -## Parameters of KNXInputSwitchTriple -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group | string | yes | KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -eis | int | no | KNX EIS (Data type) -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of KNXInputSwitchTriple -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is double clicked - 3 | Event triggered when switch is triple clicked - 1 | Event triggered when switch is single clicked - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXInputTemp -Input temperature with KNX and eibnetmux - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of KNXInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -knx_group | string | yes | KNX Group address, Ex: x/y/z -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Hostname of knxd, default to localhost -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of KNXInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputAnalog -Analog output with KNX and eibnetmux - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of KNXOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -knx_group | string | yes | KNX Group address, Ex: x/y/z -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of KNXOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of KNXOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputLight -Light output with KNX and eibnetmux - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of KNXOutputLight -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -eis | int | no | KNX EIS (Data type) -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -knx_group | string | yes | KNX Group address, Ex: x/y/z -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false - -## Conditions of KNXOutputLight -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of KNXOutputLight -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputLightDimmer -Light dimmer with KNX and eibnetmux - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of KNXOutputLightDimmer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group | string | yes | KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -eis | int | no | KNX EIS (Data type) -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of KNXOutputLightDimmer -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of KNXOutputLightDimmer -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputLightRGB -Light RGB with KNX and eibnetmux - - -RGB light. Choose a color to be set for this light. - -## Parameters of KNXOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group_blue | string | no | Blue Group address for listening status, Ex: x/y/z -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -listen_knx_group_green | string | no | Green Group address for listening status, Ex: x/y/z -knx_group_red | string | yes | Red channel KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -knx_group_green | string | yes | Green channel KNX Group address, Ex: x/y/z -listen_knx_group_red | string | no | Red Group address for listening status, Ex: x/y/z -knx_group_blue | string | yes | Blue channel KNX Group address, Ex: x/y/z - -## Conditions of KNXOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of KNXOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputShutter -Shutter with with KNX and eibnetmux - - -Simple shutter. This shutter supports open/close states, as well as impulse shutters. - -## Parameters of KNXOutputShutter -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -eis | int | no | KNX EIS (Data type) -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -time | int | yes | Time in sec for shutter to open or close -knx_group_down | string | yes | Down KNX Group address, Ex: x/y/z -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -knx_group_up | string | yes | Up KNX Group address, Ex: x/y/z - -## Conditions of KNXOutputShutter -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of KNXOutputShutter -Name | Description ----- | ----------- -impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputShutterSmart -Shutter with with KNX and eibnetmux - - -Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position. - -## Parameters of KNXOutputShutterSmart -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group_down | string | yes | Down KNX Group address, Ex: x/y/z -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -knx_group | string | yes | KNX Group address, Ex: x/y/z -time_up | int | yes | Time in sec for shutter to be fully open. The more accurate, the better it will work -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -time_down | int | yes | Time in sec for shutter to fully closed. The more accurate, the better it will work -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -knx_group_up | string | yes | Up KNX Group address, Ex: x/y/z - -## Conditions of KNXOutputShutterSmart -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of KNXOutputShutterSmart -Name | Description ----- | ----------- -up 5 | Open the shutter by X percent - set 50 | Set shutter at position X in percent - impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - down 5 | Close the shutter by X percent - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - calibrate | Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# MilightOutputLightRGB -RGB light support for Limitless/Milight RGB bulbs. - - -RGB light. Choose a color to be set for this light. - -## Parameters of MilightOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -zone | int | yes | Zone to control. Each gateway supports 4 zones. -host | string | yes | Milight wifi gateway IP address -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -port | int | no | Gateway port, default to 8899 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of MilightOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MilightOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* LimitlessLED: http://www.limitlessled.com - - -# MqttInputAnalog -Analog value read from a mqtt broker - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of MqttInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -port | int | no | TCP port of the mqtt broker. Default value is 1883 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of MqttInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# MqttInputString -String value read from a mqtt broker - -## Parameters of MqttInputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - - -# MqttInputSwitch -Switch value read from a mqtt broker - - -Basic switch with press/release states. - -## Parameters of MqttInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -on_value | string | yes | Value to interpret as ON value -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -off_value | string | yes | Value to interpret as OFF value -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | A switch can't be visible. Always false. -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - -## Conditions of MqttInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - - -# MqttInputTemp -Temperature read from a mqtt broker - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of MqttInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -port | int | no | TCP port of the mqtt broker. Default value is 1883 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of MqttInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - - -# MqttOutputAnalog -Control analog output through mqtt broker - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of MqttOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data | string | yes | The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with the state (float value) to be sent. -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -port | int | no | TCP port of the mqtt broker. Default value is 1883 -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of MqttOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of MqttOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - - -# MqttOutputLight -Control lights through mqtt broker - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of MqttOutputLight -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data | string | yes | The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with with the state (on_value, off_value) to be sent. -on_value | string | yes | Value to interpret as ON value -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -off_value | string | yes | Value to interpret as OFF value -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - -## Conditions of MqttOutputLight -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of MqttOutputLight -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# MqttOutputLightDimmer -Control lights through mqtt broker - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of MqttOutputLightDimmer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data | string | yes | The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with the state (integer value) to be sent. -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - -## Conditions of MqttOutputLightDimmer -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MqttOutputLightDimmer -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - - -# MqttOutputLightRGB -Control RGB lights through mqtt broker - - -RGB light. Choose a color to be set for this light. - -## Parameters of MqttOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -path_brightness | string | yes | The path where to found the brightness value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example 'brightness' -path_y | string | yes | The path where to found the Y (X/Y Color space) value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example color.y, try to read the x value from the color object. -path_x | string | yes | The path where to found the X (X/Y Color space) value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example color.x, try to read the x value from the color object. -data | string | yes | The data sent when publishing color to topic. The __##VALUE_R##__ __##VALUE_G##__ __##VALUE_B##__ or __##VALUE_HEX##__ or __##VALUE_X##__ __##VALUE_Y##__ __##VALUE_BRIGHTNESS##__ contained in data is substituted with the color (integer value or #RRGGBB string value) to be sent. -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - -## Conditions of MqttOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MqttOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - - -# MySensorsInputAnalog -Analog measurement with MySensors node - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of MySensorsInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | IP address of the tcp gateway if relevant -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of MySensorsInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputString -Display string from MySensors node - -## Parameters of MySensorsInputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputSwitch -Input switch with MySensors node - - -Basic switch with press/release states. - -## Parameters of MySensorsInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -visible | bool | no | A switch can't be visible. Always false. -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of MySensorsInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputSwitchLongPress -Input long press switch with MySensors node - - -Long press switch. This switch supports single press and long press. User has 500ms to perform the long press. - -## Parameters of MySensorsInputSwitchLongPress -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -visible | bool | no | A switch can't be visible. Always false. -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of MySensorsInputSwitchLongPress -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is pressed at least for 500ms (long press) - 1 | Event triggered when switch is pressed quickly - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputSwitchTriple -Input triple click switch with MySensors node - - -Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click. - -## Parameters of MySensorsInputSwitchTriple -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -visible | bool | no | A switch can't be visible. Always false. -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of MySensorsInputSwitchTriple -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is double clicked - 3 | Event triggered when switch is triple clicked - 1 | Event triggered when switch is single clicked - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputTemp -Temperature sensor with MySensors node - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of MySensorsInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | IP address of the tcp gateway if relevant -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of MySensorsInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputAnalog -Analog output with MySensors node - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of MySensorsOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values. -sensor_id | string | yes | Sensor ID, as set in your node -node_id | string | yes | Node ID as set in your network -host | string | yes | IP address of the tcp gateway if relevant -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -gateway | list | yes | Gateway type used, tcp or serial are supported -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of MySensorsOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of MySensorsOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputDimmer -Light dimmer with MySensors node - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of MySensorsOutputDimmer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values. -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -node_id | string | yes | Node ID as set in your network -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP address of the tcp gateway if relevant -sensor_id | string | yes | Sensor ID, as set in your node - -## Conditions of MySensorsOutputDimmer -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MySensorsOutputDimmer -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputLight -Light/relay with MySensors node - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of MySensorsOutputLight -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values. -sensor_id | string | yes | Sensor ID, as set in your node -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -node_id | string | yes | Node ID as set in your network -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP address of the tcp gateway if relevant - -## Conditions of MySensorsOutputLight -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of MySensorsOutputLight -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputLightRGB -RGB Light dimmer with MySensors node - - -RGB light. Choose a color to be set for this light. - -## Parameters of MySensorsOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values. -node_id_green | string | yes | Node ID for green channel, as set in your network -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -gateway | list | yes | Gateway type used, tcp or serial are supported -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -sensor_id_green | string | yes | Sensor ID green red channel, as set in your node -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP address of the tcp gateway if relevant -sensor_id_blue | string | yes | Sensor ID blue red channel, as set in your node -node_id_blue | string | yes | Node ID for blue channel, as set in your network -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -node_id_red | string | yes | Node ID for red channel, as set in your network -sensor_id_red | string | yes | Sensor ID for red channel, as set in your node - -## Conditions of MySensorsOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MySensorsOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputShutter -Shutter with MySensors node - - -Simple shutter. This shutter supports open/close states, as well as impulse shutters. - -## Parameters of MySensorsOutputShutter -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values. -sensor_id_down | string | yes | Sensor ID for closing shutter, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id_up | string | yes | Node ID for opening shutter, as set in your network -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -node_id_down | string | yes | Node ID for closing shutter, as set in your network -io_type | string | yes | IO type, can be "input", "output", "inout" -sensor_id_up | string | yes | Sensor ID for opening shutter, as set in your node -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -time | int | yes | Time in sec for shutter to open or close -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 - -## Conditions of MySensorsOutputShutter -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of MySensorsOutputShutter -Name | Description ----- | ----------- -impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputShutterSmart -Smart shutter with MySensors node - - -Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position. - -## Parameters of MySensorsOutputShutterSmart -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values. -sensor_id_down | string | yes | Sensor ID for closing shutter, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id_up | string | yes | Node ID for opening shutter, as set in your network -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -node_id_down | string | yes | Node ID for closing shutter, as set in your network -time_up | int | yes | Time in sec for shutter to be fully open. The more accurate, the better it will work -io_type | string | yes | IO type, can be "input", "output", "inout" -sensor_id_up | string | yes | Sensor ID for opening shutter, as set in your node -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -time_down | int | yes | Time in sec for shutter to fully closed. The more accurate, the better it will work -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 - -## Conditions of MySensorsOutputShutterSmart -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of MySensorsOutputShutterSmart -Name | Description ----- | ----------- -up 5 | Open the shutter by X percent - set 50 | Set shutter at position X in percent - impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - down 5 | Close the shutter by X percent - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - calibrate | Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputString -String output with MySensors node - -## Parameters of MySensorsOutputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_VAR1, see MySensors.cpp for more values. -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -node_id | string | yes | Node ID as set in your network -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP address of the tcp gateway if relevant -sensor_id | string | yes | Sensor ID, as set in your node - -## More Infos -* MySensors: http://mysensors.org - - -# OLAOutputLightDimmer -DMX Light dimmer using OLA (Open Lighting Architecture) - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of OLAOutputLightDimmer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -channel | int | yes | DMX channel to control -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -universe | int | yes | OLA universe to control -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of OLAOutputLightDimmer -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of OLAOutputLightDimmer -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - -## More Infos -* OLA: http://www.openlighting.org - - -# OLAOutputLightRGB -RGB Light dimmer using 3 DMX channels with OLA (Open Lighting Architecture) - - -RGB light. Choose a color to be set for this light. - -## Parameters of OLAOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -channel_blue | int | yes | DMX channel for blue to control -channel_red | int | yes | DMX channel for red to control -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -channel_green | int | yes | DMX channel for green to control -universe | int | yes | OLA universe to control -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of OLAOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of OLAOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* OLA: http://www.openlighting.org - - -# OutputFake -Fake test output. Do nothing. Do not use. - -## Parameters of OutputFake -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# OWTemp -Temperature measurement with DS18B20 Onewire Sensor - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of OWTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -use_w1 | bool | no | Force the use of w1 kernel driver instead of OneWire driver -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -ow_id | string | yes | Unique ID of sensor on OneWire bus. -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -ow_args | string | yes | Additional parameter used for owfs initialization.For example you can use -u to use the USB owfs drivers -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of OWTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/OneWire - - -# PingInputSwitch -A switch input based on the result of a ping command. Useful to detect presence of a host on the network. - - -Basic switch with press/release states. - -## Parameters of PingInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -interval | int | no | Interval between pings in ms. Default to 15 sec -timeout | int | no | Timeout of the ping request in ms -host | string | yes | IP address or host where to send the ping -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of PingInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | The host is offline and/or does not respond to the ping - true | The host is online and respond to the ping - -# Planet - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Planet IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of Planet -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -password | string | no | Password for user -username | string | no | Username for accessing the camera -model | string | yes | Camera model (ICA-210, ICA-210W, ICA-300, ICA-302, ICA-500) to use -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# Scenario -A scenario variable. Use this like a virtual button to start a scenario (list of actions) - -## Parameters of Scenario -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -auto_scenario | string | no | Internal use only for Auto Scenario. read only. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of Scenario -Name | Description ----- | ----------- -true | Event triggered when scenario is started - -## Actions of Scenario -Name | Description ----- | ----------- -changed | Event triggered on any change - false | Stop the scenario (only for special looping scenarios) - true | Start the scenario - - -# Squeezebox -#### Alias: slim -Squeezebox audio player allows control of a Squeezebox from Calaos - -## Parameters of Squeezebox -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -port_cli | int | no | CLI port of LMS, default to 9090 -host | string | yes | Logitech media server IP address -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -port_web | int | no | Web interface port of LMS, default to 9000. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | yes | Audio players are not displayed in rooms -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID of squeezebox in LMS - -## Conditions of Squeezebox -Name | Description ----- | ----------- -onplaylistchange | Event when a change in the current playlist happens - onvolumechange | Event when a change of volume happens - onstop | Event when stopping player - onsongchange | Event when a new song is being played - onpause | Event when pausing player - onplay | Event when play is started - -## Actions of Squeezebox -Name | Description ----- | ----------- -add | Add tracks to playlist. can be any of album_id:XX artist_id:XX playlist_id:XX, ... - play | Clear playlist and play argument. can be any of album_id:XX artist_id:XX playlist_id:XX, ... - pause | Pause player - sync | Sync this player with an other - stop | Stop player - volume up 1 | Increase volume by a value - volume set 50 | Set current volume - previous | Play previous song in playlist - volume down 1 | Decrease volume by a value - play | Start playing - next | Play next song in playlist - power on | Switch player on - sleep 10 | Start sleep mode with X seconds - power off | Switch player off - unsync | Stop sync of this player with an other - -# standard_mjpeg - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -MJPEG/Jpeg IP Camera. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of standard_mjpeg -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -ptz | bool | no | Set to true if camera has PTZ support -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -url_mjpeg | string | no | URL for mjpeg stream support -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -url_jpeg | string | yes | URL for snapshot in jpeg format -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -# StandardMjpeg - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -MJPEG/Jpeg IP Camera. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of StandardMjpeg -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -ptz | bool | no | Set to true if camera has PTZ support -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -url_mjpeg | string | no | URL for mjpeg stream support -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -url_jpeg | string | yes | URL for snapshot in jpeg format -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -# SynoSurveillanceStation - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Synology Surveillance Station IP Camera. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of SynoSurveillanceStation -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -camera_profile | int | no | Profile to use for snapshot. 0- High quality, 1- Balanced, 2- Low bandwidth -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -url | string | yes | Full url to Synology nas. Ex: https://192.168.0.22:5000 -username | string | yes | Username which can access Surveillance Station -camera_id | string | yes | ID of the camera -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | yes | Password for user - - -# TeleinfoInputAnalog -Analog measurement retrieved from Teleinfo informations. - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of TeleinfoInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -value | list | yes | All theses values are reported by the Teleinfo equipment as double. -port | string | yes | port on which to get Teleinfo information usually a serial port like /dev/ttyS0 or /dev/ttyAMA0 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of TeleinfoInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# TimeRange -#### Alias: InPlageHoraire -Represent a time range object. A time range is true if current time is in one of the included range, false otherwise. The time range also support weekdays and months. - -## Parameters of TimeRange -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A time range can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of TimeRange -Name | Description ----- | ----------- -changed | Event on any change of range - false | Event triggered when exiting the range - true | Event triggered when entering the range - - -# WebInputAnalog -Analog input read from a web document - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of WebInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -url | string | yes | URL where to download the document from -If URL begins with / or with file:// the data is read from the local file -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -file_type | string | yes | File type of the document. Values can be xml, json or text. -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of WebInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# WebInputString -String input providing from a web document - -## Parameters of WebInputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -url | string | yes | URL where to download the document from -If URL begins with / or with file:// the data is read from the local file -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -file_type | string | yes | File type of the document. Values can be xml, json or text. -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# WebInputTemp -Temperature input read from a web document - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of WebInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -url | string | yes | URL where to download the document from -If URL begins with / or with file:// the data is read from the local file -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -file_type | string | yes | File type of the document. Values can be xml, json or text. -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of WebInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - - -# WebOutputAnalog -Analog output in a web request - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of WebOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -file_type | string | yes | File type of the document. Values can be xml, json or text. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -url | string | yes | URL where to download the document from -If URL begins with / or with file:// the data is read from the local file -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of WebOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of WebOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - - -# WebOutputLight -Bool output written to a web document or URL - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of WebOutputLight -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -url | string | yes | URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be : -http://example.com/api?value=20.3 -The url is encoded before being sent. -If the URL begins with / or file:// the data is written to a file. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -data_type | string | yes | The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -data | string | yes | The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WebOutputLight -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of WebOutputLight -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# WebOutputLightRGB -RGB value written to a web document or URL - - -RGB light. Choose a color to be set for this light. - -## Parameters of WebOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -url | string | yes | URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be : -http://example.com/api?value=20.3 -The url is encoded before being sent. -If the URL begins with / or file:// the data is written to a file. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -data_type | string | yes | The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -data | string | yes | The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -raw_value | bool | no | RGB value has #RRGGBB. Sometimes some web api take only RRGGBBformat. If raw_value is true, the # in front of the line isremoved. The default value for this parameter is false. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WebOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of WebOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - - -# WebOutputString -String output written to a web document or URL - -## Parameters of WebOutputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -url | string | yes | URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be : -http://example.com/api?value=20.3 -The url is encoded before being sent. -If the URL begins with / or file:// the data is written to a file. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -file_type | string | yes | File type of the document. Values can be xml, json or text. -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -data_type | string | yes | The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -data | string | yes | The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# WIAnalog -#### Alias: WagoInputAnalog -Analog measurement with Wago module (like 0-10V, 4-20mA, ...) - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of WIAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -port | int | no | Wago ethernet port, default to 502 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -var | int | yes | PLC address of the input sensor -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Wago PLC IP address on the network -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of WIAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/entree_analog - - -# WIDigitalBP -#### Alias: WIDigital, WagoInputSwitch -Switch with digital input Wago modules (like 750-1405, ...) - - -Basic switch with press/release states. - -## Parameters of WIDigitalBP -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Wago PLC IP address on the network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -port | int | no | Wago ethernet port, default to 502 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -var | int | yes | PLC address of the digital input -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WIDigitalBP -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1045 - - -# WIDigitalLong -#### Alias: WagoInputSwitchLongPress -Switch long press with digital input Wago modules (like 750-1405, ...) - - -Long press switch. This switch supports single press and long press. User has 500ms to perform the long press. - -## Parameters of WIDigitalLong -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Wago PLC IP address on the network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -port | int | no | Wago ethernet port, default to 502 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -var | int | yes | PLC address of the digital input -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WIDigitalLong -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is pressed at least for 500ms (long press) - 1 | Event triggered when switch is pressed quickly - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1045 - - -# WIDigitalTriple -#### Alias: WagoInputSwitchTriple -Switch triple click with digital input Wago modules (like 750-1405, ...) - - -Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click. - -## Parameters of WIDigitalTriple -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Wago PLC IP address on the network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -port | int | no | Wago ethernet port, default to 502 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -var | int | yes | PLC address of the digital input -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WIDigitalTriple -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is double clicked - 3 | Event triggered when switch is triple clicked - 1 | Event triggered when switch is single clicked - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1045 - - -# WITemp -#### Alias: WagoInputTemp -Temperature measurement with Wago temperature module (like 750-460) - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of WITemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -port | int | no | Wago ethernet port, default to 502 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -var | int | yes | PLC address of the input sensor -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Wago PLC IP address on the network -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of WITemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-460 - - -# WOAnalog -#### Alias: WagoOutputAnalog -Analog output with Wago module (like 0-10V, 4-20mA, ...) - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of WOAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -port | int | no | Wago ethernet port, default to 502 -host | string | yes | Wago PLC IP address on the network -var | int | yes | PLC address of the output -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of WOAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of WOAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/sortie_analog - - -# WODali -#### Alias: WagoOutputDimmer -Light using DALI or DMX. For DALI you need a 750-641 wago module. For DMX, a DMX4ALL-LAN device connected to the Wago PLC. - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of WODali -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | Wago ethernet port, default to 502 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -fade_time | int | no | DALI fade time. value is between 1-10 -line | int | no | DALI bus line, usually 1 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -address | int | yes | Device address. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105 -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | Wago PLC IP address on the network -group | int | no | Set to 1 if address is a DALI group address, set to 0 otherwise. - -## Conditions of WODali -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of WODali -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-641 -* Calaos Wiki: http://calaos.fr/wiki/fr/dmx-lan - - -# WODaliRVB -#### Alias: WagoOutputDimmerRGB -RGB Light using DALI or DMX. To work you need 3 DALI/DMX channels. For DALI you need a 750-641 wago module. For DMX, a DMX4ALL-LAN device connected to the Wago PLC. - - -RGB light. Choose a color to be set for this light. - -## Parameters of WODaliRVB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -bfade_time | int | no | DALI fade time for blue channel. value is between 1-10 -bgroup | int | no | Set to 1 if address for blue channel is a DALI group address, set to 0 otherwise. -ggroup | int | no | Set to 1 if address for green channel is a DALI group address, set to 0 otherwise. -gaddress | int | yes | Device address for green channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105 -gline | int | no | DALI bus line for green channel, usually 1 -rfade_time | int | no | DALI fade time for red channel. value is between 1-10 -name | string | yes | Name of Input/Output. -baddress | int | yes | Device address for blue channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | Wago ethernet port, default to 502 -gfade_time | int | no | DALI fade time for green channel. value is between 1-10 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -bline | int | no | DALI bus line for blue channel, usually 1 -io_type | string | yes | IO type, can be "input", "output", "inout" -host | string | yes | Wago PLC IP address on the network -rline | int | no | DALI bus line for red channel, usually 1 -raddress | int | yes | Device address for red channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105 -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -rgroup | int | no | Set to 1 if address for red channel is a DALI group address, set to 0 otherwise. - -## Conditions of WODaliRVB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of WODaliRVB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-641 -* Calaos Wiki: http://calaos.fr/wiki/fr/dmx-lan - - -# WODigital -#### Alias: WagoOutputLight -Simple light or relay control using wago digital output modules (like 750-1504, ...) - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of WODigital -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -knx | bool | no | Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module) -var | int | yes | PLC address of the output -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | Wago ethernet port, default to 502 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | Wago PLC IP address on the network -wago_841 | bool | yes | Should be false if PLC is 750-842, true otherwise - -## Conditions of WODigital -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of WODigital -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1504 - - -# WOLOutputBool -Wake On Lan output object. Send wake-on-lan packet to a device on the network. - -## Parameters of WOLOutputBool -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -interval | int | no | Interval between pings in ms. Default to 15 sec -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -address | string | yes | Ethernet MAC address of the host to wake up -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Actions of WOLOutputBool -Name | Description ----- | ----------- -true | Send wake on lan packet to the configured device - - -# WOVolet -#### Alias: WagoOutputShutter -Simple shutter using wago digital output modules (like 750-1504, ...) - - -Simple shutter. This shutter supports open/close states, as well as impulse shutters. - -## Parameters of WOVolet -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -knx | bool | no | Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module) -wago_841 | bool | yes | Should be false if PLC is 750-842, true otherwise -var_down | int | yes | Digital output address on the PLC for closing the shutter -var_up | int | yes | Digital output address on the PLC for opening the shutter -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -port | int | no | Wago ethernet port, default to 502 -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -time | int | yes | Time in sec for shutter to open or close -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -host | string | yes | Wago PLC IP address on the network - -## Conditions of WOVolet -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of WOVolet -Name | Description ----- | ----------- -impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1504 - - -# WOVoletSmart -#### Alias: WagoOutputShutterSmart -Smart shutter using wago digital output modules (like 750-1504, ...) - - -Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position. - -## Parameters of WOVoletSmart -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -knx | bool | no | Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module) -wago_841 | bool | yes | Should be false if PLC is 750-842, true otherwise -var_down | int | yes | Digital output address on the PLC for closing the shutter -var_up | int | yes | Digital output address on the PLC for opening the shutter -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -time_up | int | yes | Time in sec for shutter to be fully open. The more accurate, the better it will work -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -time_down | int | yes | Time in sec for shutter to fully closed. The more accurate, the better it will work -port | int | no | Wago ethernet port, default to 502 -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -host | string | yes | Wago PLC IP address on the network - -## Conditions of WOVoletSmart -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of WOVoletSmart -Name | Description ----- | ----------- -up 5 | Open the shutter by X percent - set 50 | Set shutter at position X in percent - impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - down 5 | Close the shutter by X percent - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - calibrate | Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1504 - - -# X10Output -Light dimmer using X10 and heyu. - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of X10Output -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -code | string | yes | House code of the X10 light device -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of X10Output -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of X10Output -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - - -# xPLInputAnalog -xPL analog sensor - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of xPLInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -sensor | string | yes | Sensor ID, as set in your xPL network -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of xPLInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# xPLInputAnalog -xPL string sensor - -## Parameters of xPLInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -sensor | string | yes | Sensor ID, as set in your xPL network -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# xPLInputSwitch -xPL input switch - - -Basic switch with press/release states. - -## Parameters of xPLInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -sensor | string | yes | Sensor ID, as set in your xPL network -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of xPLInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - - -# xPLInputTemp -xPL temperature sensor - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of xPLInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -sensor | string | yes | Sensor ID, as set in your xPL network -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of xPLInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - - -# xPLOutputAnalog -Analog output controlled by xPL Protocol - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of xPLOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -actuator | string | yes | Actuator ID, as set in your xPL network -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of xPLOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of xPLOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - - -# xPLOutputAnalog -Analog output controlled by xPL Protocol - -## Parameters of xPLOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -actuator | string | yes | Actuator ID, as set in your xPL network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# xPLOutputSwitch -Light/relay controlled by xPL Protocol - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of xPLOutputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -actuator | string | yes | Actuator ID, as set in your xPL network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of xPLOutputSwitch -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of xPLOutputSwitch -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# ZibaseAnalogIn -Zibase analog input. This object can read value from devices like Energy monitor sensors, Lux sensors, ... - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of ZibaseAnalogIn -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -zibase_sensor | list | yes | Type of sensor -zibase_id | string | yes | Zibase device ID (ABC) -port | int | no | Zibase ethernet port, default to 17100 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Zibase IP address on the network -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of ZibaseAnalogIn -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# ZibaseDigitalIn -Zibase digital input. This object acts as a switch - - -Basic switch with press/release states. - -## Parameters of ZibaseDigitalIn -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -zibase_id2 | string | yes | Second Zibase device ID (ABC) -host | string | yes | Zibase IP address on the network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -zibase_sensor | list | yes | Type of sensor -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -zibase_id | string | yes | First Zibase device ID (ABC) -visible | bool | no | A switch can't be visible. Always false. -port | int | no | Zibase ethernet port, default to 17100 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of ZibaseDigitalIn -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - - -# ZibaseDigitalOut -Zibase digital output. This object controls Zibase devices - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of ZibaseDigitalOut -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | Zibase ethernet port, default to 17100 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -nbburst | int | no | Number of burst to send to the device -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | Zibase IP address on the network -zibase_id | string | yes | Zibase device ID (ABC) -protocol | list | yes | Protocol to use - -## Conditions of ZibaseDigitalOut -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of ZibaseDigitalOut -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# ZibaseTemp -Zibase temperature sensor - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of ZibaseTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -zibase_sensor | list | yes | Type of sensor -zibase_id | string | yes | Zibase device ID (ABC) -port | int | no | Zibase ethernet port, default to 17100 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Zibase IP address on the network -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of ZibaseTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - diff --git a/build_doc/fr/io_doc.json b/build_doc/fr/io_doc.json deleted file mode 100644 index af0f3c38..00000000 --- a/build_doc/fr/io_doc.json +++ /dev/null @@ -1,14357 +0,0 @@ -{ - "AVReceiver": { - "description": "AVReceiver object to control network amplifier", - "alias": [], - "parameters": [ - { - "description": "AVReceiver model. Supported: pioneer, denon, onkyo, marantz, yamaha", - "mandatory": "true", - "name": "model", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Zone of the amplifier (if supported)", - "mandatory": "false", - "max": "10", - "min": "0", - "name": "zone", - "readonly": "false", - "type": "int" - }, - { - "description": "IP address of the device", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Port to use for connection", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [ - { - "description": "Send a custom command to receiver (if you know the protocol)", - "name": "custom XXXXXX" - }, - { - "description": "Change current input source", - "name": "source X" - }, - { - "description": "Set current volume", - "name": "volume 50" - }, - { - "description": "Switch receiver off", - "name": "power off" - }, - { - "description": "Switch receiver on", - "name": "power on" - } - ] - }, - "Axis": { - "description": " Axis IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Resolution to use", - "mandatory": "false", - "name": "resolution", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "", - "mandatory": "false", - "name": "tilt_framesize", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "description": "", - "mandatory": "false", - "name": "pan_framesize", - "readonly": "false", - "type": "string" - }, - { - "description": "Camera model/chanel to use", - "mandatory": "true", - "name": "model", - "readonly": "false", - "type": "string" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "Set to true if camera has PTZ support", - "mandatory": "false", - "name": "ptz", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "", - "mandatory": "false", - "name": "zoom_step", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "BlinkstickOutputLightRGB": { - "description": "RGB Light dimmer using a Blinkstick RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "default": "1", - "description": "Number of LEDs to control with the blinkstick", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "nb_leds", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Blinkstick serial to control", - "mandatory": "true", - "name": "serial", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "Foscam": { - "description": " Foscam IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password for user", - "mandatory": "true", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP Address", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "88", - "description": "Port number", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "Set to true if camera has PTZ support", - "mandatory": "false", - "name": "ptz", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "", - "mandatory": "false", - "name": "zoom_step", - "readonly": "false", - "type": "string" - }, - { - "description": "Username for accessing the camera", - "mandatory": "true", - "name": "username", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "Gadspot": { - "description": " Gadspot IP Camera. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "GpioInputSwitch": { - "description": "Input switch with a GPIO Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "GPIO ID on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Set this if your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "GpioInputSwitchLongPress": { - "description": "Input switch with a GPIO Long press switch. This switch supports single press and long press. User has 500ms to perform the long press.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "GPIO ID on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is pressed at least for 500ms (long press)", - "name": "2" - }, - { - "description": "Event triggered when switch is pressed quickly", - "name": "1" - } - ], - "actions": [] - }, - "GpioInputSwitchTriple": { - "description": "Input switch with a GPIO Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "GPIO ID on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is double clicked", - "name": "2" - }, - { - "description": "Event triggered when switch is triple clicked", - "name": "3" - }, - { - "description": "Event triggered when switch is single clicked", - "name": "1" - } - ], - "actions": [] - }, - "GpioOutputShutter": { - "description": "Shutter with 2 GPIOs Simple shutter. This shutter supports open/close states, as well as impulse shutters.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low_up", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low_down", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "GPIO ID for closing on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio_down", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to open or close", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "GPIO ID for opening on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio_up", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "GpioOutputShutterSmart": { - "description": "Shutter with 2 GPIOs Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low_up", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "GPIO ID for closing on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio_down", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low_down", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "60", - "description": "Time in sec for shutter to be fully open. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_up", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to fully closed. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_down", - "readonly": "false", - "type": "int" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "GPIO ID for opening on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio_up", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open the shutter by X percent", - "name": "up 5" - }, - { - "description": "Set shutter at position X in percent", - "name": "set 50" - }, - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close the shutter by X percent", - "name": "down 5" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost.", - "name": "calibrate" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "GpioOutputSwitch": { - "description": "Light with a GPIO Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "GPIO ID on your hardware", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "gpio", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Set this is your GPIO has an inverted level", - "mandatory": "false", - "name": "active_low", - "readonly": "false", - "type": "bool" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "HueOutputLightRGB": { - "description": "RGB Light dimmer using a Philips Hue RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "description": "API key return by Hue bridge when assciation has been made. Use Hue Wizard in calaos_installer to get this value automatically.", - "mandatory": "true", - "name": "api", - "readonly": "false", - "type": "string" - }, - { - "description": "Hue bridge IP address", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Unique ID describing the Hue Light. This value is returned by the Hue Wizard.", - "mandatory": "true", - "name": "id_hue", - "readonly": "false", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "InputTime": { - "description": "Basic time input. An event is triggered when the current time equals the configured time. A specific date can also be set.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A time object can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "0", - "description": "Year for this time input", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "year", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "Minutes for this time input", - "mandatory": "true", - "max": "59", - "min": "0", - "name": "min", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Day for this time input", - "mandatory": "false", - "max": "31", - "min": "1", - "name": "day", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Hour for this time input", - "mandatory": "true", - "max": "23", - "min": "0", - "name": "hour", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Seconds for this time input", - "mandatory": "true", - "max": "59", - "min": "0", - "name": "sec", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Month for this time input", - "mandatory": "false", - "max": "12", - "min": "1", - "name": "month", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event on any change of time", - "name": "changed" - }, - { - "description": "Event triggered when current time is not equal", - "name": "false" - }, - { - "description": "Event triggered when current time equals", - "name": "true" - } - ], - "actions": [] - }, - "InputTimer": { - "description": "Timer object. trigger an event after the configured time has expired.", - "alias": [], - "parameters": [ - { - "description": "Auto restart the timer when time expires", - "mandatory": "true", - "name": "autorestart", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A timer object can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "0", - "description": "Miliseconds for the timer interval", - "mandatory": "true", - "max": "999", - "min": "0", - "name": "msec", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "Minutes for the timer interval", - "mandatory": "true", - "max": "59", - "min": "0", - "name": "min", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Hour for the timer interval", - "mandatory": "true", - "max": "23", - "min": "0", - "name": "hour", - "readonly": "false", - "type": "int" - }, - { - "description": "Auto start the timer when calaos starts", - "mandatory": "true", - "name": "autostart", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Seconds for the timer interval", - "mandatory": "true", - "max": "59", - "min": "0", - "name": "sec", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event triggered on any change", - "name": "change" - }, - { - "description": "Event triggered when timer starts", - "name": "false" - }, - { - "description": "Event triggered when timer expires", - "name": "true" - } - ], - "actions": [ - { - "description": "Reset the configured time to a value. Format is h:m:s:ms", - "name": "00:00:00:200" - }, - { - "description": "Stop the timer", - "name": "stop" - }, - { - "description": "Start the timer", - "name": "start" - } - ] - }, - "InternalBool": { - "description": "Internal boolean object. This object is useful for doing internal programing in rules, like keeping boolean states, or displaying boolean values", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false", - "mandatory": "false", - "name": "rw", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false", - "mandatory": "false", - "name": "save", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event when value is false", - "name": "false" - }, - { - "description": "Event when value is true", - "name": "true" - } - ], - "actions": [ - { - "description": "Do an impulse on boolean value. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Do an impulse on boolean value with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert boolean value", - "name": "toggle" - }, - { - "description": "Set a value to false", - "name": "false" - }, - { - "description": "Set a value to true", - "name": "true" - } - ] - }, - "InternalInt": { - "description": "Internal number object. This object is useful for doing internal programing in rules, like counters, of displaying values.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false", - "mandatory": "false", - "name": "rw", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false", - "mandatory": "false", - "name": "save", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific number value", - "name": "0" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "InternalString": { - "description": "Internal string object. This object is useful for doing internal programing in rules or displaying text values on user interfaces.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false", - "mandatory": "false", - "name": "rw", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false", - "mandatory": "false", - "name": "save", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific string value", - "name": "value" - } - ], - "actions": [ - { - "description": "Set a specific string value", - "name": "value" - } - ] - }, - "KNXInputAnalog": { - "description": "Input analog with KNX and eibnetmux An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "KNXInputSwitch": { - "description": "Input switch with KNX and eibnetmux Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "KNXInputSwitchLongPress": { - "description": "Input switch long press with KNX and eibnetmux Long press switch. This switch supports single press and long press. User has 500ms to perform the long press.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is pressed at least for 500ms (long press)", - "name": "2" - }, - { - "description": "Event triggered when switch is pressed quickly", - "name": "1" - } - ], - "actions": [] - }, - "KNXInputSwitchTriple": { - "description": "Input switch triple with KNX and eibnetmux Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is double clicked", - "name": "2" - }, - { - "description": "Event triggered when switch is triple clicked", - "name": "3" - }, - { - "description": "Event triggered when switch is single clicked", - "name": "1" - } - ], - "actions": [] - }, - "KNXInputTemp": { - "description": "Input temperature with KNX and eibnetmux Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "KNXOutputAnalog": { - "description": "Analog output with KNX and eibnetmux Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "KNXOutputLight": { - "description": "Light output with KNX and eibnetmux Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "KNXOutputLightDimmer": { - "description": "Light dimmer with KNX and eibnetmux Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "KNXOutputLightRGB": { - "description": "Light RGB with KNX and eibnetmux RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "Blue Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group_blue", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Green Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group_green", - "readonly": "false", - "type": "string" - }, - { - "description": "Red channel KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_red", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Green channel KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_green", - "readonly": "false", - "type": "string" - }, - { - "description": "Red Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group_red", - "readonly": "false", - "type": "string" - }, - { - "description": "Blue channel KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_blue", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "KNXOutputShutter": { - "description": "Shutter with with KNX and eibnetmux Simple shutter. This shutter supports open/close states, as well as impulse shutters.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to open or close", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time", - "readonly": "false", - "type": "int" - }, - { - "description": "Down KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_down", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Up KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_up", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "KNXOutputShutterSmart": { - "description": "Shutter with with KNX and eibnetmux Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position.", - "alias": [], - "parameters": [ - { - "default": "127.0.0.1", - "description": "Hostname of knxd, default to localhost", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "Send a read request at start to get the current value. Default is false", - "mandatory": "true", - "name": "read_at_start", - "readonly": "false", - "type": "bool" - }, - { - "default": "6", - "description": "KNX EIS (Data type)", - "mandatory": "false", - "max": "15", - "min": "0", - "name": "eis", - "readonly": "false", - "type": "int" - }, - { - "description": "KNX Group address for listening status, Ex: x/y/z", - "mandatory": "false", - "name": "listen_knx_group", - "readonly": "false", - "type": "string" - }, - { - "description": "Down KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_down", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group", - "readonly": "false", - "type": "string" - }, - { - "default": "60", - "description": "Time in sec for shutter to be fully open. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_up", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to fully closed. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_down", - "readonly": "false", - "type": "int" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Up KNX Group address, Ex: x/y/z", - "mandatory": "true", - "name": "knx_group_up", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open the shutter by X percent", - "name": "up 5" - }, - { - "description": "Set shutter at position X in percent", - "name": "set 50" - }, - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close the shutter by X percent", - "name": "down 5" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost.", - "name": "calibrate" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "MilightOutputLightRGB": { - "description": "RGB light support for Limitless/Milight RGB bulbs. RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "Zone to control. Each gateway supports 4 zones.", - "mandatory": "true", - "max": "4", - "min": "0", - "name": "zone", - "readonly": "false", - "type": "int" - }, - { - "description": "Milight wifi gateway IP address", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Gateway port, default to 8899", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "MqttInputAnalog": { - "description": "Analog value read from a mqtt broker An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "MqttInputString": { - "description": "String value read from a mqtt broker", - "alias": [], - "parameters": [ - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "MqttInputSwitch": { - "description": "Switch value read from a mqtt broker Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "description": "Value to interpret as ON value", - "mandatory": "true", - "name": "on_value", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Value to interpret as OFF value", - "mandatory": "true", - "name": "off_value", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "MqttInputTemp": { - "description": "Temperature read from a mqtt broker Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "MqttOutputAnalog": { - "description": "Control analog output through mqtt broker Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "description": "The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with the state (float value) to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "MqttOutputLight": { - "description": "Control lights through mqtt broker Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with with the state (on_value, off_value) to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "Value to interpret as ON value", - "mandatory": "true", - "name": "on_value", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "description": "Value to interpret as OFF value", - "mandatory": "true", - "name": "off_value", - "readonly": "false", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "MqttOutputLightDimmer": { - "description": "Control lights through mqtt broker Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "description": "The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with the state (integer value) to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "MqttOutputLightRGB": { - "description": "Control RGB lights through mqtt broker RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "description": "The path where to found the brightness value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example 'brightness'", - "mandatory": "true", - "name": "path_brightness", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the Y (X/Y Color space) value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example color.y, try to read the x value from the color object.", - "mandatory": "true", - "name": "path_y", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the X (X/Y Color space) value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example color.x, try to read the x value from the color object.", - "mandatory": "true", - "name": "path_x", - "readonly": "false", - "type": "string" - }, - { - "description": "The data sent when publishing color to topic. The __##VALUE_R##__ __##VALUE_G##__ __##VALUE_B##__ or __##VALUE_HEX##__ or __##VALUE_X##__ __##VALUE_Y##__ __##VALUE_BRIGHTNESS##__ contained in data is substituted with the color (integer value or #RRGGBB string value) to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to subscribe.", - "mandatory": "true", - "name": "topic_sub", - "readonly": "false", - "type": "string" - }, - { - "description": "Topic on witch to publish.", - "mandatory": "true", - "name": "topic_pub", - "readonly": "false", - "type": "string" - }, - { - "default": "120", - "description": "keepalive timeout in seconds. Time between two mqtt PING.", - "mandatory": "false", - "name": "keepalive", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {\"temperature\":14.23} use \"temperature\" as path\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "1883", - "description": "TCP port of the mqtt broker. Default value is 1883", - "mandatory": "false", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "User to use for authentication with mqtt broker. Password must be defined in that case.", - "mandatory": "false", - "name": "user", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "127.0.0.1", - "description": "IP address of the mqtt broker to connect to. Default value is 127.0.0.1.", - "mandatory": "false", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password to use for authentication with mqtt broker. User must be defined in that case.", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "MySensorsInputAnalog": { - "description": "Analog measurement with MySensors node An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "MySensorsInputString": { - "description": "Display string from MySensors node", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "MySensorsInputSwitch": { - "description": "Input switch with MySensors node Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "MySensorsInputSwitchLongPress": { - "description": "Input long press switch with MySensors node Long press switch. This switch supports single press and long press. User has 500ms to perform the long press.", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is pressed at least for 500ms (long press)", - "name": "2" - }, - { - "description": "Event triggered when switch is pressed quickly", - "name": "1" - } - ], - "actions": [] - }, - "MySensorsInputSwitchTriple": { - "description": "Input triple click switch with MySensors node Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click.", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is double clicked", - "name": "2" - }, - { - "description": "Event triggered when switch is triple clicked", - "name": "3" - }, - { - "description": "Event triggered when switch is single clicked", - "name": "1" - } - ], - "actions": [] - }, - "MySensorsInputTemp": { - "description": "Temperature sensor with MySensors node Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "MySensorsOutputAnalog": { - "description": "Analog output with MySensors node Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "MySensorsOutputDimmer": { - "description": "Light dimmer with MySensors node Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "MySensorsOutputLight": { - "description": "Light/relay with MySensors node Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "MySensorsOutputLightRGB": { - "description": "RGB Light dimmer with MySensors node RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID for green channel, as set in your network", - "mandatory": "true", - "name": "node_id_green", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sensor ID green red channel, as set in your node", - "mandatory": "true", - "name": "sensor_id_green", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID blue red channel, as set in your node", - "mandatory": "true", - "name": "sensor_id_blue", - "readonly": "false", - "type": "string" - }, - { - "description": "Node ID for blue channel, as set in your network", - "mandatory": "true", - "name": "node_id_blue", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID for red channel, as set in your network", - "mandatory": "true", - "name": "node_id_red", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID for red channel, as set in your node", - "mandatory": "true", - "name": "sensor_id_red", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "MySensorsOutputShutter": { - "description": "Shutter with MySensors node Simple shutter. This shutter supports open/close states, as well as impulse shutters.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID for closing shutter, as set in your node", - "mandatory": "true", - "name": "sensor_id_down", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID for opening shutter, as set in your network", - "mandatory": "true", - "name": "node_id_up", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Node ID for closing shutter, as set in your network", - "mandatory": "true", - "name": "node_id_down", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sensor ID for opening shutter, as set in your node", - "mandatory": "true", - "name": "sensor_id_up", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to open or close", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "MySensorsOutputShutterSmart": { - "description": "Smart shutter with MySensors node Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position.", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID for closing shutter, as set in your node", - "mandatory": "true", - "name": "sensor_id_down", - "readonly": "false", - "type": "string" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Node ID for opening shutter, as set in your network", - "mandatory": "true", - "name": "node_id_up", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Node ID for closing shutter, as set in your network", - "mandatory": "true", - "name": "node_id_down", - "readonly": "false", - "type": "string" - }, - { - "default": "60", - "description": "Time in sec for shutter to be fully open. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_up", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sensor ID for opening shutter, as set in your node", - "mandatory": "true", - "name": "sensor_id_up", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to fully closed. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_down", - "readonly": "false", - "type": "int" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open the shutter by X percent", - "name": "up 5" - }, - { - "description": "Set shutter at position X in percent", - "name": "set 50" - }, - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close the shutter by X percent", - "name": "down 5" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost.", - "name": "calibrate" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "MySensorsOutputString": { - "description": "String output with MySensors node", - "alias": [], - "parameters": [ - { - "description": "Data type sent to the node. Default: V_VAR1, see MySensors.cpp for more values.", - "mandatory": "false", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "/dev/ttyUSB0", - "description": "If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway.", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "serial", - "description": "Gateway type used, tcp or serial are supported", - "mandatory": "true", - "name": "gateway", - "readonly": "false", - "type": "list", - "list_value": { - "serial": "Serial", - "tcp": "TCP" - } - }, - { - "description": "Node ID as set in your network", - "mandatory": "true", - "name": "node_id", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IP address of the tcp gateway if relevant", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Sensor ID, as set in your node", - "mandatory": "true", - "name": "sensor_id", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "OLAOutputLightDimmer": { - "description": "DMX Light dimmer using OLA (Open Lighting Architecture) Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "DMX channel to control", - "mandatory": "true", - "max": "512", - "min": "0", - "name": "channel", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "OLA universe to control", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "universe", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "OLAOutputLightRGB": { - "description": "RGB Light dimmer using 3 DMX channels with OLA (Open Lighting Architecture) RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "default": "0", - "description": "DMX channel for blue to control", - "mandatory": "true", - "max": "512", - "min": "0", - "name": "channel_blue", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "DMX channel for red to control", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "channel_red", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "DMX channel for green to control", - "mandatory": "true", - "max": "512", - "min": "0", - "name": "channel_green", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "OLA universe to control", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "universe", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "OutputFake": { - "description": "Fake test output. Do nothing. Do not use.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "OWTemp": { - "description": "Temperature measurement with DS18B20 Onewire Sensor Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "description": "Force the use of w1 kernel driver instead of OneWire driver", - "mandatory": "false", - "name": "use_w1", - "readonly": "false", - "type": "bool" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID of sensor on OneWire bus.", - "mandatory": "true", - "name": "ow_id", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Additional parameter used for owfs initialization.For example you can use -u to use the USB owfs drivers", - "mandatory": "true", - "name": "ow_args", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "PingInputSwitch": { - "description": "A switch input based on the result of a ping command. Useful to detect presence of a host on the network. Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "default": "15000", - "description": "Interval between pings in ms. Default to 15 sec", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "int" - }, - { - "description": "Timeout of the ping request in ms", - "mandatory": "false", - "name": "timeout", - "readonly": "false", - "type": "int" - }, - { - "description": "IP address or host where to send the ping", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "The host is offline and/or does not respond to the ping", - "name": "false" - }, - { - "description": "The host is online and respond to the ping", - "name": "true" - } - ], - "actions": [] - }, - "Planet": { - "description": " Planet IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Password for user", - "mandatory": "false", - "name": "password", - "readonly": "false", - "type": "string" - }, - { - "description": "Username for accessing the camera", - "mandatory": "false", - "name": "username", - "readonly": "false", - "type": "string" - }, - { - "description": "Camera model (ICA-210, ICA-210W, ICA-300, ICA-302, ICA-500) to use", - "mandatory": "true", - "name": "model", - "readonly": "false", - "type": "string" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "Scenario": { - "description": "A scenario variable. Use this like a virtual button to start a scenario (list of actions)", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Internal use only for Auto Scenario. read only.", - "mandatory": "false", - "name": "auto_scenario", - "readonly": "true", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event triggered when scenario is started", - "name": "true" - } - ], - "actions": [ - { - "description": "Event triggered on any change", - "name": "changed" - }, - { - "description": "Stop the scenario (only for special looping scenarios)", - "name": "false" - }, - { - "description": "Start the scenario", - "name": "true" - } - ] - }, - "Squeezebox": { - "description": "Squeezebox audio player allows control of a Squeezebox from Calaos", - "alias": [ - "slim" - ], - "parameters": [ - { - "default": "9090", - "description": "CLI port of LMS, default to 9090", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port_cli", - "readonly": "false", - "type": "int" - }, - { - "description": "Logitech media server IP address", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "9000", - "description": "Web interface port of LMS, default to 9000.", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port_web", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "Audio players are not displayed in rooms", - "mandatory": "true", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID of squeezebox in LMS", - "mandatory": "true", - "name": "id", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when a change in the current playlist happens", - "name": "onplaylistchange" - }, - { - "description": "Event when a change of volume happens", - "name": "onvolumechange" - }, - { - "description": "Event when stopping player", - "name": "onstop" - }, - { - "description": "Event when a new song is being played", - "name": "onsongchange" - }, - { - "description": "Event when pausing player", - "name": "onpause" - }, - { - "description": "Event when play is started", - "name": "onplay" - } - ], - "actions": [ - { - "description": "Add tracks to playlist. can be any of album_id:XX artist_id:XX playlist_id:XX, ...", - "name": "add " - }, - { - "description": "Clear playlist and play argument. can be any of album_id:XX artist_id:XX playlist_id:XX, ...", - "name": "play " - }, - { - "description": "Pause player", - "name": "pause" - }, - { - "description": "Sync this player with an other", - "name": "sync " - }, - { - "description": "Stop player", - "name": "stop" - }, - { - "description": "Increase volume by a value", - "name": "volume up 1" - }, - { - "description": "Set current volume", - "name": "volume set 50" - }, - { - "description": "Play previous song in playlist", - "name": "previous" - }, - { - "description": "Decrease volume by a value", - "name": "volume down 1" - }, - { - "description": "Start playing", - "name": "play" - }, - { - "description": "Play next song in playlist", - "name": "next" - }, - { - "description": "Switch player on", - "name": "power on" - }, - { - "description": "Start sleep mode with X seconds", - "name": "sleep 10" - }, - { - "description": "Switch player off", - "name": "power off" - }, - { - "description": "Stop sync of this player with an other", - "name": "unsync " - } - ] - }, - "standard_mjpeg": { - "description": " MJPEG/Jpeg IP Camera. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Set to true if camera has PTZ support", - "mandatory": "false", - "name": "ptz", - "readonly": "false", - "type": "bool" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "URL for mjpeg stream support", - "mandatory": "false", - "name": "url_mjpeg", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "URL for snapshot in jpeg format", - "mandatory": "true", - "name": "url_jpeg", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "StandardMjpeg": { - "description": " MJPEG/Jpeg IP Camera. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "Set to true if camera has PTZ support", - "mandatory": "false", - "name": "ptz", - "readonly": "false", - "type": "bool" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "URL for mjpeg stream support", - "mandatory": "false", - "name": "url_mjpeg", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "URL for snapshot in jpeg format", - "mandatory": "true", - "name": "url_jpeg", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "SynoSurveillanceStation": { - "description": " Synology Surveillance Station IP Camera. Camera can be viewed directly inside calaos and used in rules.", - "alias": [], - "parameters": [ - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size.", - "mandatory": "false", - "name": "width", - "readonly": "false", - "type": "int" - }, - { - "default": "1", - "description": "Profile to use for snapshot. 0- High quality, 1- Balanced, 2- Low bandwidth", - "mandatory": "false", - "max": "2", - "min": "0", - "name": "camera_profile", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW.", - "mandatory": "false", - "name": "rotate", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Full url to Synology nas. Ex: https://192.168.0.22:5000", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "description": "Username which can access Surveillance Station", - "mandatory": "true", - "name": "username", - "readonly": "false", - "type": "string" - }, - { - "description": "ID of the camera", - "mandatory": "true", - "name": "camera_id", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Password for user", - "mandatory": "true", - "name": "password", - "readonly": "false", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "TeleinfoInputAnalog": { - "description": "Analog measurement retrieved from Teleinfo informations. An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "PAPP", - "description": "All theses values are reported by the Teleinfo equipment as double.", - "mandatory": "true", - "name": "value", - "readonly": "false", - "type": "list", - "list_value": { - "BASE": "Index if optione BASE is subscribed. (in Watt-hour)", - "BBRHCJB": "Index \"Heures creuses jours bleues\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHCJR": "Index \"Heures creuses jours rouges\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHCJW": "Index \"Heures creuses jours blancs\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHPJB": "Index \"Heures pleines jours bleues\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHPJR": "Index \"Heures pleines jours rouges\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "BBRHPJW": "Index \"Heures pleines jours blancs\" if otion \"Tempo\" is subscribed. (in Watt-hour)", - "EJPHN": "Index \"Heures Normales\" if otion \"EJP\" is subscribed. (in Watt-hour)", - "EJPHPM": "Index \"Heures de pointe mobile\" if otion \"EJP\" is subscribed. (in Watt-hour)", - "HCHC": "Index \"Heures Creuses\" if this option is subscribed. (in Watt-hour)", - "HCHP": "Index \"Heures Pleine\" if option \"Heures Creuses\" is subscribed. (in Watt-hour)", - "IINST": "Instant intensity. (in Ampere)", - "IMAX": "Maximal intensity. (in Ampere)", - "ISOUSC": "Subscribed intensity. (in Ampere)", - "PAPP": "Apparent power. (in Volt-ampere)" - } - }, - { - "description": "port on which to get Teleinfo information usually a serial port like /dev/ttyS0 or /dev/ttyAMA0", - "mandatory": "true", - "name": "port", - "readonly": "false", - "type": "string" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "TimeRange": { - "description": "Represent a time range object. A time range is true if current time is in one of the included range, false otherwise. The time range also support weekdays and months.", - "alias": [ - "InPlageHoraire" - ], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A time range can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of range", - "name": "changed" - }, - { - "description": "Event triggered when exiting the range", - "name": "false" - }, - { - "description": "Event triggered when entering the range", - "name": "true" - } - ], - "actions": [] - }, - "WebInputAnalog": { - "description": "Analog input read from a web document An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "URL where to download the document from\nIf URL begins with / or with file:// the data is read from the local file", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "WebInputString": { - "description": "String input providing from a web document", - "alias": [], - "parameters": [ - { - "description": "URL where to download the document from\nIf URL begins with / or with file:// the data is read from the local file", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "WebInputTemp": { - "description": "Temperature input read from a web document Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "URL where to download the document from\nIf URL begins with / or with file:// the data is read from the local file", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "WebOutputAnalog": { - "description": "Analog output in a web request Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "description": "URL where to download the document from\nIf URL begins with / or with file:// the data is read from the local file", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "WebOutputLight": { - "description": "Bool output written to a web document or URL Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be :\nhttp://example.com/api?value=20.3\nThe url is encoded before being sent.\nIf the URL begins with / or file:// the data is written to a file.", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values.", - "mandatory": "true", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "WebOutputLightRGB": { - "description": "RGB value written to a web document or URL RGB light. Choose a color to be set for this light.", - "alias": [], - "parameters": [ - { - "description": "URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be :\nhttp://example.com/api?value=20.3\nThe url is encoded before being sent.\nIf the URL begins with / or file:// the data is written to a file.", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values.", - "mandatory": "true", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "RGB value has #RRGGBB. Sometimes some web api take only RRGGBBformat. If raw_value is true, the # in front of the line isremoved. The default value for this parameter is false.", - "mandatory": "false", - "name": "raw_value", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "WebOutputString": { - "description": "String output written to a web document or URL", - "alias": [], - "parameters": [ - { - "description": "URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be :\nhttp://example.com/api?value=20.3\nThe url is encoded before being sent.\nIf the URL begins with / or file:// the data is written to a file.", - "mandatory": "true", - "name": "url", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "File type of the document. Values can be xml, json or text.", - "mandatory": "true", - "name": "file_type", - "readonly": "false", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values.", - "mandatory": "true", - "name": "data_type", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent.", - "mandatory": "true", - "name": "data", - "readonly": "false", - "type": "string" - }, - { - "description": "The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object.\nIf file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains \n10.0,10.1,10.2,10.3\n20.0,20.1,20.2,20.3\nIf the path is 2/4/, the value returne wil be 20.3\n", - "mandatory": "true", - "name": "path", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "WIAnalog": { - "description": "Analog measurement with Wago module (like 0-10V, 4-20mA, ...) An analog input can be used to read analog values to display them and use them in rules.", - "alias": [ - "WagoInputAnalog" - ], - "parameters": [ - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "PLC address of the input sensor", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "WIDigitalBP": { - "description": "Switch with digital input Wago modules (like 750-1405, ...) Basic switch with press/release states.", - "alias": [ - "WIDigital", - "WagoInputSwitch" - ], - "parameters": [ - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "PLC address of the digital input", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "WIDigitalLong": { - "description": "Switch long press with digital input Wago modules (like 750-1405, ...) Long press switch. This switch supports single press and long press. User has 500ms to perform the long press.", - "alias": [ - "WagoInputSwitchLongPress" - ], - "parameters": [ - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "PLC address of the digital input", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is pressed at least for 500ms (long press)", - "name": "2" - }, - { - "description": "Event triggered when switch is pressed quickly", - "name": "1" - } - ], - "actions": [] - }, - "WIDigitalTriple": { - "description": "Switch triple click with digital input Wago modules (like 750-1405, ...) Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click.", - "alias": [ - "WagoInputSwitchTriple" - ], - "parameters": [ - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "PLC address of the digital input", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is double clicked", - "name": "2" - }, - { - "description": "Event triggered when switch is triple clicked", - "name": "3" - }, - { - "description": "Event triggered when switch is single clicked", - "name": "1" - } - ], - "actions": [] - }, - "WITemp": { - "description": "Temperature measurement with Wago temperature module (like 750-460) Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [ - "WagoInputTemp" - ], - "parameters": [ - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "PLC address of the input sensor", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "WOAnalog": { - "description": "Analog output with Wago module (like 0-10V, 4-20mA, ...) Analog output. Useful to control analog output devices connected to calaos.", - "alias": [ - "WagoOutputAnalog" - ], - "parameters": [ - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "PLC address of the output", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "WODali": { - "description": "Light using DALI or DMX. For DALI you need a 750-641 wago module. For DMX, a DMX4ALL-LAN device connected to the Wago PLC. Light with dimming control. Light intensity can be changed for this light.", - "alias": [ - "WagoOutputDimmer" - ], - "parameters": [ - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "DALI fade time. value is between 1-10", - "mandatory": "false", - "max": "10", - "min": "1", - "name": "fade_time", - "readonly": "false", - "type": "int" - }, - { - "default": "1", - "description": "DALI bus line, usually 1", - "mandatory": "false", - "name": "line", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "default": "0", - "description": "Device address. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105", - "mandatory": "true", - "max": "612", - "min": "1", - "name": "address", - "readonly": "false", - "type": "int" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Set to 1 if address is a DALI group address, set to 0 otherwise.", - "mandatory": "false", - "max": "1", - "min": "0", - "name": "group", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "WODaliRVB": { - "description": "RGB Light using DALI or DMX. To work you need 3 DALI/DMX channels. For DALI you need a 750-641 wago module. For DMX, a DMX4ALL-LAN device connected to the Wago PLC. RGB light. Choose a color to be set for this light.", - "alias": [ - "WagoOutputDimmerRGB" - ], - "parameters": [ - { - "default": "0", - "description": "DALI fade time for blue channel. value is between 1-10", - "mandatory": "false", - "max": "10", - "min": "1", - "name": "bfade_time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Set to 1 if address for blue channel is a DALI group address, set to 0 otherwise.", - "mandatory": "false", - "max": "1", - "min": "0", - "name": "bgroup", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Set to 1 if address for green channel is a DALI group address, set to 0 otherwise.", - "mandatory": "false", - "max": "1", - "min": "0", - "name": "ggroup", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Device address for green channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105", - "mandatory": "true", - "max": "612", - "min": "1", - "name": "gaddress", - "readonly": "false", - "type": "int" - }, - { - "default": "1", - "description": "DALI bus line for green channel, usually 1", - "mandatory": "false", - "name": "gline", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "DALI fade time for red channel. value is between 1-10", - "mandatory": "false", - "max": "10", - "min": "1", - "name": "rfade_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Device address for blue channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105", - "mandatory": "true", - "max": "612", - "min": "1", - "name": "baddress", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "DALI fade time for green channel. value is between 1-10", - "mandatory": "false", - "max": "10", - "min": "1", - "name": "gfade_time", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "1", - "description": "DALI bus line for blue channel, usually 1", - "mandatory": "false", - "name": "bline", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "DALI bus line for red channel, usually 1", - "mandatory": "false", - "name": "rline", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Device address for red channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105", - "mandatory": "true", - "max": "612", - "min": "1", - "name": "raddress", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Set to 1 if address for red channel is a DALI group address, set to 0 otherwise.", - "mandatory": "false", - "max": "1", - "min": "0", - "name": "rgroup", - "readonly": "false", - "type": "int" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Decrease intensity by X percent of red channel", - "name": "down_red 5" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Decrease intensity by X percent of green channel", - "name": "down_green 5" - }, - { - "description": "Invert the light state (ON/OFF)", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Decrease intensity by X percent of blue channel", - "name": "down_blue 5" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state #AA1294" - }, - { - "description": "Increase intensity by X percent of red channel", - "name": "up_red 5" - }, - { - "description": "Set red channel to X percent", - "name": "set_red 50" - }, - { - "description": "Set blue channel to X percent", - "name": "set_blue 50" - }, - { - "description": "Increase intensity by X percent of green channel", - "name": "up_green 5" - }, - { - "description": "Set green channel to X percent", - "name": "set_green 50" - }, - { - "description": "Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33)", - "name": "set #AA1294" - }, - { - "description": "Increase intensity by X percent of blue channel", - "name": "up_blue 5" - } - ] - }, - "WODigital": { - "description": "Simple light or relay control using wago digital output modules (like 750-1504, ...) Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [ - "WagoOutputLight" - ], - "parameters": [ - { - "description": "Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module)", - "mandatory": "false", - "name": "knx", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "PLC address of the output", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Should be false if PLC is 750-842, true otherwise", - "mandatory": "true", - "name": "wago_841", - "readonly": "false", - "type": "bool" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "WOLOutputBool": { - "description": "Wake On Lan output object. Send wake-on-lan packet to a device on the network.", - "alias": [], - "parameters": [ - { - "default": "15000", - "description": "Interval between pings in ms. Default to 15 sec", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Ethernet MAC address of the host to wake up", - "mandatory": "true", - "name": "address", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [ - { - "description": "Send wake on lan packet to the configured device", - "name": "true" - } - ] - }, - "WOVolet": { - "description": "Simple shutter using wago digital output modules (like 750-1504, ...) Simple shutter. This shutter supports open/close states, as well as impulse shutters.", - "alias": [ - "WagoOutputShutter" - ], - "parameters": [ - { - "description": "Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module)", - "mandatory": "false", - "name": "knx", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Should be false if PLC is 750-842, true otherwise", - "mandatory": "true", - "name": "wago_841", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Digital output address on the PLC for closing the shutter", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var_down", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Digital output address on the PLC for opening the shutter", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var_up", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to open or close", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "WOVoletSmart": { - "description": "Smart shutter using wago digital output modules (like 750-1504, ...) Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position.", - "alias": [ - "WagoOutputShutterSmart" - ], - "parameters": [ - { - "description": "Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module)", - "mandatory": "false", - "name": "knx", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Should be false if PLC is 750-842, true otherwise", - "mandatory": "true", - "name": "wago_841", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Digital output address on the PLC for closing the shutter", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var_down", - "readonly": "false", - "type": "int" - }, - { - "default": "0", - "description": "Digital output address on the PLC for opening the shutter", - "mandatory": "true", - "max": "65535", - "min": "0", - "name": "var_up", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "60", - "description": "Time in sec for shutter to be fully open. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_up", - "readonly": "false", - "type": "int" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "60", - "description": "Time in sec for shutter to fully closed. The more accurate, the better it will work", - "mandatory": "true", - "max": "9999", - "min": "0", - "name": "time_down", - "readonly": "false", - "type": "int" - }, - { - "default": "502", - "description": "Wago ethernet port, default to 502", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "description": "If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter", - "mandatory": "false", - "name": "stop_both", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0", - "mandatory": "false", - "max": "999999", - "min": "0", - "name": "impulse_time", - "readonly": "false", - "type": "int" - }, - { - "description": "Wago PLC IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when shutter is closed", - "name": "false" - }, - { - "description": "Event when shutter is open", - "name": "true" - }, - { - "description": "Event on any change of shutter state", - "name": "changed" - } - ], - "actions": [ - { - "description": "Open the shutter by X percent", - "name": "up 5" - }, - { - "description": "Set shutter at position X in percent", - "name": "set 50" - }, - { - "description": "Open shutter for X ms", - "name": "impulse up 200" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state true" - }, - { - "description": "Close the shutter by X percent", - "name": "down 5" - }, - { - "description": "Close shutter for X ms", - "name": "impulse down 200" - }, - { - "description": "Invert shutter state", - "name": "toggle" - }, - { - "description": "Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source.", - "name": "set_state false" - }, - { - "description": "Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost.", - "name": "calibrate" - }, - { - "description": "Stop the shutter", - "name": "stop" - }, - { - "description": "Close the shutter", - "name": "down" - }, - { - "description": "Open the shutter", - "name": "up" - } - ] - }, - "X10Output": { - "description": "Light dimmer using X10 and heyu. Light with dimming control. Light intensity can be changed for this light.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "House code of the X10 light device", - "mandatory": "true", - "name": "code", - "readonly": "false", - "type": "string" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is at this value", - "name": "value" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Dynamically change light intensity when holding a switch (stop action)", - "name": "hold stop" - }, - { - "description": "Switch the light on", - "name": "true" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Set light value without switching on. This will be the light intensity for the next ON", - "name": "set off 50" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Invert the light state", - "name": "toggle" - }, - { - "description": "Decrease intensity by X percent", - "name": "down 5" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Dynamically change light intensity when holding a switch (press action)", - "name": "hold press" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state 50" - }, - { - "description": "Set light intensity and swith on if light is off", - "name": "set 50" - }, - { - "description": "Increase intensity by X percent", - "name": "up 5" - } - ] - }, - "xPLInputAnalog": { - "description": "xPL analog sensor An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Sensor ID, as set in your xPL network", - "mandatory": "true", - "name": "sensor", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "xPLInputString": { - "description": "xPL string sensor", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Sensor ID, as set in your xPL network", - "mandatory": "true", - "name": "sensor", - "readonly": "false", - "type": "string" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "xPLInputSwitch": { - "description": "xPL input switch Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "description": "Sensor ID, as set in your xPL network", - "mandatory": "true", - "name": "sensor", - "readonly": "false", - "type": "string" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "xPLInputTemp": { - "description": "xPL temperature sensor Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Sensor ID, as set in your xPL network", - "mandatory": "true", - "name": "sensor", - "readonly": "false", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - }, - "xPLOutputAnalog": { - "description": "Analog output controlled by xPL Protocol Analog output. Useful to control analog output devices connected to calaos.", - "alias": [], - "parameters": [ - { - "description": "Actuator ID, as set in your xPL network", - "mandatory": "true", - "name": "actuator", - "readonly": "false", - "type": "string" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Set a step for increment/decrement value. Default is 1.0", - "mandatory": "false", - "name": "step", - "readonly": "false", - "type": "float" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on a specific number value", - "name": "0" - }, - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [ - { - "description": "Decrement value by value", - "name": "dec 1" - }, - { - "description": "Increment value by value", - "name": "inc 1" - }, - { - "description": "Decrement value with configured step", - "name": "dec" - }, - { - "description": "Increment value with configured step", - "name": "inc" - }, - { - "description": "Set a specific number value", - "name": "0" - } - ] - }, - "xPLOutputString": { - "description": "Analog output controlled by xPL Protocol", - "alias": [], - "parameters": [ - { - "description": "Actuator ID, as set in your xPL network", - "mandatory": "true", - "name": "actuator", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [], - "actions": [] - }, - "xPLOutputSwitch": { - "description": "Light/relay controlled by xPL Protocol Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "Actuator ID, as set in your xPL network", - "mandatory": "true", - "name": "actuator", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "description": "Source name, as set in your xPL network (Format VendorId-DeviceId.Instance)", - "mandatory": "true", - "name": "source", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "ZibaseAnalogIn": { - "description": "Zibase analog input. This object can read value from devices like Energy monitor sensors, Lux sensors, ... An analog input can be used to read analog values to display them and use them in rules.", - "alias": [], - "parameters": [ - { - "default": "energy", - "description": "Type of sensor", - "mandatory": "true", - "name": "zibase_sensor", - "readonly": "false", - "type": "list", - "list_value": { - "energy": "Energy monitor sensor", - "lux": "Lux sensor", - "t_rain": "Total rain sensor", - "wind": "Wind sensor" - } - }, - { - "description": "Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id", - "readonly": "false", - "type": "string" - }, - { - "default": "17100", - "description": "Zibase ethernet port, default to 17100", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "default", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "current": "Current", - "default": "Default", - "humidity": "Humidity", - "luminosity": "Luminosity", - "pressure": "Pressure", - "speed": "Speed", - "temperature": "Temperature", - "voltage": "Voltage", - "watt": "Watt" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unit which will be displayed on the UI as a suffix.", - "mandatory": "false", - "name": "unit", - "readonly": "false", - "type": "string" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "default": "0", - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "Zibase IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of value", - "name": "changed" - }, - { - "description": "Event on a specific value", - "name": "value" - } - ], - "actions": [] - }, - "ZibaseDigitalIn": { - "description": "Zibase digital input. This object acts as a switch Basic switch with press/release states.", - "alias": [], - "parameters": [ - { - "description": "Second Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id2", - "readonly": "false", - "type": "string" - }, - { - "description": "Zibase IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "detect", - "description": "Type of sensor", - "mandatory": "true", - "name": "zibase_sensor", - "readonly": "false", - "type": "list", - "list_value": { - "detect": "Door/Window sensor", - "inter": "Switch/Remote control" - } - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "First Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "A switch can't be visible. Always false.", - "mandatory": "false", - "name": "visible", - "readonly": "true", - "type": "bool" - }, - { - "default": "17100", - "description": "Zibase ethernet port, default to 17100", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - } - ], - "conditions": [ - { - "description": "Event on any change of state", - "name": "changed" - }, - { - "description": "Event triggered when switch is released", - "name": "false" - }, - { - "description": "Event triggered when switch is pressed", - "name": "true" - } - ], - "actions": [] - }, - "ZibaseDigitalOut": { - "description": "Zibase digital output. This object controls Zibase devices Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output", - "alias": [], - "parameters": [ - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "light", - "description": "GUI style display. This will control the icon displayed on the UI", - "mandatory": "true", - "name": "io_style", - "readonly": "false", - "type": "list", - "list_value": { - "boiler": "Boiler", - "heater": "Heater", - "light": "Light", - "outlet": "Outlet", - "pump": "Pump" - } - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "17100", - "description": "Zibase ethernet port, default to 17100", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "Number of burst to send to the device", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "nbburst", - "readonly": "false", - "type": "int" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "Zibase IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id", - "readonly": "false", - "type": "string" - }, - { - "default": "0", - "description": "Protocol to use", - "mandatory": "true", - "name": "protocol", - "readonly": "false", - "type": "list", - "list_value": { - "0": "DEFAULT_PROTOCOL", - "1": "VISONIC433", - "10": "XDD868shutter", - "11": "XDD868pilot", - "12": "XDD868boiler", - "2": "VISONIC868", - "3": "CHACON", - "4": "DOMIA", - "5": "RFX10", - "6": "ZWAVE", - "7": "RFSTS10", - "8": "XDD433alrm", - "9": "XDD868alrmn" - } - } - ], - "conditions": [ - { - "description": "Event when light is off", - "name": "false" - }, - { - "description": "Event when light is on", - "name": "true" - }, - { - "description": "Event on any change of value", - "name": "changed" - } - ], - "actions": [ - { - "description": "Do an impulse on light state. Set to true for X ms then reset to false", - "name": "impulse 200" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state true" - }, - { - "description": "Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts)", - "name": "impulse 500 200 500 200" - }, - { - "description": "Invert light state", - "name": "toggle" - }, - { - "description": "Update internal light state without starting real action. This is useful when having updating the light state from an external source.", - "name": "set_state false" - }, - { - "description": "Switch the light off", - "name": "false" - }, - { - "description": "Switch the light on", - "name": "true" - } - ] - }, - "ZibaseTemp": { - "description": "Zibase temperature sensor Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value", - "alias": [], - "parameters": [ - { - "default": "temp", - "description": "Type of sensor", - "mandatory": "true", - "name": "zibase_sensor", - "readonly": "false", - "type": "list", - "list_value": { - "temp": "Temperature sensor" - } - }, - { - "description": "Zibase device ID (ABC)", - "mandatory": "true", - "name": "zibase_id", - "readonly": "false", - "type": "string" - }, - { - "default": "17100", - "description": "Zibase ethernet port, default to 17100", - "mandatory": "false", - "max": "65535", - "min": "0", - "name": "port", - "readonly": "false", - "type": "int" - }, - { - "default": "2", - "description": "Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0", - "mandatory": "false", - "max": "9999", - "min": "0", - "name": "precision", - "readonly": "false", - "type": "int" - }, - { - "description": "Name of Input/Output.", - "mandatory": "true", - "name": "name", - "readonly": "false", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, write an entry in the history event log for this IO", - "mandatory": "false", - "name": "log_history", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display the Input/Output on all user interfaces if set. Default to true", - "mandatory": "false", - "name": "visible", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Display a warning if value has not been updated for a long time. Default to true", - "mandatory": "false", - "name": "display_warning", - "readonly": "false", - "type": "bool" - }, - { - "default": "true", - "description": "Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration.", - "mandatory": "false", - "name": "enabled", - "readonly": "false", - "type": "bool" - }, - { - "default": "1", - "description": "use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0.", - "mandatory": "false", - "name": "coeff_a", - "readonly": "false", - "type": "float" - }, - { - "description": "IO type, can be \"input\", \"output\", \"inout\"", - "mandatory": "true", - "name": "io_type", - "readonly": "true", - "type": "string" - }, - { - "default": "false", - "description": "If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO", - "mandatory": "false", - "name": "logged", - "readonly": "false", - "type": "bool" - }, - { - "description": "use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0", - "mandatory": "false", - "name": "coeff_b", - "readonly": "false", - "type": "float" - }, - { - "description": "Zibase IP address on the network", - "mandatory": "true", - "name": "host", - "readonly": "false", - "type": "string" - }, - { - "description": "same as coeff_b, can be used alone. Default value is 0.0", - "mandatory": "false", - "name": "offset", - "readonly": "false", - "type": "float" - }, - { - "description": "Unique ID identifying the Input/Output in calaos-server", - "mandatory": "true", - "name": "id", - "readonly": "true", - "type": "string" - }, - { - "description": "Internal graphical type for all calaos objects. Set automatically, read-only parameter.", - "mandatory": "false", - "name": "gui_type", - "readonly": "true", - "type": "string" - }, - { - "description": "Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter", - "mandatory": "false", - "name": "period", - "readonly": "false", - "type": "float" - }, - { - "default": "15", - "description": "Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s", - "mandatory": "false", - "name": "interval", - "readonly": "false", - "type": "float" - } - ], - "conditions": [ - { - "description": "Event on any change of temperature value", - "name": "changed" - }, - { - "description": "Event on a temperature value in degree Celsius", - "name": "value" - } - ], - "actions": [] - } -} \ No newline at end of file diff --git a/build_doc/fr/io_doc.md b/build_doc/fr/io_doc.md deleted file mode 100644 index 6739d1b5..00000000 --- a/build_doc/fr/io_doc.md +++ /dev/null @@ -1,3676 +0,0 @@ - -# AVReceiver -AVReceiver object to control network amplifier - -## Parameters of AVReceiver -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -model | string | yes | AVReceiver model. Supported: pioneer, denon, onkyo, marantz, yamaha -zone | int | no | Zone of the amplifier (if supported) -host | string | yes | IP address of the device -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -port | int | no | Port to use for connection -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Actions of AVReceiver -Name | Description ----- | ----------- -custom XXXXXX | Send a custom command to receiver (if you know the protocol) - source X | Change current input source - volume 50 | Set current volume - power off | Switch receiver off - power on | Switch receiver on - -# Axis - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Axis IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of Axis -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -resolution | string | no | Resolution to use -name | string | yes | Name of Input/Output. -tilt_framesize | string | no | -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -pan_framesize | string | no | -model | string | yes | Camera model/chanel to use -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -ptz | bool | no | Set to true if camera has PTZ support -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -zoom_step | string | no | - - -# BlinkstickOutputLightRGB -RGB Light dimmer using a Blinkstick - - -RGB light. Choose a color to be set for this light. - -## Parameters of BlinkstickOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -nb_leds | int | yes | Number of LEDs to control with the blinkstick -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -serial | string | yes | Blinkstick serial to control -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of BlinkstickOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of BlinkstickOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* OLA: http://www.blinkstick.com - -# Foscam - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Foscam IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of Foscam -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -password | string | yes | Password for user -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP Address -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -port | string | yes | Port number -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -ptz | bool | no | Set to true if camera has PTZ support -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -zoom_step | string | no | -username | string | yes | Username for accessing the camera - -# Gadspot - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Gadspot IP Camera. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of Gadspot -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# GpioInputSwitch -Input switch with a GPIO - - -Basic switch with press/release states. - -## Parameters of GpioInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -gpio | int | yes | GPIO ID on your hardware -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -active_low | bool | no | Set this if your GPIO has an inverted level -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of GpioInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - - -# GpioInputSwitchLongPress -Input switch with a GPIO - - -Long press switch. This switch supports single press and long press. User has 500ms to perform the long press. - -## Parameters of GpioInputSwitchLongPress -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -gpio | int | yes | GPIO ID on your hardware -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -active_low | bool | no | Set this is your GPIO has an inverted level -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of GpioInputSwitchLongPress -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is pressed at least for 500ms (long press) - 1 | Event triggered when switch is pressed quickly - - -# GpioInputSwitchTriple -Input switch with a GPIO - - -Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click. - -## Parameters of GpioInputSwitchTriple -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -gpio | int | yes | GPIO ID on your hardware -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -active_low | bool | no | Set this is your GPIO has an inverted level -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of GpioInputSwitchTriple -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is double clicked - 3 | Event triggered when switch is triple clicked - 1 | Event triggered when switch is single clicked - - -# GpioOutputShutter -Shutter with 2 GPIOs - - -Simple shutter. This shutter supports open/close states, as well as impulse shutters. - -## Parameters of GpioOutputShutter -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -active_low_up | bool | no | Set this is your GPIO has an inverted level -active_low_down | bool | no | Set this is your GPIO has an inverted level -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -gpio_down | int | yes | GPIO ID for closing on your hardware -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -time | int | yes | Time in sec for shutter to open or close -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -gpio_up | int | yes | GPIO ID for opening on your hardware - -## Conditions of GpioOutputShutter -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of GpioOutputShutter -Name | Description ----- | ----------- -impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - - -# GpioOutputShutterSmart -Shutter with 2 GPIOs - - -Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position. - -## Parameters of GpioOutputShutterSmart -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -active_low_up | bool | no | Set this is your GPIO has an inverted level -gpio_down | int | yes | GPIO ID for closing on your hardware -active_low_down | bool | no | Set this is your GPIO has an inverted level -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -time_up | int | yes | Time in sec for shutter to be fully open. The more accurate, the better it will work -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -time_down | int | yes | Time in sec for shutter to fully closed. The more accurate, the better it will work -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -gpio_up | int | yes | GPIO ID for opening on your hardware - -## Conditions of GpioOutputShutterSmart -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of GpioOutputShutterSmart -Name | Description ----- | ----------- -up 5 | Open the shutter by X percent - set 50 | Set shutter at position X in percent - impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - down 5 | Close the shutter by X percent - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - calibrate | Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - - -# GpioOutputSwitch -Light with a GPIO - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of GpioOutputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -gpio | int | yes | GPIO ID on your hardware -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -active_low | bool | no | Set this is your GPIO has an inverted level -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of GpioOutputSwitch -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of GpioOutputSwitch -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# HueOutputLightRGB -RGB Light dimmer using a Philips Hue - - -RGB light. Choose a color to be set for this light. - -## Parameters of HueOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -api | string | yes | API key return by Hue bridge when assciation has been made. Use Hue Wizard in calaos_installer to get this value automatically. -host | string | yes | Hue bridge IP address -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -id_hue | string | yes | Unique ID describing the Hue Light. This value is returned by the Hue Wizard. -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of HueOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of HueOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* Meet Hue: http://www.meethue.com - - -# InputTime -Basic time input. An event is triggered when the current time equals the configured time. A specific date can also be set. - -## Parameters of InputTime -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | A time object can't be visible. Always false. -year | int | no | Year for this time input -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -min | int | yes | Minutes for this time input -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -day | int | no | Day for this time input -hour | int | yes | Hour for this time input -sec | int | yes | Seconds for this time input -name | string | yes | Name of Input/Output. -month | int | no | Month for this time input - -## Conditions of InputTime -Name | Description ----- | ----------- -changed | Event on any change of time - false | Event triggered when current time is not equal - true | Event triggered when current time equals - - -# InputTimer -Timer object. trigger an event after the configured time has expired. - -## Parameters of InputTimer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -autorestart | bool | yes | Auto restart the timer when time expires -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A timer object can't be visible. Always false. -msec | int | yes | Miliseconds for the timer interval -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -min | int | yes | Minutes for the timer interval -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -hour | int | yes | Hour for the timer interval -autostart | bool | yes | Auto start the timer when calaos starts -sec | int | yes | Seconds for the timer interval - -## Conditions of InputTimer -Name | Description ----- | ----------- -change | Event triggered on any change - false | Event triggered when timer starts - true | Event triggered when timer expires - -## Actions of InputTimer -Name | Description ----- | ----------- -00:00:00:200 | Reset the configured time to a value. Format is h:m:s:ms - stop | Stop the timer - start | Start the timer - - -# InternalBool -Internal boolean object. This object is useful for doing internal programing in rules, like keeping boolean states, or displaying boolean values - -## Parameters of InternalBool -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -rw | bool | no | Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -save | bool | no | Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of InternalBool -Name | Description ----- | ----------- -changed | Event on any change of value - false | Event when value is false - true | Event when value is true - -## Actions of InternalBool -Name | Description ----- | ----------- -impulse 200 | Do an impulse on boolean value. Set to true for X ms then reset to false - impulse 500 200 500 200 | Do an impulse on boolean value with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert boolean value - false | Set a value to false - true | Set a value to true - - -# InternalInt -Internal number object. This object is useful for doing internal programing in rules, like counters, of displaying values. - -## Parameters of InternalInt -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -rw | bool | no | Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false -unit | string | no | Unit which will be displayed on the UI as a suffix. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -save | bool | no | Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false -step | float | no | Set a step for increment/decrement value. Default is 1.0 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of InternalInt -Name | Description ----- | ----------- -changed | Event on any change of value - 0 | Event on a specific number value - -## Actions of InternalInt -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - - -# InternalString -Internal string object. This object is useful for doing internal programing in rules or displaying text values on user interfaces. - -## Parameters of InternalString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -rw | bool | no | Enable edit mode for this object. It allows user to modify the value on interfaces. Default to false -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -save | bool | no | Automatically save the value in cache. The value will be reloaded when restarting calaos is true. Default to false -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of InternalString -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific string value - -## Actions of InternalString -Name | Description ----- | ----------- -value | Set a specific string value - - -# KNXInputAnalog -Input analog with KNX and eibnetmux - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of KNXInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -knx_group | string | yes | KNX Group address, Ex: x/y/z -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Hostname of knxd, default to localhost -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of KNXInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXInputSwitch -Input switch with KNX and eibnetmux - - -Basic switch with press/release states. - -## Parameters of KNXInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group | string | yes | KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -eis | int | no | KNX EIS (Data type) -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of KNXInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXInputSwitchLongPress -Input switch long press with KNX and eibnetmux - - -Long press switch. This switch supports single press and long press. User has 500ms to perform the long press. - -## Parameters of KNXInputSwitchLongPress -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group | string | yes | KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -eis | int | no | KNX EIS (Data type) -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of KNXInputSwitchLongPress -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is pressed at least for 500ms (long press) - 1 | Event triggered when switch is pressed quickly - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXInputSwitchTriple -Input switch triple with KNX and eibnetmux - - -Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click. - -## Parameters of KNXInputSwitchTriple -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group | string | yes | KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -eis | int | no | KNX EIS (Data type) -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of KNXInputSwitchTriple -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is double clicked - 3 | Event triggered when switch is triple clicked - 1 | Event triggered when switch is single clicked - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXInputTemp -Input temperature with KNX and eibnetmux - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of KNXInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -knx_group | string | yes | KNX Group address, Ex: x/y/z -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Hostname of knxd, default to localhost -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of KNXInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputAnalog -Analog output with KNX and eibnetmux - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of KNXOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -knx_group | string | yes | KNX Group address, Ex: x/y/z -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of KNXOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of KNXOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputLight -Light output with KNX and eibnetmux - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of KNXOutputLight -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -eis | int | no | KNX EIS (Data type) -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -knx_group | string | yes | KNX Group address, Ex: x/y/z -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false - -## Conditions of KNXOutputLight -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of KNXOutputLight -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputLightDimmer -Light dimmer with KNX and eibnetmux - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of KNXOutputLightDimmer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group | string | yes | KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -eis | int | no | KNX EIS (Data type) -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of KNXOutputLightDimmer -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of KNXOutputLightDimmer -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputLightRGB -Light RGB with KNX and eibnetmux - - -RGB light. Choose a color to be set for this light. - -## Parameters of KNXOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group_blue | string | no | Blue Group address for listening status, Ex: x/y/z -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -listen_knx_group_green | string | no | Green Group address for listening status, Ex: x/y/z -knx_group_red | string | yes | Red channel KNX Group address, Ex: x/y/z -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -knx_group_green | string | yes | Green channel KNX Group address, Ex: x/y/z -listen_knx_group_red | string | no | Red Group address for listening status, Ex: x/y/z -knx_group_blue | string | yes | Blue channel KNX Group address, Ex: x/y/z - -## Conditions of KNXOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of KNXOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputShutter -Shutter with with KNX and eibnetmux - - -Simple shutter. This shutter supports open/close states, as well as impulse shutters. - -## Parameters of KNXOutputShutter -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -eis | int | no | KNX EIS (Data type) -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -time | int | yes | Time in sec for shutter to open or close -knx_group_down | string | yes | Down KNX Group address, Ex: x/y/z -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -knx_group_up | string | yes | Up KNX Group address, Ex: x/y/z - -## Conditions of KNXOutputShutter -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of KNXOutputShutter -Name | Description ----- | ----------- -impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# KNXOutputShutterSmart -Shutter with with KNX and eibnetmux - - -Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position. - -## Parameters of KNXOutputShutterSmart -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Hostname of knxd, default to localhost -read_at_start | bool | yes | Send a read request at start to get the current value. Default is false -eis | int | no | KNX EIS (Data type) -listen_knx_group | string | no | KNX Group address for listening status, Ex: x/y/z -knx_group_down | string | yes | Down KNX Group address, Ex: x/y/z -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -knx_group | string | yes | KNX Group address, Ex: x/y/z -time_up | int | yes | Time in sec for shutter to be fully open. The more accurate, the better it will work -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -time_down | int | yes | Time in sec for shutter to fully closed. The more accurate, the better it will work -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -knx_group_up | string | yes | Up KNX Group address, Ex: x/y/z - -## Conditions of KNXOutputShutterSmart -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of KNXOutputShutterSmart -Name | Description ----- | ----------- -up 5 | Open the shutter by X percent - set 50 | Set shutter at position X in percent - impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - down 5 | Close the shutter by X percent - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - calibrate | Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* knxd: https://github.com/knxd/knxd/g - - -# MilightOutputLightRGB -RGB light support for Limitless/Milight RGB bulbs. - - -RGB light. Choose a color to be set for this light. - -## Parameters of MilightOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -zone | int | yes | Zone to control. Each gateway supports 4 zones. -host | string | yes | Milight wifi gateway IP address -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -port | int | no | Gateway port, default to 8899 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of MilightOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MilightOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* LimitlessLED: http://www.limitlessled.com - - -# MqttInputAnalog -Analog value read from a mqtt broker - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of MqttInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -port | int | no | TCP port of the mqtt broker. Default value is 1883 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of MqttInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# MqttInputString -String value read from a mqtt broker - -## Parameters of MqttInputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - - -# MqttInputSwitch -Switch value read from a mqtt broker - - -Basic switch with press/release states. - -## Parameters of MqttInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -on_value | string | yes | Value to interpret as ON value -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -off_value | string | yes | Value to interpret as OFF value -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | A switch can't be visible. Always false. -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - -## Conditions of MqttInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - - -# MqttInputTemp -Temperature read from a mqtt broker - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of MqttInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -port | int | no | TCP port of the mqtt broker. Default value is 1883 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of MqttInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - - -# MqttOutputAnalog -Control analog output through mqtt broker - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of MqttOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data | string | yes | The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with the state (float value) to be sent. -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -port | int | no | TCP port of the mqtt broker. Default value is 1883 -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of MqttOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of MqttOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - - -# MqttOutputLight -Control lights through mqtt broker - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of MqttOutputLight -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data | string | yes | The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with with the state (on_value, off_value) to be sent. -on_value | string | yes | Value to interpret as ON value -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -off_value | string | yes | Value to interpret as OFF value -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - -## Conditions of MqttOutputLight -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of MqttOutputLight -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# MqttOutputLightDimmer -Control lights through mqtt broker - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of MqttOutputLightDimmer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data | string | yes | The data sent when publishing to topic. The __##VALUE##__ contained in data is substituted with the state (integer value) to be sent. -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - -## Conditions of MqttOutputLightDimmer -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MqttOutputLightDimmer -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - - -# MqttOutputLightRGB -Control RGB lights through mqtt broker - - -RGB light. Choose a color to be set for this light. - -## Parameters of MqttOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -path_brightness | string | yes | The path where to found the brightness value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example 'brightness' -path_y | string | yes | The path where to found the Y (X/Y Color space) value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example color.y, try to read the x value from the color object. -path_x | string | yes | The path where to found the X (X/Y Color space) value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example color.x, try to read the x value from the color object. -data | string | yes | The data sent when publishing color to topic. The __##VALUE_R##__ __##VALUE_G##__ __##VALUE_B##__ or __##VALUE_HEX##__ or __##VALUE_X##__ __##VALUE_Y##__ __##VALUE_BRIGHTNESS##__ contained in data is substituted with the color (integer value or #RRGGBB string value) to be sent. -topic_sub | string | yes | Topic on witch to subscribe. -topic_pub | string | yes | Topic on witch to publish. -keepalive | int | no | keepalive timeout in seconds. Time between two mqtt PING. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value in the mqtt payload. If payload if JSON, informations will be extracted depending on the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. if payload is somple json, just try to use the key of the value you want to read, for example : {"temperature":14.23} use "temperature" as path - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | TCP port of the mqtt broker. Default value is 1883 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -user | string | no | User to use for authentication with mqtt broker. Password must be defined in that case. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | no | IP address of the mqtt broker to connect to. Default value is 127.0.0.1. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | no | Password to use for authentication with mqtt broker. User must be defined in that case. - -## Conditions of MqttOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MqttOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - - -# MySensorsInputAnalog -Analog measurement with MySensors node - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of MySensorsInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | IP address of the tcp gateway if relevant -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of MySensorsInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputString -Display string from MySensors node - -## Parameters of MySensorsInputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputSwitch -Input switch with MySensors node - - -Basic switch with press/release states. - -## Parameters of MySensorsInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -visible | bool | no | A switch can't be visible. Always false. -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of MySensorsInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputSwitchLongPress -Input long press switch with MySensors node - - -Long press switch. This switch supports single press and long press. User has 500ms to perform the long press. - -## Parameters of MySensorsInputSwitchLongPress -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -visible | bool | no | A switch can't be visible. Always false. -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of MySensorsInputSwitchLongPress -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is pressed at least for 500ms (long press) - 1 | Event triggered when switch is pressed quickly - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputSwitchTriple -Input triple click switch with MySensors node - - -Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click. - -## Parameters of MySensorsInputSwitchTriple -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -visible | bool | no | A switch can't be visible. Always false. -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of MySensorsInputSwitchTriple -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is double clicked - 3 | Event triggered when switch is triple clicked - 1 | Event triggered when switch is single clicked - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsInputTemp -Temperature sensor with MySensors node - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of MySensorsInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -sensor_id | string | yes | Sensor ID, as set in your node -node_id | string | yes | Node ID as set in your network -gateway | list | yes | Gateway type used, tcp or serial are supported -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | IP address of the tcp gateway if relevant -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of MySensorsInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputAnalog -Analog output with MySensors node - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of MySensorsOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values. -sensor_id | string | yes | Sensor ID, as set in your node -node_id | string | yes | Node ID as set in your network -host | string | yes | IP address of the tcp gateway if relevant -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -gateway | list | yes | Gateway type used, tcp or serial are supported -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of MySensorsOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of MySensorsOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputDimmer -Light dimmer with MySensors node - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of MySensorsOutputDimmer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values. -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -node_id | string | yes | Node ID as set in your network -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP address of the tcp gateway if relevant -sensor_id | string | yes | Sensor ID, as set in your node - -## Conditions of MySensorsOutputDimmer -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MySensorsOutputDimmer -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputLight -Light/relay with MySensors node - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of MySensorsOutputLight -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values. -sensor_id | string | yes | Sensor ID, as set in your node -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -node_id | string | yes | Node ID as set in your network -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP address of the tcp gateway if relevant - -## Conditions of MySensorsOutputLight -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of MySensorsOutputLight -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputLightRGB -RGB Light dimmer with MySensors node - - -RGB light. Choose a color to be set for this light. - -## Parameters of MySensorsOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_DIMMER, see MySensors.cpp for more values. -node_id_green | string | yes | Node ID for green channel, as set in your network -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -gateway | list | yes | Gateway type used, tcp or serial are supported -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -sensor_id_green | string | yes | Sensor ID green red channel, as set in your node -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP address of the tcp gateway if relevant -sensor_id_blue | string | yes | Sensor ID blue red channel, as set in your node -node_id_blue | string | yes | Node ID for blue channel, as set in your network -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -node_id_red | string | yes | Node ID for red channel, as set in your network -sensor_id_red | string | yes | Sensor ID for red channel, as set in your node - -## Conditions of MySensorsOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of MySensorsOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputShutter -Shutter with MySensors node - - -Simple shutter. This shutter supports open/close states, as well as impulse shutters. - -## Parameters of MySensorsOutputShutter -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values. -sensor_id_down | string | yes | Sensor ID for closing shutter, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id_up | string | yes | Node ID for opening shutter, as set in your network -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -node_id_down | string | yes | Node ID for closing shutter, as set in your network -io_type | string | yes | IO type, can be "input", "output", "inout" -sensor_id_up | string | yes | Sensor ID for opening shutter, as set in your node -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -time | int | yes | Time in sec for shutter to open or close -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 - -## Conditions of MySensorsOutputShutter -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of MySensorsOutputShutter -Name | Description ----- | ----------- -impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputShutterSmart -Smart shutter with MySensors node - - -Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position. - -## Parameters of MySensorsOutputShutterSmart -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_LIGHT, see MySensors.cpp for more values. -sensor_id_down | string | yes | Sensor ID for closing shutter, as set in your node -host | string | yes | IP address of the tcp gateway if relevant -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -node_id_up | string | yes | Node ID for opening shutter, as set in your network -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -node_id_down | string | yes | Node ID for closing shutter, as set in your network -time_up | int | yes | Time in sec for shutter to be fully open. The more accurate, the better it will work -io_type | string | yes | IO type, can be "input", "output", "inout" -sensor_id_up | string | yes | Sensor ID for opening shutter, as set in your node -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -time_down | int | yes | Time in sec for shutter to fully closed. The more accurate, the better it will work -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 - -## Conditions of MySensorsOutputShutterSmart -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of MySensorsOutputShutterSmart -Name | Description ----- | ----------- -up 5 | Open the shutter by X percent - set 50 | Set shutter at position X in percent - impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - down 5 | Close the shutter by X percent - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - calibrate | Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* MySensors: http://mysensors.org - - -# MySensorsOutputString -String output with MySensors node - -## Parameters of MySensorsOutputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -data_type | string | no | Data type sent to the node. Default: V_VAR1, see MySensors.cpp for more values. -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | string | yes | If using serial gateway, port is the serial port (/dev/ttyUSB0 for ex.). If using tcp gateway port is TCP port of the gateway. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -gateway | list | yes | Gateway type used, tcp or serial are supported -node_id | string | yes | Node ID as set in your network -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | IP address of the tcp gateway if relevant -sensor_id | string | yes | Sensor ID, as set in your node - -## More Infos -* MySensors: http://mysensors.org - - -# OLAOutputLightDimmer -DMX Light dimmer using OLA (Open Lighting Architecture) - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of OLAOutputLightDimmer -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -channel | int | yes | DMX channel to control -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -universe | int | yes | OLA universe to control -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of OLAOutputLightDimmer -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of OLAOutputLightDimmer -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - -## More Infos -* OLA: http://www.openlighting.org - - -# OLAOutputLightRGB -RGB Light dimmer using 3 DMX channels with OLA (Open Lighting Architecture) - - -RGB light. Choose a color to be set for this light. - -## Parameters of OLAOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -channel_blue | int | yes | DMX channel for blue to control -channel_red | int | yes | DMX channel for red to control -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -channel_green | int | yes | DMX channel for green to control -universe | int | yes | OLA universe to control -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of OLAOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of OLAOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* OLA: http://www.openlighting.org - - -# OutputFake -Fake test output. Do nothing. Do not use. - -## Parameters of OutputFake -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# OWTemp -Temperature measurement with DS18B20 Onewire Sensor - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of OWTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -use_w1 | bool | no | Force the use of w1 kernel driver instead of OneWire driver -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -ow_id | string | yes | Unique ID of sensor on OneWire bus. -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -ow_args | string | yes | Additional parameter used for owfs initialization.For example you can use -u to use the USB owfs drivers -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of OWTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/OneWire - - -# PingInputSwitch -A switch input based on the result of a ping command. Useful to detect presence of a host on the network. - - -Basic switch with press/release states. - -## Parameters of PingInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -interval | int | no | Interval between pings in ms. Default to 15 sec -timeout | int | no | Timeout of the ping request in ms -host | string | yes | IP address or host where to send the ping -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of PingInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | The host is offline and/or does not respond to the ping - true | The host is online and respond to the ping - -# Planet - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Planet IP Camera/Encoder. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of Planet -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -password | string | no | Password for user -username | string | no | Username for accessing the camera -model | string | yes | Camera model (ICA-210, ICA-210W, ICA-300, ICA-302, ICA-500) to use -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# Scenario -A scenario variable. Use this like a virtual button to start a scenario (list of actions) - -## Parameters of Scenario -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -auto_scenario | string | no | Internal use only for Auto Scenario. read only. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of Scenario -Name | Description ----- | ----------- -true | Event triggered when scenario is started - -## Actions of Scenario -Name | Description ----- | ----------- -changed | Event triggered on any change - false | Stop the scenario (only for special looping scenarios) - true | Start the scenario - - -# Squeezebox -#### Alias: slim -Squeezebox audio player allows control of a Squeezebox from Calaos - -## Parameters of Squeezebox -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -port_cli | int | no | CLI port of LMS, default to 9090 -host | string | yes | Logitech media server IP address -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -port_web | int | no | Web interface port of LMS, default to 9000. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | yes | Audio players are not displayed in rooms -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID of squeezebox in LMS - -## Conditions of Squeezebox -Name | Description ----- | ----------- -onplaylistchange | Event when a change in the current playlist happens - onvolumechange | Event when a change of volume happens - onstop | Event when stopping player - onsongchange | Event when a new song is being played - onpause | Event when pausing player - onplay | Event when play is started - -## Actions of Squeezebox -Name | Description ----- | ----------- -add | Add tracks to playlist. can be any of album_id:XX artist_id:XX playlist_id:XX, ... - play | Clear playlist and play argument. can be any of album_id:XX artist_id:XX playlist_id:XX, ... - pause | Pause player - sync | Sync this player with an other - stop | Stop player - volume up 1 | Increase volume by a value - volume set 50 | Set current volume - previous | Play previous song in playlist - volume down 1 | Decrease volume by a value - play | Start playing - next | Play next song in playlist - power on | Switch player on - sleep 10 | Start sleep mode with X seconds - power off | Switch player off - unsync | Stop sync of this player with an other - -# standard_mjpeg - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -MJPEG/Jpeg IP Camera. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of standard_mjpeg -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -ptz | bool | no | Set to true if camera has PTZ support -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -url_mjpeg | string | no | URL for mjpeg stream support -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -url_jpeg | string | yes | URL for snapshot in jpeg format -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -# StandardMjpeg - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -MJPEG/Jpeg IP Camera. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of StandardMjpeg -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -ptz | bool | no | Set to true if camera has PTZ support -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -url_mjpeg | string | no | URL for mjpeg stream support -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -url_jpeg | string | yes | URL for snapshot in jpeg format -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -# SynoSurveillanceStation - UNDOCUMENTED IO -SPANK SPANK SPANK : naughty programmer ! You did not add documentation for this IO, that's BAD :'( -Go document it in your code or you will burn in hell! - - - -Synology Surveillance Station IP Camera. Camera can be viewed directly inside calaos and used in rules. - -## Parameters of SynoSurveillanceStation -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -width | int | no | Width of the image, if this parameter is set, video will be resized to fit the given width. Let parameter empty to keep the original size. -camera_profile | int | no | Profile to use for snapshot. 0- High quality, 1- Balanced, 2- Low bandwidth -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -rotate | int | no | Rotate the image. Set a value between. The value is in degrees. Example : -90 for Counter Clock Wise rotation, 90 for Clock Wise rotationCW. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -url | string | yes | Full url to Synology nas. Ex: https://192.168.0.22:5000 -username | string | yes | Username which can access Surveillance Station -camera_id | string | yes | ID of the camera -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -password | string | yes | Password for user - - -# TeleinfoInputAnalog -Analog measurement retrieved from Teleinfo informations. - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of TeleinfoInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -value | list | yes | All theses values are reported by the Teleinfo equipment as double. -port | string | yes | port on which to get Teleinfo information usually a serial port like /dev/ttyS0 or /dev/ttyAMA0 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of TeleinfoInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# TimeRange -#### Alias: InPlageHoraire -Represent a time range object. A time range is true if current time is in one of the included range, false otherwise. The time range also support weekdays and months. - -## Parameters of TimeRange -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A time range can't be visible. Always false. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of TimeRange -Name | Description ----- | ----------- -changed | Event on any change of range - false | Event triggered when exiting the range - true | Event triggered when entering the range - - -# WebInputAnalog -Analog input read from a web document - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of WebInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -url | string | yes | URL where to download the document from -If URL begins with / or with file:// the data is read from the local file -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -file_type | string | yes | File type of the document. Values can be xml, json or text. -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of WebInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# WebInputString -String input providing from a web document - -## Parameters of WebInputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -url | string | yes | URL where to download the document from -If URL begins with / or with file:// the data is read from the local file -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -file_type | string | yes | File type of the document. Values can be xml, json or text. -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# WebInputTemp -Temperature input read from a web document - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of WebInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -url | string | yes | URL where to download the document from -If URL begins with / or with file:// the data is read from the local file -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -file_type | string | yes | File type of the document. Values can be xml, json or text. -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of WebInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - - -# WebOutputAnalog -Analog output in a web request - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of WebOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -file_type | string | yes | File type of the document. Values can be xml, json or text. -name | string | yes | Name of Input/Output. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -url | string | yes | URL where to download the document from -If URL begins with / or with file:// the data is read from the local file -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of WebOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of WebOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - - -# WebOutputLight -Bool output written to a web document or URL - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of WebOutputLight -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -url | string | yes | URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be : -http://example.com/api?value=20.3 -The url is encoded before being sent. -If the URL begins with / or file:// the data is written to a file. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -data_type | string | yes | The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -data | string | yes | The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WebOutputLight -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of WebOutputLight -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# WebOutputLightRGB -RGB value written to a web document or URL - - -RGB light. Choose a color to be set for this light. - -## Parameters of WebOutputLightRGB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -url | string | yes | URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be : -http://example.com/api?value=20.3 -The url is encoded before being sent. -If the URL begins with / or file:// the data is written to a file. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -data_type | string | yes | The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -data | string | yes | The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -raw_value | bool | no | RGB value has #RRGGBB. Sometimes some web api take only RRGGBBformat. If raw_value is true, the # in front of the line isremoved. The default value for this parameter is false. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WebOutputLightRGB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of WebOutputLightRGB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - - -# WebOutputString -String output written to a web document or URL - -## Parameters of WebOutputString -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -url | string | yes | URL where to POST the document to. The POST request is associated with the data field if not null. When no data is provided, Calaos substitutes __##VALUE##__ string with the value to send. For example if the url is http://example.com/api?value=__##VALUE##__ the url post will be : -http://example.com/api?value=20.3 -The url is encoded before being sent. -If the URL begins with / or file:// the data is written to a file. -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -file_type | string | yes | File type of the document. Values can be xml, json or text. -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -data_type | string | yes | The HTTP header Content-Type used when posting the document. It depends on the website, but you can use application/json application/xml as correct values. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -data | string | yes | The document send when posting data. This value can be void, in, that case the value is substituted in the url, otherwise the __##VALUE##__ contained in data is substituted with with the value to be sent. -path | string | yes | The path where to found the value. This value can take multiple values depending on the file type. If file_type is JSON, the json file downloaded will be read, and the informations will be extracted from the path. for example weather[0]/description, try to read the description value of the 1 element of the array of the weather object. -If file_type is XML, the path is an xpath expression; Look here for syntax : http://www.w3schools.com/xsl/xpath_syntax.asp If file_type is TEXT, the downloaded file is returned as plain text file, and path must be in the form line/pos/separator Line is read, and is split using separator as delimiters The value returned is the value at pos in the split list. If the separator is not found, the whole line is returned. Example the file contains -10.0,10.1,10.2,10.3 -20.0,20.1,20.2,20.3 -If the path is 2/4/, the value returne wil be 20.3 - -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# WIAnalog -#### Alias: WagoInputAnalog -Analog measurement with Wago module (like 0-10V, 4-20mA, ...) - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of WIAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -port | int | no | Wago ethernet port, default to 502 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -var | int | yes | PLC address of the input sensor -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Wago PLC IP address on the network -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of WIAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/entree_analog - - -# WIDigitalBP -#### Alias: WIDigital, WagoInputSwitch -Switch with digital input Wago modules (like 750-1405, ...) - - -Basic switch with press/release states. - -## Parameters of WIDigitalBP -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Wago PLC IP address on the network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -port | int | no | Wago ethernet port, default to 502 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -var | int | yes | PLC address of the digital input -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WIDigitalBP -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1045 - - -# WIDigitalLong -#### Alias: WagoInputSwitchLongPress -Switch long press with digital input Wago modules (like 750-1405, ...) - - -Long press switch. This switch supports single press and long press. User has 500ms to perform the long press. - -## Parameters of WIDigitalLong -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Wago PLC IP address on the network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -port | int | no | Wago ethernet port, default to 502 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -var | int | yes | PLC address of the digital input -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WIDigitalLong -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is pressed at least for 500ms (long press) - 1 | Event triggered when switch is pressed quickly - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1045 - - -# WIDigitalTriple -#### Alias: WagoInputSwitchTriple -Switch triple click with digital input Wago modules (like 750-1405, ...) - - -Triple click switch. This switch can start 3 kind of actions. User has 500ms to do a multiple click. - -## Parameters of WIDigitalTriple -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -host | string | yes | Wago PLC IP address on the network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -port | int | no | Wago ethernet port, default to 502 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -var | int | yes | PLC address of the digital input -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of WIDigitalTriple -Name | Description ----- | ----------- -changed | Event on any change of state - 2 | Event triggered when switch is double clicked - 3 | Event triggered when switch is triple clicked - 1 | Event triggered when switch is single clicked - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1045 - - -# WITemp -#### Alias: WagoInputTemp -Temperature measurement with Wago temperature module (like 750-460) - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of WITemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -port | int | no | Wago ethernet port, default to 502 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -var | int | yes | PLC address of the input sensor -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Wago PLC IP address on the network -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of WITemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-460 - - -# WOAnalog -#### Alias: WagoOutputAnalog -Analog output with Wago module (like 0-10V, 4-20mA, ...) - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of WOAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -port | int | no | Wago ethernet port, default to 502 -host | string | yes | Wago PLC IP address on the network -var | int | yes | PLC address of the output -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of WOAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of WOAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/sortie_analog - - -# WODali -#### Alias: WagoOutputDimmer -Light using DALI or DMX. For DALI you need a 750-641 wago module. For DMX, a DMX4ALL-LAN device connected to the Wago PLC. - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of WODali -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | Wago ethernet port, default to 502 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -fade_time | int | no | DALI fade time. value is between 1-10 -line | int | no | DALI bus line, usually 1 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -address | int | yes | Device address. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105 -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | Wago PLC IP address on the network -group | int | no | Set to 1 if address is a DALI group address, set to 0 otherwise. - -## Conditions of WODali -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of WODali -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-641 -* Calaos Wiki: http://calaos.fr/wiki/fr/dmx-lan - - -# WODaliRVB -#### Alias: WagoOutputDimmerRGB -RGB Light using DALI or DMX. To work you need 3 DALI/DMX channels. For DALI you need a 750-641 wago module. For DMX, a DMX4ALL-LAN device connected to the Wago PLC. - - -RGB light. Choose a color to be set for this light. - -## Parameters of WODaliRVB -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -bfade_time | int | no | DALI fade time for blue channel. value is between 1-10 -bgroup | int | no | Set to 1 if address for blue channel is a DALI group address, set to 0 otherwise. -ggroup | int | no | Set to 1 if address for green channel is a DALI group address, set to 0 otherwise. -gaddress | int | yes | Device address for green channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105 -gline | int | no | DALI bus line for green channel, usually 1 -rfade_time | int | no | DALI fade time for red channel. value is between 1-10 -name | string | yes | Name of Input/Output. -baddress | int | yes | Device address for blue channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | Wago ethernet port, default to 502 -gfade_time | int | no | DALI fade time for green channel. value is between 1-10 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -bline | int | no | DALI bus line for blue channel, usually 1 -io_type | string | yes | IO type, can be "input", "output", "inout" -host | string | yes | Wago PLC IP address on the network -rline | int | no | DALI bus line for red channel, usually 1 -raddress | int | yes | Device address for red channel. For DALI address is between 1-64. For DMX, the address starts at 100. So for DMX device 5, address should be 105 -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -rgroup | int | no | Set to 1 if address for red channel is a DALI group address, set to 0 otherwise. - -## Conditions of WODaliRVB -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of WODaliRVB -Name | Description ----- | ----------- -down_red 5 | Decrease intensity by X percent of red channel - true | Switch the light on - false | Switch the light off - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_green 5 | Decrease intensity by X percent of green channel - toggle | Invert the light state (ON/OFF) - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - down_blue 5 | Decrease intensity by X percent of blue channel - set_state #AA1294 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - up_red 5 | Increase intensity by X percent of red channel - set_red 50 | Set red channel to X percent - set_blue 50 | Set blue channel to X percent - up_green 5 | Increase intensity by X percent of green channel - set_green 50 | Set green channel to X percent - set #AA1294 | Set color. Color can be represented by using HTML notation: #AABBCC, rgb(50, 10, 30), hsl(11, 22, 33) - up_blue 5 | Increase intensity by X percent of blue channel - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-641 -* Calaos Wiki: http://calaos.fr/wiki/fr/dmx-lan - - -# WODigital -#### Alias: WagoOutputLight -Simple light or relay control using wago digital output modules (like 750-1504, ...) - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of WODigital -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -knx | bool | no | Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module) -var | int | yes | PLC address of the output -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | Wago ethernet port, default to 502 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | Wago PLC IP address on the network -wago_841 | bool | yes | Should be false if PLC is 750-842, true otherwise - -## Conditions of WODigital -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of WODigital -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1504 - - -# WOLOutputBool -Wake On Lan output object. Send wake-on-lan packet to a device on the network. - -## Parameters of WOLOutputBool -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -interval | int | no | Interval between pings in ms. Default to 15 sec -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -address | string | yes | Ethernet MAC address of the host to wake up -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Actions of WOLOutputBool -Name | Description ----- | ----------- -true | Send wake on lan packet to the configured device - - -# WOVolet -#### Alias: WagoOutputShutter -Simple shutter using wago digital output modules (like 750-1504, ...) - - -Simple shutter. This shutter supports open/close states, as well as impulse shutters. - -## Parameters of WOVolet -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -knx | bool | no | Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module) -wago_841 | bool | yes | Should be false if PLC is 750-842, true otherwise -var_down | int | yes | Digital output address on the PLC for closing the shutter -var_up | int | yes | Digital output address on the PLC for opening the shutter -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -port | int | no | Wago ethernet port, default to 502 -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -time | int | yes | Time in sec for shutter to open or close -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -host | string | yes | Wago PLC IP address on the network - -## Conditions of WOVolet -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of WOVolet -Name | Description ----- | ----------- -impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1504 - - -# WOVoletSmart -#### Alias: WagoOutputShutterSmart -Smart shutter using wago digital output modules (like 750-1504, ...) - - -Smart shutter. This shutter calculates the position of the shutter based on the time it takes to open and close. It then allows to set directly the shutter at a specified position. - -## Parameters of WOVoletSmart -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -knx | bool | no | Set to true if output is a KNX device (only for 750-849 with KNX/TP1 module) -wago_841 | bool | yes | Should be false if PLC is 750-842, true otherwise -var_down | int | yes | Digital output address on the PLC for closing the shutter -var_up | int | yes | Digital output address on the PLC for opening the shutter -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -time_up | int | yes | Time in sec for shutter to be fully open. The more accurate, the better it will work -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -time_down | int | yes | Time in sec for shutter to fully closed. The more accurate, the better it will work -port | int | no | Wago ethernet port, default to 502 -stop_both | bool | no | If in impulse mode, some shutters needs to activate both up dans down relays when stopping the shutter -impulse_time | int | no | Impulse time for shutter that needs impulse instead of holding up/down relays. If set to 0 impulse shutter is disabled. Time is in ms. Default to 0 -host | string | yes | Wago PLC IP address on the network - -## Conditions of WOVoletSmart -Name | Description ----- | ----------- -false | Event when shutter is closed - true | Event when shutter is open - changed | Event on any change of shutter state - -## Actions of WOVoletSmart -Name | Description ----- | ----------- -up 5 | Open the shutter by X percent - set 50 | Set shutter at position X in percent - impulse up 200 | Open shutter for X ms - set_state true | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - down 5 | Close the shutter by X percent - impulse down 200 | Close shutter for X ms - toggle | Invert shutter state - set_state false | Update internal shutter state without starting real action. This is useful when having updating the shutter state from an external source. - calibrate | Start calibration on shutter. This opens fully the shutter and resets all internal position values. Use this if shutter sync is lost. - stop | Stop the shutter - down | Close the shutter - up | Open the shutter - -## More Infos -* Calaos Wiki: http://calaos.fr/wiki/fr/750-1504 - - -# X10Output -Light dimmer using X10 and heyu. - - -Light with dimming control. Light intensity can be changed for this light. - -## Parameters of X10Output -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -code | string | yes | House code of the X10 light device -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of X10Output -Name | Description ----- | ----------- -value | Event when light is at this value - changed | Event on any change of value - -## Actions of X10Output -Name | Description ----- | ----------- -hold stop | Dynamically change light intensity when holding a switch (stop action) - true | Switch the light on - false | Switch the light off - set off 50 | Set light value without switching on. This will be the light intensity for the next ON - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - toggle | Invert the light state - down 5 | Decrease intensity by X percent - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - hold press | Dynamically change light intensity when holding a switch (press action) - set_state 50 | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - set 50 | Set light intensity and swith on if light is off - up 5 | Increase intensity by X percent - - -# xPLInputAnalog -xPL analog sensor - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of xPLInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -sensor | string | yes | Sensor ID, as set in your xPL network -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of xPLInputAnalog -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# xPLInputAnalog -xPL string sensor - -## Parameters of xPLInputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -sensor | string | yes | Sensor ID, as set in your xPL network -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# xPLInputSwitch -xPL input switch - - -Basic switch with press/release states. - -## Parameters of xPLInputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | A switch can't be visible. Always false. -sensor | string | yes | Sensor ID, as set in your xPL network -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of xPLInputSwitch -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - - -# xPLInputTemp -xPL temperature sensor - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of xPLInputTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -sensor | string | yes | Sensor ID, as set in your xPL network -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of xPLInputTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius - - -# xPLOutputAnalog -Analog output controlled by xPL Protocol - - -Analog output. Useful to control analog output devices connected to calaos. - -## Parameters of xPLOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -actuator | string | yes | Actuator ID, as set in your xPL network -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -step | float | no | Set a step for increment/decrement value. Default is 1.0 -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 0.0 -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_sent = coeff_a * raw_value + coeff_b`. Default value is 1.0. -unit | string | no | Unit which will be displayed on the UI as a suffix. - -## Conditions of xPLOutputAnalog -Name | Description ----- | ----------- -0 | Event on a specific number value - changed | Event on any change of value - value | Event on a specific value - -## Actions of xPLOutputAnalog -Name | Description ----- | ----------- -dec 1 | Decrement value by value - inc 1 | Increment value by value - dec | Decrement value with configured step - inc | Increment value with configured step - 0 | Set a specific number value - - -# xPLOutputAnalog -Analog output controlled by xPL Protocol - -## Parameters of xPLOutputAnalog -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -actuator | string | yes | Actuator ID, as set in your xPL network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - - -# xPLOutputSwitch -Light/relay controlled by xPL Protocol - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of xPLOutputSwitch -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -actuator | string | yes | Actuator ID, as set in your xPL network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -source | string | yes | Source name, as set in your xPL network (Format VendorId-DeviceId.Instance) -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of xPLOutputSwitch -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of xPLOutputSwitch -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# ZibaseAnalogIn -Zibase analog input. This object can read value from devices like Energy monitor sensors, Lux sensors, ... - - -An analog input can be used to read analog values to display them and use them in rules. - -## Parameters of ZibaseAnalogIn -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -zibase_sensor | list | yes | Type of sensor -zibase_id | string | yes | Zibase device ID (ABC) -port | int | no | Zibase ethernet port, default to 17100 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -unit | string | no | Unit which will be displayed on the UI as a suffix. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Zibase IP address on the network -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of ZibaseAnalogIn -Name | Description ----- | ----------- -changed | Event on any change of value - value | Event on a specific value - - -# ZibaseDigitalIn -Zibase digital input. This object acts as a switch - - -Basic switch with press/release states. - -## Parameters of ZibaseDigitalIn -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -zibase_id2 | string | yes | Second Zibase device ID (ABC) -host | string | yes | Zibase IP address on the network -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -io_type | string | yes | IO type, can be "input", "output", "inout" -zibase_sensor | list | yes | Type of sensor -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -zibase_id | string | yes | First Zibase device ID (ABC) -visible | bool | no | A switch can't be visible. Always false. -port | int | no | Zibase ethernet port, default to 17100 -log_history | bool | no | If enabled, write an entry in the history event log for this IO -name | string | yes | Name of Input/Output. -id | string | yes | Unique ID identifying the Input/Output in calaos-server - -## Conditions of ZibaseDigitalIn -Name | Description ----- | ----------- -changed | Event on any change of state - false | Event triggered when switch is released - true | Event triggered when switch is pressed - - -# ZibaseDigitalOut -Zibase digital output. This object controls Zibase devices - - -Basic light. This light have only 2 states, ON or OFF. Can also be used to control simple relays output - -## Parameters of ZibaseDigitalOut -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -name | string | yes | Name of Input/Output. -io_style | list | yes | GUI style display. This will control the icon displayed on the UI -log_history | bool | no | If enabled, write an entry in the history event log for this IO -port | int | no | Zibase ethernet port, default to 17100 -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -nbburst | int | no | Number of burst to send to the device -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -host | string | yes | Zibase IP address on the network -zibase_id | string | yes | Zibase device ID (ABC) -protocol | list | yes | Protocol to use - -## Conditions of ZibaseDigitalOut -Name | Description ----- | ----------- -false | Event when light is off - true | Event when light is on - changed | Event on any change of value - -## Actions of ZibaseDigitalOut -Name | Description ----- | ----------- -impulse 200 | Do an impulse on light state. Set to true for X ms then reset to false - set_state true | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - impulse 500 200 500 200 | Do an impulse on light state with a pattern.
Ex: 500 200 500 200 means: TRUE for 500ms, FALSE for 200ms, TRUE for 500ms, FALSE for 200ms
Ex: 500 loop 200 300 means: TRUE for 500ms, then loop the next steps for infinite, FALSE for 200ms, TRUE for 300ms
Ex: 100 100 200 old means: blinks and then set to the old start state (before impulse starts) - toggle | Invert light state - set_state false | Update internal light state without starting real action. This is useful when having updating the light state from an external source. - false | Switch the light off - true | Switch the light on - - -# ZibaseTemp -Zibase temperature sensor - - -Temperature sensor input. Use for displaying temperature and to control heating devices with rules based on temperature value - -## Parameters of ZibaseTemp -Name | Type | Mandatory | Description ----- | ---- | --------- | ----------- -zibase_sensor | list | yes | Type of sensor -zibase_id | string | yes | Zibase device ID (ABC) -port | int | no | Zibase ethernet port, default to 17100 -precision | int | no | Precision of the returned value. The value represents the number of decimal after the dot. The value is rounded like this : value = 19.275 => returned value 19.28 when preicision = 2, 19.3 when precision = 1, 19 when precision = 0 -name | string | yes | Name of Input/Output. -log_history | bool | no | If enabled, write an entry in the history event log for this IO -visible | bool | no | Display the Input/Output on all user interfaces if set. Default to true -display_warning | bool | no | Display a warning if value has not been updated for a long time. Default to true -enabled | bool | no | Enable the Input/Output. The default value is true. This parameter is added if it's not found in the configuration. -coeff_a | float | no | use in conjunction of coeff_b to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 1.0. -io_type | string | yes | IO type, can be "input", "output", "inout" -logged | bool | no | If enabled, and if influxdb is enabled in local_config send the value to influxdb for this IO -coeff_b | float | no | use in conjunction of coeff_a to apply equation of the form `value_displayed = coeff_a * raw_value + coeff_b`. Default value is 0.0 -host | string | yes | Zibase IP address on the network -offset | float | no | same as coeff_b, can be used alone. Default value is 0.0 -id | string | yes | Unique ID identifying the Input/Output in calaos-server -gui_type | string | no | Internal graphical type for all calaos objects. Set automatically, read-only parameter. -period | float | no | Sampling time in microsecond. The value is read at this frequency. If this value is not set, calaos tries to read the interval parameter -interval | float | no | Sampling time in seconds. The value is read at this frequency. If this value is not set, the default value is 15s - -## Conditions of ZibaseTemp -Name | Description ----- | ----------- -changed | Event on any change of temperature value - value | Event on a temperature value in degree Celsius -