Soracom

S⁺ Camera シリーズ では Web サービス (以下、API) が動作しています。この API を呼び出すことで、カメラの設定を変更したりカメラ画像を確認したりできます。

S⁺ Camera シリーズ 上で動作するアルゴリズムから API を呼び出す場合と、Napter でリモートアクセスして API を呼び出す場合は、エンドポイントが異なります。

アルゴリズムなど S+ Camera シリーズ内部から API を呼び出す

S⁺ Camera シリーズ 上で動作するアルゴリズムからは、以下のように API を呼び出します。

カメラの状態を確認する例：

curl -X GET http://127.0.0.1:8080/v1/cameraState

$ curl -X GET http://127.0.0.1:8080/v1/cameraState
curl: (7) Failed to connect to 127.0.0.1 port 8080: Connection refused

$ sudo systemctl status soracom-deviceinterface.service
● soracom-deviceinterface.service - "SORACOM Device Interface"
   Loaded: loaded (/etc/systemd/system/soracom-deviceinterface.service; enabled; vendor preset: enabled)
   Active: inactive (dead) since Mon 2022-02-14 17:08:34 JST; 1s ago
    :

$ sudo systemctl stop soracom-deviceinterface.service
$ sudo systemctl start soracom-deviceinterface.service

Napter でリモートアクセスして S+ Camera シリーズ外部から API を呼び出す

Napter を利用して S⁺ Camera シリーズ へリモートアクセスして、API を呼び出すこともできます。

リモートアクセスを有効にする

1. S⁺ Camera シリーズ へのリモートアクセスを有効にします。

   詳しくは、S+ Camera シリーズが提供する API を外部から利用するためにリモートアクセスする場合 を参照してください。

2. 以下のコマンドを実行して、URL を変数に代入します。

   ${surplusRemoteAccessURL} には、リモートアクセスを有効にしたときに [HTTP(S)] に表示された URL を入力してください。

   $ surplusRemoteAccessURLforCameraSettings=${surplusRemoteAccessURL}
   

API を呼び出す

Napter を利用して S⁺ Camera シリーズ へリモートアクセスした場合は、以下のように API を呼び出します。

カメラの状態を確認する例：

curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/deviceState

利用できる API

S+ Camera シリーズの状態を取得する

S⁺ Camera シリーズ の状態を取得します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/deviceState
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/deviceState
  

レスポンス

カメラの状態および設定を取得する

カメラの状態および設定を取得します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/cameraState
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/cameraState
  

レスポンス

カメラの状態および設定が JSON 形式で表示されます。主なプロパティは以下のとおりです。

カメラの異常を検知したときに OS を自動的に再起動する

S⁺ Camera シリーズ には、カメラが停止していたり、同じ画像が繰り返し撮影されていることを検知したときに OS を自動的に再起動する機能が用意されています。この機能の有効 / 無効を切り替えます。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/startImageErrorReboot
  

カメラを再起動する

カメラを再起動します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:9000/mosaic/v1/SystemInterface/reboot?mode=0
  

カメラの設定を変更する

カメラの設定を変更します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X PATCH http://127.0.0.1:8080/v1/cameraState \
  -H "Content-Type: application/json" \
  -d '{
    "width":640,
    "height":480
  }'
  

• 外部から API を呼び出す場合：

  curl -X PATCH ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/cameraState \
  -H "Content-Type: application/json" \
  -d '{
    "width":640,
    "height":480
  }'
  

ヘッダー

リクエストボディ

JSON 形式でカメラの設定を指定します。

レスポンス

カメラの状態および設定が JSON 形式で表示されます。主なプロパティは以下のとおりです。

カメラの撮影を有効化する

カメラの撮影を有効化します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/startCameraCapture
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/startCameraCapture
  

カメラの撮影を無効化する

カメラの撮影を無効化します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/stopCameraCapture
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/stopCameraCapture
  

カメラ画像 (静止画・非圧縮データ) を取得する

カメラで撮影した静止画の非圧縮データ (width x height x RGB) を取得します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/cameraImage --output image.bin
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/cameraImage --output image.bin
  

レスポンス

カメラで撮影した静止画の非圧縮データ (width x height x RGB) が返されます。

カメラ画像 (静止画・JPEG 形式データ) を取得する

カメラで撮影した静止画の JPEG 形式データを取得します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/cameraJpegImage?quality=85 --output image.jpg
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/cameraJpegImage?quality=85 --output image.jpg
  

クエリパラメーター

レスポンス

カメラで撮影した静止画の JPEG 形式データが返されます。

カメラ画像 (静止画・WebP 形式データ) を取得する

カメラで撮影した静止画の WebP 形式データを取得します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/cameraWebpImage?quality=85 --output image.webp
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/cameraWebpImage?quality=85 --output image.webp
  

クエリパラメーター

レスポンス

カメラで撮影した静止画の WebP 形式データが返されます。

カメラ画像 (動画) の録画を開始する

カメラで録画を開始します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/startCameraRecording
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/startCameraRecording
  

カメラ画像 (動画) の録画を終了する

カメラで録画を終了します。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8080/v1/stopCameraRecording
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/DeviceInterface/stopCameraRecording
  

m3u8 ファイルを取得する

開始時刻と終了時刻を指定して、m3u8 形式のファイルを取得します。取得した m3u8 形式のファイルを ffmpeg などで処理すると、動画データをダウンロードできます。

m3u8 形式のファイルは、動画のプレイリストを配布するためのファイル形式です。

• S⁺ Camera シリーズ 内部から API を呼び出す場合 (例：アルゴリズムから呼び出す場合、または SSH ログインした状態から呼び出す場合)：

  curl -X GET http://127.0.0.1:8086/v1/m3u8/${startTime}/${endTime}/index.m3u8
  

• 外部から API を呼び出す場合：

  curl -X GET ${surplusRemoteAccessURLforCameraSettings}/mosaic/v1/LocalHarvestAgent/m3u8/${startTime}/${endTime}/index.m3u8
  

パスパラメーター

レスポンス

パスパラメーターで指定した時間 (目安) に撮影された動画がリストアップされた m3u8 形式のファイルが返されます。

m3u8 形式のファイルを利用して、動画データをダウンロードする方法について詳しくは、リモートアクセスを利用してカメラ画像 (動画) をダウンロードする を参照してください。