PD File's Handler

デフォルトパス

PD File's Handler に関連するファイルのデフォルトパスは次の通りです。

PD File's Handler に関連するファイルのデフォルトパス

パス名説明
/usr/sbin/pd_files_handler常駐実行オブジェクト(デーモン)
/lib/systemd/system/pd_files_handler.serviceSystemd Service ファイル
/etc/init.d/pd_files_handlerRC ファイル
/var/webui/config/pd_files_handler.conf設定ファイル
/var/run/pd_files_handler.pidPID ファイル

設定ファイルの書式

構文

{
"enable" : <bool値>,
"res_memory": <常駐メモリの増加分の上限値>,
"debug": <デバッグレベル>,
"interval": <処理間隔>,
"folder": "<ファイルフォルダのパス名>",
"cloud": "<'webdav'|'aws'|'google'>",
"fn_mode": "<'asis'|'md5'|'sha256'|'timestamp'|'serial'>",
"url": "<アップロード先URL>",
"content_type": "application/octet-stream",
"conn_timeout": <HTTP接続タイムアウト>,
"timeout": <HTTP処理タイムアウト>,
"truststore": "<Root CA 証明書のパス名>",
"ssl_verify": <bool値>,
"username": <WebDAV のBASIC 認証ユーザ名>,
"password": <WebDAV のBASIC 認証パスワード>,
"accessid": <AWS S3 のアクセスID>,
"accesskey": <AWS S3 のアクセスキー>,
"accesskey_id": <GCS のアクセスキーID>,
"accesskey_secret": <GCS のアクセスキーシークレット>,
"metadata": <bool値>,
"serial": "<シリアル番号>",
"localname": "<デバイス番号>",
"push_to": "<送信先ソケット名>",
"location": <bool値>
}

Root オブジェクト

キーデータ型説明
enable論理値デフォルト値は false.
res_memory整数値常駐メモリの増加分の上限値(Mbyte). 上限を越えると基幹プロセスを再起動する. デフォルト値は16.
debug整数値デバックレベル 0 ~ 4. デフォルト値は0.
interval整数値処理終了から次の処理開始(ファイルの取り込み)までの間隔(sec). デフォルト値は 30.
folder文字列ファイルを取り込むディレクトリのパス名. デフォルト値は '/var/webui/pd files handler'.
cloud文字列アップロード先クラウドの種別. 'webdav'(WebDAV), 'aws'(Amazon S3),'google'(GCS: Google Cloud Strage) のいずれか. デフォルト値は'webdav'.
fn mode文字列アップロード先におけるファイル名. 'asis', 'md5', 'sha256', 'timestamp', 'serial' のいずれか. 'asis' は入力ファイル名をそのまま用いる. 'md5' は入力ファイル名にシリアル番号と時刻を連結した文字列のMD5 ハッシュ値. 'sha256' は入力ファイル名にシリアル番号と時刻を連結した文字列の SHA256 ハッシュ値. 'timestamp' は入力ファイル名に時刻を連結した '<filename><YYYYMMDDTHHMMSS.SSS>' 形式の文字列. 'serial' はシリアル番号に入力ファイル名と時刻を連結した '<serial><filename><YYYYMMDDTHHMMSS.SSS>' 形式の文字列. デフォルト値は 'sha256'.
url文字列アップロード先のURL. Amazon S3 の場合は 'https://<bucket>.s3.<region>.amazonaws.com'、GCS の場合は 'https://storage.googleapis.com/<bucket>'. パス名(フォルダ名)に UTF8 日本語文字列やスペース等を用いる場合は、URL RAW エンコードを行い指定する.
content_type文字列HTTP ヘッダーに付加される 'Content-Type'. デフォルト値は 'application/octet-stream'.
conn_timeout整数値HTTP の接続タイムアウト(sec). デフォルト値は 10.
timeout整数値HTTP の処理タイムアウト(sec). デフォルト値は 180.
truststore文字列SSL 接続に用いるRoot CA 証明書のパス名. デフォルト値は '/etc/ssl/certs/ca-certificates.crt'.
ssl verify論理値サーバー証明書の検証を行うか否か. デフォルト値はアップロード先が WebDAV の場合はfalse、AWS S3 又はGCS の場合は true.
username文字列WebDAV への接続に用いる BASIC 認証ユーザ名. 'cloud' が 'webdav' の場合のみ有効.
password文字列WebDAV への接続に用いる BASIC 認証パスワード. 'cloud' が 'webdav' の場合のみ有効.
accessid文字列Amazon S3 への接続に用いるアクセスID. 'cloud' が'aws' の場合のみ有効.
accesskey文字列Amazon S3 への接続に用いるアクセスキー. 'cloud' が 'aws' の場合のみ有効.
accesskey_id文字列GCS への接続に用いるアクセスキーID. 'cloud' が'google' の場合のみ有効.
accesskey_secret文字列GCS への接続に用いるアクセスキーシークレット. cloud' が'google' の場合のみ有効.
metadata論理値メタ情報を通知するか否か. デフォルト値はtrue.
serial文字列ファイルの送り元を識別するためのシリアル番号. デフォルト値は OpenBlocks IoT Family のシリアル番号.
localname文字列デバイスのローカル名. デフォルト値は 'files 0000001'.
push_to文字列メタ情報の送り先ソケット名. 文字列の先頭が '@' の場合は abstract namespace と解釈する. 空の場合は、デフォルト値 '@/pd_repeater/<localname>.sock' が設定される.
location論理値メタ情報にOpenBlocks IoT Family に設定されてる位置情報を付加するか否か. デフォルト値は false.

メタ情報の書式

構文

{
"file": "my_local_file",
"md5": "92b9e4bd5fad35ffe0f99ece151aab07",
"content-type": "application/octet-stream",
"mtime": "2021-10-27T12:39:22.038+09:00",
"size": 103720,
"url": "https://storage.googleapis.com/pd-files-handler/8cd6614bbeb74e0a90f21fbccff9b8a6",
"serial": "JAJ00400",
"latitude": 35.80568140199508,
"longitude": 139.6730942010726,
"elevation": 12.567,
"timestamp": "2021-10-27T12:39:27.000+09:00"
}

メタ情報オブジェクト

キーデータ型説明
file文字列アップロードしたファイルの元のファイル名.
md5文字列アップロードしたファイルのMD5 値.
content-type文字列HTTP ヘッダーに付加されたContent-Type.
mtime文字列アップロードしたファイルの更新日時.
size整数値アップロードしたファイルのサイズ(byte).
url文字列アップロードしたファイルのアップロード先 URL.
serial文字列アップロード元を識別するシリアル番号.
latitude実数値アップロード元の緯度.
longitude実数値アップロード元の経度.
elevation実数値アップロード元の標高.
timestamp文字列アップロードした時刻.