AI Rule Settings
Use AI rules to automatically play audio, send webhooks, or trigger relay actions based on event type and conditions. This document guides the complete procedure for creating and operating rules.
Set AI rules in the following situations.
-
Send a webhook to an external server when a specific AI event occurs.
-
Play audio on the device when a specific AI event occurs.
-
Trigger a relay connected to an access door when a specific AI event occurs
-
Automate different follow-up actions by event type.
Before you start
Before starting rule setup, check the following.
-
AI events must already exist. Refer to the following documents to create AI events.
-
Prepare the audio clips to play before using audio.
-
Prepare the webhook receiver URL beforehand.
-
When using relays, verify that the relay port on the device or subdevice is connected.
-
Set at least one action: audio, webhook, or relay.
In AI events, Door Access cannot be used as a condition for AI rules.
Create AI rule
Start creating a rule
-
Click the AI&Rule menu in the upper-left corner of the screen.
-
Click Rule Settings on the left sidebar.
-
Click + Add at the top right of the screen.
-
When the New Rule screen appears, enter the rule name and set conditions and actions.
Enter rule name
Enter the rule name in the Name input field. Rule name is required. Up to 64 characters.
Set conditions
Conditions determine whether a rule executes when an AI event occurs. In the Condition section, set conditions as instructed below. The Type and Event options appear based on the settings specified when creating the AI event.
-
Channel: The channel is fixed to CH 1. Only Fisheye view is supported.
-
Type: Select the AI event type. Select one of the following.
- People Tracking
- Intrusion
- Line Crossing
- People Counting
-
Event: Select the AI event that will trigger the rule. The event list shows AI events that match the selected type. Events appear in the format
(ID:N) event_name. -
Entry Area / Intrusion Area / Line / Counting Area: Add conditions for an area based on the selected event type.
-
Event Type: Select the event type that determines whether the rule executes. The rule executes based on the selected event type.
You must select at least one event type.
User selection
In the User section, select the user who determines whether the rule runs. The system runs the rule when it detects the selected user in an AI event.
-
Click Select users to trigger actions to select specific users. When the user list appears, select the desired users and click the Save button.
-
Click Select All to select all registered users.
Audio action settings
Audio action plays audio from the camera when an AI event occurs. In the Action section, click the Audio toggle to enable the action, and then click . The audio settings pop-up appears.
-
Audio Clip: Select the audio clip to play. Select an audio clip from the list of clips uploaded to the system.
-
Repeat: Set the number of times to repeat audio playback. Plays the audio clip repeatedly the number of times you set. It can be set to a maximum of 10 times.
-
Schedule: Select the schedule when the rule runs and plays audio.
Click Apply to save the audio action settings.
-
Prepare audio clips before configuring audio actions. Upload audio clips in System → Audio. For more information, refer to Upload Audio Clips.
-
Create, edit, or delete schedules in AI&Rule → Schedule. For more information on schedule management, see Manage Schedules.
Webhook action settings
Webhook action sends a webhook to an external server when an AI event occurs. In the Action section, click the Webhook toggle to enable the action, and then click . The webhook settings pop-up appears.
-
Method: The webhook transmission method. Only the
POSTmethod is supported. -
URL: Enter the URL to receive the webhook. The address must be valid and start with
http://orhttps://. -
Header: Set the HTTP headers to include in the webhook. Click + Add to add headers. Enter each header as a key-value pair.
-
Body: Set the HTTP body to include in the webhook. Click + Add to add body items. Enter each body item as a key-value pair.
-
Schedule: Select the schedule when the rule runs and sends webhooks.
Click the Apply button to save the webhook action setting.
-
Webhook send logs and response codes can be checked in the system logs for troubleshooting.
-
Create, edit, or delete schedules in AI&Rule → Schedule. For more information on schedule management, see Manage Schedules.
Relay action settings
The relay action feature triggers the relay on the device or subdevice when an AI event occurs. For example, trigger the door relay to restrict access when an event involves a blacklisted user.
In the Action section, click the Relay toggle to enable the action. Then click the button. The relay settings pop-up appears.
-
Port: Select the relay port to activate. Select the relay port on the device or on a subdevice connected to the device. Ports already used by other rules or doors show "In use" in the list, and the system prevents selection.
-
Open Time: Set how long the relay remains open. Move the slider or enter a value in the input field. Set it to 1–120 seconds.
-
Keep until event off: Set Type to People Counting, and specify the area set in Count Limit as the condition to use the Keep until event off option. Selecting this option keeps the relay open until the count limit event clears, regardless of open time.
-
-
Contact Type: Select the relay contact type. Select a relay port to set options. The default is Normal Close.
-
Normal Open: Normally open, and closes when the relay activates.
-
Normal Close: Normally closed, and opens when the relay activates.
-
-
Schedule: Select the schedule when the rule runs and triggers the relay.
Click Apply to save the relay operation settings.
Contact Type is a setting applied to the relay port, not a rule. Changing Contact Type applies immediately to all rules and doors that use the port. When the port is fixed to Lock or Unlock, changing Contact Type inverts the output and may open a locked door.
-
Firmware version 1.1.0 or later supports this feature.
-
Create, edit, or delete schedules in AI&Rule → Schedule. For more information on schedule management, see Manage Schedules.
Save rule
After completing rule setup, click Save at the top right to save the rule. Saved rules appear in the rule list. The rule list shows the rule name, type, event, and schedule.
Enable/Disable AI rules
In the rule list, click the leftmost toggle for a rule to enable or disable it. Enabled rules execute the configured actions when an AI event occurs. Disabled rules do not execute actions when AI events occur.
The rule list shows enabled status at a glance. Rules with a blue toggle are enabled; rules with a gray toggle are disabled.
Edit AI rule
Click a rule in the rule list to view or edit its details. On the rule details screen, after modifying conditions and actions, click Update to save changes.
Delete AI rule
In the rule list, click on the right of a rule to delete it. Deleted rules cannot be recovered.
