search

mnakada / atomcam_tools

Hack tool for atomcam and wyzecam.
Other
178 stars 22 forks source link
atomcam go2rtc homekit nas rtsp ssh timelapse webhook wyzecam

readme

atomcam_tools

これはATOMCam/ATOMCam2/AtomSwing/WyzeCamV3の機能を拡張するツールキットです。
標準的な機能に満足できないユーザーが、各自の責任において機能を拡張するためのツール・スクリプトをまとめたものです。
利用にあたって、当然のことながらカメラメーカへの問い合わせなどは厳に慎んでください。
それ以外、自由に利用できますが、仮に悪用し、他人へ迷惑をかけた場合の責任は、その設定を行った者が負うべきものであることを理解してください。
質問、動作不具合、機能のリクエストは　Issues を立ててください。


[!IMPORTANT]

Ver.2.3.xからVer.2.4.0以降へのVer. Upは設定を記録しているhack.iniが変換されます。
Ver. 2.3.x以下にVer.Downする場合はSD-Cardに保存されているhack.ini_0_9_9.bakファイルをhack.iniに上書きしてください。

設定項目が増えてきて分かりにくくなってきたのでVer.2.4.0からメニュー構成を変更しました。


AtomSwingの画面

WyzeCamV3の画面


実現される機能


セキュリティに関わる重要事項

上記項目に書いてある各ポートが利用可能となります。
現時点ではこのポートはセキュリティ上の懸念材料となりますので、
ネットワークのセキュリティーを各自十分に保つように心がけてください。 WebUI、video、jpegに関してはLAN内からは自由に見える設定になっています。 sshは物理的にSD-Cardへアクセスして公開鍵を書かないとloginできないようにしています。 ただし、ATOMCamはSSID,passwordを平文でカメラ内のフラッシュメモリ（SD-Cardではない）に保存しているのでカメラを盗難されて中を見られるとWiFiにアクセスされる可能性がありますのでご注意ください。


ファームウェアの更新の注意

atomcam_toolsは以下のATOMCamのVersionで動作確認しています。更新した場合機能が使えなくなることもあるのでご注意ください。

ATOMCam Ver.4.33.3.68, 4.33.3.73

ATOMCam2 Ver.4.58.0.115, 4.58.0.120, 4.58.0.135, 4.58.0.139

ATOMSwing Ver.4.37.1.117, 4.37.1.122, 4.37.1.142, 4.37.1.152

WyzeCamV3 Ver.4.36.9.139 （Experimental release) 4.36.10.xx以降のVer.では動作しません。

WyzeCamV3は未検証／未対応の機能があります。また、H.265は対応していません。


関連記事

Qiitaに少し解説を書いています。

Qiita.com ATOMCam2を少し改造して導入してみた

Qiita.com AtomSwingを少し改造して遊んでみた

atomcam_toolsのtimelapseの負荷低減

atomcam_toolsのHomeKit, RTMP対応

ATOMSwingのtimelapseで星座追尾


使用法

https://github.com/mnakada/atomcam_tools/releases/latest

からatomcam_tools.zipをダウンロードし、適当なツールで解凍します。

解凍されて出てきたすべてのファイルを、ATOMCamで使用可能なmicroSDカードのルートフォルダに保存します 。

複数台運用する場合はhostnameを修正して重複しない様に設定してください。

保存したmicroSDカードをATOMCamに入れて電源を入れます。

SD-Cardはできるだけ高速なものをFAT-FSで使用してください。

AtomCamのu-bootがexFATに対応していないため、exFATだとhackが認識されず起動されません。

また、メモリ不足をSD-Card上のswapで補っているため、遅いメディアだと負荷が高くなりすぎてうまく動かない事があります。（Class10以上を推奨）


Web設定画面

http://atomcam.local を開くと設定画面にアクセスできます。

mDNS未対応で開けない場合は、ATOMCam純正アプリや、IPアドレス確認ツールなどでATOMCamのIPアドレスを確認し、 ブラウザで http://[ATOMCamのIPアドレス] を開きます。

