README

Genie Aladdin Connect

A sleak Node.js module that allows you to easily interact with your Genie Aladdin Connect garage door opener.

Example Usage

const Aladdin = require('genie-aladdin-connect');

const Client = new Aladdin({
  user: ALADDIN_USER,
  password: ALADDIN_PASSWORD,
  doors: [
    {
      id: 0,
      title: 'Large Garage Door',
    }
  ]
});

Client.init();

console.log(await Client.getDoorsInfo());

Client.stop();

Aladdin Client

The aladdin client is object oriented and when a new instance is created so is a timer to get a new token every 15 minutes. When a new instance is created it must be initialized using Client.init() as this will fetch your garage doors

Constructor Options Object

Option	Description
user	(required) Your Genie Aladdin Connect Username (usually an email address)
password	(required) Your Genie Aladdin Connect Password
doors	(semi-optional, default: {id:1, title:'Little Door'},{id:3, title:'Big Door'}) Doors you have with an id and title.
userId	(optional) This is for streamlining the initialization, reducing setup requests.
portalId	(optional) This is for streamlining the initialization, reducing setup requests.
cik	(optional) This is for streamlining the initialization, reducing setup requests.
clientId	(optional) This is for streamlining the initialization, reducing setup requests.
portalNumber	(optional - 0, 1, 2, default: 0) Use for multiple Garage Door controller devices on 1 account

Functions

Function	Parameters	Description
init		Make all necessary API calls to get tokens and door information.
stop		Cancel the token timer, if not cancelled will request a new token every 15 minutes
getToken		Fetches an updated token
statusDoor	Door Number	Get the status of a door
operateDoor	Door Number, 'OPENING' or 'CLOSING'	Send a command to a door to open or close
getDoorsInfo		Get the status of all doors decleared in the constructor

Credits

Loosely based on:
- node-aladdin-connect-garage-door
- aladdin connect postman

Usage no npm install needed!