Action Types
In the Actions list of the add screen, click Add action to see the types not yet added. Choose a type, fill in its fields, and click Done to add it to the list. Done is unavailable while a required field is empty.
| Action | What you enter | What happens |
|---|---|---|
| Phone notification | Nothing | Sends a notification with a photo to the Litmus app. |
| Play media | Choose a file under Media file, or enter a Media URL (an http or https address) instead of a file. | Plays the sound or video on the speaker and screen connected to the device PC. A burglar alarm siren is selected at first, so you can use it right away. Default sound files such as sirens and a doorbell are included. |
| Read text aloud | Text to read (up to 200 characters) and Voice. | Reads the text aloud on the device PC speaker. Voices: Korean, English, Chinese, German, French, Spanish, Portuguese, Hindi, Arabic, and Russian. |
| Telegram | Chat ID and Bot token. | Sends a message with a photo and the camera name through your Telegram bot. |
| Webhook | Request URL, Method (POST or GET), and for POST, the Body. | Sends a request to the address. A body starting with { or [ is sent as JSON. |
| Home Assistant | Sensor name (up to 60 characters) and Connection (server address, port, HTTPS, long-lived access token). | Creates a sensor in Home Assistant and turns it on for 5 seconds on each detection. |
| Zigbee | Choose a Zigbee device, then check the properties to change and enter their values. Click Add values to add more values to send after a set time. | Sets the chosen properties of the device to those values. Any values added after them are sent in order once each set time has passed. If no values are added after them, the properties are not changed back. |
- Each type can be added once, and all actions in the list run at the same time.
- With no actions at all, Create is unavailable.
- Click an action in the list to change it, or click its trash icon to remove it.
Telegram bot token and Home Assistant connection
Done becomes available only after you enter the bot token in its secure field and press Enter or click the save icon to save it to the device. A place has one Telegram bot, shared by all items. Each place also has one text-to-speech voice, so changing it affects the other items too.
On a device running as a Home Assistant add-on, check Installed as a Home Assistant add-on (connects without address or token) and you do not need to enter the server address or token. After you enter a sensor name, the name of the sensor that Home Assistant will create appears below it.
Home Assistant sensor attributes
The Home Assistant sensor also includes details of what was detected as attributes. The values reflect the moment the action ran and remain on the sensor after it turns off, until the next detection. Attributes require device software 2.1.0 or later.
| Attribute | Content | Actions that include it |
|---|---|---|
| camera | Camera name (This PC's microphone for sound detection on the device PC's microphone) | All |
| label | What was detected (person, car, truck, bus, motorcycle). Set to car for license plate actions. For sound detection, the chosen sounds (any of fire_alarm, glass, scream, bark, baby_cry, gunshot, speech, meow, joined with commas) | All |
| sub_label | Name of a registered face, or the nickname of a registered vehicle (its plate number if it has no nickname). Empty if not registered | Face and license plate actions |
| recognized_license_plate | The plate number that was read | License plate actions |
| score | Confidence (0 to 1) | Person, face, and license plate actions |
| zone | Detection zone name (empty outside zones) | Cameras with detection zones |
| description | The description you entered | Describing what to detect |
The attribute names match the detection data Frigate sends to Home Assistant. In a Home Assistant automation, trigger on the sensor turning on and compare attribute values in a condition. For example, to open the gate for registered vehicles only, add a condition that sub_label is not empty; to open it for one vehicle only, add a condition that recognized_license_plate equals its plate number.
Sending Zigbee values with a delay
The first values are sent Right away. Each click on Add values adds another set of values, with a time (seconds or minutes) above it. Each delay is measured from when the set above it was sent. A new set is prefilled with the on/off properties of the set above it, set to the opposite value.
For example, to sound a siren for one minute, set Alarm to True in the first set, click Add values, then set the time to 1 min and Alarm to False. Click Delete to remove a set you do not need.
If something is detected again while the values are being sent, the whole sequence runs once more after the last values are sent.