Differences

This shows you the differences between two versions of the page.

--- supported_hardware:caldav [2021/01/28 17:35] – created James Sentman
+++ supported_hardware:caldav [2021/02/14 12:45] – James Sentman
@@ Line 1: / Line 1: @@
-=====CalDAV Event Plugin=====
+=====CalDAV/vCalendar Event Plugin=====
 The XTension caldav plugin lets you link Units in XTension to the existence of an event on your calendar during a certain relative time frame. For example a unit could turn on if an event containing the term “no school” was present on the calendar for tomorrow.
@@ Line 12: / Line 12: @@
 From the Interface List window create a new Interface and select Caldav Event Plugin from the Device or plugin popup.
-The URL field should be filled in with the link to the caldav principal base. For Apple Calendars see the next section.  The Username and Password fields can be left blank if none is required.
+**Resource Type:** Calendars are generally shared as either a straight vCalendar download link or through an actual CalDav server. The plugin supports both types but you have to tell it which your link is to. For an actual CalDav server select that, if your link is a vCalendar file from a regular web server select the vCalendar option.
+**URL:** The URL field should be filled in with the link to the caldav principal base. For Apple Calendars see the next section.  The Username and Password fields can be left blank if none is required. NOTE that if you’re using a vCalendar server you will need to encode any necessary user and password into the URL itself and not use the user/password fields. Like: "http://user@password:servername/link"
 Generally only a single plugin instance will be necessary for any given server or service. All the calendars that are available to your account will be available to a single instance of the plugin. It is not necessary to create separate instances for each Calendar if they are available to the same account.
-The Update popup selects how often you wish to update the data. This creates load on the server and should not be set any faster than necessary for your application. Generally every 15 minutes should be fine but for many applications running every hour would be more than sufficient.
+This is different also for a straight vCalendar link. In that case the first vCalendar defined in the file is used. If you need to parse longer vCalendar files that may define multiple calendars please let me know as that can be added in a future version.
+**Update:** The Update popup selects how often you wish to update the data. This creates load on the server and should not be set any faster than necessary for your application. Generally every 15 minutes should be fine but for many applications running every hour would be more than sufficient.
 Note that the update intervals are calculated from the start of the hour, for example even if you start the plugin at 3 minutes after the hour with an interval set to 5 minutes it will run an update at 5 minutes after, 10 minutes after etc. The same is done for the other intervals. If you select 15 minutes they will run at :00, :15, :30 and :45 after the hour. An initial load is done immediately upon starting up of the interface, but after that they are calculated to fall on the proper intervals.
@@ Line 48: / Line 52: @@
 To look for an event existing between 6:00am and 9:00am use “6h” as the start date and “9h” as the end date. The starting position is always the start of the day and not the time that the update is run.
+====vCalendar Differences:=====
+When connecting to a straight vCalendar file the Calendar Name field on the Edit Unit dialog is ignored. Otherwise they function the same.
 ====Scripting Commands:====
@@ Line 72: / Line 78: @@
 ====History:====
   * The CalDAV plugin was written by James Sentman in January of 2021 and was first included in XTension version 9.4.36.
+  * The ability to work with straight vCalendar files was added in XTension version 9.4.37