joeshaw / myq

Go package and CLI tool for the Chamberlain / LiftMaster MyQ API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MyQ

GoDoc

This project is now archived, see Status below.

myq is a Go package and command-line tool providing access to the Liftmaster / Chamberlain MyQ API.

With the MyQ API you can get a list of devices and open and close garage doors and gates.

Command-line tool

The myq tool can be installed with:

go install github.com/joeshaw/myq/cmd/myq@latest

Run myq by itself to see full usage information.

To list devices:

myq -username <username> -password <password> devices

To open a door:

myq -username <username> -password <password> open <device ID>

To close a door:

myq -username <username> -password <password> open <device ID>

Usernames and passwords can also be provided through the environment variables MYQ_USERNAME and MYQ_PASSWORD.

MyQ protocol

David Pfeffer's MyQ API reference on Apiary was a helpful reference.

David also has an implementation in Ruby: https://github.com/pfeffed/liftmaster_myq

ArrayLab has a Python implementation: https://github.com/arraylabs/pymyq

J. Nunn has a Python implementation that ties in with Amazon Alexa: https://github.com/jbnunn/Alexa-MyQGarage

HJD has a JavaScript implementation: https://github.com/hjdhjd/myq

Status

In October and November 2023, MyQ made their API much harder to access by third parties. See this article on The Verge for more details.

I've replaced my MyQ Wifi module with a Ratgdo, which I strongly recommend. As a result, I am no longer maintaining this project.

License

Copyright 2018-2022 Joe Shaw

myq is licensed under the MIT License. See the LICENSE file for details.

About

Go package and CLI tool for the Chamberlain / LiftMaster MyQ API

License:MIT License


Languages

Language:Go 100.0%