Skip to content

constdrop/rubyiot_server

BranchesTags
 
 

Repository files navigation

rubyiot_server

このソフトウェアは、住宅に設置されたセンサーの情報を収集したり、 機器を操作したりする、いわゆるIoTのサーバーを、 Rubyで実装したサンプルです。 開発にあたって、ECHONETの規格を少し意識しています。

全体像

このソフトウェアは、IoTをRubyで実装したサンプルの一部で、 全体は下記のような構成になっています。

[device] - [gateway] - [server] - [mobile]
  ├ [sensor]
  └ [controller]
  • device
    環境を測定する専用機器や、家電そのもの、家電のリモコンなどを想定しています。 デバイスに接続、もしくは内蔵されたsensorの測定値をgatewayに送信したり、 gatewayから送られてきた操作の命令に従って、各種機器のOn/Offなど、 controllerを制御します。
  • gateway
    住宅ごとに1台から数台設置する、deviceとインターネットを接続する装置を 想定しています。 deviceから送られてきた情報を蓄積およびserverに送信したり、 mobileやserverから送られてきた操作の命令を、deviceに転送したりします。
  • server
    たくさんのgatewayから送られてきた情報を蓄積して、 複数のgatewayに渡る情報をユーザーに提供したり、 mobileから送られてきた操作の命令を、適切なgatewayに転送したりします。
  • mobile
    スマートフォンなどから、住宅の環境を確認したり、家電などを操作します。

serverの機能

Web画面

  • /login
    ログイン画面が表示され、ユーザー名とパスワードを入力して「Login」 ボタンをクリックすることで、loginセッションを取得します。
  • /mypage
    以下の機能を提供します。loginセッションが必要です。
    • 自宅などのgatewayのhardware_uid登録機能
    • 温度の表示機能
    • logout機能(/logoutへのリンク)
  • /logout
    ログアウトし、/login にリダイレクトします。
  • /chart
    温度変化のグラフを提供します。loginセッションが必要です。

API

APIは、gatewayからの通信を受けるものと、mobileからの通信を受ける もの、両方の通信を受けるものの、大きく3種類に分けられます。 現在、両方からの通信を受けるAPIを含め、gatewayからの通信では loginセッションは必要ありませんが、mobileからの通信では、 loginセッションが必要です。

gateway、mobile両方とのAPI

  • POST /api/monitor

    • 機能: sensorの監視値（上限値・下限値）を登録・更新する。

    • アクセス: mobile, gateway => server

    • POSTデータ: 以下の形式のJSONデータ
      （1階層目のkeyの"xxx"はserverで管理するsensor_id）

          { "xxx": { "min": "下限値", "max": "上限値" } }

  • GET /api/monitor?sensor_id=xxx

    • 機能: sensorの監視値（上限値・下限値）を取得する。

    • アクセス: mobile, gateway => server

    • クエリ: sensor_id

    • GETデータ: 以下のJSON形式のデータ

          { "min": "下限値", "max": "上限値" }

gateway向けのAPI

  • POST /api/device

    • 機能: sensorやcontrollerが接続されたdeviceを、登録・更新する。

    • アクセス: gateway => server

    • POSTデータ: 以下のJSON形式のデータ
      （各codeはECHONET機器オブジェクト詳細規定による。）

          { "gateway_uid": "<gatewayのhardware_uid(Seriarl、MACなど)>",
      "device_uid": "<deviceのhardware_uid(Seriarl、MACなど)>",
      "properties":
      [
        { "class_group_code": "0x00",
          "class_code": "0x00",
          "property_code": "0x00",
          "type": "< sensor | controller >" },

        ...

      ]
    }

    • 応答データ: 以下のJSON形式のデータ
      （1階層目のkeyはserverで発行するdevice_id。 2階層目のkeyはproperty_code。 valueはserverで発行するsensor_idまたはcontroller_id。）

          { "xxx":
      [
        { "id": "yyy"
          "class_group_code": "0x00",
          "class_code": "0x00",
          "property_code": "0x00" },

        ...

      ]
    }

  • POST /api/sensor_data

    • 機能: センサーの測定データを登録する。

    • アクセス: gateway => server

    • POSTデータ: 以下の形式のJSONデータ （keyの"xxx"はserverで管理するsensor_id）

          { "xxx": "測定値" }

  • POST /api/sensor_alert

    • 機能: センサーの測定データを登録する。

    • アクセス: gateway => server

    • POSTデータ: 以下の形式のJSONデータ （keyの"xxx"はserverで管理するsensor_id）

          { "xxx": { "value": "測定値", "min": "下限値", "max": "上限値" } }

  • GET /api/operation?< hardware_uid=xxx | gateway_id=xxx >

    • 機能: controllerへの操作指示を取得する。（1リクエストにつき1操作）

    • アクセス: gateway => server

    • クエリ: hardware_uid or gateway_id

    • GETデータ: 以下のJSON形式のデータ
      （keyの"xxx"はgatewayのserverで管理するgateway_id）
      （操作値はECHONET機器オブジェクト詳細規定による。今回は、0:ON, 1:OFFのみ。） （登録から60秒以内の操作指示のみ取得される。）

          { "xxx": { "operation_id": "yyy", "value": "操作値" } }

  • POST /api/operation_status

    • 機能: controllerへの操作指示を登録する。

    • アクセス: gateway => server

    • POSTデータ: 以下のJSON形式のデータ （keyの"xxx"はserverで管理するoperation_id、 実行結果は、0:成功, 1:失敗）

          { "xxx": "実行結果" }

