MMM-CalDAV

MMRIZE

UPDATE 2.0.0

Newly rebuilt from scratch
OAUTH supported (For Google Calendar)
Multi servers/calendars in one module.
more secure and efficiently

Now, you can use Google Calendar in the default calendar module(and more).
https://github.com/MMRIZE/MMM-CalDAV

MMRIZE

@matt216
More details about your environment are needed to know what happens.

Let’s start with the concept.

Some CALDAV Providers don’t serve any public iCAL(.ics) URL to be consumed externally. You don’t need this module if your CALDAV service can host iCAL URLs. I have no idea about baikal, but I think you know whether that service would provide iCAL or not.

MMM-CALDAV can access the CALDAV server(which would not host any public iCAL URL) to get target calendar events. Then, this module converts the event data to a real iCAL file(.ics). And this module also hosts that file as a URL accessible from the default calendar module or some iCAL consuming modules with security. MMM-CALDAV will work like a private iCAL provider service.

So, to show your event on MM, you may need both MMM-CALDAV and calendar module together.

.env file is needed to connect/authenticate CALDAV server and some security features. Calendar events are very private so I want to block the security hole on working this module. You should put .env in MMM-CALDAV directory.

So, where are you stuck now? Tell me what happens.

matt216

@MMRIZE Thank you for your help, but I managed to figure out getting baikal to generate the ics file, so I don’t need this module anymore.

Thanks anyway

MMRIZE

Update 2.1.0

Birthday calendar enabled. (CardDAV implementation)
Some code refactoring.
calendars: [], is changed to targets: []. you have to reconfigure your config.js

Now you can get Birthdays calendar from iCloud or Google Contacts. (Of course, other CardDAV supported contacts services.)

Tiller

@MMRIZE

Hello I’m trying to sync my synology calendar to the MagicMirror calendar with the MMM_CalDAV module. Sadly it’s not working and I don’t know why. I tried different settings and everything I could find online.

My config.js (without the standard stuff) looks like this:

