Invoke custom function

Use this action to trigger a PGM (Programmable) output on a DSC alarm panel, for example to activate a relay or an auxiliary output wired to your panel.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To trigger a PGM output from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Search for and select Envisalink: Invoke custom function.
6. Enter the Partition and the PGM output number to trigger.
7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as envisalink.invoke_custom_function:

action: envisalink.invoke_custom_function
data:
  partition: "1"
  pgm: 2

This triggers PGM output 2 on partition 1.

Options in YAML

Good to know

• This action only works with DSC panels.
• You must set the alarm panel’s code parameter in the integration configuration for this action to work.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: trigger an auxiliary output

Trigger a PGM output to activate an auxiliary output wired to your panel, for example a relay that opens a gate, when an input boolean is turned on.

• Trigger: State: Gate button turns on
• Action: Envisalink: Invoke custom function
  • Partition: 1
  • PGM: 2

alias: "Open the gate with a PGM output"
triggers:
  - trigger: state
    entity_id: input_boolean.gate_button
    to: "on"
actions:
  - action: envisalink.invoke_custom_function
    data:
      partition: "1"
      pgm: 2

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Alarm keypress: Sends custom keypresses to an Envisalink alarm panel.