上のタイトル帯には左にタイトルとtoolsのVer.、真ん中にCameraの種類とVer.、その右にカメラ内の時間、右端に言語設定とこの説明ページへのlinkボタンがあります。

左側には各ページの切り替えのタブがあります。ここを選択する事でページが切り替わります。

以下、各タブのページの説明になります。


カメラ画像

最初に上記のカメラ画像のページが開きます。

AtomSwingの場合はPan/Tiltのスライダーがカメラ画面の左と下に表示され、つまんで動かす事ができます。

AtomCam / WyzeCamV3の場合はスライダーは表示されません。

右下にはナイトビジョンのon/auto/offの切り替えボタンがあります。


カメラ設定（ATOMCam/ATOMSwingのみ）

ATOMアプリのカメラの設定項目の機能をWebからも設定できるようにしました。

このページの設定はATOMアプリ同様に切り替えたタイミングでカメラに反映されるため、右下の設定ボタンはありません。

機能設定

- ナイトビジョン

ナイトビジョンのon/auto/offの切り替えをします。

onにすると暗視の白黒画像、offにするとカラー画像、autoにすると環境に応じて自動切り替えになります。

- 切り替えタイミング（auto選択時のみ)

ナイトビジョンがautoの時の切り替えタイミングの設定です。

切り替えタイミングを暗い／非常に暗いから選択します。

- 赤外線ライト（on/auto選択時のみ）

ナイトビジョンの時に赤外線ライトを点灯するかどうかの選択です。

検出設定

- モーション検知

モーション検知でモーション検知録画をするかどうかの設定です。

ここをonにしていないと録画設定のモーション検知録画が動作しません。

- 感度調整

モーション検知の感度を高／中／低から選択します。

- サウンド検知

サウンド検知でモーション検知録画をするかどうかの設定です。

- 感度調整

サウンド検知の感度を高／中／低から選択します。

- 火災／CO警報音検知

火災／CO警報音検知でモーション録画をするかどうかの設定です。

- モーションタグ

モーション検知時に緑色の枠を表示します。

- 録画モード

連続録画の記録をモーション検知のみ行うか検知してなくても録画するかの設定です。

その他

- ステータスランプ

正面のLEDの点灯を設定します。

- 画像180°反転

画像を180°回転させます。

- タイムスタンプ

画面右側のタイムスタンプの表示を設定します。

- ロゴ

画面左側のwatermark(ロゴ)の表示を設定します。

このロゴはSD-Cardに下記のファイルを置くことで置き換えることができます。

filename: watermark.bgra
先頭8byteにLittleEndian 32bit intでロゴのY size, X size
それ以降はBGRA32bit/pixelのフォーマットでbitmapを配置
最大 width:500px, height: 80px（wyzecamの場合は60px)

defaultは　atomcam_tools　の文字がロゴの代わりに表示されます。

元々のATOMのロゴに戻すにはSD-Cardに空のwatermark.brga ファイルを置いてください。


SD Card

カメラ内のSD-Cardの映像記録のフォルダーにアクセスできます。

alarm_recordはモーション検知録画、recordは連続録画、time_lapseはタイムラプスの保存されているフォルダーです。

ファイルをクリックすることでmp4, jpegファイルを開くことができます。

smbアクセスでSD-Cardを開くよりもこちらで開く方が負荷が少ないです。


録画設定

連続録画

SD-Card/NASのrecordフォルダーに１分ごとのファイルが記録されます。

モバイルアプリからアクセスされるためSD-Cardのファイル名は変更できません。そのため保存するパスの設定はできません。

モーション検知録画

ATOMCamアプリで設定した検出時にクラウドサーバーに保存される12秒の映像と静止画をSD-Card/NASにも記録します。記録されるフォルダーは alarm_record です。

！！！　「録画ファイルの自動削除」で保存日数を指定しないと一杯になっても削除されません　！！！

以下、各録画項目内の設定です。

- SD-Card録画

SD-Cardへの記録をします。

- NAS録画

NASへの記録をします。

- 保存するPATH

指定フォルダ以下のファイルのPATHを指定します。最後に拡張子が自動的に付加されます。