{
  module: "MMM-CalDAV", 
  config: {
    timeRangeStart: -30,
    servers: [
      { 
        envPrefix: "SYOLOGY_", 
        serverUrl: "http://192.168.xxx/caldav/",
        targets: ["family" ], 
  },
},
},


{
  module: "calendar",
  position: "top_left",
  config: {
    servers: [
      {
        symbol: "calendar-check",
        url: "http://localhost:8080/CALDAV/SYNOLOGY_family.ics",
        auth: { 
          user: 'username1',
          pass: 'password1', 
          method: 'basic'
        }
      },

The .env looks like this:

CALDAV_SERVICE_USERNAME=
CALDAV_SERVICE_USERNAME=

### For SYNOLOGY
SYNOLOGY_username=username1
SYNOLOGY_password=password1

Do you have any idea what I could try to do, to sync it?

Thank you

Tillmann

sdetweil

@Tiller can you show any of the output from
npm start

if using pm2 to autolaunch, then

pm2 logs --lines=xxxx

xxxx is the number of the most recent lines in the logs, default 15

note that the log data will have full urls for calendar , so this could expose info

MMRIZE

@Tiller said in MMM-CalDAV:

CALDAV_SERVICE_USERNAME=
CALDAV_SERVICE_USERNAME=

For SYNOLOGY

SYNOLOGY_username=username1
SYNOLOGY_password=password1

I think you may have confusing the username and password for the server and the module.

SYNOLOGY_username=username1
SYNOLOGY_password=password1

This is for your Synology Caldav Server, usually it is your account id/password to login Synology Server (Or Synology calendar account)

CALDAV_SERVICE_USERNAME=username2
CALDAV_SERVICE_PASSWORD=password2

This is a different thing. It is used for your MM calendar module. This module provide a secure calendar ics host by itself with this auth information. You should need to set your calendar config like this;

// default calendar module.
{
  module: "calendar",
  position: "top_left",
  config: {
    calendars: [
      {
        symbol: "calendar-check",
        url: "http://localhost:8080/CALDAV/SYNOLOGY_Family.ics",
        auth: { // REQUIRED
          user: 'username2', // <= used here (CALDAV_SERVICE_USERNAME)
          pass: 'password2', // <= used here (CALDAV_SERVICE_PASSWORD)
          method: 'basic'
        }
      },
...

Tiller

Thank you for your quick reply.

@sdetweil I’m not using pm2 at the moment, but I could try to do it and check the logs.

@MMRIZE sorry, my bad. I changed the password for the post, it’s correct in my .env but not working.

I’m not exactly sure about the Synology url
synology.com says I should use
http://192.168.x.x:5000/caldav
and than log in with my username and password

But an older link is (seems there was an update)
http://192.168.x.x:5000/caldav/username/ejialfjl/

If I’m using the last one in the browser, it is downloading an .ics file.

But it’s not working with both urls.

Maybe I should try to reinstall everything?

sdetweil

@Tiller if you are not using pm2 then the errors would be shown where you do npm start

sdetweil

@Tiller no reinstall

can you show us the new url(#2) in config.js,
assume you are still using the env variables

MMRIZE

@Tiller
CalDAV is different to general ics hosting.

Usually, the URL of Synology CalDAV accessing would be;

https://IP_OR_URL:5001/caldav/
http://IP_OR_URL:5000/caldav/

Anyway, there would be some log to diagnosis. Can you show the frontend and backend logs?

caw

@MMRIZE

Hi,

i´ve got the same problem. I´m completly new to magicmirror but the integration of my Synology CalDAV should be the main part of it.

i´ve tried several combinations and addresses but no one worked for me.

maybe its possible to get a “step - by - step” Tutorial.

hopefully you can help :)

MMRIZE

@caw

https://github.com/MMRIZE/MMM-CalDAV/wiki

Install

cd <Your MagicMirror directory>/modules
git clone https://github.com/MMRIZE/MMM-CalDAV
cd MMM-CalDAV
npm install

There would be .env (It would be hidden, so you should check it with ls -al or equivalent for your environment/OS)

If not there, copy it from env.example

cp env.example .env

Open your Synology Calendar. You can open it from your Synology Package Center Or installed app lists. Usually it will have http(s)://<IP_OR_URL>:<PORT(5000 or 5001)>/?launchApp=SYNO.Cal.Application as URL so you can open it on the browser.

You will see something like this.

Get the CadDAV account. Copy or memo the URL. Usually URL will have http(s)://<IP_OR_URL>:<PORT_5000_OR_5001>/caldav/ format.

Back to the terminal. Open the .env file with your favourite editor. Then, fulfil these lines.
Then configure the MMM-CalDAV module and the calendar module like this.

Carefully See the configuration of the calendar module.

Then run the MagicMirror.
At the very first execution, some time would be needed for CalDAV calendars to be reflected on the screen. So, just stop the MagicMirror.

If CalDAV calendars would be success to be derived, the log will say something like this.

[2024-09-03 22:52:01.461] [LOG]   [CALDAV] File: SYNOLOGY_test.ics is refreshed.

And there be files to be hosted in the service directory like these;

I have two calendars, My Calendar and test, so there would be 2 hidden ics files generated, service/.SYNOLOGY_My_20Calendar.ics and service/.SYNOLOGY_test.ics.

But the real URL consumed by the calendar module would be http://localhost:8080/CALDAV/SYNOLOGY_test.ics, don’t be confused.

Rerun the MM again. Now on the screen, your hosting calendar will be served.

caw

@MMRIZE said in MMM-CalDAV:

Hi thank you very much for the really fast supply.

the strange thing is that i configured it like you said. but if im running it the magicmirror it is showing me that the “Site is not reachable” (The Synology default page)

if im running MM just without the CALDAV Module it´s working.

I´m running the MM in Docker on the Synology.

MMRIZE

@caw could you show me the capture of error message to know what happened?

caw

@MMRIZE if i´m adding the

 {
		module :"MMM-CalDAV",
		config: {
			servers: [
				{
					envPrefix: "SYNOLOGY_",
					serverUrl: "https://myownsynologyadress.de/caldav/",
			],
		},
	},

following error occurs

MMRIZE

@caw said in MMM-CalDAV:

following error occurs

???
I cannot understand the context. What did you do? The image seems like that something on the browser.

Does your MagicMirror is executed on the Synology NAS with Docker?

MMRIZE

@caw said in MMM-CalDAV:

{
module :“MMM-CalDAV”,
config: {
servers: [
{
envPrefix: “SYNOLOGY_”,
serverUrl: “https://myownsynologyadress.de/caldav/”,
],
},
},

And you’ve missed a closing brace in your code.

 {
		module :"MMM-CalDAV",
		config: {
			servers: [
				{
					envPrefix: "SYNOLOGY_",
					serverUrl: "https://myownsynologyadress.de/caldav/",
                                 }, // <-- HERE
			],
		},
	},

caw

@MMRIZE yes the image is a screen from the browser. MM is running till i add the Caldav-Module. So i assume I missconfigured something. The missing bracket did not solve the problem in the log:

2024/09/04 15:33:13 stderr if (key?.startsWith(prefix)) {
2024/09/04 15:33:13 stderr [04.09.2024 15:33.13.728] [ERROR] /opt/magic_mirror/modules/MMM-CalDAV/node_helper.js:14
2024/09/04 15:33:13 stderr [04.09.2024 15:33.13.727] [ERROR] Whoops! There was an uncaught exception…
2024/09/04 15:33:13 stdout [04.09.2024 15:33.13.726] [LOG] No helper found for module: MMM-Carousel.
2024/09/04 15:33:13 stdout [04.09.2024 15:33.13.726] [LOG] No helper found for module: clock.
2024/09/04 15:33:13 stdout [04.09.2024 15:33.13.725] [LOG] Module helper loaded: updatenotification
2024/09/04 15:33:13 stderr at /opt/magic_mirror/js/app.js:166:6
2024/09/04 15:33:13 stderr at loadNextModule (/opt/magic_mirror/js/app.js:164:5)
2024/09/04 15:33:13 stdout [04.09.2024 15:33.13.725] [LOG] Initializing new module helper …
2024/09/04 15:33:13 stderr at loadModule (/opt/magic_mirror/js/app.js:126:19)
2024/09/04 15:33:13 stderr at require (internal/modules/cjs/helpers.js:74:18)
2024/09/04 15:33:13 stderr at Module.require (internal/modules/cjs/loader.js:887:19)
2024/09/04 15:33:13 stdout [04.09.2024 15:33.13.725] [LOG] No helper found for module: alert.
2024/09/04 15:33:13 stderr at Function.Module._load (internal/modules/cjs/loader.js:708:14)
2024/09/04 15:33:13 stderr at Module.load (internal/modules/cjs/loader.js:863:32)
2024/09/04 15:33:13 stdout [04.09.2024 15:33.13.724] [LOG] Loading module helpers …
2024/09/04 15:33:13 stderr at Object.Module._extensions…js (internal/modules/cjs/loader.js:1027:10)
2024/09/04 15:33:13 stderr at Module._compile (internal/modules/cjs/loader.js:963:27)
2024/09/04 15:33:13 stderr at wrapSafe (internal/modules/cjs/loader.js:915:16)
2024/09/04 15:33:13 stderr SyntaxError: Unexpected token ‘.’

sdetweil

@caw because you are running in server mode, the version of nodejs matters.

your version is way down level

the ?. syntax shown on line 14 is from the latest js version