@totallyinformation/node-red-contrib-events
Version:
Event broadcast and receive nodes for Node-RED.
36 lines (31 loc) • 1.47 kB
HTML
<p>
Event-driven notifications. Create an event from an input msg.topic.
An instance of this node will receive the same msg as that sent with a matching <code>msg.topic</code> to any <code>event-out</code> node.
</p>
<h3>Inputs</h3>
<p>
There are no inputs. The node is triggered by a <code>event-out</code> node with a matching input <code>msg.topic</code>
</p>
<h3>Outputs</h3>
<p>
The node outputs the node that was input to the matching <code>event-out</code> node.
</p>
<h3>Node Settings</h3>
<dl class="message-properties">
<dt>Name <span class="property-type">string</span></dt>
<dd>A short description shown in the admin interface</dd>
<dt>Topic <span class="property-type">string</span></dt>
<dd>
<p>
<b>REQUIRED</b>. The topic name to match.<br>
The defined topic string may include the character <code>*</code> (or <code>+</code>) to act as a single-level wildcard.
Use <code>**</code> or <code>#</code> for a multi-level wildcard.
The <code>/</code> character acts as a level (namespace) separator for the wildcards.
</p>
<h5>Example</h5>
<p>
<code>one/*/three</code> will match input topics of <code>one/two/three</code>, <code>one/99/three</code>, etc.<br>
<code>one/**</code> or <code>one/#</code> will match input topics like <code>one/two/three</code>, or <code>one/99</code>.<br>
</p>
</dd>
</dl>