mirror of
				https://github.com/node-red/node-red-nodes.git
				synced 2025-03-01 10:37:43 +00:00 
			
		
		
		
	added i18n help files
This commit is contained in:
		
							
								
								
									
										8
									
								
								function/PID/locales/en-US/pidcontrol.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								function/PID/locales/en-US/pidcontrol.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/x-red" data-help-name="PID control">
 | 
			
		||||
    <p>A PID controller node.</p>
 | 
			
		||||
    <p>This node ONLY expects a numeric <code>msg.payload</code> containing the current reading.
 | 
			
		||||
    It will output the correction that needs to be applied in order to move to the preset <i>set point</i> value.</p>
 | 
			
		||||
    <p>See <a href="https://en.wikipedia.org/wiki/PID_controller" target="_new">Wikipedia</a> for more details.</p>
 | 
			
		||||
    <p>The <i>set point</i> may be overridden by <code>msg.setpoint</code>. If you do so the edit box value can be used as the initial value.</p>
 | 
			
		||||
</script>
 | 
			
		||||
@@ -24,14 +24,6 @@
 | 
			
		||||
    The damping factors are typically in the range 0 - 1.<br></div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/x-red" data-help-name="PID control">
 | 
			
		||||
    <p>A PID controller node.</p>
 | 
			
		||||
    <p>This node ONLY expects a numeric <code>msg.payload</code> containing the current reading.
 | 
			
		||||
    It will output the correction that needs to be applied in order to move to the preset <i>set point</i> value.</p>
 | 
			
		||||
    <p>See <a href="https://en.wikipedia.org/wiki/PID_controller" target="_new">Wikipedia</a> for more details.</p>
 | 
			
		||||
    <p>The <i>set point</i> may be overridden by <code>msg.setpoint</code>. If you do so the edit box value can be used as the initial value.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('PID control',{
 | 
			
		||||
        color:"#d6ba48",
 | 
			
		||||
 
 | 
			
		||||
@@ -45,16 +45,6 @@
 | 
			
		||||
    <div class="form-tips" id="node-tip">Tip: This node ONLY works with numbers.</div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="smooth">
 | 
			
		||||
    <p>A simple node to provide various functions across several previous values, including max, min, mean, high and low pass filters.</p>
 | 
			
		||||
    <p>Messages arriving with different <code>msg.topic</code> can be treated as separate streams if so configured.</p>
 | 
			
		||||
    <p>Max, Min and Mean work over a specified number of previous values.</p>
 | 
			
		||||
    <p>The High and Low pass filters use a smoothing factor. The higher the number the more the smoothing. E.g. a value of 10 is similar to an α of 0.1. It is analagous to an RC time constant - but there is no time component to this as the time is based on events arriving.</p>
 | 
			
		||||
    <p>Enabling the Reduce option causes the node to only emit one message per N values (available for the Max, Min and Mean functions). E.g. if set to Mean over 10 values, there will only be one outgoing message per 10 incoming ones.</p>
 | 
			
		||||
    <p>If <code>msg.reset</code> is received (with any value), all the counters and intermediate values are reset to an initial state.</p>
 | 
			
		||||
    <p><b>Note:</b> This only operates on <b>numbers</b>. Anything else will try to be made into a number and rejected if that fails.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('smooth', {
 | 
			
		||||
        color: "#E2D96E",
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										10
									
								
								function/smooth/locales/en-US/17-smooth.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								function/smooth/locales/en-US/17-smooth.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,10 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="smooth">
 | 
			
		||||
    <p>A simple node to provide various functions across several previous values, including max, min, mean, high and low pass filters.</p>
 | 
			
		||||
    <p>Messages arriving with different <code>msg.topic</code> can be treated as separate streams if so configured.</p>
 | 
			
		||||
    <p>Max, Min and Mean work over a specified number of previous values.</p>
 | 
			
		||||
    <p>The High and Low pass filters use a smoothing factor. The higher the number the more the smoothing. E.g. a value of 10 is similar to an α of 0.1. It is analagous to an RC time constant - but there is no time component to this as the time is based on events arriving.</p>
 | 
			
		||||
    <p>Enabling the Reduce option causes the node to only emit one message per N values (available for the Max, Min and Mean functions). E.g. if set to Mean over 10 values, there will only be one outgoing message per 10 incoming ones.</p>
 | 
			
		||||
    <p>If <code>msg.reset</code> is received (with any value), all the counters and intermediate values are reset to an initial state.</p>
 | 
			
		||||
    <p><b>Note:</b> This only operates on <b>numbers</b>. Anything else will try to be made into a number and rejected if that fails.</p>
 | 
			
		||||
</script>
 | 
			
		||||
@@ -10,13 +10,6 @@
 | 
			
		||||
    </div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/x-red" data-help-name="nnotify">
 | 
			
		||||
    <p>Uses node-notifier to provide a desktop popup containing the <code>msg.payload</code>. Only useful on the local machine.</p>
 | 
			
		||||
    <p>Optionally uses <code>msg.topic</code> as the title, and <code>msg.icon</code> as the full path to an icon file to display.</p>
 | 
			
		||||
    <p>Uses node-notifier so should work cross platform but may need to intall pre-reqs... see <i><a href="https://www.npmjs.com/package/node-notifier" target="_new">this link.</a></i></p>
 | 
			
		||||
    <p>If installing on Windows you MUST read the install instructions...  or it WILL NOT work.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('nnotify',{
 | 
			
		||||
        category: 'output',
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										7
									
								
								social/notify/locales/en-US/57-notify.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								social/notify/locales/en-US/57-notify.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,7 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/x-red" data-help-name="nnotify">
 | 
			
		||||
    <p>Uses node-notifier to provide a desktop popup containing the <code>msg.payload</code>. Only useful on the local machine.</p>
 | 
			
		||||
    <p>Optionally uses <code>msg.topic</code> as the title, and <code>msg.icon</code> as the full path to an icon file to display.</p>
 | 
			
		||||
    <p>Uses node-notifier so should work cross platform but may need to intall pre-reqs... see <i><a href="https://www.npmjs.com/package/node-notifier" target="_new">this link.</a></i></p>
 | 
			
		||||
    <p>If installing on Windows you MUST read the install instructions...  or it WILL NOT work.</p>
 | 
			
		||||
</script>
 | 
			
		||||
@@ -39,13 +39,6 @@
 | 
			
		||||
    </div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="leveldb in">
 | 
			
		||||
    <p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
 | 
			
		||||
    <p>Use this node to <b>get</b>, or retrieve the data already saved in the database.</p>
 | 
			
		||||
    <p><code>msg.topic</code> must hold the <i>key</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
 | 
			
		||||
    <p>If nothing is found for the key then <code>msg.payload</code> is set to the <i>null</i> object.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('leveldb in',{
 | 
			
		||||
        category: 'storage-input',
 | 
			
		||||
@@ -67,7 +60,6 @@
 | 
			
		||||
    });
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-template-name="leveldb out">
 | 
			
		||||
    <div class="form-row node-input-level">
 | 
			
		||||
        <label for="node-input-level"><i class="fa fa-briefcase"></i> Database</label>
 | 
			
		||||
@@ -86,13 +78,6 @@
 | 
			
		||||
    </div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="leveldb out">
 | 
			
		||||
    <p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
 | 
			
		||||
    <p>Use this node to either <b>put</b> (store) the <code>msg.payload</code> to the named database file, using <code>msg.topic</code> as the key.</p>
 | 
			
		||||
    <p>To <b>delete</b> information select delete in the properties dialogue and again use <code>msg.topic</code> as the key.</b>.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('leveldb out',{
 | 
			
		||||
        category: 'storage-output',
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										13
									
								
								storage/leveldb/locales/en-US/67-leveldb.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								storage/leveldb/locales/en-US/67-leveldb.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,13 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="leveldb in">
 | 
			
		||||
    <p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
 | 
			
		||||
    <p>Use this node to <b>get</b>, or retrieve the data already saved in the database.</p>
 | 
			
		||||
    <p><code>msg.topic</code> must hold the <i>key</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
 | 
			
		||||
    <p>If nothing is found for the key then <code>msg.payload</code> is set to the <i>null</i> object.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="leveldb out">
 | 
			
		||||
    <p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
 | 
			
		||||
    <p>Use this node to either <b>put</b> (store) the <code>msg.payload</code> to the named database file, using <code>msg.topic</code> as the key.</p>
 | 
			
		||||
    <p>To <b>delete</b> information select delete in the properties dialogue and again use <code>msg.topic</code> as the key.</b>.</p>
 | 
			
		||||
</script>
 | 
			
		||||
@@ -55,13 +55,6 @@
 | 
			
		||||
    });
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="MySQLdatabase">
 | 
			
		||||
    <p>Add the credentials for accessing your database here.</p>
 | 
			
		||||
    <p>Timezone can be set like GMT, EST5EDT, UTC, etc</p>
 | 
			
		||||
    <p>The Charset defaults to the "old" 3 byte Mysql UTF8. If you need support for emojis etc then use UTF8MB4.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-template-name="mysql">
 | 
			
		||||
    <div class="form-row">
 | 
			
		||||
        <label for="node-input-mydb"><i class="fa fa-database"></i> Database</label>
 | 
			
		||||
@@ -73,18 +66,6 @@
 | 
			
		||||
    </div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="mysql">
 | 
			
		||||
    <p>Allows basic access to a MySQL database.</p>
 | 
			
		||||
    <p>This node uses the <b>query</b> operation against the configured database. This does allow both INSERTS and DELETES.
 | 
			
		||||
    By its very nature it allows SQL injection... so <i>be careful out there...</i></p>
 | 
			
		||||
    <p><code>msg.topic</code> must hold the <i>query</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
 | 
			
		||||
    <p><code>msg.payload</code> can contain an array of values to bind to the topic.</p>
 | 
			
		||||
    <p>Typically the returned payload will be an array of the result rows.</p>
 | 
			
		||||
    <p>If nothing is found for the key then <i>null</i> is returned,</p>
 | 
			
		||||
    <p>The reconnect timeout in milliseconds can be changed by adding a line to <b>settings.js</b>
 | 
			
		||||
    <pre>mysqlReconnectTime: 30000,</pre></p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('mysql',{
 | 
			
		||||
        category: 'storage-input',
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										18
									
								
								storage/mysql/locales/en-US/68-mysql.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								storage/mysql/locales/en-US/68-mysql.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,18 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="MySQLdatabase">
 | 
			
		||||
    <p>Add the credentials for accessing your database here.</p>
 | 
			
		||||
    <p>Timezone can be set like GMT, EST5EDT, UTC, etc</p>
 | 
			
		||||
    <p>The Charset defaults to the "old" 3 byte Mysql UTF8. If you need support for emojis etc then use UTF8MB4.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="mysql">
 | 
			
		||||
    <p>Allows basic access to a MySQL database.</p>
 | 
			
		||||
    <p>This node uses the <b>query</b> operation against the configured database. This does allow both INSERTS and DELETES.
 | 
			
		||||
    By its very nature it allows SQL injection... so <i>be careful out there...</i></p>
 | 
			
		||||
    <p><code>msg.topic</code> must hold the <i>query</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
 | 
			
		||||
    <p><code>msg.payload</code> can contain an array of values to bind to the topic.</p>
 | 
			
		||||
    <p>Typically the returned payload will be an array of the result rows.</p>
 | 
			
		||||
    <p>If nothing is found for the key then <i>null</i> is returned,</p>
 | 
			
		||||
    <p>The reconnect timeout in milliseconds can be changed by adding a line to <b>settings.js</b>
 | 
			
		||||
    <pre>mysqlReconnectTime: 30000,</pre></p>
 | 
			
		||||
</script>
 | 
			
		||||
@@ -41,17 +41,6 @@
 | 
			
		||||
  </div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="sunrise">
 | 
			
		||||
    <p>Uses the suncalc module to generate an output at sunrise and sunset based on a specified location.</p>
 | 
			
		||||
    <p>Several choices of definition of sunrise and sunset are available, see the <i><a href = "https://github.com/mourner/suncalc" target="_new">suncalc</a></i> module for details.</p>
 | 
			
		||||
    <p>The start and end times can be offset by a number of minutes before (minus) or after (plus) the chosen event time.</p>
 | 
			
		||||
    <p>The first output emits a <code>msg.payload</code> of <i>1</i> or <i>0</i> every minute depending if in between selected times or not.
 | 
			
		||||
    The second output emits only on the transition between night to day (<i>-> 1</i>) or day to night (<i>-> 0</i>).</p>
 | 
			
		||||
    <p>It also outputs <code>msg.start</code>, <code>msg.end</code> and <code>msg.now</code> which are todays start and end times, with offsets applied, in ISO format, and the current ISO time.</p>
 | 
			
		||||
    <p><code>msg.sun</code> is an object containing the azimuth and altitude, in degrees, of the current sun position.</p>
 | 
			
		||||
    <p><code>msg.moon</code> is an object containing <thead></thead> position, phase, illumination and icon of the moon.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('sunrise',{
 | 
			
		||||
        category: 'time',
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										11
									
								
								time/suncalc/locales/en-US/79-suncalc.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								time/suncalc/locales/en-US/79-suncalc.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,11 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="sunrise">
 | 
			
		||||
    <p>Uses the suncalc module to generate an output at sunrise and sunset based on a specified location.</p>
 | 
			
		||||
    <p>Several choices of definition of sunrise and sunset are available, see the <i><a href = "https://github.com/mourner/suncalc" target="_new">suncalc</a></i> module for details.</p>
 | 
			
		||||
    <p>The start and end times can be offset by a number of minutes before (minus) or after (plus) the chosen event time.</p>
 | 
			
		||||
    <p>The first output emits a <code>msg.payload</code> of <i>1</i> or <i>0</i> every minute depending if in between selected times or not.
 | 
			
		||||
    The second output emits only on the transition between night to day (<i>-> 1</i>) or day to night (<i>-> 0</i>).</p>
 | 
			
		||||
    <p>It also outputs <code>msg.start</code>, <code>msg.end</code> and <code>msg.now</code> which are todays start and end times, with offsets applied, in ISO format, and the current ISO time.</p>
 | 
			
		||||
    <p><code>msg.sun</code> is an object containing the azimuth and altitude, in degrees, of the current sun position.</p>
 | 
			
		||||
    <p><code>msg.moon</code> is an object containing <thead></thead> position, phase, illumination and icon of the moon.</p>
 | 
			
		||||
</script>
 | 
			
		||||
							
								
								
									
										12
									
								
								time/timeswitch/locales/en-US/timeswitch.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								time/timeswitch/locales/en-US/timeswitch.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,12 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="timeswitch">
 | 
			
		||||
    <p>Timeswitch node to schedule daily on/off events.</p>
 | 
			
		||||
    <p>Sets <code>msg.payload</code> to 1 at on time, and 0 at off time.</p>
 | 
			
		||||
    <p>Also allows the use of sunrise and sunset.</p>
 | 
			
		||||
    <p>Sunrise and sunset times can be offset both positively (+ve) for minutes later
 | 
			
		||||
    or negatively (-ve) for minutes earlier.</p>
 | 
			
		||||
    <p>The output emits a <code>msg.payload</code> of <i>1</i> or <i>0</i> every minute depending on
 | 
			
		||||
    whether the current time is during the selected on time or off time.</p>
 | 
			
		||||
    <p>If you just need the transitions from 0->1 or 1->0 then follow this node with an RBE node.</p>
 | 
			
		||||
    <p>You may also optionally specify a <code>msg.topic</code> if required.</p>
 | 
			
		||||
</script>
 | 
			
		||||
@@ -876,18 +876,6 @@
 | 
			
		||||
    </div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="timeswitch">
 | 
			
		||||
    <p>Timeswitch node to schedule daily on/off events.</p>
 | 
			
		||||
    <p>Sets <code>msg.payload</code> to 1 at on time, and 0 at off time.</p>
 | 
			
		||||
    <p>Also allows the use of sunrise and sunset.</p>
 | 
			
		||||
    <p>Sunrise and sunset times can be offset both positively (+ve) for minutes later
 | 
			
		||||
    or negatively (-ve) for minutes earlier.</p>
 | 
			
		||||
    <p>The output emits a <code>msg.payload</code> of <i>1</i> or <i>0</i> every minute depending on
 | 
			
		||||
    whether the current time is during the selected on time or off time.</p>
 | 
			
		||||
    <p>If you just need the transitions from 0->1 or 1->0 then follow this node with an RBE node.</p>
 | 
			
		||||
    <p>You may also optionally specify a <code>msg.topic</code> if required.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
 | 
			
		||||
    function getSunriseSunsetUsage() {
 | 
			
		||||
 
 | 
			
		||||
@@ -20,70 +20,6 @@
 | 
			
		||||
    </div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="annotate-image">
 | 
			
		||||
    <p>A node that can annotate JPEG images with simple shapes and labels.</p>
 | 
			
		||||
    <h3>Inputs</h3>
 | 
			
		||||
    <dl class="message-properties">
 | 
			
		||||
        <dt>payload<span class="property-type">Buffer</span></dt>
 | 
			
		||||
        <dd>A Buffer containing a JPEG image. Support for PNG will come soon.</dd>
 | 
			
		||||
        <dt>annotations<span class="property-type">Array</span></dt>
 | 
			
		||||
        <dd>An array of annotations to apply to the image. See below for details
 | 
			
		||||
            of the annotation format.</dd>
 | 
			
		||||
    </dl>
 | 
			
		||||
    <h3>Outputs</h3>
 | 
			
		||||
    <dl class="message-properties">
 | 
			
		||||
        <dt>payload<span class="property-type">Buffer</span></dt>
 | 
			
		||||
        <dd>The image with any annotations applied.</dd>
 | 
			
		||||
    </dl>
 | 
			
		||||
    <h3>Details</h3>
 | 
			
		||||
    <p>The annotations provided in <code>msg.annotations</code> are applied in order.
 | 
			
		||||
       Each annotation is an object with the following properties:</p>
 | 
			
		||||
        <dl class="message-properties">
 | 
			
		||||
            <dt>type<span class="property-type">string</span></dt>
 | 
			
		||||
            <dd><ul>
 | 
			
		||||
                <li><code>"rect"</code> - draws a rectangle</li>
 | 
			
		||||
                <li><code>"circle"</code> - draws a circle</li>
 | 
			
		||||
            </dd>
 | 
			
		||||
            <dt>x,y <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The top-left corner of a <code>rect</code> annotation, or the center of a <code>circle</code> annotation.</dd>
 | 
			
		||||
            <dt>w,h <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The width and height of a <code>rect</code> annotation.</dd>
 | 
			
		||||
            <dt>r <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The radius of a <code>circle</code> annotation.</dd>
 | 
			
		||||
            <dt>bbox <span class="property-type">array</span></dt>
 | 
			
		||||
            <dd>This can be used instead of <code>x</code>,<code>y</code>,<code>w</code>,<code>h</code> and <code>r</code>. It should
 | 
			
		||||
                be an array of four values giving the bounding box of the annotation: <code>[x, y, w, h]</code>.<br>
 | 
			
		||||
                If this property is set and <code>type</code> is not set, it will default to <code>rect</code>.</dd>
 | 
			
		||||
            <dt>label <span class="property-type">string</span></dt>
 | 
			
		||||
            <dd>An optional piece of text to label the annotation with</dd>
 | 
			
		||||
            <dt>stroke <span class="property-type">string</span></dt>
 | 
			
		||||
            <dd>The line color of the annotation. Default: <code>"#ffC000"</code></dd>
 | 
			
		||||
            <dt>lineWidth <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The stroke width used to draw the annotation. Default: <code>5</code></dd>
 | 
			
		||||
            <dt>fontSize <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The font size to use for the label. Default: <code>24</code></dd>
 | 
			
		||||
            <dt>fontColor <span class="property-type">string</span></dt>
 | 
			
		||||
            <dd>The color of the font to use for the label. Default: <code>"#ffC000"</code></dd>
 | 
			
		||||
            <dt>labelLocation <span class="property-type">string</span></dt>
 | 
			
		||||
            <dd>The location to place the label. Can be set to <code>top</code> or <code>bottom</code>.
 | 
			
		||||
                Default: <code>"automatic"</code>.</dd>
 | 
			
		||||
        </dl>
 | 
			
		||||
    <h3>Examples</h3>
 | 
			
		||||
    <pre> msg.annotations = [ {
 | 
			
		||||
    type: "rect",
 | 
			
		||||
    x: 10, y: 10, w: 50, h: 50,
 | 
			
		||||
    label: "hello"
 | 
			
		||||
}]</pre>
 | 
			
		||||
<pre> msg.annotations = [ {
 | 
			
		||||
    type: "circle",
 | 
			
		||||
    x: 50, y: 50, r: 20
 | 
			
		||||
}]</pre>
 | 
			
		||||
<pre> msg.annotations = [ {
 | 
			
		||||
    type: "rect",
 | 
			
		||||
    bbox: [ 10, 10, 50, 50]
 | 
			
		||||
}]</pre>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
 | 
			
		||||
(function() {
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										64
									
								
								utility/annotate-image/locales/en-US/annotate.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										64
									
								
								utility/annotate-image/locales/en-US/annotate.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,64 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="annotate-image">
 | 
			
		||||
    <p>A node that can annotate JPEG images with simple shapes and labels.</p>
 | 
			
		||||
    <h3>Inputs</h3>
 | 
			
		||||
    <dl class="message-properties">
 | 
			
		||||
        <dt>payload<span class="property-type">Buffer</span></dt>
 | 
			
		||||
        <dd>A Buffer containing a JPEG image. Support for PNG will come soon.</dd>
 | 
			
		||||
        <dt>annotations<span class="property-type">Array</span></dt>
 | 
			
		||||
        <dd>An array of annotations to apply to the image. See below for details
 | 
			
		||||
            of the annotation format.</dd>
 | 
			
		||||
    </dl>
 | 
			
		||||
    <h3>Outputs</h3>
 | 
			
		||||
    <dl class="message-properties">
 | 
			
		||||
        <dt>payload<span class="property-type">Buffer</span></dt>
 | 
			
		||||
        <dd>The image with any annotations applied.</dd>
 | 
			
		||||
    </dl>
 | 
			
		||||
    <h3>Details</h3>
 | 
			
		||||
    <p>The annotations provided in <code>msg.annotations</code> are applied in order.
 | 
			
		||||
       Each annotation is an object with the following properties:</p>
 | 
			
		||||
        <dl class="message-properties">
 | 
			
		||||
            <dt>type<span class="property-type">string</span></dt>
 | 
			
		||||
            <dd><ul>
 | 
			
		||||
                <li><code>"rect"</code> - draws a rectangle</li>
 | 
			
		||||
                <li><code>"circle"</code> - draws a circle</li>
 | 
			
		||||
            </dd>
 | 
			
		||||
            <dt>x,y <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The top-left corner of a <code>rect</code> annotation, or the center of a <code>circle</code> annotation.</dd>
 | 
			
		||||
            <dt>w,h <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The width and height of a <code>rect</code> annotation.</dd>
 | 
			
		||||
            <dt>r <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The radius of a <code>circle</code> annotation.</dd>
 | 
			
		||||
            <dt>bbox <span class="property-type">array</span></dt>
 | 
			
		||||
            <dd>This can be used instead of <code>x</code>,<code>y</code>,<code>w</code>,<code>h</code> and <code>r</code>. It should
 | 
			
		||||
                be an array of four values giving the bounding box of the annotation: <code>[x, y, w, h]</code>.<br>
 | 
			
		||||
                If this property is set and <code>type</code> is not set, it will default to <code>rect</code>.</dd>
 | 
			
		||||
            <dt>label <span class="property-type">string</span></dt>
 | 
			
		||||
            <dd>An optional piece of text to label the annotation with</dd>
 | 
			
		||||
            <dt>stroke <span class="property-type">string</span></dt>
 | 
			
		||||
            <dd>The line color of the annotation. Default: <code>"#ffC000"</code></dd>
 | 
			
		||||
            <dt>lineWidth <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The stroke width used to draw the annotation. Default: <code>5</code></dd>
 | 
			
		||||
            <dt>fontSize <span class="property-type">number</span></dt>
 | 
			
		||||
            <dd>The font size to use for the label. Default: <code>24</code></dd>
 | 
			
		||||
            <dt>fontColor <span class="property-type">string</span></dt>
 | 
			
		||||
            <dd>The color of the font to use for the label. Default: <code>"#ffC000"</code></dd>
 | 
			
		||||
            <dt>labelLocation <span class="property-type">string</span></dt>
 | 
			
		||||
            <dd>The location to place the label. Can be set to <code>top</code> or <code>bottom</code>.
 | 
			
		||||
                Default: <code>"automatic"</code>.</dd>
 | 
			
		||||
        </dl>
 | 
			
		||||
    <h3>Examples</h3>
 | 
			
		||||
    <pre> msg.annotations = [ {
 | 
			
		||||
    type: "rect",
 | 
			
		||||
    x: 10, y: 10, w: 50, h: 50,
 | 
			
		||||
    label: "hello"
 | 
			
		||||
}]</pre>
 | 
			
		||||
<pre> msg.annotations = [ {
 | 
			
		||||
    type: "circle",
 | 
			
		||||
    x: 50, y: 50, r: 20
 | 
			
		||||
}]</pre>
 | 
			
		||||
<pre> msg.annotations = [ {
 | 
			
		||||
    type: "rect",
 | 
			
		||||
    bbox: [ 10, 10, 50, 50]
 | 
			
		||||
}]</pre>
 | 
			
		||||
</script>
 | 
			
		||||
@@ -49,16 +49,6 @@
 | 
			
		||||
    All parameters should be passed in as arguments.</div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="daemon">
 | 
			
		||||
    <p>Calls out to a long running system command. Sends <code>msg.payload</code> to stdin of the process.</p>
 | 
			
		||||
    <p>Provides 3 outputs... stdout, stderr, and return code , from the running command.</p>
 | 
			
		||||
    <p>If the called program stops (i.e. a return code is produced), this node can attempt to restart the command.</p>
 | 
			
		||||
    <p>Setting <code>msg.kill</code> to a signal name (e.g. SIGINT, SIGHUP) will stop the process - but if the
 | 
			
		||||
    restart flag is set it will then auto restart. Sending <code>msg.start</code> will also re-start the process.</p>
 | 
			
		||||
    <p><b>Note:</b> Some applications will automatically buffer lines of output. It is advisable to turn off this behaviour.
 | 
			
		||||
    For example, if running a Python app, the <code>-u</code> parameter will stop the output being buffered.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('daemon',{
 | 
			
		||||
        category: 'function',
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										10
									
								
								utility/daemon/locales/en-US/daemon.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								utility/daemon/locales/en-US/daemon.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,10 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="daemon">
 | 
			
		||||
    <p>Calls out to a long running system command. Sends <code>msg.payload</code> to stdin of the process.</p>
 | 
			
		||||
    <p>Provides 3 outputs... stdout, stderr, and return code , from the running command.</p>
 | 
			
		||||
    <p>If the called program stops (i.e. a return code is produced), this node can attempt to restart the command.</p>
 | 
			
		||||
    <p>Setting <code>msg.kill</code> to a signal name (e.g. SIGINT, SIGHUP) will stop the process - but if the
 | 
			
		||||
    restart flag is set it will then auto restart. Sending <code>msg.start</code> will also re-start the process.</p>
 | 
			
		||||
    <p><b>Note:</b> Some applications will automatically buffer lines of output. It is advisable to turn off this behaviour.
 | 
			
		||||
    For example, if running a Python app, the <code>-u</code> parameter will stop the output being buffered.</p>
 | 
			
		||||
</script>
 | 
			
		||||
@@ -17,17 +17,6 @@
 | 
			
		||||
    </div>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="exif">
 | 
			
		||||
    <p>Extract <a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format">Exif</a> information from JPEG images.</p>
 | 
			
		||||
    <p>This node expects an incoming JPEG image buffer in the selected property. If Exif data is present,
 | 
			
		||||
    it extracts the data into the <code>msg.exif</code> object.</p>
 | 
			
		||||
    <p>The node then adds location data as <code>msg.location</code>, should the Exif data carry this information.
 | 
			
		||||
    This also includes an icon, bearing and field of view arc suitable for use in the worldmap node.
 | 
			
		||||
    The selected input property retains the original, unmodified image buffer.</p>
 | 
			
		||||
    <p>If configured to use the worldmap in node then the existing image payload will be replaced by the location
 | 
			
		||||
    object so that it can be fed back to the map directly.</p>
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<script type="text/javascript">
 | 
			
		||||
    RED.nodes.registerType('exif',{
 | 
			
		||||
        category: 'utility',
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										11
									
								
								utility/exif/locales/en-US/94-exif.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								utility/exif/locales/en-US/94-exif.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,11 @@
 | 
			
		||||
 | 
			
		||||
<script type="text/html" data-help-name="exif">
 | 
			
		||||
    <p>Extract <a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format">Exif</a> information from JPEG images.</p>
 | 
			
		||||
    <p>This node expects an incoming JPEG image buffer in the selected property. If Exif data is present,
 | 
			
		||||
    it extracts the data into the <code>msg.exif</code> object.</p>
 | 
			
		||||
    <p>The node then adds location data as <code>msg.location</code>, should the Exif data carry this information.
 | 
			
		||||
    This also includes an icon, bearing and field of view arc suitable for use in the worldmap node.
 | 
			
		||||
    The selected input property retains the original, unmodified image buffer.</p>
 | 
			
		||||
    <p>If configured to use the worldmap in node then the existing image payload will be replaced by the location
 | 
			
		||||
    object so that it can be fed back to the map directly.</p>
 | 
			
		||||
</script>
 | 
			
		||||
		Reference in New Issue
	
	Block a user