Node-REDでTCP通信操作をするときの設定手順のメモ。
鶏頭で忘れっぽいのでメモ。

Node-REDは起動済みでブラウザで接続済みであるものとします。

UDPで送信

パレット(左側のペイン)の「出力」の下の「UDP」をフローにドラッグ&ドロップ
ドロップした「UDP」をダブルクリック → 編集メニューが表示される
- 「送信」で出力するメッセージ種別を選択
  - 「UDPメッセージ」(ユニキャスト)/「ブロードキャストメッセージ」/「マルチキャストメッセージ」から選択
- 「ポート」で送信先ポート番号を設定
  - 受信プログラムが待ち受けしているポート番号を指定
- 「アドレス」に送信先アドレス(名前 or IPアドレス)を指定
- さらにその右で使用するIPプロトコル(IPv4/IPv6)を選択
- 特定のポートから送信したいときは「ローカルポートを使用」を選択し、その右に送信元ポート番号を指定する
  - ポート番号は0 ～ 65535が指定可能
  - ただし、1023以下のポート番号は特権ポートなので管理者しか使用できない
  - 使用済みポート番号は指定できない
  - 通常は「ローカルポートをランダムに使用」で大丈夫
- 入力データがBase64エンコードされたBufferオブジェクトの場合は「Base64形式のペイロードを複合」にチェックを入れる
  - 入力データがBase64文字列かをチェックするだけで、ここでデータを変換するわけではない(?)
  - 通常はチェックしないでOK
- 必要なら「名前」を設定
  - 省略すると送信先アドレスとポートが表示される
- 右上の「完了」をクリック
送信データを作成するノードを接続
- UDPノードはmsg.payloadを送信する
デプロイする

UDPで受信

パレットの「入力」の下の「UDP」をフローにドラッグ&ドロップ
ドロップした「UDP」をダブルクリック → 編集メニューが表示される
- 「待ち受け」で受信待ちするするメッセージ種別を選択
  - 「UDPメッセージ」(ユニキャスト or マルチキャスト)/「ブロードキャストメッセージ」から選択
- 「ポート」で受信待ちポート番号を設定
  - ポート番号は0 ～ 65535が指定可能
  - ただし、1023以下のポート番号は特権ポートなので管理者しか使用できない
  - 使用済みポート番号は指定できない
- 「種類」で使用するIPプロトコル(IPv4/IPv6)を選択
- 「出力」で受信したデータをどのような形式で次段のノードに出力するかを選択する
  - 「バイナリバッファ」を選択すると受信したデータをそのままbufferオブジェクトとして出力
  - 「文字列」を選択すると受信したデータをStringオブジェクトにデコードする
  - 「Base64文字列」を選択すると受信したデータをBase64 Stringオブジェクトにデコードする
  - 「Base64文字列」と「文字列」は内部でtoStringのencodingに’base64’を指定するか’utf8’を指定するかの違い(?)
- 必要なら「名前」を設定
  - 省略すると受信待ちポートが表示される
- 右上の「完了」をクリック
受信データを処理するノードを接続
デプロイする

フローの例

[
    {
        "id": "2506be7d.1b5332",
        "type": "tab",
        "label": "UDP",
        "disabled": false,
        "info": ""
    },
    {
        "id": "44364ec0.0b59b8",
        "type": "udp out",
        "z": "2506be7d.1b5332",
        "name": "",
        "addr": "localhost",
        "iface": "",
        "port": "4000",
        "ipv": "udp4",
        "outport": "",
        "base64": false,
        "multicast": "false",
        "x": 550,
        "y": 80,
        "wires": []
    },
    {
        "id": "20cee006.2fee4",
        "type": "inject",
        "z": "2506be7d.1b5332",
        "name": "",
        "topic": "",
        "payload": "",
        "payloadType": "date",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 150,
        "y": 80,
        "wires": [
            [
                "44364ec0.0b59b8"
            ]
        ]
    },
    {
        "id": "eb875fd8.7aa5f8",
        "type": "udp in",
        "z": "2506be7d.1b5332",
        "name": "",
        "iface": "",
        "port": "4000",
        "ipv": "udp4",
        "multicast": "false",
        "group": "",
        "datatype": "utf8",
        "x": 160,
        "y": 140,
        "wires": [
            [
                "a6b72636.514e2"
            ]
        ]
    },
    {
        "id": "a6b72636.514e2",
        "type": "debug",
        "z": "2506be7d.1b5332",
        "name": "",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "x": 520,
        "y": 140,
        "wires": []
    }
]
 

