# node-aladdin-connect-garage-door

> node.js script to connect to aladdin connect garage door

Latest version **0.1.2** (published 2020-03-20) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install node-aladdin-connect-garage-door
pnpm add node-aladdin-connect-garage-door
yarn add node-aladdin-connect-garage-door
bun add node-aladdin-connect-garage-door
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-03-20 |
| First published | 2019-04-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | apexad |
| Maintainers | apexad, ianatoly |
| Keywords | node, garage, door, genie, aladdin, connect |

## Links

- npm: https://www.npmjs.com/package/node-aladdin-connect-garage-door
- Repository: https://github.com/apexad/node-aladdin-connect-garage-door
- Homepage: https://github.com/apexad/node-aladdin-connect-garage-door#readme
- Issues: https://github.com/apexad/node-aladdin-connect-garage-door/issues
- npm.io page: https://npm.io/package/node-aladdin-connect-garage-door

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.81.0
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.4

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2020-03-20
- 0.1.1 — 2020-02-21
- 0.1.0 — 2020-02-21
- 0.0.16 — 2020-02-20
- 0.0.15 — 2020-02-07
- 0.0.14 — 2020-01-30
- 0.0.13 — 2020-01-30
- 0.0.12 — 2020-01-24
- 0.0.10 — 2019-10-30
- 0.0.9 — 2019-10-23
- 0.0.8 — 2019-10-21
- 0.0.7 — 2019-08-01
- 0.0.6 — 2019-07-30
- 0.0.5 — 2019-07-30
- 0.0.4 — 2019-04-05
- … 3 more at https://npm.io/package/node-aladdin-connect-garage-door/versions

## README

# Node tool for Aladdin Connect Garage Door
[![NPM Version](https://img.shields.io/npm/v/node-aladdin-connect-garage-door.svg)](https://www.npmjs.com/package/node-aladdin-connect-garage-door)

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)

---
_Source: https://npm.io/package/node-aladdin-connect-garage-door · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._