WebSocket API仕様(竜巻注意情報受信者向け)

竜巻注意情報について

  • 竜巻注意情報は、積乱雲の下で発生する竜巻、ダウンバーストなどの激しい突風（以下「竜巻等」）に対して注意を呼びかける情報で、雷注意報を補足する情報として、各地の気象台等が担当地域（概ね一つの県）を対象に発表します。

注意事項

  • 本サービスは、竜巻発生を予知するものではありません。
  • 本サービスは、気象庁が発表する竜巻注意情報に含まれる情報（予報区域、対象市町村など）を用いて、発表の有無を通知するものです。
  • 竜巻注意情報についての詳細は、 気象庁のwebサイト でご確認ください。
  • 竜巻注意情報の有効期間は、発表から約1時間です。
  • 気象庁が発表する竜巻注意情報では、竜巻の 「目撃情報」 も取得できますが、範囲が広範囲となるため、本サービスでは取り扱いません。

取り扱い対象データについて

  • 本サービスで取り扱うデータには、「通常報」「訓練報」「試験報」の3つのモード(運用種別)が存在しております。
    データを利用する際は、これらのモードに対して適切な処理を行ってください。
    • 例えば「訓練報」「試験報」モードのデータは利用しない、利用する場合は明らかに 訓練 や 試験 であることが分かるようにするなど、利用者の混乱を避けてください。
    • 「訓練報」「試験報」モードのデータを、「通常報」データであるかのような処理は 行わない でください。
    • モードの誤用によるトラブルについては、弊社は一切の責任を負わないものとします。

  • 取り扱うモードは利用するサーバによって異なります。各サーバで取り扱うモードは、以下の通りといたします。

本番系WebSocketサーバでのAPI利用の場合

  • 本番系WebSocketサーバでは、「通常報」のみを取り扱い、それ以外のモードは取り扱いません。

トライアル/開発系WebSocketサーバでのAPI利用の場合

  • トライアル/開発系WebSocketサーバでは、「通常報」「訓練報」「試験報」の3つのモードを取り扱います。

竜巻注意情報の通知について

  • 気象庁が竜巻注意情報の発表時に、発令された情報をWebSocket API経由で通知します。
  • 本サービスでは、気象庁で定義された市町村コードごとの竜巻情報の発表の有無を通知します。
  • この情報の有効期間は、発表から1時間です。

WebSocket API 竜巻注意情報通知メッセージ仕様

  • 竜巻注意情報:WebSocket API通知メッセージ表

    セクション パラメータ タイプ 設定値 意味 備考
    version   Hash 以下の2パラメータを設定 メッセージのバージョン情報設定セクション  
      common_version String 任意 commonセクションのパラメータバージョン 現在は1のみ対応
      details_version String 任意 detailsセクションのパラメータバージョン 現在は1のみ対応
    common   Hash 以下の4パラメータを設定 メッセージの共通情報設定セクション 以下の4パラメータはバージョン1のもの
      datatype String jmatornado メッセージのタイプ  
      msgid String 任意 メッセージ毎の一意な番号  
      sendid String 任意 メッセージの配信元情報  
      senddatetime String YYYY-MM-DD HH:mm:SS+HHmm形式 メッセージの送信時刻  
    details   Array データタイプ毎のパラメータを設定 メッセージの詳細情報設定セクション 竜巻注意情報を設定します。

  • WebSocket APIからの竜巻注意情報通知メッセージ詳細

    • version区(セクション)
      • common_version：common区のバージョンが設定。(現在は"1"のみ利用)
      • details_version：details区(竜巻注意情報)のバージョンが設定。(現在は"1"のみ利用)
    • common区(セクション)
      • common_version: "1"は、以下のパラメータを含みます。
        • datatype：竜巻注意情報のdatatype名:"jmatornado"が設定されます。
        • msgid：竜巻注意情報毎の一意な値が設定されます。
        • sendid：竜巻注意情報の発信元情報などが設定されます。(例:JMA など)
        • senddatetime：竜巻注意情報通知メッセージの送信時刻が設定されます。(YYYY-MM-DD HH:mm:SS+HHmm形式)
    • details区(セクション)

サンプルプログラム

  • html(javascript)

    • WebSocket APIへの接続と認証および竜巻注意情報メッセージの受信表示処理

       1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
      <html>
<head>
</head>
<body>
<div id="output"></div>

<script>
(function() {
  // websocketサーバアドレスおよびポートを指定
  var ws = new WebSocket("wss://localhost:443");

  var output = document.getElementById('output');

  function logStr(eventStr, msg) {
    return '<div>' + eventStr + ':' + msg + '</div>';
  }

  // websoket接続確立イベント処理
  ws.onopen = function() {
    output.innerHTML += logStr('connect', 'success');

    // websocket認証メッセージ
    var auth_message = {
      version: {
        common_version:   "1",                // commonセクションバージョン
        details_version:  "1"                 // detailsセクションバージョン
      },
      common: {
        datatype:     "authentication",       // データタイプ:認証(authenticaion指定)
        msgid:        "*",                    // *を設定(認証では利用しない)
        sendid:       "*",                    // *を設定(認証では利用しない)
        senddatetime: "*"                     // *を設定(認証では利用しない)
      },
      details:      {
        password:     "trialpass"             // ユーザパスワードを設定(利用申請時に発行)
      },
      sender: {
        version:      "1",                    // senderセクションバージョン
        userid:       "trialuser",            // ユーザＩＤを設定(利用申請時に発行)
        termid:       "000000001"             // 接続端末識別ＩＤを設定(ユーザがユニークな値となるよう任意に採番)
      },
      receiver: {
        version:      "1",                    // receiverセクションバージョン
        userid:       "*",                    // *を設定(認証では利用しない)
        termid:       "*"                     // *を設定(認証では利用しない)
      }
    };
    // JSON形式に変換し、websocketサーバに送信
    ws.send(JSON.stringify(auth_message));
  };

  // メッセージ受信イベント処理
  ws.onmessage = function(e) {
    // JSON形式からオブジェクトに変換
    var parse = JSON.parse(e.data);

    switch( parse.common.datatype ) {
      case "authentication":    // 認証メッセージ受信処理
        output.innerHTML += logStr('recieved', 'authentication result');
        if( parse.details.resultcode === '200' ) {
          // 認証成功
          output.innerHTML += logStr('authentication', 'success');
        } else {
          // 認証失敗
          output.innerHTML += logStr('authentication', 'failed');
        }
        break;
      case "jmatornado":        // 竜巻注意情報受信処理
        // 竜巻注意情報メッセージ種別判別
        for( var i = 0, len = parse.details.length; i < len; i++ ) {
          var data = parse.details[i];
          // 竜巻注意情報(例:市町村コード:東京都千代田区:1310100)
          if( data.citycode == "1310100" ) {
            switch( data.controlstatuscode ) {
              case "0":  // 通常報
                break;
              case "1":  // 訓練報
                output.innerHTML += "<br><FONT color=\"#ff0000\">これは訓練報です。</FONT><br>";
                break;
              case "2":  // 試験報
                output.innerHTML += "<br><FONT color=\"#ff0000\">これはテスト報です。</FONT><br>";
                break;
            }
            output.innerHTML += "東京都千代田区の竜巻注意情報が" + data.status + "になりました。<br>";
          }
        }
        break;
    }
  };

  // 切断イベント処理
  ws.onclose = function (e) {
    output.innerHTML += logStr('disconnect', e.code + ' - ' + e.type);
  };
}());

</script>
</body>
</html>