書式はstrftimeの指定形式です。最後の/以降はファイル名として後ろに.mp4が付加されます。

例えば %Y%m%d/%H%M%S を指定すると/alarm_record/20211128/223000.mp4 というようなファイルが作られます。

フォルダがない場合は自動で作成します。

- ファイルの自動削除

保存日数で指定した日を超えたファイルを自動削除する機能です。

自動で削除したくない場合はoffにしてください。

容量にご注意ください。

- 保存日数

録画ファイルを保存しておく日数です。この日数経過すると自動的に削除されます。

- 録画スケジュール

スケジュールを選ぶと、曜日と時間帯を指定する項目が追加されます。

映像を記録する時間帯を設定します。

右端のー/＋で指定項目を削除/追加できます。複数の項目はor条件で効きます。


タイムラプス設定

SD-Card/NASに指定した一定時間毎に映像を記録します。早送りのような映像が作成できます。

指定した全記録が終わるまではmp4ファイルが完成しません。

設定項目は下記以外は録画設定と同じです。

- サンプリング設定

開始する曜日と時間を指定します。

録画の完了する時間が計算されますが、この時刻の後にmp4への変換処理をするので次の録画スタートまで５分以上間を空けてください。

開始時刻から周期と回数で指定された枚数の記録をとり指定されたフレームレートの録画ファイルを生成します。

右側の＋／ーで設定項目を増減できます。

サンプリングの時間設定が重ならない様に設定してください。

開始時間に他のサンプリングが実行中の場合、そのサンプリングはskipされます。

- 出力fps

出力ファイルの再生フレームレートを指定します。数値は1秒間の表示枚数です。

- 動作状態

動作中は進捗を表示します。

- 中止

動作中に停止したい場合は、Lockを外して中止ボタンを押してください。

mp4ファイルを生成して中止します。


メディア設定

SD-Card設定

- smbアクセス

onにするとSD-Cardの /record, /time_lapse, /alarm_record をSamba4.0でデバイス名のネットワークフォルダとしてLAN内に公開します。

​ ※ 負荷が重いためストリーミングRTSPと同時使用は推奨しません。

　　　Webアクセスの方が負荷が少ないです。

- 録画を直接記録

offにすると一旦RAM-Diskにファイルを生成してからSD-Cardにコピーします。

onにするとSD-Cardに直接ファイルを生成します。

SD-Cardのスピードや各種設定によって最適な設定が分からないため設定を変えて試してください。

SD-Cardに記録される常時録画かモーション検知録画のファイルに効果があります。

- SD-Card消去

SD-Cardのrecord, alarm_record, time_lapseフォルダの中身を消去します。

SD-Cardにtoolが入っているため、アプリからのSD-Cardのフォーマットをdisableしています。

その代替手段として用意しています。

Lockスイッチを解除してからEraseボタンを押してください。


NAS設定

- ネットワークPATH

NASのホスト名＋フォルダー名を//[ホスト名]/[フォルダー名] の形式で指定します。

- アカウント

NASにアクセスするためのアカウント（ユーザー名）を指定します。

- パスワード

NASにアクセスするためのパスワードを指定します。（このパスワードは生値でSD-Cardに保存されます）


配信設定

RTSP

※ 負荷が重いためSD-Cardのネットワークアクセスと同時使用は推奨しません。

画面は説明のために全てonにしていますが、配信自体も処理が重たい為使わないところはできるだけoffにしてください。

Main

Main(video0)側のRTSPストリーミングを行います。

HD AVCの出力になります。

- 音声

Main側の音声を切り替えます。

音声を配信したくない場合はoffに、HomeKitとWebRTCはOPUS、RTMPはAACを選択します。RTSPだけを使う場合はどれでも構いません。

- URL

Main側のVLC media playerの「ネットワークストリーミングを開く」で入力するURLが表示されます。

Main HEVC (ATOMCamのみ)

Main(video2)側のRTSPストリーミングを行います。

HD HEVCの出力になります。

- 音声

Main HEVC側の音声を切り替えます。

RTSPのみの対応なので音声はどれでも構いません。

