Skip to main content
Skip table of contents

State Commands

Last updated: 2026/1/7 22:53:14

Path To

Name

Description/Function

/api/state

/full

Get the state of the camera.

/api/state

/getprops

Get the state of the camera.

/api/state

/partial

Get the state of the camera.

/full

Description

Get the state of the camera.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/state/full

Response

The full camera state.

Response Type

JSON object

Response Example

CODE
{
  "app.Version": "4.7.1.2",
  "auxinput.AuxDevice0": "KongsbergPanTilt",
  "auxinput.BaudRate0": "9600",
  "auxinput.Standard0": "RS232",
  "auxinput.AuxDevice1": "AquoreaMk3",
  "auxinput.BaudRate1": "115200",
  "auxinput.Standard1": "RS485",
  "clock.InternalDateTime": "1767836998105",
  "device.SerialNumber": "00130",
  "device.Nickname": "DO NOT USE Adam Test Camera",
  "device.RomVersion": "4.7.1.2",
  "device.FirmwareVersion": "SubC Rayfin v12.2.7",
  "device.Generation": "Mk2",
  "device.StorageRemaining": "369",
  "device.TotalStorage": "422",
  "device.AmbientTemperature": "29.33",
  "device.CPUTemperature": "462",
  "device.Humidity": "12.62",
  "device.TeensyMode": "Normal",
  "expansion.ExpansionPortType": "Output",
  "expansion.IsOn0": "True",
  "expansion.IsOn1": "False",
  "expansion.IsOn2": "False",
  "expansion.IsOn3": "False",
  "expansion.IsFaulted0": "False",
  "expansion.IsFaulted1": "False",
  "expansion.IsFaulted2": "False",
  "expansion.IsFaulted3": "False",
  "exposure.IsAutoExposure": "False",
  "exposure.ExposureValue": "0",
  "focus.IsAutoFocus": "False",
  "focus.FocusValue": "0.1",
  "focus.FarLimit": "511",
  "focus.NearLimit": "416",
  "imu.IMUZero": "1.00:0.00:0.00:0.00",
  "imu.IsHorizontalOrientation": "True",
  "iso.ISOValue": "200",
  "laser.IsOn": "False",
  "laser.IsInverted": "False",
  "led.IsLEDOn": "False",
  "led.LampBrightness": "60",
  "led.IsStrobeEnabled": "False",
  "led.StrobeBrightness": "70",
  "lens.ZoomLevel": "1",
  "lens.LensType": "Stock",
  "network.DNS1": "8.8.8.8",
  "network.DNS2": null,
  "network.Gateway": null,
  "network.IPAddress": "192.168.2.128",
  "network.IsStaticIP": "False",
  "network.StaticIPAddress": "192.168.2.198",
  "network.SubnetMask": "255.255.255.0",
  "network.ConnectionSpeed": "1000",
  "ntp.Server": "pool.ntp.org",
  "ntp.NtpClockDrift": "4.04100036621094",
  "ntp.NtpClockDriftThreshold": "1",
  "ois.IsOISEnabled: ": "False",
  "pantilt.Pan": "13",
  "pantilt.Tilt": "37",
  "rdi.RDIRate": "0.5",
  "rdi.ActualRDIRate": "0.5",
  "rdi.IsRDIing": "False",
  "recording.Bitrate": "25",
  "recording.DirectoryTemplate": "Recording_SYNC_{yyyy}-{MM}-{dd}",
  "recording.Encoder": "H264",
  "recording.FilenameTemplate": "{HH}{mm}{ss}.{fff}",
  "recording.Framerate": "30",
  "recording.IsRecording": "False",
  "recording.MaxFileSize": "10",
  "recording.PathTemplate": "Recording_SYNC_{yyyy}-{MM}-{dd}/{HH}{mm}{ss}.{fff}",
  "recording.RecordingDuration": "00:00:00",
  "recording.Resolution": "HD",
  "rtsp.Framerate": "30",
  "rtsp.Bitrate": "10000",
  "rtsp.Resolution": "1920x1080",
  "rtsp.VideoCodec": "H265",
  "rtsp.BitrateMode": "vbr",
  "script.IsScriptExecuting": "False",
  "shutter.ShutterLock": "30",
  "shutter.IsShutterLocked": "False",
  "shutter.ShutterLimit": "33333333",
  "shutter.ShutterFramerate": "30",
  "shutter.ShutterNanoseconds": "33333333",
  "still.JPEGQuality": "75",
  "still.PathTemplate": "Still_SYNC_{yyyy}-{MM}-{dd}/{HH}{mm}{ss}.{fff}",
  "still.DirectoryTemplate": "Still_SYNC_{yyyy}-{MM}-{dd}",
  "still.FilenameTemplate": "{HH}{mm}{ss}.{fff}",
  "still.IsMonoEnabled": "False",
  "still.ImageFormat": "jpeg",
  "strobecompensation.ExposureStops": "0",
  "time.TimeZone": "America/St_Johns",
  "time.IsAuto": "True",
  "whitebalance.Presets": "",
  "whitebalance.WhiteBalanceMode": "auto",
  "whitebalance.RedChannel": "1.901219",
  "whitebalance.GreenChannel": "1",
  "whitebalance.BlueChannel": "1.702174",
  "zsl.IsZSLEnabled": "False"
}

/getprops

Description

Get the state of the camera.

Method

Post

Example

CODE
http://IP_ADDRESS:8080/api/state/getprops

Body

CODE
[
  "exposure",
  "focus"
]

Response

The specific properties from camera state.

Response Type

JSON object

/partial

Description

Get the state of the camera.

Method

Post

Example

CODE
http://IP_ADDRESS:8080/api/state/partial

Body

CODE
[
  "auxinput.AuxDevice0",
  "auxinput.BaudRate0",
  "auxinput.Standard0",
  "auxinput.AuxDevice1",
  "auxinput.BaudRate1",
  "auxinput.Standard1"
]

Response

A partial camera state.

Response Type

JSON object

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.