dlbroadfoot / pygogogate2

Python wrapper for Gogogate2 API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pygogogate2

Python wrapper for Gogogate2 API

Build Status

PyPi Package: https://pypi.python.org/pypi/pygogogate2/

Introduction

This is a python module aiming to interact with the Gogogate2 API.

Code is licensed under the MIT license.

Getting Started

Usage

pip install 'pygogogate2'

from pygogogate2 import Gogogate2API as pygogogate2

gogate2 = pygogogate2(username, password, ip_address)

gogate2.get_status(1)

gogate2.get_temperature(1)

Methods

def get_devices(self): """Return devices from API"""

def get_status(self, device_id): """Return current door status(open/closed)"""

def get_temperature(self, device_id): """Return current door temperature(F)"""

def close_device(self, device_id): """Send request to close the door."""

def open_device(self, device_id): """Send request to open the door."""

Disclaimer

The code here is based off of an unsupported API from Gogogate2 and is subject to change without notice. The authors claim no responsibility for damages to your garage door or property by use of the code within.

Development

# Setup the virtual environemnt.
python -m venv venv

# Enter venv
source venv/bin/activate

# Install dependencies.
pip install -r requirements.txt

# Test code
python setup.py test

About

Python wrapper for Gogogate2 API

License:MIT License


Languages

Language:Python 100.0%