- URL

Main HEVC側のVLC media playerの「ネットワークストリーミングを開く」で入力するURLが表示されます。

Sub

Sub(video1)側のRTSPストリーミングを行います。

360p/320pの出力になります。

- 音声

Sub側の音声を切り替えます。

RTSPのみの対応なので音声はどれでも構いません。

- URL

Sub側のVLC media playerの「ネットワークストリーミングを開く」で入力するURLが表示されます。

RTSP over HTTP

RTSPをUDPでなくHTTP経由で送出します。

AtomCamからPCまでの経路でのパケット伝送が保障されますが、再送により遅延が発生する可能性があります。

変更するとRTSP Main/SubのURLが変わります。

パスワード認証

RTSPにパスワード認証を要求します。

- アカウント

RTSPのアカウントを設定します。

- パスワード

RTSPのパスワードを設定します。

HomeKit

HomeKitのOn/Offを設定します。

Onにしたあと設定ボタンを押すとしばらくしてQR-Codeが表示されます。

iOSのホームアプリで右上の＋を開いてアクセサリを追加の画面でQR-Codeを読み取ってください。

登録完了するとQR-Codeが消えて下記の画面に切り替わります。

強制接続解除

iOS側で登録を解除しても、解除のタイミングによっては設定が残ることがあります。

iOSで解除してもQR-Codeが表示されない場合は強制接続解除を実行してください。

HomeKitのアクセサリーは同時に複数のiOS/HomeHUBには接続できません。

（iOS/HomeHUBに複数のアクセサリーは登録できます）

RTMP

RTMPのOn/Offを設定します。

URLに配信先のURLを設定してください。

YouTube liveへの配信の場合はrtmp://a.rtmp.youtube.com/live2/<livekey>の形式になります。

配信するアカウントのYouTube Studioのライブ配信設定を確認してください。

WebRTC

WebRTCのOn/Offを設定します。

URLをコピーしてブラウザで開くか、Linkボタンで開くことができます。


イベント通知

WebHook

動体検知や録画ファイルの書き込み等のイベントのタイミングで指定のURLに通知します。

- 通知URL

WebHookを受け取るURLを指定します。今のところ実験的な実装なのでLAN内のnon-secureなpostを想定しています。

{ type: 'event名', data: あれば何か }の形式でpostします。

- 未認証接続許可

URLが自己証明書等の認証されていない証明書を提示しても接続を許可します。

- 動体検知

動体検知が働いた時に通知URLに type: alarmEvent をpostします。

- 動体認識情報

動体検知の認識情報取得時に通知URLに type: recognitionNotify, data: recognition data をpostします。

- 動体検知録画終了

動体検知での録画が終了した時に通知URLに type: uploadVideoFinish をpostします。

- 動体検知録画転送

動体検知での録画が終了した時に通知URLに mime:video/mp4で録画ファイル をpostします。

- 動体検知静止画保存

動体検知での静止画保存完了時に通知URLに type: uploadPictureFinishをpostします。

- 動体検知静止画転送

動体検知での静止画保存完了時に通知URLに mime:image/jpegで静止画ファイルをpostします。

- 定常録画保存

１分間の定常録画が終了するたびに通知URLに type: recordEventをpostします。

- タイムラプス開始

タイムラプス開始時に通知URLに type: timelapseStart, data: timelapse pathをpostします。

- タイムラプス記録

タイムラプス記録のたびに通知URLに type: timelapseEvent, data: timelapse pathをpostします。

- タイムラプス録画終了

タイムラプス録画終了時に通知URLに type: timelapseFinish, data: timelapse pathをpostします。


クルーズ設定（AtomSwingのみ）

Swing座標初期化

Swingのpan/tilt座標系を初期化します。

両側の端点に当てることでモーターの動作範囲をリセットさせるための動作をします。

クルーズ動作

クルーズ動作のOn/Offの設定とシーケンス登録

以下の項目を登録順に動作し、最後までいくと最初に戻って繰り返します。

シーケンスの１項目を選択中は薄緑の色がつきます。色がついてる項目を編集できます。

