Skip to content

intelligencecompany/nuki-ical

Repository files navigation

#Nuki-iCal

Synopsis

This package can be used with the NUKI Smartlock Web Api - https://api.nuki.io and internet calendars like AirBnB. Get notified by email when an user is granted or revoked acces.

npm install nuki-ical

Code Example

const nuki = require('nuki-ical');

let settings = new nuki.models.settings({
    defaultEmail: '[email protected]',
    smartlockId: 000000000,
    interval: nuki.models.interval.MINUTE,
    smtp: {
        service: 'Gmail',
        auth: {
            user: '[email protected]',
            pass: 'xxxxxxxxxxxxxxxxxxxxx'
        }
    },
    nukiApiKey: 'xxxxxxxxxxxxxxxxxxxxx'   
});

let calendar = new nuki.models.icalmodels.ICal({
    url: "https://www.airbnb.nl/calendar/ical/xxxxxxxxxxxxxxxxxxxxxxx",
    type: nuki.models.icalmodels.ICalTypes.AIRBNB,
    name: 'AirBnB'
};

ical.writeSettings(settings).then(function () {
    ical.findSmartLockByName('xxx').then(function (smartlock) {
        ical.addCalendar(calendar).then(function () {
            ical.start(); // Start the application.
        }).catch(function (error) {
            console.log(error);
        });
    });
});

Motivation

This package was initially build to integrate the NUKI Smartlock with AirBnB, Booking.com, HomeAway and other internet calendars. Other relevant and depending packages are:

  1. ical-booking
  2. nuki-api

API Reference

Get your API-key from https://web.nuki.io/nl/#/admin/web-api

Request Parameters
findSmartlockByName (string) name
addCalendar (models.icalmodels.ICal) icalendar
readSettings (int) smartlockId (optional)
writeSettings (models.settings) settings
removeSettings (int) smartlockId
start (int) smartlockId (optional)
stop
restart

Contributors

If you want to contribute or donate to the project, please contact me on [email protected].

License

MIT licence.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published