mobile向けのAPI

  • POST /api/login

    • 機能: loginセッションを取得する。

    • アクセス: mobile => server

    • POSTデータ: 以下のJSON形式のデータ

          { "username": "xxx",
      "password_hash": "SHA-256でハッシュしたパスワード" }

  • GET /api/logout

    • 機能: loginセッションを破棄する。

    • アクセス: mobile => server

    • GETデータ: 以下のJSON形式のデータ

          { "status": "OK" }

  • POST /api/user

    • 機能: ログインしているユーザーのユーザー情報を更新する。

    • アクセス: mobile => server

    • POSTデータ: 以下のJSON形式のデータ

          { "nickname": "xxx",
      "email": "[email protected]" }

  • POST /api/password

    • 機能: ログインしているユーザーのパスワードを更新する。

    • アクセス: mobile => server

    • POSTデータ: 以下のJSON形式のデータ

          { "password": "xxx" }

  • POST /api/gateway_add

    • 機能: 自宅などのgatewayを追加する。

    • アクセス: mobile => server

    • POSTデータ: 以下のJSON形式のデータ

          { "hardware_uid": "xxx",
      "name": "gatewayの任意の名前" }

  • POST /api/gateway_del

    • 機能: 自宅などのgatewayを削除する。

    • アクセス: mobile => server

    • POSTデータ: 以下のJSON形式のデータ

          { "gateway_id": "xxx" }

  • GET /api/gateway

    • 機能: ログインしているユーザーの配下にあるgatewayのリストを取得する。

    • アクセス: mobile => server

    • GETデータ: 以下のJSON形式のデータ
      （keyの"xxx"はserverで管理するgateway_id）

          { "xxx":
      { "hardware_uid": "yyy",
        "name": "gatewayの名前" },

      ...

    }

  • POST /api/sensor

    • 機能: sensorの名前を登録・更新する。

    • アクセス: mobile => server

    • POSTデータ: 以下のJSON形式のデータ （keyの"xxx"はserverで管理するsensor_id）

          { "xxx": { "name": "センサーの任意の名前" } }

  • GET /api/sensor?< hardware_uid=xxx | gateway_id=xxx >

    • 機能: 指定したgatewayの配下にあるsensorのリストを取得する。

    • アクセス: mobile => server

    • クエリ: hardware_uid or gateway_id

    • GETデータ: 以下のJSON形式のデータ
      （1階層目のkeyの"yyy"、"zzz"は、serverで管理するsensor_id） （2階層目のdevice_idは、serverで管理するdevice_id）

          { "yyy":
      { "name": "ex: キッチンのガス漏れセンサー",
        "property_name": "Detection threshold level",
        "device_id": "YYY",
        "value": "最新の測定値",
        "unit": "測定値の単位",
        "datetime": "最新の測定時刻",
        "alert": "< 0:無 | 1:有 >" },

      ...

      "zzz":
      { "name": "ex: リビングの温度計"
        "data-unit": "degree Celsius",
        "property_name": "Measured temperature value",
        "device_id": "ZZZ",
        "value": "最新の測定値",
        "datetime": "最新の測定時刻",
        "alert": "< 0:無 | 1:有 >" },

      ...

    }

  • POST /api/controller

    • 機能: controllerの名前を登録・更新する。

    • アクセス: mobile => server

    • POSTデータ: 以下のJSON形式のデータ （keyの"xxx"はserverで管理するcontroller_id）

          { "xxx": { "name": "機器と操作の内容" } }

  • GET /api/controller?< hardware_uid=xxx | gateway_id=xxx >

    • 機能: 指定したgatewayの配下にあるsensorのリストを取得する。

    • アクセス: mobile => server

    • クエリ: hardware_uid or gateway_id

    • GETデータ: 以下のJSON形式のデータ
      （1階層目のkeyの"yyy"は、serverで管理するcontroller_id）
      （2階層目のvalue_rangeは、"min","max"による値の範囲か、操作内容と値の列挙） （2階層目のdevice_idは、serverで管理するdevice_id）

          { "yyy":
      { "name": "ex: リビングのエアコンの電源",
        "property_name": "Operation status",
        "value_range": { "ON": "0", "OFF": "1" },
        "value": "1"
        "device_id": "YYY"}
      ...

    }

  • GET /api/sensor_data?sensor_id=xxx&start=2014-10-10+12:00:00&span=daily

    • 機能: serverに蓄積されたセンサーの測定データを取得する。

    • アクセス: mobile => server

    • クエリ: sensor_id, start（取得する時刻範囲の開始時刻）,
      span（5-minutely, hourly, daily, weekly, monthly, yearlyのいずれか。 5-minutely, hourlyはstartが48時間以上前の場合は指定できない。）

    • GETデータ: 以下のJSON形式のデータ （測定時刻の間隔は下表のようにspanによって調整し、件数が概ね200件以下になるようにする）

          { "測定時刻": "測定値", "測定時刻": "測定値", ... }
    span 間隔 件数
    5-minutely 10秒 30
    hourly 2分 30
    daily 1時間 24
    weekly 6時間 28
    monthly 1日 31
    yearly 10日 36

  • GET /api/sensor_alert?sensor_id=xxx&datetime=2014-10-10+12:00:00

    • 機能: 現在もしくは指定した時刻の測定値が、異常値であったかを取得する。

    • アクセス: mobile => server

    • クエリ: sensor_id, datetime（指定しない場合は現在時刻）

    • GETデータ: 以下のJSON形式のデータ

          { "alert": "< 0:無 | 1:有 >", "value": "測定値",
      "datetime": "測定時刻", "min": "下限値", "max": "上限値" }

  • POST /api/operation

    • 機能: controllerへの操作指示を登録する。

    • アクセス: mobile => server

    • POSTデータ: 以下のJSON形式のデータ （keyの"xxx"はserverで管理するcontroller_id）
      （操作値はECHONET機器オブジェクト詳細規定による。今回は ON/OFF の 0/1 のみ。）

          { "xxx": "操作値" }

    • 応答データ: 以下のJSON形式のデータ

          { "operation_id": "xxx" }

  • GET /api/operation_status?operation_id=xxx

    • 機能: controllerへの操作指示の内容と状態を取得する。

    • アクセス: mobile => server

    • クエリ: operation_id

    • GETデータ: 以下のJSON形式のデータ
      （状態値は、0:未実行, 1:実行中, 2:完了, 9:異常）

          { "value": "操作値", "status": "状態値" }

