node-red

2025-08-28 16:20:24 +08:00
parent 61e533cddf
commit 73e887ebf4
1539 changed files with 360926 additions and 0 deletions
@@ -0,0 +1,34 @@
+<!--
+  Copyright JS Foundation and other contributors, http://js.foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<script type="text/html" data-help-name="inject">
+<p>手動もしくは一定間隔でメッセージをフローに注入します。メッセージのペイロードには、文字列、JavaScriptオブジェクト、現在の時刻など、さまざまな値を指定できます。</p>
+<h3>出力</h3>
+<dl class="message-properties">
+    <dt>payload<span class="property-type">各種</span></dt>
+    <dd>指定したメッセージペイロード。</dd>
+    <dt class="optional">topic <span class="property-type">文字列</span></dt>
+    <dd>任意で指定可能なプロパティ。</dd>
+</dl>
+<h3>詳細</h3>
+<p>injectノードを用いることで、指定したペイロード値を用いてフローを開始できます。デフォルトのペイロード値は現在時刻のタイムスタンプを1970年1月1日からの経過ミリ秒で表現した値です。</p>
+<p>文字列、数値、真偽値、JavaScriptオブジェクト、フロー/グローバルコンテキストの値などの送出も可能です。</p>
+<p> デフォルト設定では、エディタ内に表示されるボタンをクリックすることで、ノードを手動で起動できます。指定間隔もしくはスケジュールに従ってメッセージを送出するように設定することも可能です。</p>
+<p>また、フロー開始の際に一度だけメッセージを送出させることもできます。</p>
+<p>「<i>時間間隔</i>」に指定可能な値の最大値は、約596時間(もしくは24日)です。一日より長い間隔を扱いたい場合は、電源停止や再起動にも対応可能なスケジューラノードの利用を検討すると良いでしょう。</p>
+<p><b>注</b>:「<i>指定した時間間隔、日時</i>」と「<i>指定した日時</i>」オプションは標準的なcronシステムを内部で利用します。したがって「20分」という指定は、その時点から20分後ではなく、毎時きっかり、20分、40分を意味します。現時刻から20分毎を指定するには「<i>指定した時間間隔</i>」オプションを用います。</p>
+<p><b>注</b>: 文字列に改行を含めたい場合は、functionノードまたはtemplateノードを使ってペイロードを設定してください。</p>
+</script>
@@ -0,0 +1,26 @@
+<!--
+  Copyright JS Foundation and other contributors, http://js.foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<script type="text/html" data-help-name="debug">
+    <p>サイドバーの「デバッグ」タブに、選択したメッセージプロパティの値を表示します。設定により、ランタイムログへの出力も可能です。デフォルトの表示対象は<code>msg.payload</code>ですが、設定により、指定したプロパティ、メッセージ全体、もしくは、JSONata式の評価結果を出力できます。</p>
+    <h3>詳細</h3>
+    <p>「デバッグ」サイドバーは受け取ったメッセージの階層構造を表示する機能を備えます。この機能によりメッセージの構造を容易に理解できます。</p>
+    <p>JavaScriptオブジェクトと配列は必要に応じて折り畳んだり展開したりできます。バッファオブジェクトを生データとして表示したり、表現可能な場合に文字列として表示したりすることも可能です。</p>
+    <p>メッセージを受信した時刻、送信ノード、メッセージの型に関する情報を「デバッグ」サイドバーに表示されたメッセージに付随して表示します。送信元ノードのIDを選択すると、ワークスペース内の対応ノードを確認できます。</p>
+    <p>出力の有効/無効はノード上のボタンで切り替えられます。フロー上で未使用のdebugノードは、無効化するか削除することを推奨します。</p>
+    <p>全てのメッセージをランタイムログに送付、もしくは、(32文字の)短いデータをdebugノードの下のステータステキストに表示することも可能です。</p>
+</script>
+
@@ -0,0 +1,24 @@
+<!--
+  Copyright JS Foundation and other contributors, http://js.foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<script type="text/html" data-help-name="complete">
+    <p>他のノードにおけるメッセージ処理の完了を受けてフローを開始します。</p>
+    <h3>詳細</h3>
+    <p>ノードからランタイムに対してメッセージ処理の完了が通知されると、本ノードによって次のフローを開始できます。</p>
+    <p>本ノードは出力ポートを持たないノードと共に用いる場合などに有用です。例えば、Email送信ノードで送信後にフローを起動する場合がこれに当たります。</p>
+    <p>このノードはフロー内で選択したノードに対するイベントを処理するように設定します。Catchノードとは異なり、「全てのノード」モードを指定して、フロー中の全てのノードを対象とすることはできません。</p>
+    <p>全てのノードで本ノードのイベント処理を開始するわけではありません。Node-RED 1.0で導入した本機能を対象ノードがサポートしている必要があります。</p>
+</script>
@@ -0,0 +1,36 @@
+<!--
+  Copyright JS Foundation and other contributors, http://js.foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<script type="text/html" data-help-name="catch">
+    <p>同じタブ内のノードが送出したエラーをキャッチします。</p>
+    <h3>出力</h3>
+    <dl class="message-properties">
+        <dt>error.message <span class="property-type">文字列</span></dt>
+        <dd>エラーメッセージ</dd>
+        <dt>error.source.id <span class="property-type">文字列</span></dt>
+        <dd>エラーを送出したノードのID</dd>
+        <dt>error.source.type <span class="property-type">文字列</span></dt>
+        <dd>エラーを送出したノードの種別</dd>
+        <dt>error.source.name <span class="property-type">文字列</span></dt>
+        <dd>エラーを送出したノードの名称(設定されている場合)</dd>
+    </dl>
+    <h3>詳細</h3>
+    <p>メッセージの処理中にノードがエラーを送出した場合、フロー実行は基本的に停止します。このノードを使うと、エラーをキャッチして対応するフローで処理させることができます。</p>
+    <p>デフォルトでは、同じタブの全てのノードが送出したエラーをキャッチします。特定のノードをキャッチ対象とするか、対象catchノードで補足されていないエラーのみ補足するように指定することも可能です。</p>
+    <p>エラー発生時には、マッチするすべてのcatchノードがメッセージを受け取ります。</p>
+    <p>サブフロー内でエラーが送出された場合、まずサブフロー内のcatchノードで処理されます。対応するノードが存在しない場合には、そのサブフローが配置されたタブにエラーを伝播して処理します。</p>
+    <p>メッセージが<code>error</code>プロパティを持っている場合、元の<code>error</code>は<code>_error</code>へコピーします。</p>
+</script>
@@ -0,0 +1,33 @@
+<!--
+  Copyright JS Foundation and other contributors, http://js.foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<script type="text/html" data-help-name="status">
+    <p>同じタブ内のノードのステータスメッセージを取得します。</p>
+    <h3>出力</h3>
+    <dl class="message-properties">
+        <dt>status.text <span class="property-type">文字列</span></dt>
+        <dd>ステータス文字列</dd>
+        <dt>status.source.type <span class="property-type">文字列</span></dt>
+        <dd>ステータスを表示したノードの種別</dd>
+        <dt>status.source.id <span class="property-type">文字列</span></dt>
+        <dd>ステータスを表示したノードのID</dd>
+        <dt>status.source.name <span class="property-type">文字列</span></dt>
+        <dd>ステータスを表示したノードの名称(設定されている場合)</dd>
+    </dl>
+    <h3>詳細</h3>
+    <p>このノードは<code>payload</code>を設定しません。</p>
+    <p>デフォルトでは、同じワークスペースタブ内の全てのノードのステータスを取得します。特定のノードのステータスを取得対象とすることも可能です。</p>
+</script>
@@ -0,0 +1,53 @@
+<!--
+  Copyright JS Foundation and other contributors, http://js.foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<script type="text/html" data-help-name="link in">
+    <p>フロー間に仮想的なリンクを作成します。</p>
+    <h3>詳細</h3>
+    <p>任意のタブ上に存在する<code>link out</code>ノードに接続できます。この接続はあたかも直接リンクしたかのように動作します。</p>
+    <p>linkノード間のリンクはlinkノードを選択した場合にのみ表示されます。他のタブへのリンクがある場合には、仮想的なノードを表示します。この仮想的ノードをクリックすると、対応するタブに移動できます。</p>
+    <p><b>注: </b>サブフローの外から中、もしくは、中から外へのリンクを作成することはできません。</p>
+</script>
+
+<script type="text/html" data-help-name="link out">
+    <p>フロー間に仮想的なリンクを作成します。</p>
+    <h3>詳細</h3>
+    <p>任意のタブ上に存在する<code>link in</code>ノードに接続できます。この接続はあたかも直接リンクしたかのように動作します。</p>
+    <p>linkノード間のリンクはlinkノードを選択した場合にのみ表示されます。他のタブへのリンクがある場合には、仮想的なノードを表示します。この仮想的ノードをクリックすると、対応するタブに移動できます。</p>
+    <p><b>注: </b>サブフローの外から中、もしくは、中から外へのリンクを作成することはできません。</p>
+</script>
+
+<script type="text/html" data-help-name="link call">
+    <p><code>link in</code> で始まり、応答を返すフローを呼び出します。</p>
+    <h3>入力</h3>
+    <dl class="message-properties">
+      <dt class="optional">target<span class="property-type">文字列</span></dt>
+      <dd><b>リンクの種類</b>で"対象を動的に指定"を選択した場合、<code>msg.target</code>に呼び出したい<code>link in</code>ノードの名前を指定します。</dd>
+    </dl>
+    <h3>詳細</h3>
+    <p>本ノードは、任意のタブ内に存在する <code>link in</code> ノードに接続できます。 接続先のフローは、`返却`モードが設定された <code>link out</code> ノードで終了する必要があります。</p>
+    <p>本ノードはメッセージを受信すると、メッセージを接続した <code>link in</code> ノードへ渡します。
+       その後、応答を待った後にメッセージを送信します。</o>
+    <p>もし、設定したタイムアウト(デフォルト30秒)以内に応答がない場合は、<code>catch</code> ノードを用いてエラーをログに記録することもできます。</p>
+    <p><b>リンクの種類</b>で"対象を動的に指定"を選択した場合、<code>link in</code>ノードのIDもしくは名前を<code>msg.target</code>に指定して呼び出すことができます。
+    <ul>
+      <li>同じIDの<code>link in</code>ノードがある場合、それを呼び出します。</li>
+      <li>もし、同じ名前を付けた<code>link in</code>ノードが2つ以上ある場合、エラーが発生します。</li>
+      <li><code>link call</code>は、サブフローの中の<code>link in</code>ノードを呼び出すことはできません。</li>
+    </ul>
+    </p>
+    本ノードから呼び出すフローは、終端の<code>link out</code>ノードに'返却'モードを設定する必要があります。</p>
+</script>
@@ -0,0 +1,21 @@
+<!--
+  Copyright JS Foundation and other contributors, http://js.foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<script type="text/html" data-help-name="comment">
+    <p>フローにコメントを記述するために利用します。</p>
+    <h3>詳細</h3>
+    <p>編集パネルはMarkdown形式を記入可能です。入力したテキストは、「情報」サイドパネルに表示されます。</p>
+</script>
@@ -0,0 +1,3 @@
+<script type="text/html" data-help-name="global-config">
+    <p>大域的なフローの設定を保持するノード。グローバル環境変数の定義を含みます。</p>
+</script>
@@ -0,0 +1,24 @@
+<!--
+  Copyright JS Foundation and other contributors, http://js.foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<script type="text/html" data-help-name="unknown">
+    <p>インストールされたNode-REDが認識できない種別のノードです。</p>
+    <h3>詳細</h3>
+    <p><i>この種別のノードをデプロイした場合、設定は保持されますが、足りないノードをインストールするまでフローを開始することはできません。</i></p>
+    <p><code>メニュー - パレットの管理</code>を使ってノードの検索とインストールを行うか、<b>npm install &lt;モジュール&gt;</b>で不足モジュールのインストールを行ってNode-REDを再起動した後、ノードを再インポートしてください。</p>
+    <p>この種別のノードがインストール済みであるが依存ライブラリがインストールされていないケースもあります。Node-REDの起動ログを参照して不足ノードに関連したエラーメッセージをチェックすると良いでしょう。</p>
+    <p>それでも解決しない場合、フローの作者に依頼して不足ノードのコピーを入手してください。</p>
+</script>