Salesforseでリアルタイム監視
前回まででINA260で測定した電流・電圧値をRaspberryPiでロギングできるようになったが、せっかくなので、インターネット上にアップロードして発電量をどこからでも確認できるようにしたい。
その方法の選択肢は様々あると思うが、今回はSalesforceのDeveloper Editionを利用した。
● Salesforceを利用するメリット
PaaS (Platform as a Service)であること
クラウドサービスには大きく分けて、IaaS(Infrastracture as a Service),PaaS (Platform as a Service),SaaS (Software as a Service)の３つが存在する。
SalesforceはPaaSに属している。
PaaSは、IaaSのような環境構築が不要で、かつ、SaaSよりも自由度が高く、リッチな機能を自由に簡単にカスタマイズ可能である。Developer Editionは無料であること
Salesforceは基本的には有料ライセンスを購入する必要があるが、Developer Editionならフル機能使えて無料で利用可能である。
ただし、以下の制限がある。
・ 作成できるユーザー数は2
・ 利用可能なデータストレージ 5MByte
・ 利用可能なファイルストレージ 20MByte
詳細は、「Salesforce の機能とエディションの割り当て - Salesforce Help」「データストレージとファイルストレージの割り当て」を参照
データストレージ5Mが小さいと思われるかもしれないが、BigObjectを活用すれば100万件までレコードを格納できる。こちらについては後ほど説明する。
● Salesforce Developer Editionの登録
Salesforce Developer Editionは、以下のサイトからユーザー登録すれば、使用できるようになる。
登録からメールが届くまでタイムラグがあることがあるので注意すること。
● Salesforceへのログイン
Salesforceにログインするには、以下のサイトにアクセスする。
登録したユーザ名とパスワードを入力し、ログインする。
最初のログイン時には、ガイダンスの後、基本的には下記の画面(サービスの設定)が表示される。
いろいろとメニューが多く、何をすればよいのかわからないかもしれないが、ここでは以下の手順で設定していく。
- カスタムオブジェクトの作成
- OAuth設定とAPIの有効化
- SOAP API経由でテストデータの投入
- レポートの作成
- ダッシュボードの作成
● カスタムオブジェクトの作成
Salesforceには、標準オブジェクトとカスタムオブジェクトが存在する。
これらはデータベースのテーブルに該当する。
標準オブジェクト：最初からCRM等のアプリケーションのために用意されているオブジェクト。カスタマイズ可能。
カスタムオブジェクト：完全にユーザーが自由に定義できるオブジェクト。
以下、カスタムオブジェクトの作成手順である。
画面右上の歯車アイコンをクリックし。「設定」を選択する。
画面左のメニューから
プラットフォームツール-「オブジェクト及び項目」-「オブジェクトマネージャ」を選択
画面右側の「作成」をクリックし、ドロップダウンメニューから「カスタムオブジェクト」を選択する。
4.カスタムオブジェクトの作成
カスタムオブジェクトの名前とAPIアクセス名を設定する。
カスタムオブジェクトのAPIアクセス名は、保存後、末尾に「__c」が付く。
ここでは以下のように設定している。
5.カスタムタブの作成
4で、「カスタムオブジェクトの保存後、新規カスタムタブウィザードを起動する」をチェックすると、カスタムオブジェクト保存後、自動的に「新規カスタムタブ画面」が表示される。
もし、チェックを入れ忘れた場合は、
設定-プラットフォームツール-「ユーザーインターフェース」-「タブ」から「新規」ボタンをクリックすると新規カスタムタブ作成画面が起動する。
ここでは、タブスタイルを選択し、「次へ」をクリック。
その後、表示するユーザー・表示するアプリケーションの設定があるが、デフォルトのまま「次へ」で進み、保存する。
6.カスタム項目の作成
再度、設定-プラットフォームツール-「オブジェクト及び項目」-「オブジェクトマネージャ」から、先ほど作成したカスタムオブジェクトを選択する。
左メニューより、「項目とリレーション」を選択する。
画面右上の「新規」ボタンをクリック。
項目のデータ型等を選択する。
ここでは例として電流値の項目を作るので、「数値」を選択して「次へ」をクリックする。
項目名、桁数等設定して「次へ」をクリックする。
項目レベルセキュリティの設定はデフォルトのまま「次へ」をクリックする。
ページレイアウトへの追加もデフォルトのままでよい。
「保存」あるいは「保存＆新規」をクリックする。
上記と同様の手順で、必要な項目を追加していく。
● OAuth設定とAPIの有効化
RaspberryPiから測定値をSalesforceにアップロードするには、REST APIかSOAP APIを使用する。
これを使用可能にするには、ユーザープロファイルの「APIの有効化」にチェックを入れる必要がある。
「設定」-「ユーザー」でユーザー一覧を表示。
DBアクセスに使用するユーザーのプロファイルを開き、「編集」ボタンを押す。そして、「APIの有効化」にチェックを入れて保存する。
あと、外部からAPIアクセス時に、パスワードとは別にセキュリティトークンを求められる。
セキュリティトークンがわからない場合は、以下の手順で再発行できる。
- 画面右上のキャラクターアイコンをクリックし、「設定」をクリック。
- 左側メニューから、「私のセキュリティトークンをリセット」を選択。
- 「セキュリティトークンをリセット」ボタンを押す。
上記を実施すると、登録したメールアドレスにセキュリティートークンが記載されたメールが送られてくる。
次に、OAuth設定をするために「接続アプリケーション」を作成する。
「設定」-「アプリケーション」-「接続アプリケーション」から作成できる。
これについては、以下のサイトに詳しく書かれているので参照させていただいた。
simple_salesforceを使ってPythonからSalesforceのREST APIへアクセスしてみた
REST APIを使ってSalesforceのデータを取得する
●REST API経由でテストデータの投入
ここからはRaspberryPi側での作業となる。
前回の記事のソースコードを修正し、測定値をSalesforceのカスタムオブジェクトにアップロードするコードを追加した。
Salesforceへのアクセスには、Salesforce REAST APIを使用する。
Salesforceのpython用のライブラリはいくつかあるようだが、ここでは、simple_salesforceを使用する。
先ほど紹介したサイトにライブラリの導入手順等書かれているので参照させていただいた。
simple_salesforceを使ってPythonからSalesforceのREST APIへアクセスしてみた
import serial
import struct
import datetime as dt
import json
from simple_salesforce import Salesforce
USERNAME = "ユーザー名"
PASSWORD = 'パスワード'
SECURITY_TOKEN = "セキュリティトークン"
use_port = "/dev/ttyACM0"
_serial = serial.Serial(use_port)
_serial.baudrate = 115200
_serial.parity = serial.PARITY_NONE
_serial.bytesize = serial.EIGHTBITS
_serial.stopbits = serial.STOPBITS_ONE
_serial.timeout = 15
def Login():
sf = Salesforce(username=USERNAME, password=PASSWORD,
security_token=SECURITY_TOKEN)
return sf
sf = Login()
try: while True:
rx = _serial.readline()
#rx = rx.strip()
st = "{0},{1}".format(dt.datetime.now(), rx)
print(st)
with open('/home/pi/current_{}.log'.format(dt.date.today()), mode="a") as f:
f.write(st)
datas = st.split(",")
if len(datas)<3:
continue
t1 = datas[0][0:19] t2 = t1.replace(" ","T") + "Z" print("{0},{1}".format(t1,t2))
try:
for i in range(1,len(datas)):
datas[i] = datas[i].replace("b'","").replace("\\r\\n'","").strip()
if len(datas[1])==0 or len(datas[2])==0 or len(datas[1])>10 or len(datas[2])>10 :
continue
if datas[1][:1].isdigit()==False or datas[2][:1].isdigit()==False:
continue
res = sf.GeneratorLog__c.create({'Name': t1, # Name項目を文字列型とし、日時をセットしている
'MeasDate__c': t2, # 日時(Datetime型)
'Current__c': float(datas[1]), # 電流値
'Voltage__c': float(datas[2]), # 電圧値
'Temperature__c': 20.00}) # 温度は将来的に測定予定のため、項目だけ作成したが、固定値を設定
if res.get('error'):
raise Exception(response.get('error_description'))
print(json.dumps(res, indent=4))
except Exception as e:
sf = Login() # ログインし続けるとタイムアウトで例外発生するので、再ログインしてリトライ
res = sf.GeneratorLog__c.create({'Name': t1,
'MeasDate__c': t2,
'Current__c': float(datas[1]),
'Voltage__c': float(datas[2]),
'Temperature__c': 20.00})
print(json.dumps(res, indent=4))
except Exception as ex:
print(ex)
finally:
_serial.close()
INA260に太陽光パネル、あるいはテスト用の電池等を接続して実行すると、Salesforceの画面からデータがアップロードされているのを確認できる。
ちなみに、作成したカスタムタブの表示方法は、Lightning Experienceアプリケーションで、タブ表示欄右端のペンマークをクリックすると、表示させるタブを選択できる。
Classicアプリケーションだとタブ表示のカスタマイズができたくなっているので注意すること。
タブ表示欄左端のアプリケーション選択ボタン押下で、「すべて表示」からでもタブ選択ができた。(最近、Lightning Experienceへの切り替え移行のためか、以前できていたことができなくなることがあるので要注意)
どのアプリケーションでもよいので、つぎのタブを追加する。
・発電ログ(作成したカスタムタブ)
・レポート(以下で説明)
・ダッシュボード(以下で説明)
● レポートの作成
データをロギングしても、ただ貯めるだけでは楽しくない。
やはりグラフ化しないと傾向が良くわからない。
グラフ表示するために、レポートを作成する。
レポートタブを選択し、画面上部の「新規レポートの作成」をクリックする。このとき、Classicではない方のボタンをクリックすること。
「レポートタイプを選択」画面では、存在するオブジェクトが一覧表示される。自分が作成したカスタムオブジェクト(発電ログ)を選択。
ここから
・表示項目
・検索条件
・グループ化
を設定して、グラフにするためのデータを用意していく。
描きたいグラフは、日別にX軸に時間、Y軸に電流を表示したい。
そのため、表示項目に電流を追加する。
画面左の「列」下の検索欄に「電流」と入力するか、画面左端の「項目」を開き、「電流」を選択する。
すると、画面中央の表に「電流」が追加されるのがわかる。
しかし、画面上部の「グラフを追加」ボタンが無効のままである。
グラフを表示させるにはグループ化する必要がある。
そのため、日別に10分毎の平均電流を表示させることにする。
ここで、「サービスの設定」-「オブジェクト及び項目」に戻り、カスタムオブジェクト(発電ログ)にカスタム項目を追加することにする。
| 項目名 | データ型 | 数式 | 備考 |
|---|---|---|---|
| 日 | 数式 | DATEVALUE( LEFT(Name,10)) | |
| 分時間 | 数式 | VALUE(MID(Name,12,2) & "." & MID(Name,15,1)) | 時間と、分の10の位をセット |
ちなみに、Name項目には測定日時が文字列型で「yyyy-MM-dd HH
ss」で入力されている。
作成したカスタム項目を、早速レポートに追加する。
「行をグループ化」で「日」「分時間」を追加。
また、「列」の「電流」をクリックすると、集計メニューが表示されるので、平均を選択。
ここでようやく、「グラフを追加」ボタンが有効になる。
「グラフの追加」をクリック。
グラフ右上のギアボタンをクリック。
表示グラフ：折れ線
タイトル：電流測定
X軸：分時間
系列：日
Y軸：電流平均
画面上にグラフが正常に表示されていることが確認出来たら保存する。
同様に、電圧や電力に関してもレポート作成してみてもよいだろう。
● ダッシュボードの作成
レポートを見やすく表示するために、ダッシュボードに追加する。
ダッシュボードタブを選択し、画面上部の「新規ダッシュボード」をクリック。
ダッシュボードの名前を入力して「作成」をクリック。
画面上部の「＋コンポーネント」ボタンを押すと、レポート一覧が表示されるので、表示したいレポートを選択する。
つぎに、レポートのグラフ作成と同様のフォームが表示されるので、レポートのグラフ作成と同様に設定する。
「追加」ボタンを押すと、グラフのコンポーネントが画面上に追加される。
表示したいレポートを同様にどんどん追加して保存すると、こんな感じになる。
これで、どこからでもSalesforceにログインしてダッシュボードにアクセスすれば、発電量をリアルタイム監視できるようになった。
ただ、注意点が一つ。
画面右上の更新ボタンを押さないとデータ更新されないので気を付けること。