使用方法

動作環境

最低限、以下のソフトウェアがインストールされている必要があります。

  • Ruby 2.3.0
  • SQLite 3（開発環境）
  • MySQL 5.5（本番環境）

データベースの用意

本番環境では、MySQLのデータベースを以下のように用意します。 なお、ここではlocalhostにデータベースを用意していますが、異なるホストに用意する場合は、 適宜内容を変更してください。 また、パスワードを 'secret' としていますが、これも適切なものに変更してください。

mysql> CREATE DATABASE rubyiot_server DEFAULT CHARACTER SET 'utf8';
mysql> GRANT ALL PRIVILEGES ON rubyiot_server.* TO 'rubyiot'@'localhost' IDENTIFIED BY 'secret'

デプロイ

本番環境の場合、アプリケーションを導入するディレクトリで、以下のようにコマンドを実行します。

$ git clone https://github.com/ossforumjp-app-IoT/rubyiot_server.git
$ cd rubyiot_server
$ cp db/database.yml.default db/database.yml
$ bundle install --path vendor/bundle
$ export RAILS_ENV=production
$ export RUBYIOT_SERVER_DATABASE_PASSWORD=secret #作成したデータベースのパスワード
$ bundle exec rake db:migrate
$ bundle exec unicorn -c unicorn.rb -E production -D

ダミーデータ作成

下記スクリプトのSensorID、START、INTERVAL、SPANを編集して、以下のように実行します。

$ export RAILS_ENV=production
$ bundle exec ruby create_dummydata.rb

ライセンス

Copyright(C) 2016 Japan OSS Promotion Forum

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.

About

IoT server sample written in Ruby

Resources

Readme
Activity

Stars

0 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 77.6%
  • HTML 19.4%
  • JavaScript 2.4%
  • Other 0.6%