| Line 1: |
Line 1: |
| − | <pre class="header-style"> | + | <pre class="header-style">The Calendar Event trigger fires when a specified calendar event starts or ends. This allows you to automate actions based on your calendar schedule, such as enabling silent mode during meetings or sending reminders before appointments.</pre> |
| − | This trigger will fire when a specific calendar event starts/ends.
| |
| | | | |
| − | Note that this trigger normally only fires on 5 minute boundaries, so if you have an event that starts between the boundaries, it may fire a few minutes later.
| + | ''' Options ''' |
| − | </pre>
| |
| | | | |
| − | '''Magic Text'''<br/> | + | * '''Event Starts''' - Trigger fires when the calendar event begins |
| − | When this trigger is used, you can access magic text via the [...] button where available.<br/>[https://macrodroidforum.com/wiki/index.php/Magic_text#Bluethooth_.28Device_connected_or_device_disconnected.29 Magic text]
| + | * '''Event Ends''' - Trigger fires when the calendar event ends |
| | | | |
| − | '''Configuration Options''' | + | ''' Configuration ''' |
| | | | |
| − | * '''Event starts / Event ends'''
| + | The trigger offers extensive configuration options: |
| − | Defines whether the event will start at the beginning of the event or at the end of the event.
| |
| | | | |
| − | * '''Calendar'''
| + | '''Calendar Selection''' |
| − | Choose the specific calendar that you want to monitor for events. | + | * Choose which calendar to monitor from your synced calendars |
| | | | |
| − | * '''Availability''' | + | '''Availability Filter''' |
| − | You can choose to trigger only if the free/busy state is set or trigger on any state (default).
| + | * '''Any''' - Trigger for all events regardless of availability status |
| | + | * '''Busy''' - Only trigger for events marked as busy |
| | | | |
| − | * '''Title (Optional)'''
| + | '''Title Match (Optional)''' |
| − | The event must match this title.
| + | * Enter text to match against the event title |
| | + | * Supports regex patterns when enabled |
| | + | * Case-insensitive matching option available |
| | | | |
| − | * '''Event detail (Optional)'''
| + | '''Detail/Description Match (Optional)''' |
| − | The event must match the detail text.
| + | * Enter text to match against the event description |
| | + | * Supports regex patterns when enabled |
| | | | |
| − | * '''Enable regular expression matching''' | + | '''Text Matching Options''' |
| − | Regular expression matching (or regex matching) is a technique for finding patterns within text using a specialized syntax known as regular expressions. It's a powerful tool for text processing and pattern recognition.
| + | * '''Enable Regex''' - Use regular expressions for pattern matching |
| | + | * '''Ignore Case''' - Perform case-insensitive matching (disabled when regex is enabled) |
| | | | |
| − | * '''Case insensitive''' | + | '''Event Filtering''' |
| − | If enabled the text comparison will ignore any differences in upper and lower case text in the title and detail text.
| + | * '''Ignore All Day Events''' - Exclude all-day events from triggering |
| | | | |
| − | * '''Ignore all day events''' | + | '''Timing Options''' |
| − | When enabled, any events defined as full day will be ignored by the trigger.
| + | * '''Check in Advance''' - Fire the trigger before the event starts |
| | + | ** Set days, hours, and minutes in advance |
| | + | ** Use negative values to fire after the event (e.g., 2 hours after end) |
| | + | * '''Use Alarm''' - Ensures more accurate triggering timing for important events |
| | | | |
| − | * '''Check in advance'''
| + | ''' Magic Text ''' |
| − | Instead of triggering at the exact moment the calendar event triggers, it will check for events int he future (for example 2 hours in advance). This way, you can receive alerts in advance about a specific calendar event.
| |
| | | | |
| − | * '''Use negative value'''
| + | When this trigger fires, the following information is available via magic text: |
| − | When using this option the trigger will fire at the specified time after the calendar event occurred (e.g. 2 hours after the calendar event). | + | * Event title - {calendar_title} |
| | + | * Event description/detail - {calendar_detail} |
| | + | * Event location - {calendar_location} |
| | + | * Event start date and time - {calendar_start_date}, {calendar_start_time} |
| | + | * Event end date and time - {calendar_end_date}, {calendar_end_time} |
| | | | |
| − | * '''Use alarm'''
| + | ''' Examples ''' |
| − | Use this option if the trigger time is not accurate (and you need it) e.g. for high importance events it is recommended to enable this option else the calendar checking will likely be very sporadic. | + | |
| | + | ''Example 1: Silent Mode During Meetings'' |
| | + | <pre class="trigger-style">Triggers |
| | + | |
| | + | Calendar Event - Event Starts (Busy)</pre> |
| | + | <pre class="action-style">Actions |
| | + | |
| | + | Volume Change: Ring to 0 (Silent) |
| | + | Volume Change: Notification to 0</pre> |
| | + | |
| | + | ''Example 2: Reminder 30 Minutes Before Appointment'' |
| | + | <pre class="trigger-style">Triggers |
| | + | |
| | + | Calendar Event - Event Starts [+30m] (Title: Doctor)</pre> |
| | + | <pre class="action-style">Actions |
| | + | |
| | + | Notification: Doctor appointment in 30 minutes!</pre> |
| | + | |
| | + | ''' Notes ''' |
| | + | |
| | + | * This trigger normally only fires on 5-minute boundaries (configurable in settings), so events that start between boundaries may fire a few minutes late |
| | + | * The update rate can be adjusted in MacroDroid settings |
| | + | * Use the "Use Alarm" option for more accurate timing on important events |
| | + | * When importing macros, the trigger will attempt to match the calendar by name on the new device |
| | + | * Regex matching automatically disables the "Ignore Case" option (use regex flags instead) |
| | + | |
| | + | ''' Permissions Required ''' |
| | + | |
| | + | * '''Calendar Permission''' - READ_CALENDAR permission required to access calendar events |
| | + | * '''Schedule Exact Alarm''' - Required for precise timing |
| | + | |
| | + | ''' See Also ''' |
| | + | |
| | + | * [[Action:_Calendar_-_Add_Event|Add Calendar Event Action]] |
| | + | * [[Constraint:_Calendar_Entry|Calendar Event Constraint]] |