右端のー、＋マークで項目の削除、追加ができます。

編集するときは、一旦クルーズをOffにして設定してからにしないとカメラの方向が動いてやりにくいです。

- pan, tilt,速度

カメラを向ける方向と移動時の速度を指定します。

pan,tiltは数値を直接入力するか、Jpeg表示の左、下にあるスライダーで方向を制御しても入力できます。

速度は１が低速、９が高速です。

- 動作後待機時間

カメラの移動が終わってから、次の移動までの待機時間を秒数で指定します。

- 検知

待機時間中に動体検知すると、待機時間を延長します。

動体検知が終わってからの待機時間は下の項目の検知後待機時間になります。

- 追尾

待機時間中に動体検知すると、動体を追尾し、待機時間を延長します。

検知後待機時間は上記の検知と同様です。

- 検知後待機時間

検知後の待機時間中も動体検知は働いて、待機時間の間検知しないと次のシーケンスに進みます。

- 追尾速度

追尾時の移動速度です。

速度は１が低速、９が高速です。


システム設定

デバイス設定

- デバイス名

カメラのデバイス名を設定します。 ここで設定した名前はCIFS(Samba) / mDNS(avahi) / NASのフォルダー名に使用されます。

- ログイン認証

アカウントとパスワードを設定することでWebUIの簡易ログイン認証を行います。

md5によるdigest認証なので安全ではありません。LAN内での簡易認証として使用してください。

- アカウント

１文字以上の英数記号を使用できます。但し':'と'\'は使用できません。

特にエラーチェックはしてないので入れるとおかしくなるかもしれません。

- パスワード

１文字以上の英数記号を使用できます。但し':'と'\'は使用できません。

特にエラーチェックはしてないので入れるとおかしくなるかもしれません。

動体検知

- 動体検知周期の短縮

動体検知アラームの不感知期間を５分から30秒に短縮します。

設定変更時には反映するために再起動されます。

- 動体検知録画upload停止

動体検知時にAtomTechのawsサーバーに12秒間の録画データがuploadされますが、このuploadを停止します。これを停止するとAtomCamのアプリから録画データを見る事ができなくなります。

設定変更時には反映するために再起動されます。

ビデオ設定

- フレームレート

１秒あたりのフレーム数(1-28fps)を設定します。

- Mainの帯域

Main HDのビットレート(300-2000bps)を設定します。

- MainHEVCの帯域 (ATOMCamのみ)

Main H.265/HEVC HDのビットレート(300-2000bps)を設定します。

- Subの帯域

Sub360p/320pのビットレート(100-500bps)を設定します。


メンテナンス

モニタリング

- Network確認

LANとの接続を確認し、再接続を試みます。

- 異常時再起動

LANとの接続ができない状態が継続した場合、システムの再起動をします。

- ping

定期的な疎通確認を行います。

- 通知URL

疎通確認をするURLを指定します。

ここで指定したURLにhttp getを１分毎に行います。

Update

- Update

GitHubのLatest VersionにUpdate します。GitHubからLatest Versionをダウンロードして展開して書き込み再起動します。180秒くらいかかります。

現在のtoolのバージョン（タイトル部に表示されています）がLatest Versionより古い場合のみUpdateすることができます。

台数が多い場合や回線が細い場合、PCでGitHubのLatest Versionのatomcam_tools.zipをダウンロードし、展開せずにそのままSamba経由でSD-Cardのupdateフォルダに入れて、リブートすることでもUpdateできます。この場合はVerのチェックは行われません。

- カスタム更新ZIPファイル

Updateの更新ZIPファイルを指定のURLから取得します。

独自のpackage buildをする場合の用途になります。

再起動

- 定期リスタート

カメラのシステムを指定したスケジュールで再起動します。

ネットワークの不調など、何らかの理由でATOMCamが連続稼働することができない場合の対応ですが、必ずしもこれによって問題が解決するとは限りません。

- リブート

AtomCamを再起動します。

Lockスイッチを解除してRebootボタンを押してください。

再起動に60~80秒くらいかかります。


Copyright

LICENSEファイルを参照してください