# Watchdog

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/watchdog/

_Requires Symcon >= 5.1_

Checks whether variables defined in a list are overdue. If variables are overdue, an alarm is set and a list of them is displayed in the Visualization.

### scope
- Monitoring of listed variables.
- Set whether the variables are to be checked for changes or updates.
- Set how long the listed variables may be overdue.
- Switching on/off via Visualization button or script function.
- Display when the listed variables were last checked.
- Display of the original path or an individual name.

### software installation
- Install the Watchdog module via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/).

### Setting up the instances in IP-Symcon
- Under "Add Instance" the 'Watchdog' module can be found using the quick filter.
  - More information about adding instances in the [Instances documentation](https://www.symcon.de/en/service/documentation/basics/instances/).
- All variables to be switched must be added to the "Variables" list in the instance configuration.

#### ConfigurationPage:

| name      | description                                                          |
| --------- | -------------------------------------------------------------------- |
| Variables | Variables to watch are added to this list.                           |
| Time      | Duration of inactivity until the listed variables trigger the alarm. |
| Unit      | Unit of time.                                                        |

If variables have different allowed inactivity time, it is recommended to use multiple instances of the watchdog module.

### status variables
The status variables/categories are created automatically. Deleting individual ones can lead to malfunctions.

| name            | type    | description                                                                           |
| --------------- | ------- | ------------------------------------------------------------------------------------- |
| Active alarms   | String  | Contains the table for the display in the Visualization.                              |
| Alarm           | Boolean | The variable indicates whether an alarm is present. True = Alarm; False = OK;         |
| Last Check      | Integer | UnixTimestamp which indicates the time when the last check was done.                  |
| Watchdog active | Boolean | Indicates whether the watchdog is activated or not. True = Enabled; False = Disabled; |

### Visualization
The watchdog can be enabled/disabled via the Visualization.
Additionally the information is displayed at which time the watchdog was last checked.

## WD_GetAlertTargets

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/watchdog/wd-getalerttargets/

`array WD_GetAlertTargets(int $InstanzID)`

_Requires Symcon >= 5.1_

returns an array with the overdue variables

**Parameters**

- `$InstanzID` (int): ID of the Instanz

**Returns** (array): Array of active alarms of the watchdog instance with InstanceID __InstanceID__.

ID of the Instanz

**Example**

```text
WD_GetAlertTargets(12345);
```

## WD_SetActive

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/watchdog/wd-setactive/

`bool WD_SetActive(int $InstanzID, bool $SetActive)`

_Requires Symcon >= 5.1_

de-/activate the instance

**Parameters**

- `$InstanzID` (int): ID of the Instanz
- `$SetActive` (bool): Enables/disables the watchdog

**Returns** (bool): If the command could be executed successfully, it returns __TRUE__ as result, otherwise __FALSE__.

Enables/disables the watchdog

**Example**

```text
WD_SetActive(12345, true);
```