GithubHelp home page GithubHelp logo

myq's Introduction

myq

A library and tool in Go to control LiftMaster MyQ-enabled openers. Reverse engineered from the LiftMaster Web app. Updated 26-Nov-2016 to conform to the current app API.

##PACKAGE DOCUMENTATION

package myq

TYPES

type MyQ struct {
    // contains filtered or unexported fields
}

###Functions: func (m *MyQ) Close(d Device) error Close a specific door/device

func (m *MyQ) DoorDetails(d Device)

Show details & current state for a specific door/device

func (m *MyQ) FindDoorByName(name string) (d Device, err error)

Find a device/door by its name

func (m *MyQ) GetState(d Device)

Show the state (open, closed, ... ) of a specfic door/device

func (m *MyQ) New(username string, password string, debug bool, machineReadable bool) (err error)

Create a new MyQ Session

func (m *MyQ) Open(d Device) error

Open a specific door/device

func (m *MyQ) ShowByState(state string)

Show devices currently in state /state/ (Open, Closed, ... )

func (m *MyQ) ShowDoors()

Show all devices/doors

func (m *MyQ) ShowLocations()

Show all locations associated with this MyQ account

##MyQ TOOL myqt [-DM] [-user username] [-password password]

Options:
  -D=false: Debugging enabled
  -M=false: Machine parsable output
  -password="": Password
  -user="": Username

Commands:  
  help - this message
  list - show all doors
  locations - show all locations
  details <door> - show details for door <door>
  state <door> - return the state (open|closed) of <door>
  open <door> - Open <door>
  close <door> - Close <door>
  listopen - list all open doors
  listclosed - list all closed doors

The user and password options can be specified in a configuration file, located at ~/.config/myqt/config.ini. Parameters are:

    user = <username>
    password = <password>

The -user and -password command line options override the configuration file.

myq's People

Contributors

wfd3 avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.