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

small issue with the documentation: "Control Topic" #10

Closed
Urs-Eppenberger opened this issue Nov 20, 2020 · 1 comment
Closed

small issue with the documentation: "Control Topic" #10

Urs-Eppenberger opened this issue Nov 20, 2020 · 1 comment

Comments

@Urs-Eppenberger
Copy link

In the Information panel to the node I read the following:
Messages with the topic Control Topic are control messages, which set the state of the gate.

The two words Control Topic are in red. I thought that I need to set
msg.topic = "Control Topic";
but it seems that
msg.topic = "Control";
is the correct setting. In my personal view the text is slightly misleading.
Without the red word 'Topic' I probably would have made it in the first try (and probably would made other errors).

Maybe you look at it and decide yourself.
Kind regards,
Urs.

@drmibell
Copy link
Owner

If you look at the node's edit dialog, you will see that Control Topic is the name of the parameter (string) that the user can define to be the topic for control messages. The default value for that parameter is "control", but you can set it as you like. I think you will find that this sort of usage to distinguish between the name of a parameter and its value is fairly standard in Node-RED and does not generally lead to confusion.

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

No branches or pull requests

2 participants