Alarm Symbols

This list contains all configured alarm symbols.

General Information

Domain

TcHmiAlarm

Full symbol path

TcHmiAlarm.Config::alarmSymbols

Property is hidden

No

Contained in every configuration by default

No

Schema

Type

object

JSON Schema

{
    "additionalProperties": {
        "configDescription": "DESC_ALARM_SYMBOL",
        "optionMethod": {
            "symbol": "ListSymbolNames"
        },
        "properties": {
            "alarmSettings": {
                "additionalProperties": {
                    "additionalProperties": false,
                    "configDescription": "alarmSetting",
                    "properties": {
                        "alarmTextKey": {
                            "propertyOrder": 9,
                            "type": "string"
                        },
                        "condition": {
                            "allOf": [
                                {
                                    "$ref": "tchmi:server#/definitions/filter"
                                },
                                {
                                    "minItems": 1
                                },
                                {
                                    "configDescription": "DESC_CONDITION",
                                    "propertyOrder": 8
                                }
                            ]
                        },
                        "enabled": {
                            "default": true,
                            "propertyOrder": 1,
                            "type": "boolean"
                        },
                        "notificationType": {
                            "default": 1,
                            "enum": [
                                0,
                                1,
                                2
                            ],
                            "options": [
                                {
                                    "label": "enum_0_message",
                                    "value": 0
                                },
                                {
                                    "label": "enum_1_alarm_with_confirmation",
                                    "value": 1
                                },
                                {
                                    "label": "enum_2_alarm",
                                    "value": 2
                                }
                            ],
                            "propertyOrder": 2,
                            "type": "integer"
                        },
                        "severity": {
                            "$ref": "tchmi:server#/definitions/severity",
                            "propertyOrder": 3
                        }
                    },
                    "required": [
                        "severity",
                        "condition",
                        "notificationType",
                        "enabled"
                    ],
                    "type": "object"
                },
                "propertyOrder": 3,
                "type": "object"
            },
            "enabled": {
                "default": true,
                "propertyOrder": 0,
                "type": "boolean"
            },
            "interval": {
                "default": "PT1S",
                "format": "timespan",
                "formatMinimum": "PT0.01S",
                "propertyOrder": 2,
                "type": "string"
            },
            "onError": {
                "configDescription": "DESC_ON_ERROR",
                "default": false,
                "hidden": true,
                "propertyOrder": 1,
                "type": "boolean"
            }
        },
        "required": [
            "alarmSettings",
            "enabled",
            "onError",
            "interval"
        ],
        "title": "titleAlarmSymbol",
        "type": "object"
    },
    "configDescription": "DESC_ALARM_SYMBOLS",
    "propertyOrder": 2,
    "type": "object"
}