HTTPでREST API

HTTP入力ノードの作成

パレットの「入力」の下の「http」をフローにドラッグ&ドロップ
ドロップした「http」をダブルクリック → 編集メニューが表示される
- 「メソッド」でメソッド種別を選択
  - ここでは「GET」で設定を進める(他のメソッドは他所で調べてね)
- 「URL」でエンドポイント(要はパス)を設定
- 必要なら「名前」を設定
  - 省略するとメソッドとURLが表示される
- 右上の「完了」をクリック
レスポンスを作成するノード(下記)を接続

レスポンス生成ノードの作成

ここでは、簡単にfunctionノードで固定文字列を返すものを作っています。

パレットの「機能」の下の「function」をフローにドラッグ&ドロップ
ドロップした「http」をダブルクリック → 編集メニューが表示される
- 必要なら「名前」を設定
  - 省略すると空欄になるので、なるべく識別できる名前を付けましょう
- 「コード」に処理するプログラムを記述
  - msg.payloadに表示するページの本文を設定する
  - 例えば以下
- 「名前」の横のアイコンをクリックすると作成したノードの保存/読み込みが出来る
  - コードは ~/.node-red/lib/functions/ に指定したフォルダとファイル名で保存される
  - 保存したコードは別のノードで読み込むことができる
- 右上の「完了」をクリック

msg.payload = "<h1> ぼ～っと生きてんじゃね～よ！ </H1>";
return msg;

HTTP出力ノードの作成

パレットの「出力」の下の「http response」をフローにドラッグ&ドロップ
ドロップした「http」をダブルクリック → 編集メニューが表示される
- 必要なら「名前」を設定
  - 省略すると「http」と表示される
- 必要なら「状態コード」を設定
- 必要なら「ヘッダ」を設定
- シンプルな処理の場合、何も設定しなくてもOK

入力、レスポンス生成、出力を接続

上記で作成したノードを接続
デプロイする

ブラウザでアクセス接続

ブラウザで、http://対象IPアドレス:1880/《HTTP入力ノードに設定したURL》に接続
- ブラウザにレスポンス生成ノードで作成したメッセージが表示される

フローの例

[
    {
        "id": "7508e635.c8bf48",
        "type": "tab",
        "label": "HTTP_REST",
        "disabled": false,
        "info": ""
    },
    {
        "id": "c7938d8a.3ae9d",
        "type": "http in",
        "z": "7508e635.c8bf48",
        "name": "",
        "url": "/rest_api_1",
        "method": "get",
        "upload": false,
        "swaggerDoc": "",
        "x": 160,
        "y": 60,
        "wires": [
            [
                "fb01d5fd.b76918",
                "86c0f820.b0a56"
            ]
        ]
    },
    {
        "id": "fb01d5fd.b76918",
        "type": "function",
        "z": "7508e635.c8bf48",
        "name": "ぼ～っと生きてんじゃね～よ！",
        "func": "msg.payload = \"<h1> ぼ～っと生きてんじゃね～よ！ </H1>\";\nreturn msg;\n",
        "outputs": 1,
        "noerr": 0,
        "x": 430,
        "y": 60,
        "wires": [
            [
                "8d3518af.f9da7",
                "86c0f820.b0a56"
            ]
        ]
    },
    {
        "id": "8d3518af.f9da7",
        "type": "http response",
        "z": "7508e635.c8bf48",
        "name": "",
        "statusCode": "",
        "headers": {},
        "x": 690,
        "y": 60,
        "wires": []
    },
    {
        "id": "86c0f820.b0a56",
        "type": "debug",
        "z": "7508e635.c8bf48",
        "name": "",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "x": 700,
        "y": 120,
        "wires": []
    }
]

Websocketでデータを送受信

テストツールのインストール

ここではテストツールにwscatを使うこととします。
wscat は以下のコマンドでインストールできます。

sudo npm install -g wscat

Websocketでデータ送信(クライアント)

クライアントとしてWebsocketでデータを送信してみます

