0.1.2 • Published 4 years ago

node-aladdin-connect-garage-door v0.1.2

Weekly downloads
19
License
ISC
Repository
github
Last release
4 years ago

Node tool for Aladdin Connect Garage Door

NPM Version

This tool can be used to check the status and open/close an Aladdin Connect Garage Door via a Node.js script.

Example Script

var aladdinGarageDoor = require('node-aladdin-connect-garage-door');
var allowDebug = true;
var action = 'status';
var deviceNumber = 0;
var garageNumber = 1;

function callback(text)  {
  console.log(text);
}

aladdinGarageDoor('USERNAME/EMAIL', 'PASSWORD', action, callback, deviceNumber, garageNumber, allowDebug);

Function Parameters

ParameterDescription
USERNAME/EMAIL(required) Your Genie Aladdin Connect Username (usually an email address)
PASSWORD(required) Your Genie Aladdin Connect Password
action(required, invalid default: status) status, battery, status-and-batt, open, or close
callback(required) action callback, function parameter is action result (like door status or battery level).
deviceNumber(optional - 0, 1, 2, default: 0) Use for multiple Garage Door controller devices on 1 account
garageNumber(optional - 1, 2, 3, default: 1) Use for multiple Garage Doors connected to a single device
allowDebug(optional - true, false, default: false) Set to true for more logs to be generated

Actions

ActionCallback function results
statusString(OPENING, OPEN, CLOSING, CLOSED)
batteryInteger(% of Battery Level)
status-and-battString(status:battery)
openString(OPENING)
closeString(CLOSING)

Credits

Uses API Documentation from aladdin connect postman which was implemented via python by shoejosh.

Home Automation

This can be used in a home automation program that will run commands to check status, open, and close a garage door.
If using homebridge, just use homebridge-aladdin-connect-garage-door

0.1.2

4 years ago

0.1.0

4 years ago

0.1.1

4 years ago

0.0.16

4 years ago

0.0.15

4 years ago

0.0.14

4 years ago

0.0.13

4 years ago

0.0.12

4 years ago

0.0.10

5 years ago

0.0.9

5 years ago

0.0.8

5 years ago

0.0.7

5 years ago

0.0.6

5 years ago

0.0.5

5 years ago

0.0.4

5 years ago

0.0.3

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago