State Commands

Last updated: 2025/5/22 17:15:3
Path To	Name	Description/Function
/api/state	/full	Get the state of the camera.
/api/state	/partial	Get the state of the camera.
/api/state	/getprops	Get the state of the camera.

/full

Function	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.5.0.14", "auxinput.AuxDevice0": "AquoreaMk3", "auxinput.BaudRate0": "115200", "auxinput.Standard0": "RS485", "auxinput.AuxDevice1": "Laser", "auxinput.BaudRate1": "115200", "auxinput.Standard1": "RS485", "clock.InternalDateTime": "1747848654193", "device.SerialNumber": "19001", "device.Nickname": "Software QA BPC", "device.RomVersion": "4.5.0.14-dev-704", "device.FirmwareVersion": "SubC Rayfin v12.2.5", "device.Generation": "Mk2", "device.StorageRemaining": "313", "device.TotalStorage": "422", "device.AmbientTemperature": "41.66", "device.CPUTemperature": "408", "device.Humidity": "8.99", "device.TeensyMode": "Normal", "expansion.ExpansionPortType": "None", "exposure.IsAutoExposure": "False", "exposure.ExposureValue": "0", "focus.IsAutoFocus": "True", "focus.FocusValue": "1.88", "focus.FarLimit": "511", "focus.NearLimit": "0", "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": "5", "led.IsStrobeEnabled": "False", "led.StrobeBrightness": "5", "lens.ZoomLevel": "1", "lens.LensType": "Stock", "network.DNS1": "8.8.8.8", "network.DNS2": null, "network.Gateway": null, "network.IPAddress": "192.168.2.100", "network.IsStaticIP": "False", "network.StaticIPAddress": "192.168.1.85", "network.SubnetMask": "255.255.255.0", "network.ConnectionSpeed": "100", "ntp.IsEnabled": "True", "ntp.Server": "pool.ntp.org", "ntp.NtpClockDrift": "0.395499974489212", "ntp.NtpClockDriftThreshold": "1", "ois.IsOISEnabled: ": "True", "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": "5000", "rtsp.Resolution": "1280x720", "rtsp.VideoCodec": "H265", "rtsp.BitrateMode": "vbr", "script.IsScriptExecuting": "False", "shutter.ShutterLock": "30", "shutter.IsShutterLocked": "False", "shutter.ShutterLimit": "0", "shutter.ShutterFramerate": "30", "shutter.ShutterNanoseconds": "33333333", "still.JPEGQuality": "1", "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": "3", "time.TimeZone": "America/St_Johns", "whitebalance.Presets": "", "whitebalance.WhiteBalanceMode": "auto", "whitebalance.RedChannel": "2.340773", "whitebalance.GreenChannel": "1", "whitebalance.BlueChannel": "2.505018", "zsl.IsZSLEnabled": "False" }

/partial

Function	Get the state of the camera based on requested objects/props.
Method	Post
Body	CODE `[ "whitebalance", "time" ]`
Response	A partial camera state.
Explanation	Takes a collection of objects and request all possible matches related with values.
Example	CODE `http://IP_ADDRESS:8080/api/state/partial` Example 1 CODE `[ "whitebalance", "time" ]` Output CODE `curl -X POST http://<ip>:<port>/api/state/partial -H 'Content-Type: application/json' -d '[ "whitebalance", "time" ]'`
Response Type	JSON object
Response Example	CODE `} "time.TimeZone": "America/St_Johns", "whitebalance.Presets": "", "whitebalance.WhiteBalanceMode": "auto", "whitebalance.RedChannel": "2.340773", "whitebalance.GreenChannel": "1", "whitebalance.BlueChannel": "2.505018" }`

/getprops

Function	Lookup the states of the submitted properties of the camera.
Method	Post
Body	CODE `[ "whitebalance.RedChannel" ]`
Response	The specific properties from camera state.
Explanation	Takes a submitted object and returned it’s submitted value in a JSON result.
Example	Example 1 CODE `[ "whitebalance.RedChannel" ]` Output CODE `curl -X POST http://<ip>:<port>/api/state/getprops -H 'Content-Type: application/json' -d '[ "whitebalance.RedChannel" ]'`
Response Type	JSON Object
Response Example	CODE `{ "whitebalance.RedChannel": "2.340773" }`