Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation is lacking clarity #64

Open
ericblade opened this issue Jun 24, 2017 · 8 comments
Open

Documentation is lacking clarity #64

ericblade opened this issue Jun 24, 2017 · 8 comments

Comments

@ericblade
Copy link

ericblade commented Jun 24, 2017

.. the documentation is quite.. not.. clear. I'm having trouble figuring out what this even is -- is it completely seperate thing that wraps around Node-red adding additional functionality? Is it for some reason a modified version of node-red ? The readmes are not at all clear, and don't really explain anything, not purpose, nor enough clarity to result in a working installation of anything at all. (following all the steps outside of the BlueMix README, results in a pile of files that has no obvious start point)

... what exactly does this do, to provide Wink capability in Node-RED? How does it work ,and how do you use it? (more importantly, why isn't it implemented as a plugin to node-red using the existing methods of expanding node-red? or is it, and that's just not documented at all?)

@skot0123
Copy link
Collaborator

Wow, welcome? Have you looked through the wink node red facebook group or read the robots, schedules, or sample uses read me files? They should give you an idea about what it does. Just so we are on the same page here, wnr was developed by a couple of guys in their spare time and shared with everyone free of charge. Since then many have contributed to it to expand its capabilities. All of us work on wnr as a hobby, it is not a business. The read me files were created out of generosity, most by one guy. Check out the facebook group if you'd like.

@ericblade
Copy link
Author

Hi! I'm not trying to be adversarial, my apologies if it came out that way.

I seriously cannot make any sense out of the README, or the additional READMEs that are linked from the README. I'm interested in getting Wink support on my Node-RED, but searching Google, only leads me here, which leads me to the README, which leads me .. nowhere.

I had no idea there was a facebook group -- there's no link to a facebook group, nor does it come up when searching Google. So, I've sent a request to join that, thank you.

@skot0123
Copy link
Collaborator

Maybe its just late and I took it wrong. Did you find the group? https://www.facebook.com/groups/WinkNodeRed/

@robross0606
Copy link

robross0606 commented Jan 12, 2018

I have to kinda agree. I'm SUPER excited and appreciative of this potential software since I'm scratching my head at the lack of more integration like this in Node-Red. However, this software doesn't install into Node-RED like other plugins so I'm in the same boat. I will definitely take a look at the group contents once my joining is approved.

Taken in the context of other Node-Red plugins, I have to concur that at least the README is pretty confusing mostly because it doesn't clearly state whether this is a plugin to an existing Node-Red installation or this is a wrapper around Node-Red. If it is indeed a plugin, the installation instructions are simultaneously lacking and too complicated mostly because they focus on how you install and set up Node-Red itself and include almost nothing about how you actually install or use the plugin. The documentation suffers from lack of proper scoping. Unless you're providing a forked Node-Red version, installation instructions for Node-Red itself (nodejs, etc.) is not your concern.

@mifbody
Copy link
Collaborator

mifbody commented Jan 12, 2018 via email

@robross0606
Copy link

So they're JUST flows? To get to the root of the question, how would someone install this functionality into an existing Node-Red setup?

@mifbody
Copy link
Collaborator

mifbody commented Jan 12, 2018 via email

@skot0123
Copy link
Collaborator

Like Brian said, it is basically using existing nodes in most Node Red setups, and in some instances installing additional nodes such as Alexa nodes and such. When you import the flow of nodes that Timur created these nodes are already setup as needed to perform whatever function that flow is designed for, what I am trying to say is the code is already in each node to make it do what it needs to in order to integrate. So you need the basic flows that do the integration portion; Wink Core, Tablet UI, Integration, and Freeboards. These flows work together to tie Wink and other data sources and automation systems into node red. You can then import tabs such as Schedules and Robots that you would then adjust to meet your specific needs such as building schedules based on/using your systems and Robots that do certain things if certain circumstances or events occur.

Timur's Readme goes through the basic setup of node red and then Brian's sample schedules and robots flows show how to do the customization part. Many of us that started using Timur's setup had no clue what Node Red was initially nevermind how it works so his readme was an almost start from scratch, here's how to get going, kind of thing and has evolved into a much more diverse system over the past couple of years. If one knows what Node Red is and how to use it then that person could essentially import the core flows. The samples are simply easy to use examples for those of us that only half know what we are doing. If a user is well versed in java, or whatever coding, he or she could easily take their personal setup in a totally different direction. Many of us use Brian's flows as our base but there have also been a few that haven't and through their own understanding of Node Red have chosen to use independent nodes for device and robot control and gone a totally different route by just importing the core flows and going from there.

So basically...

Import core flows, make the appropriate personolization changes outlined in the main readme, and if you know how to code everything then go from there on your own. If you don't know how to create your own system then import the core flows, make the appropriate changes, import Brian's example robots and schedules flows, and follow the instructions in the notes within the Schedule/Robot node to set it up for your particular situation. If you want to see examples of how others have used the example flows check out the sample uses readme and other samples on the GIT

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants