Skip to content

Repository files navigation

LightWatch

LightWatchはmacOSのメニューバーまたはLinuxのヘッドレス環境で常駐するアプリです。Webカメラ画像の明るさ変化を監視し、設定したDiscord Webhookへ通知します。

動作要件

  • macOS 13以降、または64bit Linux
  • Python 3.11以降
  • マシンに接続されたWebカメラ
  • Discord Webhook URL

Raspberry Piでは、64bit版OSを使用するRaspberry Pi 2リビジョン1.2以降、Raspberry Pi 3以降、またはZero 2 Wが依存関係上の対象です。ARMv6のRaspberry Pi 1、初代Zero、Zero W、Compute Module 1、およびARMv7のRaspberry Pi 2リビジョン1.1には対応しません。実機での処理速度は未検証です。

ビルド

開発環境を作成します。

python3 -m venv .venv
. .venv/bin/activate
python -m pip install -e ".[dev]"

macOSではメニューバーアプリ、Linuxではヘッドレス監視として起動します。

lightwatch

配布用アプリとDMGは次のコマンドで作成します。

installer/macos/build-app.sh 0.0.0

初回起動

lightwatch

macOSでは初回起動時にカメラ権限ダイアログが出ます。許可しない場合、監視は開始できません。

Webhook URLの設定

メニューバーの電球アイコンから設定を開くを選び、Discord Webhook URLへDiscordのWebhook URLを入力して保存します。

同じ設定画面で、使用するカメラ番号も選択できます。SplitCamを使う場合は、SplitCamを起動して仮想カメラを作成してからカメラ欄で番号を選んで保存します。

判定タブの設定は保存を押したあと、次の監視処理から使われます。

Discord通知は🟢人がいますまたは⚪人がいませんの一行です。

判定設定

光判定は、MediaPipeで人物領域を除外したうえで、端のpositive ROIの中央値と明るいピクセル比率を使います。人物領域に隠れて監視領域の有効ピクセルが不足するフレームでは状態を変えません。アプリ起動時は常に消灯中から始まり、監視領域の明るい状態または暗い状態が確認時間だけ続いた場合に状態を確定します。画像基準との比較や短期比較は使いません。

macOSの設定ファイルは次の場所に保存されます。

~/Library/Application Support/LightWatch/config.json

Linuxでは次の場所に保存されます。XDG_DATA_HOMEが設定されている場合は、そのディレクトリ内のLightWatch/config.jsonを使用します。

~/.local/share/LightWatch/config.json

アプリ上で設定できない場合は、初回起動後に作成されるconfig.jsonを開き、既存のdiscordWebhookURLの値を書き換えます。他のキーは削除しないでください。

macOSでの常駐運用とスリープ防止

ビルド済みのLightWatch.app/Applicationsへ配置して起動します。ログイン時に常駐を有効にすると、ユーザーのLaunchAgentへ登録され、次回ログイン時に起動します。監視プロセスが異常終了した場合は自動的に再起動します。macOSのカメラ権限はログイン中のユーザーに付与されるため、root権限やLaunchDaemonは使用しません。

  1. LightWatch.appを起動します。
  2. カメラ権限を許可します。
  3. メニューバーの電球アイコンから設定を開くを選びます。
  4. Discord Webhook URLを保存します。
  5. SplitCamを使う場合は、カメラ欄でSplitCamを選んで保存します。
  6. ログイン時に常駐を有効にします。

アプリはメニューバーにアイコンだけで常駐します。Dockには表示されません。監視中はmacOSのスリープ、ディスプレイスリープ、アイドルスリープを防止します。一時停止または終了すると、スリープ防止も解除されます。

動作確認

起動できているかは次のコマンドで確認できます。

pgrep -fl LightWatch

CLIから起動する場合は、展開したアプリを/Applicationsへ移動してから次を実行します。

/Applications/LightWatch.app/Contents/MacOS/LightWatch

初回起動後にconfig.jsonが作成されていれば、設定保存先は動作しています。

ログ

メニューバーの電球アイコンからログを開くを選ぶとログディレクトリを開けます。

~/Library/Application Support/LightWatch/logs/

通常の明るさサンプルと状態遷移はログへ保存しません。カメラ、Webhook、設定のエラーだけをerrors.logへ記録します。

Linuxのログは~/.local/share/LightWatch/logs/へ保存します。XDG_DATA_HOMEが設定されている場合は、設定ファイルと同じLightWatchディレクトリ内のlogs/へ保存します。

Webhook URLが未設定の場合、通知は送信されず、errors.logに記録されます。

起動直後に終了した場合は、次のコマンドで起動失敗の詳細を確認できます。

tail -n 100 "$HOME/Library/Application Support/LightWatch/logs/errors.log"

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages