Major update to Wink plugin - published to npm

---

Hi -
I am making some significant updates to the wink plugin and was wondering if anyone can help with testing - I only have switches and lightbulbs but don’t have shades which this plugin supports.

If anyone is using this plugin and can help test please reply to this thread. I should have the version ready for testing in a couple of days.

New features:

• Supports auto-discovery in 0.9

• Realtime updates from Wink’s pubnub channel so pimatic status stays in sync with real device status without polling. Pubnub is globally distributed and is much more responsive than using the Wink API

• All settings and keys are in the config now

• Added support for locks

• Added a new device type that allows Wink light_bulb type devices to be turned on and off, without changing the dim level. I mostly use it GE fan comtrols, since 90% of the time I just want on/off and want to leave the speed the same

• Added support for independent on/off from dim level, and custom UI for the dimmer- This makes the light bulbs and dimmers behaviour consistent with the official Wink app.

INSTALLATION -
https://github.com/dgmltn/pimatic-wink

UPGRADE INSTRUCTIONS -
1 -If you are using a previous version of the plugin - please copy the auth key from pimatic-wink/WINK_AUTH_TOKEN file in the “auth_token”: setting either via the Pimatic UI or manually, make sure there are quotes around it, if you do it manually. You will probably need to restart once to get everthing in place. The plugin will do what it needs.

2- you will either nedd to add pubnub settings for all wink devices or better idea, remove all devices and add them using auto-discover.

See the installation instructions for further details

Update July/2/2016

cc: @mwittig @leader21

@Enis-Hoca said in Major update to Wink plugin - need help testing:

cc: @mwittig

I can review and dry-run, but I don’t have wink equipment to test with. I am glad and grateful you have taken the initiative here!

I had similar in mind. A couple of days I queried for wink users but there is no response yet - https://forum.pimatic.org/topic/1905/pimatic-wink

@mwittig said in Major update to Wink plugin - need help testing:

I can review and dry-run,

@mwittig Thank you - I am new to JS and Coffescript and still getting my head around promises - a review would be greatly appreciated. How do I get added to the developers group?

I am also loving 0.9 a lot, especially the ability to make config changes from the UI. Given the new UI I think I am going to make some breaking changes from the previous plugin to remove the workarounds that are not needed anymore, this will require restructuring a fundamental concept which will make it impossible to keep it backward compatible with the original

The original plugin was caching the config received from wink and looking up device IDs from it, this is not needed any more because this can be automatically pushed to the config from discovery - similarly the pubnub settings that I need for subscription need to be set and the best way of doing it is pushing it from discovery

The original add-in had some manual steps in it for the initial seeding of the OAuth token which were not very well documented.

Given this and the fact that the original author doesnt have pimatic anymore I am thinking of publishing this as a new plugin.

@leader21 Can you pls add Enis to the developers group? Thanks

@mwittig said in Major update to Wink plugin - need help testing:

@leader21 Can you pls add Enis to the developers group? Thanks

it’s a pleasure
done!

@Enis-Hoca said in Major update to Wink plugin - need help testing:

this will require restructuring a fundamental concept which will make it impossible to keep it backward compatible with the original

I don’t think this is an issue, as the number of users affected is small - may be just you as nobody elese has replied yet

The original plugin was caching the config received from wink and looking up device IDs from it, this is not needed any more because this can be automatically pushed to the config from discovery - similarly the pubnub settings that I need for subscription need to be set and the best way of doing it is pushing it from discovery

Agree. What ever can be set as a result of the discovery procedure is great as you don’t want normal users to make settings which are difficult to understand and which are easily done wrong.

The original add-in had some manual steps in it for the initial seeding of the OAuth token which were not very well documented.

Given this and the fact that the original author doesnt have pimatic anymore I am thinking of publishing this as a new plugin.

Another option is to ask the author to make you co-maintainer, i.e., give you write access to github and npmjs.

@mwittig I am stuck one thing and can use some guidance. On the first run I have to fetch the OAuth token from the Wink API this is done in the init function. It takes a while to get the token, I need to suspend init until the token has been retrieved. How can I do that. Its probably ok not to load the plugin and once the token has been fetched send a message to the UI to reload pimatic or preferably reload the plugin. We shouldn’t listen to any device messages until there is a valid token

Would appreciate any advice.

@Enis-Hoca I think you should use a promise for this. This way you can wait for your token asynchronously. Just be sure that you wait for it, if someone wants to use the device before the token is there.

@michbeck100 thanks I am very new to this - would it be possible for you to show me with a code snippet? Thanks

@Enis-Hoca It’s basically like this:

Promise.resolve()
          .then( => @getOAuthToken() )
          .then( (token) =>
            # do something with the new token
          )
          .catch( (err) => # handle error
          )
          .finally( => # this is called in any case
          ).done()
# this line gets executed immediately and won't wait until Promise is finished 

Hope this helps.

@michbeck100 thank you - that did it

@michbeck100 @mwittig I have checked in my first pass - would really really appreciate a code review. I have not had any level of js/coffeescript experience mostly followed other people’s patterns. I am certainly not confident about how I am handling the auth promises stuff.

github link - https://github.com/enishoca/pimatic-wink

@michbeck100 your plugin was especially helpful for me to learn from - before I publish I am going to do another refactor, and separate out each device in a separate classes following your pattern. I have door lock coming next week so hopefully I will add that too.

But it looks like I am the only one using this plugin LOL -

@Enis-Hoca said in Major update to Wink plugin - need help testing:

But it looks like I am the only one using this plugin LOL -

you never know maybe some are using it without giving feedback or are not registered to the forum.

@leader21 I have published this version now and its available on npm - however the link on the pimatic website still shows the original page. Also how do you setup so it can be upgraded @dgmltn had made me a collaborator and given me access both on npm and github.

thanks

Should be OK now.
We’re having an automatic update procedure for the plugin overview.
Have a look if your changes are up to date now.

@leader21 Instructions look good but there is one thing that is a bit weird - it the name it shows is - Doug Melton (enishoca) - Doug and I are two diff people. I of-course did the release on NPM - its a minor thing and personally I don’t care, but Doug may and it conveys incorrect info to the user

ok i’ll see what there is to do.
guess it’s an entry in the package.json to be edited/changed

@leader21 can you tell me what needs to change please - in the package Doug is listed as the author and I am contributor, unless npm changes the author entry to the last submitter

Just give me some more time to check. Actually I need to get the info where exactly we grep the information from

@Enis-Hoca The problem was part of the update task of the website. I used the “_npmUser” field of the package information from the npm registry as the npm authors username. However this was wrong. “_npmUser” is the publishing user, not the author. I fixed the update task and the information is now correct. Sorry for the long delay.