---
title: "Events for Event-Based Programs"
canonical: "https://farmconnect.docs.rubiconwater.com/space/FCD/2035351762/Events%20for%20Event-Based%20Programs"
format: markdown
---
> Macro (toc)

# What are Events?

Events include devices opening and closing, devices turning off and on, and device tags (such as **Water Level**) reaching specified values.

> ℹ️ **Note**
> ℹ️ 
> ℹ️ Events are created automatically when devices are commissioned. You cannot create your own events.

Events that you can use for event-based programs depend on the devices that are associated with your bays and channels. See [https://rubiconwater.atlassian.net/wiki/spaces/FCD/pages/2036957345](https://rubiconwater.atlassian.net/wiki/spaces/FCD/pages/2036957345) for a list of automatically generated events and actions for each device type.

# Configuring Events

When you add events to a step in the Advanced Program Interface you can configure the event properties directly.

![image](media://b3413ac6-9e76-4e66-bb1c-0c3a1d828fe4)

When you add an event to a program step in the **Simple Program Interface** you can view and modify the event configuration by clicking the **Edit Program Action Group** button in the program step.

![image](media://d71c8758-44e2-4adc-ab64-7b43afc3326e)

> ℹ️ **Note**
> ℹ️ 
> ℹ️ Action durations and event timeouts and errors may interact in unexpected ways. Take care to check the event settings to confirm that the sequence of actions is what you require.

These are the configuration options that you should consider:

| **Property** | **Description** |
| --- | --- |
| Event Timeout/Delay | This is the duration in minutes for which the controller will listen for your event. If the event does not occur within this period the controller will execute the **Event Timeout Action**. |
| Event Timeout Action | This specifies what the controller will do after an event times out without firing. The options are:<br>- *Do Action* - performs the current action and move to the next action.
- *Continue without action* - moves to the next action in this action group without performing the current action.
- *Abort program* - stops program execution and raises the **Program Abort **alarm.
- *Do action and abort group* - perform the current action but no further actions in this action group. Move to the next action group.
- *Abort group* - stop all remaining actions in this action group and move to the next action group. |
| Error Action | This is what the controller does if there is a device error that would prevent the action being performed (for example, a communications error). If an error** **is detected, the specified **Error Action** will be performed immediately. The options are:<br>- *Continue without action* - moves to the next action in this action group without performing the current action.
- *Abort program* - stops program execution and raises the **Program Abort **alarm.
- *Abort group* - stop all remaining actions in this action group and move to the next action group. |

> ℹ️ **Caution**
> ℹ️ 
> ℹ️ Use the event time out and error actions *Abort program* and *Abort grou*p with caution. If you have a program step that begins an irrigation, but you abort the step or the program before completing the irrigation, the control gate will remain open.

> ℹ️ **Examples:**
> ℹ️ 
> ℹ️ Suppose we have a program step that includes the following:
> ℹ️ 
> ℹ️ - An **Action** *Irrigate Bay* which runs for a default period of 60 minutes.
> ℹ️ - A** Finish Event** for the SmartFront meter *Detected water level exceeds* 350 mm (typically ground level).
> ℹ️ 
> ℹ️ The sequence of events will depend on the settings for both the action and the finish event. For example:
> ℹ️ 
> ℹ️ - If the finish event **Event Timeout** is set for *30 minutes* and the **Timeout Action** is *Do Action* then the control gate will close no later than 30 minutes after the start of the irrigation whatever the length of the irrigation is set to (it may be sooner if the finish event fires).
> ℹ️ - If the finish **Event Timeout** is set for *30 minutes* and the **Timeout Action** is *Abort Group* then if the finish event has not fired within 30 minutes the program will move on to the next program step WITHOUT CLOSING THE GATE.
> ℹ️ - If the finish **Event Timeout** is set for *120 minutes* but the event does not fire within 60 minutes then the gate will close at 60 minutes anyway as required by the **Irrigate Bay** action.

# Creating Alarm Actions for Program Events

You can be notified of event timeouts and event error timeouts during a program by creating [https://rubiconwater.atlassian.net/wiki/spaces/FCD/pages/2022113344](https://rubiconwater.atlassian.net/wiki/spaces/FCD/pages/2022113344) for the events. See [Creating Alarm Actions for Program Events](https://rubiconwater.atlassian.net/wiki/spaces/FCD/pages/2022113344/Alarm+Actions#Creating-Alarm-Actions-for-Program-Events) for details of how to do this.

---