Skip to main content
POST
/
api
/
camera
/
getFullCameraState
Get full camera state
curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/getFullCameraState \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "force": false
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "fullCameraState": {
    "afSupport": true,
    "audioSupported": true,
    "baseVideoOperationUri": "<string>",
    "connectionStatus": "RED",
    "connectionTimestampMs": 123,
    "createdAtMillis": 123,
    "defaultInterface": "<string>",
    "defaultInterfaceMac": "<string>",
    "directionRadians": 123,
    "externalIPAddress": "<string>",
    "facetNameMap": {},
    "firmwareUpdateInProgress": true,
    "firmwareVersion": "<string>",
    "floorNumber": 123,
    "healthStatus": "RED",
    "healthStatusDetails": "DISCONNECTED",
    "hwVariation": "RASPBERRY_PI_3",
    "lanAddresses": [
      "<string>"
    ],
    "latestFirmwareVersion": "<string>",
    "latitude": 123,
    "liveStreamShared": true,
    "liveStreamsSharedCount": 123,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "longitude": 123,
    "maxZoomPercent": 123,
    "mediaRegion": "<string>",
    "mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "mummified": true,
    "name": "<string>",
    "onCameraState": {},
    "onCloudState": {},
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "region": "<string>",
    "secondaryLanAddresses": [
      "<string>"
    ],
    "serialNumber": "<string>",
    "ssid": "<string>",
    "stateUpdatedTimestampMs": 123,
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "supportedFacets": [
      "v0, a0"
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "versionsBehind": 123,
    "wifiApMac": "<string>",
    "wifiBars": 123,
    "wifiSignalStrength": 123
  },
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to retrieve the full state information of a camera.

cameraUuid
string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

force
boolean | null

Whether to force a refresh of the camera state

Example:

false

Response

200 - application/json

OK

Response containing the full state information of a camera.

error
boolean | null
errorMsg
string | null
fullCameraState
object

Full device state information for the robot

warningMsg
string | null