パレットの「出力」の下の「websocket」をフローにドラッグ&ドロップ
ドロップした「websocket」をダブルクリック → 編集メニューが表示される
- 「種類」で「接続」を選択
- 「URL」で「新規に websocket-client を追加」を選択してその右の編集ボタンをクリック
  - 「URL」でサーバのURLを設定(例： ws://PiDev25.local:5000/ws/data01)
  - 「送信/受信」でペイロードのみ送受信するか、メッセージ全体を送受信するかを選択
  - 追加をクリック
- または既に設定されているサーバを選択
- URL に今設定したURLが表示されていることを確認
- 必要なら「名前」を設定
  - 省略するとURLが表示される
- 完了をクリック
トリガとなるノードを接続
- 送信データは文字列の場合、そのまま送信される。
- 数値の場合、文字列に変換して送信される。
  - 受信側では文字列→数値変換を行う必要がある
- オブジェクトの場合、JSON文字列に変換して送信される。
  - 受信側ではJSON文字列のデコードを行う必要がある
デプロイする

テスト

あらかじめ、ターミナル or コンソールで以下のコマンドを実行します。以下の場合、上記設定例にあわせてマシン名PiDev25.localのマシンでポート番号5000で待ち受けしています。

wscat --listen 5000

Node-RED側で Websocketの送信をトリガするとwscatの表示に送信したデータが表示されます。
以下の表示例でデータが受信できていることが確認できます。

listening on port 5000 (press CTRL+C to quit)
client connected
< 0
< 1
< true
< false
< 文字列
< {"data1":0,"data2":1,"data3":"data"}

wscatを終了するのはCTRL-Cを入力します。

フローの例

[
    {
        "id": "75e44664.73e018",
        "type": "tab",
        "label": "Websocket_send",
        "disabled": false,
        "info": ""
    },
    {
        "id": "49b725b6.0e0934",
        "type": "websocket out",
        "z": "75e44664.73e018",
        "name": "",
        "server": "",
        "client": "99ad88ce.8bcf7",
        "x": 600,
        "y": 40,
        "wires": []
    },
    {
        "id": "762ccf62.73a48",
        "type": "inject",
        "z": "75e44664.73e018",
        "name": "",
        "topic": "",
        "payload": "0",
        "payloadType": "num",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 40,
        "wires": [
            [
                "49b725b6.0e0934"
            ]
        ]
    },
    {
        "id": "fe2498d8.71c17",
        "type": "inject",
        "z": "75e44664.73e018",
        "name": "",
        "topic": "",
        "payload": "1",
        "payloadType": "num",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 80,
        "wires": [
            [
                "49b725b6.0e0934"
            ]
        ]
    },
    {
        "id": "47ef3c99.d6eefc",
        "type": "inject",
        "z": "75e44664.73e018",
        "name": "",
        "topic": "",
        "payload": "true",
        "payloadType": "bool",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 120,
        "wires": [
            [
                "49b725b6.0e0934"
            ]
        ]
    },
    {
        "id": "f97b4d60.afc278",
        "type": "inject",
        "z": "75e44664.73e018",
        "name": "",
        "topic": "",
        "payload": "false",
        "payloadType": "bool",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 160,
        "wires": [
            [
                "49b725b6.0e0934"
            ]
        ]
    },
    {
        "id": "6d15d519.6289ec",
        "type": "inject",
        "z": "75e44664.73e018",
        "name": "",
        "topic": "",
        "payload": "文字列",
        "payloadType": "str",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 200,
        "wires": [
            [
                "49b725b6.0e0934"
            ]
        ]
    },
    {
        "id": "87c94e6f.db3458",
        "type": "inject",
        "z": "75e44664.73e018",
        "name": "オブジェクト",
        "topic": "",
        "payload": "{\"data1\":0,\"data2\":1,\"data3\":\"data\"}",
        "payloadType": "json",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 110,
        "y": 240,
        "wires": [
            [
                "49b725b6.0e0934",
                "e7c2219c.07acf8"
            ]
        ]
    },
    {
        "id": "175e465.15aaa3a",
        "type": "inject",
        "z": "75e44664.73e018",
        "name": "バッファ",
        "topic": "",
        "payload": "[0,1,2,3]",
        "payloadType": "bin",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 120,
        "y": 280,
        "wires": [
            [
                "49b725b6.0e0934",
                "e7c2219c.07acf8"
            ]
        ]
    },
    {
        "id": "e7c2219c.07acf8",
        "type": "debug",
        "z": "75e44664.73e018",
        "name": "",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "x": 520,
        "y": 280,
        "wires": []
    },
    {
        "id": "99ad88ce.8bcf7",
        "type": "websocket-client",
        "z": "",
        "path": "ws://PiDev25.local:5000/ws/data01",
        "tls": "",
        "wholemsg": "false"
    }
]

Websocketでデータ送信(サーバ)

サーバとしてWebsocketでデータを送信してみます

パレットの「出力」の下の「websocket」をフローにドラッグ&ドロップ
ドロップした「websocket」をダブルクリック → 編集メニューが表示される
- 種類で「待ち受け」を選択
- パスで「新規に websocket-listner を追加」を選択してその右の編集ボタンをクリック
  - パスを適当に設定(/ws/wsdata1 など)
    - Websocket の Listen port のポート番号は Node-RED のポート番号と同じになるので、Client側で指定するURLはそのポート番号を指定すること
  - 送信/受信で送受信するデータを選択
  - 追加をクリック
- または既に設定されているパスを選択
- パスに今設定したパスが表示されていることを確認
- 必要なら「名前」を設定
  - 省略するとパスが表示される
- 完了をクリック
トリガとなるノードを接続
デプロイする

テスト

ターミナル or コンソールで以下のコマンドを実行します。以下の場合、サーバのマシン名がPiDev25.local、サーバ側がポート番号1880、パス/ws/wstest1で待ち受けしているものとします。

wscat --connect ws://PiDev25.local:1880/ws/wstest1

connected (press CTRL+C to quit)
< 0
< 1
< true
< false
< 文字列
< {"data1":0,"data2":1,"data3":"data"}

wscatを終了するのはCTRL-Cを入力します。

フローの例

[
    {
        "id": "22d6d63b.99a952",
        "type": "tab",
        "label": "Websocket_send_server",
        "disabled": false,
        "info": ""
    },
    {
        "id": "d64e2a6a.27ead8",
        "type": "websocket out",
        "z": "22d6d63b.99a952",
        "name": "",
        "server": "d7536de3.b48578",
        "client": "",
        "x": 520,
        "y": 40,
        "wires": []
    },
    {
        "id": "79358fcc.5a5a68",
        "type": "inject",
        "z": "22d6d63b.99a952",
        "name": "",
        "topic": "",
        "payload": "0",
        "payloadType": "num",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 40,
        "wires": [
            [
                "d64e2a6a.27ead8"
            ]
        ]
    },
    {
        "id": "cd6acb87.0a77",
        "type": "inject",
        "z": "22d6d63b.99a952",
        "name": "",
        "topic": "",
        "payload": "1",
        "payloadType": "num",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 80,
        "wires": [
            [
                "d64e2a6a.27ead8"
            ]
        ]
    },
    {
        "id": "7991d417.429124",
        "type": "inject",
        "z": "22d6d63b.99a952",
        "name": "",
        "topic": "",
        "payload": "true",
        "payloadType": "bool",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 120,
        "wires": [
            [
                "d64e2a6a.27ead8"
            ]
        ]
    },
    {
        "id": "ee88046b.37b298",
        "type": "inject",
        "z": "22d6d63b.99a952",
        "name": "",
        "topic": "",
        "payload": "false",
        "payloadType": "bool",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 160,
        "wires": [
            [
                "d64e2a6a.27ead8"
            ]
        ]
    },
    {
        "id": "7eac2c2e.6fa39c",
        "type": "inject",
        "z": "22d6d63b.99a952",
        "name": "",
        "topic": "",
        "payload": "文字列",
        "payloadType": "str",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 130,
        "y": 200,
        "wires": [
            [
                "d64e2a6a.27ead8"
            ]
        ]
    },
    {
        "id": "650517e9.5e34a8",
        "type": "inject",
        "z": "22d6d63b.99a952",
        "name": "オブジェクト",
        "topic": "",
        "payload": "{\"data1\":0,\"data2\":1,\"data3\":\"data\"}",
        "payloadType": "json",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 110,
        "y": 240,
        "wires": [
            [
                "d64e2a6a.27ead8",
                "5871022e.6bbb1c"
            ]
        ]
    },
    {
        "id": "d197151e.8b01e",
        "type": "inject",
        "z": "22d6d63b.99a952",
        "name": "バッファ",
        "topic": "",
        "payload": "[0,1,2,3]",
        "payloadType": "bin",
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "x": 120,
        "y": 280,
        "wires": [
            [
                "d64e2a6a.27ead8",
                "5871022e.6bbb1c"
            ]
        ]
    },
    {
        "id": "5871022e.6bbb1c",
        "type": "debug",
        "z": "22d6d63b.99a952",
        "name": "",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "x": 520,
        "y": 280,
        "wires": []
    },
    {
        "id": "d7536de3.b48578",
        "type": "websocket-listener",
        "z": "",
        "path": "/ws/wstest1",
        "wholemsg": "false"
    }
]

Websocketでデータを受信(クライアント)

クライアントとしてWebsocketでデータを受信してみます

パレットの「入力」の下の「websocket」をフローにドラッグ&ドロップ
ドロップした「websocket」をダブルクリック → 編集メニューが表示される
- 種類で「接続」を選択
- 「URL」で「新規に websocket-client を追加」を選択してその右の編集ボタンをクリック
  - URL でサーバのURLを設定(例： ws://PiDev25.local:5002/ws/wsdata2)
  - 追加をクリック
- または既に設定されているサーバを選択
- URL に今設定したURLが表示されていることを確認
- 必要なら「名前」を設定
  - 省略するとURLが表示される
- 完了をクリック
受信したメッセージを処理するノードを接続
デプロイする

テスト

ターミナル or コンソールで以下のコマンドを実行します。以下の場合、上記設定例にあわせてマシン名PiDev25.localのマシンでポート番号5002で待ち受けしています。

wscat --listen 5002

接続されたあと、適当に文字列を入力するとNode-RED側で受信され、メッセージ処理ノードが実行されます。

listening on port 5002 (press CTRL+C to quit)
client connected
> 適当に文字を入力する     → Node-REDに送信される

wscatを終了するのはCTRL-Cを入力します。

フローの例

[
    {
        "id": "a45bd125.622fb8",
        "type": "tab",
        "label": "Websocket_recv",
        "disabled": false,
        "info": ""
    },
    {
        "id": "24a93730.cf2a7",
        "type": "websocket in",
        "z": "a45bd125.622fb8",
        "name": "",
        "server": "45ba6028.84fc88",
        "client": "",
        "x": 220,
        "y": 60,
        "wires": [
            [
                "15576052.1536"
            ]
        ]
    },
    {
        "id": "15576052.1536",
        "type": "debug",
        "z": "a45bd125.622fb8",
        "name": "",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "x": 630,
        "y": 60,
        "wires": []
    },
    {
        "id": "45ba6028.84fc88",
        "type": "websocket-listener",
        "z": "",
        "path": "ws://PiDev25.local:5002/ws/wsdata2",
        "wholemsg": "false"
    }
]

Websocketでデータを受信(サーバ)

サーバとしてWebsocketでデータを受信してみます

パレットの「入力」の下の「websocket」をフローにドラッグ&ドロップ
ドロップした「websocket」をダブルクリック → 編集メニューが表示される
- 種類で「待ち受け」を選択
- パスで「新規に websocket-listner を追加」を選択してその右の編集ボタンをクリック
  - パスを適当に設定(/ws/wsdata2 など)
    - Websocket の Listen port のポート番号は Node-RED のポート番号と同じになるので、Client側で指定するURLはそのポート番号を指定すること
  - 送信/受信で送受信するデータを選択
  - 追加をクリック
- または既に設定されているパスを選択
- パスに今設定したパスが表示されていることを確認
- 必要なら「名前」を設定
  - 省略するとパスが表示される
- 完了をクリック
受信したメッセージを処理するノードを接続
デプロイする

テスト

ターミナル or コンソールで以下のコマンドを実行します。以下の場合、サーバのマシン名がPiDev25.local、サーバ側がポート番号1880、パス/ws/wstest2で待ち受けしているものとします。

wscat --connect ws://PiDev25.local:1880/ws/wsdata2

接続されたあと、適当に文字列を入力するとNode-RED側で受信され、メッセージ処理ノードが実行されます。

connected (press CTRL+C to quit)
> 適当に文字を入力する     → Node-REDに送信される

wscatを終了するのはCTRL-Cを入力します。

フローの例

[
    {
        "id": "15604b9.9721eb4",
        "type": "tab",
        "label": "Websocket_recv_server",
        "disabled": false,
        "info": ""
    },
    {
        "id": "80f59585.469758",
        "type": "websocket in",
        "z": "15604b9.9721eb4",
        "name": "",
        "server": "11528a5d.783b0e",
        "client": "",
        "x": 140,
        "y": 60,
        "wires": [
            [
                "f37c8fe9.6307c"
            ]
        ]
    },
    {
        "id": "f37c8fe9.6307c",
        "type": "debug",
        "z": "15604b9.9721eb4",
        "name": "",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "x": 630,
        "y": 60,
        "wires": []
    },
    {
        "id": "11528a5d.783b0e",
        "type": "websocket-listener",
        "z": "",
        "path": "/ws/wsdata2",
        "wholemsg": "false"
    }
]