https://github.com/apexad/node-aladdin-connect-garage-door

Delete the app, your computer can control your Aladdin Connect Garage Door now
https://github.com/apexad/node-aladdin-connect-garage-door

aladdin-connect automation garage-door genie nodejs

Last synced: about 8 hours ago
JSON representation

Delete the app, your computer can control your Aladdin Connect Garage Door now

• Host: GitHub
• URL: https://github.com/apexad/node-aladdin-connect-garage-door
• Owner: apexad
• Created: 2019-04-05T09:23:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-25T20:03:00.000Z (over 1 year ago)
• Last Synced: 2024-05-01T20:49:21.694Z (7 months ago)
• Topics: aladdin-connect, automation, garage-door, genie, nodejs
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/node-aladdin-connect-garage-door
• Size: 65.4 KB
• Stars: 8
• Watchers: 5
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# Node tool for Aladdin Connect Garage Door

[![mit license](https://badgen.net/badge/license/MIT/red)](https://github.com/apexad/homebridge-mysmartblinds-bridge/blob/master/LICENSE)

[![npm](https://badgen.net/npm/v/node-aladdin-connect-garage-door)](https://www.npmjs.com/package/node-aladdin-connect-garage-door)

[![npm](https://badgen.net/npm/dt/node-aladdin-connect-garage-door)](https://www.npmjs.com/package/node-aladdin-connect-garage-door)

[![donate](https://badgen.net/badge/donate/paypal/91BE09)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=JS2VTL89E6VZ4&source=url)

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

## Example Script

```javascript

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

Parameter       | Description

----------------|------------

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

Action          | Callback function results

----------------|--------------------------

status          | String(OPENING, OPEN, CLOSING, CLOSED)

battery         | Integer(% of Battery Level)

status-and-batt | String(status:battery)

open            | String(OPENING)

close           | String(CLOSING)

## Credits

Uses API Documentation from  [aladdin connect postman](https://documenter.getpostman.com/view/5856894/RzZAjHxV) which was implemented via python by [shoejosh](https://github.com/shoejosh/aladdin-connect).

## 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](https://github.com/iAnatoly/homebridge-aladdin-connect-garage-door)