Python ガジェット

おんどとりWeb StorageからPythonで現在値データを取得する

おんどとりWeb StorageはAPIが公開されているので、任意のプログラムから登録してある機器のデータを取得する事ができます。
Pythonで最新の温度データを取得するには以下のようにします。

事前準備

  • API Keyの取得
  • 読み取り専用アカウントを作成する
  • APIのアクセス情報を/var/tmp/webstorage.jsonに記載する

アクセス情報はjson形式の外部ファイルから読み込む仕様にしました。

Key 説明
api_key API Key
user_id WebStorageのアカウントID
user_pass WebStorageのアカウントパスワード

アカウントIDとパスワードは読み取り専用アカウントを作成することをオススメします。

コードで使っているモジュールはpipでインストールしておきます。

?
$ pip3 install requests
$ pip3 install json

サンプルコード

?
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
# coding utf-8
import requests
import pprint
import json
 
# API KEYなどのアクセス情報を記載したファイルのパス
ACCESS_INFO_FILE_PATH = "/var/tmp/webstorage.json"
"""
ファイルは以下の形式を想定
{
    "api_key":"xxxxxxxxxxxxxxxxxxxxxxxxx",
    "user_id" : "rbacXXXX",
    "user_pass" : "*******"
    "_comment" : "OndotoriWebStorage API Key and view only account info"
}
"""
 
# アクセスするAPIのURI
API_URI_GET_CURRENT = "https://api.webstorage.jp/v1/devices/current"
 
def load_access_info():
    """ WebStorageにアクセスするための情報をファイルから読み込む """
    info_path = ACCESS_INFO_FILE_PATH
    f = open(info_path, 'r')
    load_info = json.load(f)
 
    api_info = {}
    api_info["api-key"]    = load_info["api_key"]
    api_info["login-id"]   = load_info["user_id"]
    api_info["login-pass"] = load_info["user_pass"]
 
    return api_info
 
access_param_info = load_access_info()
response = requests.post(API_URI_GET_CURRENT, json.dumps(access_param_info), headers={'Content-Type': 'application/json', 'X-HTTP-Method-Override': 'GET'})
 
# debug
pprint.pprint(response.json())
 
receive_data = json.loads(response.text)
 
# あとはお好きなように...

receive_dataに取得した現在値データが入っているので、煮るなりやくなりできます。
詳細はAPIリファレンスをご確認ください。 これを応用して、死活監視ができます。

応用 死活監視の方法

わたしは「エネループ」で動作させているので、通信が途絶えたらできるだけ早く電池交換したいので3時間通信がなかったらSlackに投稿するようにしました。
APIでは、最後に通信してきた時刻は取得できないので、現在値データにある最後のデータ時刻からどれぐらい通信ができていないのか調べます。
このコードをRaspberryPiでcronを使って1時間に1回実行するようにして、死活監視をおこないます。
サンプルコードは以下からどうぞ。

参考情報

0 件のコメント :

コメントを投稿