---
title: "relayCUE-8"
canonical: "https://docs.cuesystem.com/space/CVCHELP/522682770/relayCUE-8"
format: markdown
---
> Macro (toc)

---

# Properties

- **UnitID** is a unique number that can be seen on the front panel of each relayCUE-8, defaults to 1.` `Note: The UnitID allows the system to set the basic communication parameters to the unit: Address and Bank. All the remaining communication is then done by using these parameters.
- **Address** can be set to a value in the range of 0-11. The default Address is 1.
- **Bank** - There can be 10 Banks assigned by Bank number. The Bank number is valued in the range of 0-9. In each Bank, there can be relayCUE-8 units - each of them with a different unit Address. Default Bank is 1.
- **Filter** is time in range 0.01-0.20 sec, defaults to 40 msec. It means a minimum time of closing/releasing the input contacts (pressing the button) for the press to be valid. If the input is closed/released for a shorter time than set in the Filter property, it has no effect.
- **Long Press** is time in the range of 0.0-0.9 sec, defaults to 400 msec. If the time of pressing the button is longer than this value, the press is interpreted as a long press.

***The following parameters can be set for each relay independently:**** *

- **RelayX function** selection for control relay by buttons connected to relayCUE-8 inputs, defaults to coded.
  - **0 - no action** button on appropriate input is disabled.
  - **1 - coded** each press causes the toggle of the relay state (switched on/off).
  - **2 - relay** when the button is pressed, the output is on, otherwise, it is off.
  - **3 - system on** when pressed, and the relay switches on; it can be switched off only by command through a serial line.
  - **4 - run** a short press and switches the relay on for the period of “Time” entered in its parameter. Long time press switches the relay on only while the button is being held. It is suitable for use in a couple with another channel with direction mode for controlling of AC motors. For function in “run” mode, the property “RelayX Paired Channel” must be set, which is to work in “direction” mode.
  - **5 -direction** it is useful for selecting the direction of controlled AC motors. After 200 ms, the couple relay with mode “run” is switched on too. For function in “direction” mode, the property “RelayX Paired Channel” must be set, which is to work in “run” mode. Mostly the relays working in this mode must be equipped with N.C. as well as N.O. Make sure to assign this function only to these relays - if so requested! (It means relays 2, 4, 6, and 8).
  - **6 - delayed off** the relay is switched on at once, but it is switched off after delay “Time”.
  - **7 - delayed on** the relay is switched off at once, but it is switched on after delay “Time”.
  - **8 - run DC** short press switch relay on for parameter “Time”. Long time press switches the relay on only while the button is being held. It is suitable for use in a couple with another channel with the same mode for controlling DC motors (the paired relay will be switched off). For function in “run DC” mode, the property “RelayX Paired Channel” must be set, which is to work in couple also in “runDC” mode. Mostly the relays working in this mode must be equipped with N.C. as well as N.O.! Pay attention to assign this function only to these relays - if so requested! (It means relays 2, 4, 6, and 8).
  - **9 - pulse** of the relay is switched on for a short time impulse entered in the parameter “Time”.
- **RelayX Time** can be set to range time: 00:00:00.01 – 23:59:59.99, defaults to 0.4 sec.
- **RelayX Paired relay **is relevant only for functions where two relays are to work in a pair – i.e. “run”, “direction” or “runDC”. The number is in the range 0-8 where 0 means NO paired relay channel and numbers 1-8 means the number of the paired relay. Please pay attention to setting this parameter correctly where necessary. Check if paired relay properties are correctly set in each pair. Inappropriate settings can lead to unexpected operations. A default value is none.

# Close

This function switches the relay ON. 

#### Syntax 

```visualbasic
Function Close()
```

# ClosePulse

This function switches the relay ON and after **pulsetime** switches it OFF. 

#### Syntax 

```visualbasic
Function ClosePulse(pulsetime As Time)
```

#### Parameters 

pulsetime 

[<u>Time</u>](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Time) It is a time of the pulse. 

# IsClosed

The function returns if a channel is closed or opened. 

#### Syntax 

```visualbasic
Function IsClosed() As Boolean
```

#### Return value 

[<u>Boolean</u>](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True if the channel is closed, False otherwise. 

# IsInputClosed

The function returns if an input channel is closed or opened. 

#### Syntax 

```visualbasic
Function IsInputClosed() As Boolean
```

#### Return value 

[<u>Boolean</u>](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) It is True if the input channel is closed, False otherwise. 

# Open

This function switches the relay OFF. 

#### Syntax 

```visualbasic
Function Open()
```