SSNG for Node.js

2018.07.17 1st release

Abstract

SSNG for Node.jsは、ECHONET Liteコマンド送受信ツールである。

SSNG for Node.js is a tool to send and receive ECHONET Lite command.

Requirements

Node.jsがインストールされたWindows PC, Macまたは Raspberry Pi

Windows PC, Macintosh or Raspberry Pi on which Node.js is installed.

Installation

ターミナルで "npm install ssng" を実行する

Execute "npm install ssng" on a terminal

Launch

Japanese

1. ssngがインストールされた directory に移動し、ターミナルで "node app" を実行する
2. Web Browserを起動し、localhost:3000/ssng をアクセスする
3. SSNGのGUIが表示される(Fig. 1)

English

1. move to the directory where ssng is installed and execute "node app" on a terminal
2. Launch a Web Browser and access localhost:3000/ssng
3. GUI of SSNG is displayed(Fig. 1)

How to use

Japanese

基本的な使い方

IP Address, DEOJ, ESV, EPC, EDTのデータ入力欄に値を入力し、SENDボタンをクリックするとECHONET Liteコマンドが送信される。受信したECHONET LiteデータはDATA areaに自動的に表示される。

IP Address 入力欄

IPv4形式の値を入力する。初期値はマルチキャストアドレス 224.0.23.0 である。

ECHONET Lite Data 入力欄

16進数(HEX)の値を入力する。"0x"は省略可能。
　TIDは0x0001から始まり、コマンドを送信するごとに自動でインクリメントされる。OPCは0x01の固定値。PDCはEDTから自動で計算される。EDTが２バイト以上の場合は、0xAA33FF のような値を入力する。EDTが不要なESVの場合、EDT入力欄のデータは無視される。

Free Data 入力欄

OPC=2以上のコマンドを送る場合や、ECHONET Liteとしては正しくないコマンドを送る場合は、Free Data 入力欄を利用する。ラジオボタンでFree Dataを選択するとFree Data を入力できるようになる。入力するデータのフォーマットは、コンマで区切られた１バイトデータ（0xを省略したの16進数）である。

SEND ボタン

その時点で選択されている入力欄のデータを用いてECHONET Liteコマンドを送信する。

SEARCH ボタン

機器探索のためのコマンドを送信する。

CLEAR DATA ボタン

DATA表示欄をクリアする。

SAVE DATA ボタン

DATA表示欄のデータをファイルとして保存する。保存先はホームディレクトリで、ファイル名は以下のように "ssngLog_" の後にtimestamp(YYYYMMDDHHMMSS)を付加したものである。

ssngLog_20180625161502.txt

English

Basic usage

Type data to input field of IP Address, DEOJ, ESV, EPC and EDT. Click SEND button, then ECHONET Lite command is sent. Received ECHONET Lite data is displayed in the DATA area automatically.

IP Address input field

Type IPv4 address. Initial data of 224.0.23.0 is a multicast address of ECHONET Lite.

ECHONET Lite Data input field

Type HEX data. "0x" can be omitted.
TID starts from 0x0001 and it is incremented automatically upon sending a new command. OPC is fixed value of 0x01. PDC is calculated automatically with EDT. In case of more than 2 bytes data of EDT, input data like this "0xAA33FF". EDT data is ignored depending on ESV value.

Free Data input field

Free data input field can be utilized in case OPC is more than 2 or a command is not compliant to ECHONET Lite. Select Free data radio button then input field is enabled. Data format should be comma separated byte data in HEX without "0x".

SEND Button

Sends a command with data in the currently selected input field.

SEARCH Button

Sends a command to search ECHONET Lite devices.

CLEAR Button

Clear data display ares.

SAVE DATA Button

Save data on Data display area to a home directory. The file name starts with "ssngLog_" and timestamp(YYYYMMDDHHMMSS) follows. Here is an example.

"ssngLog_20180625161502.txt".

Data display area

Japanese

DATA表示エリアには、送信・受信したデータが表示される。第１コラムは送受信を示す記号(S:送信/R:受信)、第２コラムはIP addressである。
DATA表示欄にはデータ表示を制御するチェックボックスやラジオボタンが存在する。

Time stamp check box

Time stamp(HHMMSS)の付加をコントロールするチェックボックスである。

Order radio button (Norm, Rvs)

ログデータの表示の順序をコントロールするラジオボタンである。Norm(Normal)を選択すると時間軸は下向き、Rvs(Reverse)を選択すると時間軸は上向きとなる。

Filter check box (GET, INF, GET_RES, Others)

受信データのESVの値によって表示にフィルタをかける。チェックをはずすと非表示となる。

English

Data display area shows sent and received data with a symbol that represent SEND:S and RECEIVE:R at the first column and IP address at the second column. There are check boxes and radio buttons to control views of data display at DATA display area.

Time stamp check box

A check box to show/hide time stamp.

Order radio button (Norm, Rvs)

A radio button to control the order of time.

Filter check box (GET, INF, GET_RES, Others)

Check boxes to show/hide data by the value of ESV.