目指すものは
ラズパイ1B+をネットワーク共有サーバーとして、バッテリーバックアップを行いながら常時起動しておくことを考えています。
利用する部材は
アマゾンで購入の手作りUPSは、2,499円で購入しました。最近出荷されているモデルのラズパイのボード本体を固定する穴位置と重なる同じ穴位置形状の制御ボードです。ラズパイとの接続は、IOの 40ピンコネクタにそのまま重なる HAT と呼ばれる一連の製品群で、板状のバッテリーが付属していて信じられないくらい安いと感じます。
しかし、一般的な国内メーカーが販売するような完成されたパッケージ品とは大きく異なり、付属資料は全く無くて適当なキーワード(例えば UPS HAT) を元にネットで検索すると、それらしい情報が見つかり色々と提供されているサンプル類は、自分の責任で確認してバグ取りや性格に合わせたカスタマイズ作業が必要です。
完成したサーバーのイメージは
今回のネットワーク共有サーバーシステムは、2TBの2.5インチHDDと組合せて、100均のケースに組んで動作させています。ケースからは、AC100VからDC5V-2.4Aに変換した Micro USB のケーブル、イーサネットの RJ-45 のケーブルの２本だけが出ています。
バッテリー監視用のサービスソフト
以前、普段使いのノートPCのLinux(Ubuntu)立上げ後に、ネットワーク共有サーバー上に自動的に、Windowsファイルの一部をバックアップするsystemdのサービスを追加したことがあり、同様に常時起動のラズパイ1B+にバッテリー監視のサービスを起動しようと考えました。
今回の作業背景
何となくネットで見付け、半信半疑の思いつきで購入した安価な製品で、ラズパイに装着できる制御ボードとバッテリーのセットです。付属の説明書類は一切無いもので、使うにはどのようにするのかも含めて、頭をフル回転して情報収集から始めました。
Raspi UPS HAT Board と呼ばれているようで、資料が公開されています。
この公開資料では色々と説明されていて、サンプルコードも多数提示されているのですが、何か詰が甘くて動作を検証しても期待したような結果が出ません。公開されているサンプルのままで期待した結果だったモジュールは、C言語で記述された File:Ups-hat-c.zip だけでした。これはモジュールとして解説の手順でコンパイルすると、ups-read が作成されます。
この ups-read の利用方法としては、引数を [付ける/付けない] により少し異なりますが、バッテリー電圧とバッテリー容量が取得できます。ただ信用できない値が渡されることが多いのですが、そこを考慮すれば簡単に bash とか一般的なシェルからバッテリーの情報を取得できるため、色々な処理を自分で記述するのが簡単にできます。
解説の中には、root権限で実行するためにパスワード無しの sudo を冠して実行するための /etc/sudoers の追加記述がありますが、最新の raspbian では単純にユーザー権限のままでも実行できるようでした。
バッテリーの充放電の検証
引数無しでは、バッテリー容量がパーセンテージで表した整数値のみで返されます。これはバッテリー制御ボードから直接受け取った情報を特定の関数で変換していると思われますが、ちょっとした落とし穴があって、パーセンテージから判断して 0 〜 100 と思い込みますが、0〜100 ではない場合があり、 割合を表す数値としてはありえない 120 とか 112 とかになっていることがあります。
さらに雑音のような、前後の読み取りからはかけ離れた突発的な数値、197 とか 213 とかありえない値が渡されることがあり、その辺りの対策も必要です。
なお、サンプルの中でのステートメントのロジックでは、100%ならのような表現を色々な箇所で使っていますが、実際に渡される情報と一致しないため期待した結果にならないようです。
引数には、v と c が指定でき、両方指定すれば電圧と容量が、当てにならない小数点以下６桁で、3.498750V 9.480469% のように表示されます。10秒毎に読み取ってリストにして確認してみましたが、電圧の変化と容量の変化にはある程度の相関関係があるようです。
実際の制御ボードには、バッテリーの充電や放電の状況を直接見える LED が付けられているのですが、私が持つ個体では完全充電されていてもそれを表す表示になることがないようで、かなりいい加減です。その程度に思って利用した方が良いようです。
ちなみに、バッテリー容量が 0.000000% でも動作していますが、電圧値が、3.000000V を下回った頃に、一気に電力不足でシステムが異常停止しているようでした。バッテリー容量が 5.000000% 以下になったのを見て正常な停止処理に移行させた方が良さそうです。
作ろうとしている私のネットワーク共有サーバーとしての動作環境は、ラズパイ1B+ と 2TB 2.5インチ HDD で構成されています。フル充電から 5.0% まで容量が減衰する動作継続時間は、優に１時間を越えています。ある程度バッテリーが劣化しても余裕がありそうです。
先程の公開資料ですが、その中で提供されているサンプルは、ほぼ python で記述されていて、I2Cインタフェースからバッテリーの電圧と容量を取得するルーチンが紹介されています。
正常な停止処理に移行させるには
その中に UPS のバッテリーを監視して shutdown を起動するサンプルが次の項目に紹介されています。
Driver and Sample code
- File:Rpi-ups-hat.zip
- File:UserManual.pdf
zip を解凍すると、rpi-ups-hat ディレクトリ下に example.py と raspiupshat.so があります。raspiupshat.so が、UPSのバッテリー電圧と容量を取得できるライブラリです。
example.py では、そのライブラリを利用して、無限ループで容量をチェックして、5% を切ると shutdown コマンドが起動される例として記述されています。
残念なことにサンプルでは、os.system(“sudo shutdown”) の行で、ライブラリ os が import されていないため、エラーメッセージを表示して正常終了には移行せず、アブノーマルエンドしてしまいます。
UserManual.pdf は、英語と中国語?で書かれた利用条件の説明です。その中で wiringPi のインストールが必須として書かれていますが、最新の raspbian では事前にセットアップされているようです。
これを流用させて頂き、UPS制御として組込みます。
バッテリー監視の常駐サービス
systemd のサービスとして起動する方法については、次のサイトを参考に制作しますが、一度私のノートPCで作成した経験があるので、自分の備忘録も見返しながらの作業になります。
ここからが作業の本題
Raspbian 起動時に、一度だけ起動して常時バッテリーを監視して、容量が 5% を下回った時に shutdown プロセスを起動させます。
systemd に登録するサービスの指示書が、ユニットファイルと呼ばれます。
- パッケージ名: UPS-Watch-shut
- ユニットファイル名: ups-watching.service
サービス(ユニットファイル)の登録は、 /etc/systemd/system/ups-watching.service で、この中には登録するサービスの情報を決められた書式で記述します。
そして実際に動作させるプログラムは、パッケージ名で管理するディレクトリに集めるようで、 /opt/UPS-Watch-shut/bin に置きます。バッテリーの情報を取得するライブラリ raspiupshat.so もここに置きます。
systemd のサービスとして組込み
カレントで作成して、それを該当するディレクトリにコピーして、所有者を root に変更したり、アクセス権の変更をします。
まずは、ユニットファイルの作成です。
$ vi ups-watching.service [Unit] Description = UPS Watching AutoRun After=network-online.target remote-fs.target nss-lookup.target ConditionPathExists=/opt/UPS-Watch-shut/bin [Service] ExecStart=/opt/UPS-Watch-shut/bin/startup-1st.sh Restart=no Type=simple [Install] WantedBy=multi-user.target
追加するサービスの準備を行います。
$ sudo cp ups-watching.service /etc/systemd/system $ sudo chown root:root /etc/systemd/system/ups-watching.service $ sudo chmod 644 /etc/systemd/system/ups-watching.service
サービスから最初に起動するモジュールを作成します。
$ vi startup-1st.sh #!/bin/sh exec /usr/bin/env python /opt/UPS-Watch-shut/bin/ups-shutdown.py
パッケージをまとめるディレクトリを作成します。
$ sudo mkdir -p /opt/UPS-Watch-shut/bin $ sudo chmod 755 /opt/UPS-Watch-shut/bin $ sudo cp startup-1st.sh /opt/UPS-Watch-shut/bin $ sudo chown root:root /opt/UPS-Watch-shut/bin/startup-1st.sh $ sudo chmod 755 /opt/UPS-Watch-shut/bin/startup-1st.sh
シャットダウンプログラム
提供されていた python のサンプルプログラムは、サンプルの指示手順で解凍すると pythonの原形とバッテリー情報取得ライブラリ raspiupshat.so が提供されています。少し手を加えて、動作するように直し、単体ではシャットダウンが行われることを確認できました。
$ vi ups-shutdown.py #!/usr/bin/env python # Raspi UPS Hat # We only provide 2 interface to get battery information; # #Interface 1: #Function: get current battery voltage #Return value: battery voltage; #float getv(); #Interface 2: #Function: get battery capacity #Return value: 0~100+ #float getsoc(); # import sys # import Raspi UPS Hat library import raspiupshat import os import time import datetime # init Raspi UPS Hat raspiupshat.init(); # Get info now = datetime.datetime.now() print("{0:%Y-%m-%d %H:%M:%S} ; ".format(now) + "Voltage:%5.2fV ; Battery:%5i%%" % (raspiupshat.getv(), raspiupshat.getsoc())) if raspiupshat.getsoc() >= 100: print "Battery FULL" if raspiupshat.getsoc() < 20: print "Battery LOW" while 1: if raspiupshat.getsoc() < 5: print "System will shutdown now,bye!" os.system("sudo shutdown -h 0") # now = datetime.datetime.now() # print("{0:%H:%M:%S} ; ".format(now) + "Voltage:%5.2fV ; Battery:%5i%%" % (raspiupshat.getv(), raspiupshat.getsoc())) # time.sleep(10)
無限ループ内の最後の３行は、確認時に10秒毎に時間とバッテリー電圧値、バッテリー容量を表示するためのものです。必要なら先頭のコメント ‘#‘ を消すことでデバッグ行の表示ができます。
それとバッテリー情報収集用のライブラリ raspiupshat.so を同じ場所に配置します。
$ sudo cp ups-shutdown.py /opt/UPS-Watch-shut/bin $ sudo chown root:root /opt/UPS-Watch-shut/bin/ups-shutdown.py $ sudo chmod 755 /opt/UPS-Watch-shut/bin/ups-shutdown.py $ sudo cp raspiupshat.so /opt/UPS-Watch-shut/bin $ sudo chown root:root /opt/UPS-Watch-shut/bin/raspiupshat.so $ sudo chmod 755 /opt/UPS-Watch-shut/bin/raspiupshat.so
サービスとして定義している ups-watching.service により startup-1st.sh が起動されます。その中で単純にシャットダウンプログラムの ups-shutdown.py を起動しています。
ユニットファイルを systemd に登録
ここからは、systemd へのサービス(ユニットファイル)の登録と検証作業です。ユニットファイル等を追加や変更した後には、必ず次のコマンド sudo systemctl daemon-reload を実行します。
そして一緒にステータスも確認しておきます。
$ sudo systemctl daemon-reload $ sudo systemctl status ups-watching.service ● ps-watching.service - UPS Watching AutoRun Loaded: loaded (/etc/systemd/system/note-startup-1st.service; disabled; vendor preset: enabled) Active: inactive (dead)
ステータスで表示される Loaded: 行のカッコ内の１つ目と２つ目のセミコロンの間の disabled となっているのは、自動起動が無効になっているということのようで、自動起動できるように設定します。
自動起動が行われるように設定
$ sudo systemctl enable ups-watching.service Created symlink /etc/systemd/system/multi-user.target.wants/ups-watching.service → /etc/systemd/system/ups-watching.service. $ sudo systemctl status ups-watching.service ● ups-watching.service - UPS Watching AutoRun Loaded: loaded (/etc/systemd/system/ups-watching.service; enabled; vendor preset: enabled) Active: inactive (dead)
ユニットファイルの定義内に、[ Install ] の WantedBy= で定義しているユニットにリンクが張られ、先ほどの /etc/systemd/system/ups-watching.service; の後の disabled が enabled に変わっています。
これで再立ち上げで自動実行されるようになっているはずですが、その前にコマンドで起動して確認したり、停止させる操作をして動作を確認します。
$ ls -l /opt/UPS-Watch-shut/bin/ -rw-r--r-- 1 root root 7416 1月 25 11:07 raspiupshat.so -rwxr-xr-x 1 root root 76 1月 24 22:49 startup-1st.sh -rwxr-xr-x 1 root root 987 1月 25 11:06 ups-shutdown.py $ sudo systemctl daemon-reload $ sudo systemctl start ups-watching.service $ sudo systemctl status ups-watching.service ● ups-watching.service - UPS Watching AutoRun Loaded: loaded (/etc/systemd/system/ups-watching.service; enabled; vendor preset: enabled) Active: active (running) since Sat 2019-01-26 08:57:28 JST; 5h 36min ago Main PID: 367 (python) CGroup: /system.slice/ups-watching.service └─367 python /opt/UPS-Watch-shut/bin/ups-shutdown.py 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:31:08 ; Voltage: 4.34V ; Battery: 100% 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:31:18 ; Voltage: 4.35V ; Battery: 100% 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:31:28 ; Voltage: 4.35V ; Battery: 100% 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:31:38 ; Voltage: 4.35V ; Battery: 100% 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:31:48 ; Voltage: 4.35V ; Battery: 100% 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:31:58 ; Voltage: 4.35V ; Battery: 100% 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:32:08 ; Voltage: 4.35V ; Battery: 100% 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:32:18 ; Voltage: 4.35V ; Battery: 100% 1月 26 14:32:48 rpi1-disk startup-1st.sh[367]: 14:32:28 ; Voltage: 4.35V ; Battery: 100%
上記の結果では、実際に shutdown 動作を行う python のプログラムの ‘#’ のコメントを取り除き、メッセージ書き出しのステートメントを有効にし組込みました。
systemd の動作に不慣れで、正しく理解できていないのですが、systemctl status コマンドでは、処理中で書き出されたメッセージが直接表示されているわけではないようで、別に journalctl -u コマンドで表示できるようです。
書き出されたメッセージが、キューかバッファのような所に蓄積されていて、 systemctl status の実行時に移されて、journalctl -u で見られる場所に蓄積していくような感じです。そのため、最新の情報を確認するためには、systemctl status を先に実行してから journalctl -u を実行して確認する必要があるようです。
メッセージの各行先頭には、systemctl status で移された日時が記述されているようで、前回の確認から今回新しく加えられた行を判別することが可能なようです。なお、操作方法は less コマンドの操作と同じなので、‘/’ で文字列を検索したり、行をスキップしたり、‘1G’ で先頭行に移動したり、‘G’ で最終行に移動することもでき、上下の矢印キーで前後にメッセージを辿ることができます。
実際の動作検証作業
本番でのシステム終了動作を確認するために、ssh でリモート接続したまま、バッテリーの情報を 10 秒毎に表示して確認しましたが、5% になった後の１分後くらいにセッション切断のメッセージと共に、4% を表示して停止していました。
期待したシステム終了が行われているようで一安心です。メッセージが蓄積されている journalctl -u コマンドの結果例を次に示します。このコマンドは一般ユーザーで確認できるようです。
$ journalctl -u ups-watching.service 1月 26 08:57:28 rpi1-disk systemd[1]: Started UPS Watching AutoRun. 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 2019-01-26 08:57:32 ; Voltage: 3.77V ; Battery: 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: Battery LOW 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 08:57:32 ; Voltage: 3.77V ; Battery: 5% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 08:57:42 ; Voltage: 3.78V ; Battery: 5% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 08:57:52 ; Voltage: 3.77V ; Battery: 5% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 08:59:54 ; Voltage: 3.77V ; Battery: 5% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:00:04 ; Voltage: 3.77V ; Battery: 5% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:00:14 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:00:24 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:00:34 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:00:44 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:00:54 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:01:05 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:01:15 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:01:25 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:01:35 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:01:45 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:01:55 ; Voltage: 3.78V ; Battery: 6% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:02:05 ; Voltage: 3.78V ; Battery: 7% 1月 26 09:14:56 rpi1-disk startup-1st.sh[367]: 09:02:15 ; Voltage: 3.78V ; Battery: 7% lines 1-22
今回のUPSバッテリー監視と shutdown では、特にプログラムやサービスについての依存関係は無いので、これで完了です。
次は、UPSバッテリーの充放電に伴う携帯メールへの通知についての対策を考えています。