Skip to content

Latest commit

 

History

History
195 lines (137 loc) · 6.82 KB

README.md

File metadata and controls

195 lines (137 loc) · 6.82 KB

Node RED ical events

This Node RED module gets the events from an ical-URL or from a caldav-server.

Node-RED is a tool for wiring together hardware devices, APIs and online services in new and interesting ways.

❓ Get Help

For bug reports and feature requests, open issues. 🐛

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀
  • PayPal PayPal— You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵
  • Support me on using Brave Browser Brave— It's free for you. Brave is a browser that improves the security and the access time of websites by blocking ads, trackers and scripts. Give the new Brave Browser a try and Brave will contribute to me on your behalf. 😉
  • ko-fi Ko-fi— I'll buy a tea coffee. ☕ 😉
  • Bitcoin—You can send me bitcoins at this address (or scanning the code): 3KDjCmXsGFYawmycXRsVwfFbphog117N8P

Thanks! ❤️

☁️ Installation

First of all install Node-RED

$ sudo npm install -g node-red
# Then open  the user data directory  `~/.node-red`  and install the package
$ cd ~/.node-red
$ npm install node-red-contrib-ical-events

Or search for ical-events in the manage palette menu

Then run

node-red

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

git clone https://github.com/naimo84/node-red-contrib-ical-events.git
cd node-red-contrib-ical-events
npm install
gulp
cd ~/.node-red
npm install /path/to/node-red-contrib-ical-events

📝 Documentation

node explanation

events

The calendar is checked for new events on input or cronjob. For events in the future within the preview timespan, a separated cronjob is generated. It's fired on the start datetime of the ical event. So, on input or check-cronjob, no output is generated. Only when an event starts.

sensor

The calendar is checked for running events on input or configurable timeout.

Configuration

  • "Check every": how often the calendar is checked for new events

  • "Trigger": possible values:

    • Always (Filter expression is ignored)
    • Match (only events that match the Filter expression are processed)
    • No Match (only events that don't match the Filter expression are processed)

  • "Filter": events are filterd against this regular expression

  • "Name": Displayname

If an event is running at time of checking, msg.on is true, otherwise false.

The message additionaly contains the following values of the calendar entry

  • summary
  • id
  • location
  • eventStart
  • eventEnd
  • description

upcoming

As of the events node, its checked on input or cronjob. The msg.payload contains a list of upcoming events.

Configuration

  • "Check every": how often the calendar is checked for new events

  • "Trigger": possible values:

    • Always (Filter expression is ignored)
    • Match (only events that match the Filter expression are processed)
    • No Match (only events that don't match the Filter expression are processed)

  • "Filter": events are filterd against this regular expression

  • "Name": Displayname

  • "Preview": Only Events within now and this future value are checked.

  • "Past view": Only Events within now and this past value are checked.

INPUT

msg.url msg.language msg.replacedates msg.caldav msg.username msg.password msg.calendar msg.pastWeeks msg.futureWeeks msg.filter msg.trigger msg.preview msg.previewUnits msg.pastview msg.pastviewUnits msg.offset msg.offsetUnits

OUTPUT

Additional msg properties are:

  • msg.today - number of upcoming events today
  • msg.tomorrow - number of upcoming events tomorrow
  • msg.total - number of upcoming events totally
  • msg.htmlTable - a html formated table of upcoming events
  • msg.payload - arraylist of upcoming events
    • date
    • summary
    • event
    • eventStart
    • eventEnd
    • description
    • id
    • allDay
    • rule
    • location

General Configuration:

  • URL URL to Calendar
  • Replace Dates with name Dates are formated in a readable way, like today, tommorrow, in 3 weeks,...
  • Language if dates are replaced with names, the following languages are available at the moment Deutsch, English, русский, polski, Nederlands, français, Italiano, Espanol
  • Username HTTP Basic authentication user
  • Password HTTP Basic authentication user
  • Type Type can be ical or caldav

instead of cron-expression, an input node can be used.

example.png

📜 Credits

📜 The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Coded with ❤️ in ☁️