Homebridge-calendar-scheduler NPM

📅 Homebridge Calendar Scheduler

Creating and maintaining Homebridge plugins consume a lot of time and effort, if you would like to share your appreciation, feel free to "Star" or donate.

Click here to review more of my plugins.

Info

Calendar Scheduler plugin for Homebridge, which allows flexible scheduling of triggers with event progress report using any iCal calendar.

Installation

After Homebridge has been installed:

sudo npm install -g --unsafe-perm homebridge-calendar-scheduler@latest

Example Config

{
  "platforms": [
    {
      "platform": "CalendarScheduler",
      "debug": false,
      "calendars": [
        {
          "calendarName": "calendar-1",
          "calendarUrl": "https://calendar.google.com/calendar/ical/{...}.ics",
          "calendarUpdateInterval": 3,
          "calendarTriggerOnUpdates": true,
          "calendarUpdateButton": false,
          "calendarEvents": [
            {
              "eventName": "event-name1"
            },
            {
              "eventName": "event-name-with-retrigger",
              "eventTriggerOnUpdate": true
            }
          ]
        },
        {
          "calendarName": "calendar-2",
          "calendarUrl": "https://calendar.google.com/calendar/ical/{...}.ics",
          "calendarUpdateInterval": 30,
          "calendarTriggerOnUpdates": false,
          "calendarTriggerOnAllEvents": true,
          "calendarEvents": [
            {
              "eventName": "event-name-without-retrigger",
              "eventTriggerOnUpdate": false
            },
            {
              "eventName": "^event-(.*)",
              "eventTriggerOnUpdate": false,
              "calendarEventNotifications": [
                {
                  "notificationName": "event-notification-name-before-start-15m",
                  "notificationStartOffset": -15
                },
                {
                  "notificationName": "event-notification-name-after-start-15m",
                  "notificationStartOffset": 15
                },
                {
                  "notificationName": "event-notification-name-before-end-15m",
                  "notificationEndOffset": -15
                },
                {
                  "notificationName": "event-notification-name-after-end-15m",
                  "notificationEndOffset": 15
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Config Field	Description	Default	Required
platform	Must always be `CalendarScheduler`.	`"CalendarScheduler"`	Yes
caseInsensitiveEventsMatching	Enable for case insensitive events matching globally.	`false`	No
unsafeEventNames	Enable unsafe events names globally. (Be careful as this may cause unexpected behavior.)	`false`	No
debug	Enable for displaying debug messages.	`false`	No
calendars	Array of watched calendars.	`[]`	No

Calendar Config Field	Description	Default	Required
calendarName	A unique name for the calendar. Will be used as the accessory name and default sensor for any calendar events.	`"calendar-name1"`	Yes
calendarUrl	The address of the calendar. Can be a `webcal://`, a `http://` or an `https://` URL.	`""`	Yes
calendarUpdateInterval	The polling interval the plugin uses to retrieve calendar updates in minutes. If not set, the plugin will update the calendar ones in 60 minutes.	`60`	No
calendarUpdateButton	If set to true, then button for manual update available for this calendar accessory.	`true`	No
calendarTriggerOnUpdates	If set to true, then every minute calendar sensor trigger update if any defined event is active.	`true`	No
calendarTriggerOnAllEvents	If set to true, then calendar sensor trigger update if any event is active.	`false`	No
caseInsensitiveEventsMatching	Enable for case insensitive events matching for this calendar.	`false`	No
unsafeEventNames	Enable unsafe events names for this calendar. (Be careful as this may cause unexpected behavior.)	`false`	No
calendarEvents	Array of watched calendar events.	`[]`	No

Calendar Event Config Field	Description	Default	Required
eventName	A unique name for the calendar event. Will be used as calendar sensor for matched calendar event. Note that this can either be an event name or more generally a regular expression.	`"event-name1"`	Yes
eventTriggerOnUpdates	If set to true, then every minute sensor trigger update for active event.	`true`	No
caseInsensitiveEventsMatching	Enable for case insensitive events matching for this event.	`false`	No
unsafeEventNames	Enable unsafe events names for this event. (Be careful as this may cause unexpected behavior.)	`false`	No
calendarEventNotifications	Array of calendar event notifications.	`[]`	No

Calendar Event Notification Config Field	Description	Default	Required
notificationName	A unique name for the calendar event notification. `notificationStartOffset` or `notificationEndOffset` field is required to make it work.	`"notification-name1"`	Yes
notificationStartOffset	Amount of time in minutes before the event start to trigger the notification. If positive, then notification will be triggered after the event start. If negative, then notification will be triggered before the event start.	`undefined`	No
notificationEndOffset	Amount of time in minutes after the event end to trigger the notification. If positive then notification will be triggered after the event end. If negative, then notification will be triggered before the event end.	`undefined`	No