> For the complete documentation index, see [llms.txt](https://help.boomerang3.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.boomerang3.com/boomerang-3-user-manual/dashboard/alarms_and_warnings/alarm-filter.md).

# Alarm filter

Each alarm limit has a parameter called **Alarm Filter**.

Use Alarm Filter for real-world scenarios where you log a parameter frequently, but you only want an alarm after a few consecutive readings are outside the limits.

Alarm Filter is the number of consecutive out-of-limit readings required before the alarm becomes **armed**.

With `Alarm Filter = N`, the alarm triggers on the (`N + 1`)th consecutive out-of-limit reading.

At the start of each “out-of-limit” sequence, the system initializes an internal counter `C`.

The counter works like this:

* `C` is initially equal to the Alarm Filter value.
* `C` is decremented by 1 for each reading outside the limits.
* If `C = 0`, alarm detection is armed, and the **next** reading outside the limits triggers an alarm.
* After an alarm is generated, `C` is ignored. Further out-of-limit readings do not generate additional alarms.
* When a reading returns within the limits, `C` is reset to the Alarm Filter value, and alarm detection is re-enabled.
* When an alarm for the measuring point (MP) is signed, `C` is reset to the Alarm Filter value, and alarm detection is re-enabled.

### Examples

#### Example 1

<figure><img src="/files/NGmsc0BjChJLhmpzPzwl" alt=""><figcaption><p>Alarm Filter = 0 (alarm is always armed)</p></figcaption></figure>

`Alarm Filter = 0`, initial `C = 0`. The alarm is triggered by the first reading outside the limits.

#### Example 2

<figure><img src="/files/ZAhvswy6aVYZCeMt4Ku0" alt=""><figcaption><p>Alarm Filter = 2 (requires 3 consecutive out-of-limit readings)</p></figcaption></figure>

Alarm Filter = 2, initial `C = 2`. The alarm is triggered by the third consecutive reading outside the limits.

#### Example 3

<figure><img src="/files/zGuJhg8K7hCvA8P98nDk" alt=""><figcaption><p>Alarm Filter = 2 (sequence is broken before the alarm triggers)</p></figcaption></figure>

Alarm Filter = 2, initial `C = 2`. No alarm is triggered because the reading when `C = 0` is within the limits. This resets `C` back to 2.

{% hint style="info" %}
This method has the following consequences:

* If an active (not signed) alarm exists and the next reading returns within the limits, the next out-of-limit sequence can generate a new active alarm.
* If an active alarm exists and readings remain outside the limits, no new alarm is activated. If the alarm is signed while readings are still outside the limits, the alarm can be generated again once the alarm filter conditions are met.
  {% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.boomerang3.com/boomerang-3-user-manual/dashboard/alarms_and_warnings/alarm-filter.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
