V6 Support #34

nsnyder · 2021-01-09T23:39:39Z

Noticed errors being thrown from my implementation of this package. After a bit of looking, it appears that Chamberlain has deprecated V5 of their API, and has moved to V6. (Discussion here.)

It looks like someone on that side has been able to reverse engineer it, but I'm not sure how to grab the logs myself to get an implementation going. Might be possible to get into the Discord server and ask them for the info.

Not sure how big a change this is. Ideally, the public facing API for this package remains as-is.

Happy to help if I have time.

thomasmunduchira · 2021-01-09T23:49:35Z

Acknowledged, thanks for reporting! This does align with the cron tests that started failing as of yesterday.

I might try to see if I can MITM to see what the new requests look like. I will join the Discord as well to keep up with progress on the Homebridge end.

RedondoBoony · 2021-01-11T20:53:52Z

Thanks a lot.
Stupid that they just can change the api without compatibility to the last one...

cjustinhall · 2021-01-11T21:44:39Z

I'll add my thanks - yes, would love to see this work again! Missing the functionality here. Shout if I can help in any way.

thomasmunduchira · 2021-01-19T09:58:34Z

A short-term fix with the V5 API has landed (see #35). I did some MITM/research with the V6 API that I didn't get a chance to publish yet, but hopefully I can get around to it relatively soon.

avie · 2021-03-21T23:34:27Z

Does the app work for you using mitmproxy? I was trying to capture some traces (and yes, noticed the app is now using V6 per the hombridge implementation) but when using mitmproxy the app says it can't find the server. I can see the initial OAuth traffic but that's it.

BTW, thanks for doing this!

heisler3030 · 2021-08-25T19:35:23Z

I'm getting consistent 400 errors today, chatter on other projects seems to indicate something changed with the API to break it. The Homebridge plugin ported to v6 Oauth and seems to be still working. Any current plans to update to v6 or otherwise fix?

syntag · 2021-08-25T22:42:56Z

Receiving the same 400 issue today as well. Coincidently when I got a new garage motor, thought it was because of that 😅

simmonyau · 2021-08-26T00:10:35Z

Yes, I'm getting the same error:

Error received:
{ MyQError: Unidentified error returned from service.
    at Function.handleServiceError (/srv/dev/cfg/openhab2/scripts/node_modules/myq-api/src/ErrorHandler.js:49:13)
    at MyQ._executeServiceRequest (/srv/dev/cfg/openhab2/scripts/node_modules/myq-api/src/MyQ.js:732:27)
    at process._tickCallback (internal/process/next_tick.js:68:7)
  name: 'MyQError',
  code: 'ERR_MYQ_INVALID_SERVICE_RESPONSE',
  _serviceError:
   { Error: Request failed with status code 400
       at createError (/srv/dev/cfg/openhab2/scripts/node_modules/axios/lib/core/createError.js:16:15)
       at settle (/srv/dev/cfg/openhab2/scripts/node_modules/axios/lib/core/settle.js:17:12)
       at IncomingMessage.handleStreamEnd (/srv/dev/cfg/openhab2/scripts/node_modules/axios/lib/adapters/http.js:244:11)
       at IncomingMessage.emit (events.js:203:15)
       at endReadableNT (_stream_readable.js:1145:12)
       at process._tickCallback (internal/process/next_tick.js:63:19)

thomasmunduchira · 2021-08-29T19:03:09Z

We need to prioritize this now that the v5 API is turned down. I'll actively start working on this, but it won't be an overnight fix by any means.

nsnyder · 2021-08-30T21:49:14Z

Let me know if I can be of assistance :)

avie · 2021-08-31T01:33:01Z

I haven't looked at what @koush did but have been updating some home automation code I have that was based on what I learned from this project. I now have it mostly working. I figured most things out by looking at the HomeBridge code along with some detective work watching network traffic. The MyQ server is very finicky and wants headers and such a certain way. Anyway, if it's helpful, the general gist of V6 is the switch to the Oauth2/PKCE flow and minor changes to the regular api. Here's some more details:

For auth:

Instead of the old security token you use an Access Code generated by the OAuth flow. It's passed along in the api with an Authorization header. [Yes, it gives you an "access_token" in a JSON reply but you put it in an Authorization header].

To do this, start at https://partner-identity.myq-cloud.com/connect/authorize with a bunch of query params (see Homebridge code) and the PKCE challenge. This will return with several redirects. Keep following them until the server returns with a 200 returns code. With this return you need to parse the html and find a __RequestVerificationToken. With that token, redo the last query as a POST and in the body of the POST put url encoded email, password and token.

This will return a page with one more redirect... don't follow the redirect! Instead, pull out the "code" and "scope" it returns and turn around and use them in a POST to https://partner-identity.myq-cloud.com/connect/token (you will also send along the PKCE verifier now), which will return an actual access code.

The reply will have an "access_token" and "token_type" which are then used in all the api commands. Basically, create a header as "Authorization: <token_type> <access_token>" which replaces prior use of the Security Token. You can also save away the refresh_token to get new access tokens when you need them without logging back in. [I have not tried that].

Now that you've got your access token everything is very similar to what it was before. First, you need to get the account ID. This is a little different. Query https://accounts.myq-cloud.com/api/v6.0/accounts and a list of accounts will be returned. Not sure why there can be more than one. Anyway, this will give you and Account ID which you use in the api as before.

To get the device list, use https://devices.myq-cloud.com/api/v5.2/Accounts//Devices. This list will be the same as before.

To then control a device use https://account-devices-gdo.myq-cloud.com/api/v5.2/Accounts//door_openers//

where command is "Open" or "Close" (used to be open or close). This is a PUT command as before with an empty body (be sure to set Content-Length: 0).

Oh, make sure to have cookie processing on as it is required.

You can find details of some of the search parameters in the HomeBridge code.

Hope it helps!

cjustinhall · 2021-08-31T01:42:41Z

Here's what koush did... https://github.com/koush/myq/blob/main/src/myq-api.ts

Some useful bits from his commenting:

Starting with v6 of the myQ API, myQ now uses OAuth 2.0 + PKCE to authenticate users and
provide access tokens for future API calls. In order to successfully use the API, we need
to first authenticate to the myQ API using OAuth, get the access token, and use that for
future API calls.
On the plus side, the myQ application identifier and HTTP user agent - previously pain
points for the community when they get seemingly randomly changed or blacklisted - are
no longer required.
For those familiar with prior versions of the API, v6 does not represent a substantial
change outside of the shift in authentication type and slightly different endpoint
semantics. The largest non-authentication-related change relate to how commands are
sent to the myQ API to execute actions such as opening and closing a garage door, and
even those changes are relatively minor.

koush · 2021-08-31T02:04:44Z

Here's what koush did... https://github.com/koush/myq/blob/main/src/myq-api.ts

The above is not my code, it's from the myq homebridge plugin. I stripped out the homebridge stuff for just the MyQ API bindings, which were updated to work with the v6 API. Hopefully it helps the authors of this project. Or anyone else that has a pressing need to control their MyQ devices, and want a relatively quick way to access them, albeit by targeting a different node library.

skykep · 2021-09-03T16:11:18Z

What's the best way to test this? Node won't run it, nor npm.

parnic · 2021-09-03T16:46:59Z

What's the best way to test this? Node won't run it, nor npm.

This is a library, not an application, so you would need to build an application to use this library's API. Examples are listed in the readme.

simmonyau · 2021-09-03T18:34:15Z

In case it helps anyone, I ended up switching my home automation to use the following API that works very well:

https://github.com/arraylabs/pymyq

skykep · 2021-09-03T19:49:44Z

What's the best way to test this? Node won't run it, nor npm.

This is a library, not an application, so you would need to build an application to use this library's API. Examples are listed in the readme.

Perfect. Just what I needed. Thanks!

skykep · 2021-09-03T20:03:58Z

What's the best way to test this? Node won't run it, nor npm.

This is a library, not an application, so you would need to build an application to use this library's API. Examples are listed in the readme.

It appears I need a little more handholding. How do you reference the v6 library since it's written in TypeScript?
The older myq-api is JS. I tried running tsc on it to convert it, but get errors about it being an ES module...

koush · 2021-09-03T21:15:00Z

What's the best way to test this? Node won't run it, nor npm.

This is a library, not an application, so you would need to build an application to use this library's API. Examples are listed in the readme.

It appears I need a little more handholding. How do you reference the v6 library since it's written in TypeScript?
The older myq-api is JS. I tried running tsc on it to convert it, but get errors about it being an ES module...

Sorry, it's been fixed. I had the incorrect package entry point. Should work from a normal js project.

skykep · 2021-09-03T21:28:10Z

Sorry, it's been fixed. I had the incorrect package entry point. Should work from a normal js project.

Thanks, so what is the proper way to call this?
Using const MyQ = require('myq-api'); still calls the v5 api and pointing the require directly to your myq-api.js doesn't work either.

koush · 2021-09-03T21:32:44Z

Sorry, it's been fixed. I had the incorrect package entry point. Should work from a normal js project.

Thanks, so what is the proper way to call this?
Using const MyQ = require('myq-api'); still calls the v5 api and pointing the require directly to your myq-api.js doesn't work either.

Make sure you're on at least v1.0.9

npm install @koush/myq@latest

require('@koush/myq')

skykep · 2021-09-03T22:39:55Z

Make sure you're on at least v1.0.9

npm install @koush/myq@latest

require('@koush/myq')

No joy.

const MyQ = require('@koush/myq');
const account = new MyQ();

phuz@wazebot:~/MyQ$ node myq.js
/home/phuz/MyQ/myq.js:6
const account = new MyQ();
                ^
TypeError: MyQ is not a constructor

(that was me that DM'd you on discord earlier)

koush · 2021-09-04T02:54:07Z

> require('@koush/myq')
{ myQApi: [Getter] }

that example is out of date I think.

skykep · 2021-09-04T11:40:04Z

that example is out of date I think.

yeah that old example won't work with this new API, but I can't even figure out my starting point on this. It also looks like multiple things need to happen during the authentication process. I wonder if we look at the homebridge code to see how they're using it specifically.

koush · 2021-09-04T16:34:27Z

yeah, that's how I did it. it's not complicated.

    this.account = new myQApi(console.log.bind(console), console, email, password);
    await this.account.refreshDevices();
    
    const devices: Device[] = [];
    for (const device of this.account.devices) {
      // do stuff
    }

skykep · 2021-09-04T17:27:49Z

yeah, that's how I did it. it's not complicated.

I've tried very similar but I still get the myQApi is not a constructor

koush · 2021-09-04T17:30:26Z

const {myQApi} = require('@koush/myq')

you're probably importing it wrong

skykep · 2021-09-04T17:36:17Z

you're probably importing it wrong

hah, yup. completely missed the deconstruction. but that opened up more errors. I hope this isn't all related to being on node v12 (which I need on this test box)

skykep · 2021-09-04T18:25:18Z

For the heck of it, I just wiped my code and pasted what you have above (with credentials) and it still blows up.
Did that actually work for you?
TypeError: this.devices is not iterable

koush · 2021-09-04T19:11:07Z

For the heck of it, I just wiped my code and pasted what you have above (with credentials) and it still blows up.
Did that actually work for you?
TypeError: this.devices is not iterable

yes.

const { myQApi } = require('@koush/myq')


async function start() {
    const account = new myQApi(console.log.bind(console), console, 'username', 'password');
    await account.refreshDevices();
    
    for (const device of account.devices) {
        console.log(device);
    }
}

start();

skykep · 2021-09-04T19:19:57Z

yes.

Then I've got something else going on because that's more or less what I had with the exception of a different function name.
Thanks for what you've done and provided so far.

cjustinhall · 2021-09-05T16:29:49Z

I can confirm that this does indeed work.

(I'm running on redhat ent latest, npm 7.21.1)

Create a directory for the myq-v6, cd that directory
npm install @koush/myq@latest
Created a test.js with the above code... edit with your username/pwd...
node test.js

Works! Returns all the gateways/hubs and door openers that I have physically installed.

To Open all doors, (for testing purposes...)
Inside of the account.devices iteration, add these lines
if(device.device_family=='garagedoor') {
account.execute(device,"Open");
}

nsnyder · 2021-09-06T16:38:13Z

Could we please limit discussion to this issue, in this library? Thanks to @koush for his work porting a V6 implementation, but issues with that just muddy up this ticket and make noise for the rest of us.

parnic mentioned this issue Aug 25, 2021

Status tiling parnic/MMM-MyQ#1

Closed

heisler3030 mentioned this issue Aug 25, 2021

MyQ Lite is no longer able to login to MyQ.com brbeaird/SmartThings_MyQ#126

Closed

nsnyder mentioned this issue Aug 27, 2021

ERR_MYQ_INVALID_SERVICE_RESPONSE recently started appearing #46

Open

thomasmunduchira self-assigned this Aug 29, 2021

thomasmunduchira added the enhancement label Aug 29, 2021

dre2901 mentioned this issue Aug 30, 2021

Liftmaster Light is Not a Light dre2901/node-red-contrib-myq#3

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

V6 Support #34

V6 Support #34

nsnyder commented Jan 9, 2021 •

edited

Loading

thomasmunduchira commented Jan 9, 2021

RedondoBoony commented Jan 11, 2021

cjustinhall commented Jan 11, 2021

thomasmunduchira commented Jan 19, 2021

avie commented Mar 21, 2021

heisler3030 commented Aug 25, 2021

syntag commented Aug 25, 2021

simmonyau commented Aug 26, 2021

thomasmunduchira commented Aug 29, 2021

nsnyder commented Aug 30, 2021

avie commented Aug 31, 2021

cjustinhall commented Aug 31, 2021

koush commented Aug 31, 2021 •

edited

Loading

skykep commented Sep 3, 2021

parnic commented Sep 3, 2021

simmonyau commented Sep 3, 2021

skykep commented Sep 3, 2021

skykep commented Sep 3, 2021 •

edited

Loading

koush commented Sep 3, 2021

skykep commented Sep 3, 2021

koush commented Sep 3, 2021 •

edited

Loading

skykep commented Sep 3, 2021 •

edited

Loading

koush commented Sep 4, 2021

skykep commented Sep 4, 2021

koush commented Sep 4, 2021 •

edited

Loading

skykep commented Sep 4, 2021

koush commented Sep 4, 2021

skykep commented Sep 4, 2021

skykep commented Sep 4, 2021

koush commented Sep 4, 2021 •

edited

Loading

skykep commented Sep 4, 2021

cjustinhall commented Sep 5, 2021 •

edited

Loading

nsnyder commented Sep 6, 2021

V6 Support #34

V6 Support #34

Comments

nsnyder commented Jan 9, 2021 • edited Loading

thomasmunduchira commented Jan 9, 2021

RedondoBoony commented Jan 11, 2021

cjustinhall commented Jan 11, 2021

thomasmunduchira commented Jan 19, 2021

avie commented Mar 21, 2021

heisler3030 commented Aug 25, 2021

syntag commented Aug 25, 2021

simmonyau commented Aug 26, 2021

thomasmunduchira commented Aug 29, 2021

nsnyder commented Aug 30, 2021

avie commented Aug 31, 2021

cjustinhall commented Aug 31, 2021

koush commented Aug 31, 2021 • edited Loading

skykep commented Sep 3, 2021

parnic commented Sep 3, 2021

simmonyau commented Sep 3, 2021

skykep commented Sep 3, 2021

skykep commented Sep 3, 2021 • edited Loading

koush commented Sep 3, 2021

skykep commented Sep 3, 2021

koush commented Sep 3, 2021 • edited Loading

skykep commented Sep 3, 2021 • edited Loading

koush commented Sep 4, 2021

skykep commented Sep 4, 2021

koush commented Sep 4, 2021 • edited Loading

skykep commented Sep 4, 2021

koush commented Sep 4, 2021

skykep commented Sep 4, 2021

skykep commented Sep 4, 2021

koush commented Sep 4, 2021 • edited Loading

skykep commented Sep 4, 2021

cjustinhall commented Sep 5, 2021 • edited Loading

nsnyder commented Sep 6, 2021

nsnyder commented Jan 9, 2021 •

edited

Loading

koush commented Aug 31, 2021 •

edited

Loading

skykep commented Sep 3, 2021 •

edited

Loading

koush commented Sep 3, 2021 •

edited

Loading

skykep commented Sep 3, 2021 •

edited

Loading

koush commented Sep 4, 2021 •

edited

Loading

koush commented Sep 4, 2021 •

edited

Loading

cjustinhall commented Sep 5, 2021 •

edited

Loading