package bosdyn.api.spot_cam
Get desktop application:
View/edit binary Protocol Buffers messages
service AudioService
service.proto:117Upload and play sounds over the SpotCam's speakers.
rpc PlaySound (, )
service.proto:120Given a soundRequest that identifies a single sound present in the system's sound effects table, PlaySound executes the sound effect.
message
audio.proto:69Begin playing a loaded sound from the robot's speakers.
optional header = 1
Common request header.
optional sound = 2
The sound identifier as uploaded by LoadSoundRequest or listed in ListSoundsResponse.
optional gain = 3
If the gain field is populated, then volume of the sound is multiplied by this value. Does not modify the system volume level.
message
audio.proto:80Result of staring playback of a sound.
optional header = 1
Common response header.
rpc LoadSound (stream , )
service.proto:126LoadSound loads a sound effect into the system's sound table. The stream must contain a wav file, with a RIFF header describing it. The argument is a stream, to allow for sounds that are bigger then the MTU of the network; in this case, the complete stream must contain the entire sound. If the stream ends early, an error will be returned. The header and sound fields of the entire stream must be the same.
message
audio.proto:101Load a new sound onto the robot for future playback.
optional header = 1
Common request header.
optional sound = 2
Identifier for the sound. If the same identifier is used as a previously loaded sound, that sound will be overwritten with the new data.
optional data = 3
WAV bytes to be joined.
message
audio.proto:113Result of uploading a sound.
optional header = 1
Common response header.
rpc DeleteSound (, )
service.proto:128Delete the sound identified in the argument from the system's sound table.
message
audio.proto:87Remove a loaded sound from the library of loaded sounds.
optional header = 1
Common request header.
optional sound = 2
The sound identifier as uploaded by LoadSoundRequest or listed in ListSoundsResponse.
message
audio.proto:95Result of deleting a sound from the library.
optional header = 1
Common response header.
rpc ListSounds (, )
service.proto:130ListSounds returns a list of all of the sound effects that the system knows about.
message
audio.proto:27Request for all sounds present on the robot.
optional header = 1
Common request header.
message
audio.proto:33List of all sounds present on the robot.
optional header = 1
Common response header.
repeated sounds = 2
All sounds currently loaded.
rpc SetVolume (, )
service.proto:132Set the overall volume level for playing sounds.
message
audio.proto:41Set the desired volume level of the system.
optional header = 1
Common request header.
float volume = 2
volume, as a percentage of maximum.
message
audio.proto:49Result of changing the system volume level.
optional header = 1
Common response header.
rpc GetVolume (, )
service.proto:134Set the overall volume level for playing sounds.
message
audio.proto:55Query the current volume level of the system.
optional header = 1
Common request header.
message
audio.proto:61Provides the current volume level of the system.
optional header = 1
Common response header.
float volume = 2
volume, as a percentage of maximum.
message
audio.proto:126Request to set the audio capture channel
optional header = 1
AudioCaptureChannel channel = 2
message
audio.proto:132Result of setting the audio capture channel
optional header = 1
message
audio.proto:137Request to get the audio capture channel
optional header = 1
message
audio.proto:142Result of getting the audio capture channel
optional header = 1
AudioCaptureChannel channel = 2
rpc SetAudioCaptureGain (, )
service.proto:139message
audio.proto:148Request to set the audio capture channel
optional header = 1
AudioCaptureChannel channel = 2
double gain = 3
Gain for microphone, range from 0.0 to 1.0
message
audio.proto:156Result of setting the audio capture gain
optional header = 1
rpc GetAudioCaptureGain (, )
service.proto:140message
audio.proto:161Request to get the audio capture channel
optional header = 1
AudioCaptureChannel channel = 2
message
audio.proto:167Result of getting the audio capture gain
optional header = 1
double gain = 2
Gain for microphone, range from 0.0 to 1.0
Change the layout of of the video stream between available presets.
rpc SetScreen (, )
service.proto:28SetScreen changes the current view that is streamed over the network
message
compositor.proto:90Switch the camera layout in the video stream to the one specified.
optional header = 1
Common request header.
string name = 2
Identifier as specified in ListScreensResponse.
message
compositor.proto:99Result of setting the camera layout.
optional header = 1
Common response header.
string name = 2
Identifier of the screen used.
rpc GetScreen (, )
service.proto:30GetScreen returns the currently-selected screen
message
compositor.proto:26Request the current screen in use.
optional header = 1
Common request header.
message
compositor.proto:32Specify which screen is currently being displayed in the video stream.
optional header = 1
Common response header.
string name = 2
Identifier of the current screen.
rpc ListScreens (, )
service.proto:32ListScreens returns a list of available screens
message
compositor.proto:76Request the different screen layouts available.
optional header = 1
Common request header.
message
compositor.proto:82Response with all screen layouts available.
optional header = 1
Common response header.
repeated screens = 2
List of all screen layouts that can be selected.
rpc GetVisibleCameras (, )
service.proto:34GetVisibleCameras returns a list of currently visible windows, with any available metadata
message
compositor.proto:40Request information about the current cameras in the video stream.
optional header = 1
Common request header.
message
compositor.proto:47Description of the parameters and locations of each camera in the current video stream.
optional header = 1
Common response header.
repeated streams = 2
List of all camera streams visible in the current video stream.
rpc SetIrColormap (, )
service.proto:36set the mapping between radiometric IR samples to color, for video
message
compositor.proto:140optional header = 1
optional map = 2
message
compositor.proto:145optional header = 1
rpc GetIrColormap (, )
service.proto:38get the mapping between radiometric IR samples to color, for video
message
compositor.proto:149optional header = 1
message
compositor.proto:153optional header = 1
optional map = 2
rpc SetIrMeterOverlay (, )
service.proto:40apply settings for the 'ir meter overlay'
message
compositor.proto:194optional header = 1
optional overlay = 2
message
compositor.proto:199optional header = 1
rpc GetIrMeterOverlay (, )
service.proto:42retrieve settings for the 'ir meter overlay'
message
compositor.proto:203optional header = 1
message
compositor.proto:207optional header = 1
optional overlay = 2
service HealthService
service.proto:144Query temperature and built-in test results.
rpc GetTemperature (, )
service.proto:147GetTemperature returns a list of thermometers in the system, and the temperature that they measure.
message
health.proto:70optional header = 1
Common request header.
message
health.proto:75optional header = 1
Common response header.
repeated temps = 2
List of all temperatures measured.
rpc GetBITStatus (, )
service.proto:151GetBitStatus returns two lists; a list of system events, and a list of ways that the system is degraded; for instance, a degradation may include a missing PTZ unit, or a missing USB storage device.
message
health.proto:39Request the status of all built-in tests.
optional header = 1
Common request header.
message
health.proto:45Data on the current status of built-in tests.
optional header = 1
Common response header.
repeated events = 2
Fault events that have been reported.
repeated degradations = 3
List of system states that may effect performance.
rpc ClearBITEvents (, )
service.proto:153ClearBitEvents clears out the events list of the BITStatus structure.
message
health.proto:27Clear Built-in Test events.
optional header = 1
Common request header.
message
health.proto:33Response to clearing built-in test events.
optional header = 1
Common response header.
rpc GetSystemLog (, stream )
service.proto:157GetSystemLog retrieves an encrypted log of system events, for factory diagnosis of possible issues. The data streamed back should be concatenated to a single file, before sending to the manufacturer.
message
health.proto:83optional header = 1
message
health.proto:87optional header = 1
optional data = 2
service LightingService
service.proto:65Change the brightness level of individual LEDs.
rpc SetLEDBrightness (, )
service.proto:66message
LED.proto:31Set individual LED brightnesses.
optional header = 1
Common request header.
map<int32, float> brightnesses = 2
Brightness [0, 1] to assign to the LED located at indices [0, 3].
message
LED.proto:39Response with any errors setting LED brightnesses.
optional header = 1
Common response header.
rpc GetLEDBrightness (, )
service.proto:67message
LED.proto:17Request the current state of LEDs on the SpotCam.
optional header = 1
Common request header.
message
LED.proto:23Describes the current brightnesses of all LEDs.
optional header = 1
Common response header.
repeated float brightnesses = 2
Brightness [0, 1] of the LED located at indices [0, 3].
service MediaLogService
service.proto:71Trigger data acquisitions, and retrieve resulting data.
rpc Store (, )
service.proto:74Store queues up a Logpoint, which is a bit of media that the user wishes to store to disk (still images are supported for now, more media types will be supported in the future)
message
logging.proto:152Trigger a data acquisition.
optional header = 1
Common request header.
optional camera = 2
Which camera to capture.
Logpoint.RecordType type = 3
Type of data capture to perform.
string tag = 4
Metadata to associate with the store.
message
logging.proto:164Result of data acquisition trigger.
optional header = 1
Common response header.
optional point = 2
The log point returned here can be used to add a tag to the Logpoint later It will very likely be in th 'QUEUED' state.
rpc GetStatus (, )
service.proto:77GetStatus reads the 'name' field of the Logpoint contained in GetStatusRequest, and fills in the rest of the fields. Mainly useful for getting the 'state' of the logpoint.
message
logging.proto:95Request for status about the current stage of data acquisition.
optional header = 1
Common request header.
optional point = 2
Log point to query. Only the name is used.
message
logging.proto:103Provide an update on the stage of data acquisition.
optional header = 1
Common response header.
optional point = 2
The logpoint returned here can be used to add a tag to the Logpoint later
rpc Tag (, )
service.proto:79Tag updates the 'tag' field of the Logpoint that's passed, which must exist.
message
logging.proto:174Add tag metadata to an existing log point.
optional header = 1
Common request header.
optional point = 2
Logpoint to add metadata to. Name and tag are used.
message
logging.proto:182Result of adding tag metadata to a log point.
optional header = 1
Common response header.
rpc EnableDebug (, )
service.proto:82EnableDebug starts the periodic logging of health data to the database; this increases disk utilization, but will record data that is useful post-mortem
message
logging.proto:254Change debug logging settings on the SpotCam.
optional header = 1
Common request header.
bool enable_temperature = 2
Set true to enable logging of temperature data;
bool enable_humidity = 3
Set true to enable logging of humidity data;
bool enable_BIT = 4
Set true to enable logging of BIT events; BIT events are always recorded to volatile memory and can be viewed (and cleared) with the Health service, but this enables writing them to disk.
bool enable_shock = 5
Set true to enable logging of Shock data; this is on by default.
bool enable_system_stat = 6
Set to true to enable logging of system load stats cpu, gpu, memory, and network utilization
Nowow a BIT, set true to enable logging of led driver status. bool enable_led_stat = 7;
message
logging.proto:277Response with any errors for debug setting changes.
optional header = 1
Common response header.
rpc ListCameras (, )
service.proto:84ListCameras returns a list of strings that identify valid cameras for logging
message
logging.proto:188Request the available cameras.
optional header = 1
Common request header.
message
logging.proto:194Provide the list of available cameras.
optional header = 1
Common response header.
repeated cameras = 2
List of all cameras which can be used in a StoreRequest.
rpc RetrieveRawData (, stream )
service.proto:86Retrieve returns all raw data associated with a given logpoint
message
logging.proto:135Retrieve the binary data associated with a log point, with no processing applied. Storing a panorama will retrieve tiled individual images. For IR, the temperature at each pixel is 0.1 * the int value in Kelvin.
optional header = 1
Common request header.
optional point = 2
Log point to retrieve. Only the name is used.
message
logging.proto:142optional header = 1
Common response header.
optional logpoint = 2
Log point retrieved.
optional data = 3
Data chunk bytes field should be concatenated together to recover the binary data.
rpc Retrieve (, stream )
service.proto:88Retrieve returns all data associated with a given logpoint
message
logging.proto:112Retrieve the binary data associated with a log point.
optional header = 1
Common request header.
optional point = 2
Log point to retrieve. Only the name is used.
message
logging.proto:123Provide the data stored at a log point. Store() dictates what processing happens in this response. c0 -> c4 will return the raw (rgb24) fisheye image of the camera at that index. Storing a panorama will process the data into a stitched image.
optional header = 1
Common response header.
optional logpoint = 2
Log point retrieved.
optional data = 3
Data chunk bytes field should be concatenated together to recover the binary data.
rpc Delete (, )
service.proto:90Delete removes a Logpoint from the system
message
logging.proto:81Delete a log point from the store.
optional header = 1
Common request header.
optional point = 2
Log point to delete. Only the name is used.
message
logging.proto:89Response to a deletion with any errors that occurred.
optional header = 1
Common response header.
rpc ListLogpoints (, stream )
service.proto:93ListLogpoints returns a list of all logpoints in the database. Warning: this may be a lot of data.
message
logging.proto:203List all available log points, whether they have completed or not.
optional header = 1
Common request header.
message
logging.proto:209Provide all log points in the system.
optional header = 1
Common response header.
repeated logpoints = 2
List of all the individual log points concatenated into a list. This stream may take a long time to complete if there are a lot of stored images.
rpc SetPassphrase (, )
service.proto:97SetPassphrase sets the eCryptFS passphrase used by the filesystem. there is no symmetry here, because key material is write-only This rpc is now deprecated as of the switch from EXT4 to NTFS and returns UnimplementedError
message
logging.proto:218Set encryption for the disk.
optional header = 1
Common request header.
string passphrase = 2
After setting the passphrase, please reboot the system to remount the encrypted filesystem layer.
message
logging.proto:248Response from setting the disk encryption. After setting the passphrase, please reboot the system to remount the encrypted filesystem layer.
optional header = 1
Common response header.
service NetworkService
service.proto:162Modify or query network settings of the SpotCam and ICE resolution servers.
rpc SetICEConfiguration (, )
service.proto:165SetICEConfiguration sets up parameters for ICE, including addresses for STUN and TURN services
message
network.proto:114Modify the ICE configuration. Note: this configuration replaces any configuration currently present. It is *not* appended. This may also cause existing connections to close.
optional header = 1
Common request header.
repeated servers = 2
List of servers used for ICE resolution.
message
network.proto:122Result of modifying the ICE configuration.
optional header = 1
Common response header.
rpc GetICEConfiguration (, )
service.proto:168GetICEConfiguration retrieves currently set parameters for ICE, including addresses for STUN and TURN services
message
network.proto:97Request the servers used for ICE resolution.
optional header = 1
Common request header.
message
network.proto:103Provides the ICE resolution servers.
optional header = 1
Common response header.
repeated servers = 2
List of servers used for ICE resolution.
service PowerService
service.proto:54Turn hardware components' power on or off.
rpc SetPowerStatus (, )
service.proto:57Turn components' power on or off. This should not be used to power cycle a component Turning PTZ power off for too long will cause the video stream to fail
message
power.proto:42Turn components on or off.
optional header = 1
Common request header.
optional status = 2
status indicates the requested power status of the controllable devices 'true' for power-on, 'false' for power-off
message
power.proto:51Result of turning components on or off.
optional header = 1
Common response header.
optional status = 2
status indicates the requested changes upon success 'true' for power-on, 'false' for power-off
rpc GetPowerStatus (, )
service.proto:59Get current status of a component
message
power.proto:27Request component power status.
optional header = 1
Common request header.
message
power.proto:33Provides the power status of all components.
optional header = 1
Common response header.
optional status = 2
status indicates the power status of the controllable devices 'true' for power-on, 'false' for power-off
rpc CyclePower (, )
service.proto:61Cycle power for a component
message
power.proto:60Turn components off and then back on without needing two separate requests.
optional header = 1
Common request header.
optional status = 2
status indicates the devices for which cycle-power is requested 'true' for cycle-power, else no effect power cycle will not be performed on a given device if its state is power-off prior to this call
message
power.proto:71Result of power cycling components.
optional header = 1
Common response header.
optional status = 2
status indicates the power status of the controllable devices after a successful power cycle 'true' for power-on, 'false' for power-off
service PtzService
service.proto:101Control real and virtual ptz mechanisms.
rpc SetPtzPosition (, )
service.proto:103SetPosition points the referenced camera to a given vector (in PTZ-space)
message
ptz.proto:102Command the ptz to move to a position.
optional header = 1
Common request header.
optional position = 2
Desired position to achieve.
message
ptz.proto:110Result of a SetPtzPositionRequest.
optional header = 1
Common response header.
optional position = 2
Applied desired position.
rpc GetPtzPosition (, )
service.proto:105GetPosition returns the current settings of the referenced camera
message
ptz.proto:56Request the current position of a ptz.
optional header = 1
Common request header.
optional ptz = 2
Only the name is used.
message
ptz.proto:64Provides the current measured position.
optional header = 1
Common response header.
optional position = 2
Current position of the mechanism.
rpc SetPtzVelocity (, )
service.proto:106message
ptz.proto:118Command a velocity for a ptz.
optional header = 1
Common request header.
optional velocity = 2
Desired velocity to achieve.
message
ptz.proto:126Result of a SetPtzVelocityRequest.
optional header = 1
Common response header.
optional velocity = 2
Applied desired position.
rpc GetPtzVelocity (, )
service.proto:107message
ptz.proto:72Request the velocity of a ptz
optional header = 1
Common request header.
optional ptz = 2
Only the name is used.
message
ptz.proto:80Provides the current measured velocity.
optional header = 1
Common response header.
optional velocity = 2
Current velocity of the mechanism.
rpc ListPtz (, )
service.proto:108message
ptz.proto:88Request all available ptzs on the SpotCam.
optional header = 1
Common request header.
message
ptz.proto:94Provide all available ptz on the SpotCam.
optional header = 1
Common response header.
repeated ptzs = 2
List of ptzs, real and virtual.
rpc InitializeLens (, )
service.proto:110Reinitializes PTZ autofocus
message
ptz.proto:134Command to reset PTZ autofocus
optional header = 1
Common response header.
message
ptz.proto:140Result of a InitializeLensRequest.
optional header = 1
Common response header.
rpc SetPtzFocusState (, )
service.proto:112message
ptz.proto:166optional header = 1
optional focus_state = 2
message
ptz.proto:171optional header = 1
rpc GetPtzFocusState (, )
service.proto:113message
ptz.proto:175optional header = 1
message
ptz.proto:179optional header = 1
optional focus_state = 2
Set quality parameters for the stream, such as compression and image postprocessing settings.
rpc SetStreamParams (, )
service.proto:47message
streamquality.proto:89Modify the video stream parameters.
optional header = 1
Common request header.
optional params = 2
Set only the fields that should be modified.
message
streamquality.proto:97Result of setting video stream parameters.
optional header = 1
Common response header.
optional params = 2
Applied video stream parameters.
rpc GetStreamParams (, )
service.proto:48message
streamquality.proto:75Request the current video stream parameters.
optional header = 1
Common request header.
message
streamquality.proto:81Provides the current video stream parameters.
optional header = 1
Common response header.
optional params = 2
Current video stream parameters.
message
streamquality.proto:104optional header = 1
bool enable_congestion_control = 2
A boolean 'true' enables receiver congestion control while 'false' disables it
message
streamquality.proto:110optional header = 1
service VersionService
service.proto:172Query the version of the software release running on the SpotCam.
rpc GetSoftwareVersion (, )
service.proto:173message
version.proto:18Request the software version running on the SpotCam.
optional header = 1
Common request header.
message
version.proto:24Provide the SpotCam's software release version.
optional header = 1
Common response header.
optional version = 2
Version of the software currently running on the SpotCam.
string detail = 3
Extra detail about the version of software running on spotcam. May contain metadata about build dates and configuration.
Audio capture channel
Used in: , , ,
AUDIO_CHANNEL_UNKNOWN = 0
AUDIO_CHANNEL_INTERNAL_MIC = 1
AUDIO_CHANNEL_EXTERNAL_MIC = 2
message
camera.proto:16Used in: , , ,
string name = 1
Identifier for the camera.
optional resolution = 2
Resolution of the sensor, where x = width and y = height.
string base_frame_name = 3
The frame name for the parent frame of this camera. This frame will show up in the FrameTreeSnapshot grabbed from the payload registration service.
optional base_tfrom_sensor = 4
'base_tfrom_sensor' defines the transform from the specific camera to the named base from. DEPRECATED as of 3.0.1 in favor of 'base_tform_sensor' which follows the intended naming convention and FrameTree directionality convention of the Spot system as defined in geometry.proto.
optional base_tform_sensor = 7
The transform from the named base frame to this specific camera
oneof intrinsics
pinhole = 5
Physical cameras
spherical = 6
Only synthetic spherical panoramas
message
camera.proto:35Used in: ,
optional focal_length = 1
Focal_length in pixels
optional center_point = 2
Center point in pixels
float k1 = 3
The following 4 parameters are radial distortion coefficients to 4 orders. See: https://en.wikipedia.org/wiki/Distortion_(optics)#Software_correction If all 4 of these values are 0, do not apply any correction.
float k2 = 4
float k3 = 5
float k4 = 6
message
camera.proto:53Spherical limits are the minimum and maximum angle of the image. IE the upper left pixel is at min_angle.x, min_angle.y and the lower right pixel is at max_angle.x, max_angle.y for a full-FOV image this will be (-180, 90) and (180, -90)
Used in:
optional min_angle = 1
optional max_angle = 2
message
health.proto:54Degradations are not necessarily faults; a unit with no installed mechanical PTZ will behave differently, but nothing's actually wrong.
Used in:
Degradation.DegradationType type = 1
System affected.
string description = 2
Description of the kind of degradation being experienced.
Systems that can experience performance degradations.
Used in:
STORAGE = 0
PTZ = 1
LED = 2
message
network.proto:31Retrieve current network configuration.
optional header = 1
Common request header.
message
network.proto:37Provides the current network configuration.
optional header = 1
Common response header.
optional settings = 2
Current network configuration.
message
network.proto:46Request the SSL certificate currently in use.
optional header = 1
Common request header.
message
network.proto:52Provides the SSL certificate currently in use.
optional header = 1
Common response header.
string certificate = 2
An ASCII-armored representation of the SSL certificate
message
compositor.proto:52The location and camera parameters for a single camera.
Used in:
optional window = 1
The location of this camera stream within the larger stream.
optional camera = 2
The name field in this camera member is of the form 'c:w', where c is the name of the camera and w is the name of the window that's projecting it.
message
compositor.proto:54The location of a sub-image within a larger image.
Used in:
int32 xoffset = 1
int32 yoffset = 2
int32 width = 3
The image should be cropped out of the stream at this resolution, and then scaled to the resolution described in the 'camera' member, below. once that scaling takes place, the intrinsics will be valid.
int32 height = 4
message
network.proto:61Servers used in the ICE resolution process.
Used in: ,
ICEServer.servertype type = 1
STUN or TURN server.
string address = 2
Network address of the server.
uint32 port = 3
Only the least significant 16 bits are used.
ICEServer.icetransport transport = 4
optional auth = 5
auth is optional, and is only used for TURN
message
network.proto:80Used in:
optional username = 1
username is optional, and is only used for authenticated TURN servers
oneof credential
oauth = 2
password = 3
message
network.proto:83Used in:
string MACKey = 1
string AccessToken = 2
Used in:
TRANSPORT_UNKNOWN = 0
TRANSPORT_UDP = 1
TRANSPORT_TCP = 2
Possible types of servers
Used in:
UNKNOWN = 0
STUN = 1
TURN = 2
message
compositor.proto:108the colormap is a mapping of radiometric data to color, to make the images easier for people to look at in real time.
Used in: ,
IrColorMap.ColorMap colormap = 1
optional scale = 2
optional auto_scale = 3
if auto_scale is true, then the min and max values are derived from the data itself, and the settings above are ignored
Used in:
COLORMAP_UNKNOWN = 0
COLORMAP_GREYSCALE = 1
the greyscale colormap maps the minimum value (defined below) to black and the maximum value (defined below) to white
COLORMAP_JET = 2
the jet colormap uses blues for values closer to the minimum, and red values for values closer to the maximum.
COLORMAP_INFERNO = 3
the inferno colormap maps the minimum value to black and the maximum value to light yellow RGB(252, 252, 164). It is also easier to view by those with color blindness
COLORMAP_TURBO = 4
the turbo colormap uses blues for values closer to the minimum, red values for values closer to the maximum, and addresses some short comings of the jet color map such as false detail, banding and color blindness
message
compositor.proto:127Used in:
double min = 1
the minimum value to do color mapping, in degrees Celsius
double max = 2
the maximum value to do color mapping, in degrees Celsius
message
compositor.proto:159the ir meter overlay allows for pixel-accurate measurements to be taken and displayed to the user
Used in: ,
bool enable = 1
If enable isn't true, don't overlay any IR meter
optional coords = 2
DEPRECATED as of 3.3.0.
repeated meter = 3
optional unit = 4
repeated delta = 5
message
compositor.proto:187each delta pair should be a pair of indices in the above 'meter' list that need to have deltas generated
Used in:
int32 a = 1
int32 b = 2
message
compositor.proto:166these coordinates, normalized from 0-1, are within the ir camera 'window' note: if the coordinates lie within an 'invalid' region of the window, then the meter will be disabled.
Used in:
double x = 1
double y = 2
message
compositor.proto:174Used in:
TempUnit.TempUnitType value = 1
Used in:
TEMPUNIT_UNKNOWN = 0
TEMPUNIT_CELSIUS = 1
TEMPUNIT_FAHRENHEIT = 2
TEMPUNIT_KELVIN = 3
message
logging.proto:22A representation of a stored data acquisition.
Used in: , , , , , , , , ,
string name = 1
Unique identifier for a data acquisition event.
Logpoint.RecordType type = 2
Type of data held in this log point.
Logpoint.LogStatus status = 3
Current stage of acquisition.
Logpoint.QueueStatus queue_status = 8
Only filled out when status == QUEUED
string tag = 4
An arbitrary string to be stored with the log data.
optional timestamp = 5
Time of acquisition.
optional image_params = 6
Image format of the stored data.
repeated calibration = 7
Camera data for all sub-images contained within the image data.
message
logging.proto:61Data describing the camera intrinsics and extrinsics for a window of the image.
Used in:
int32 xoffset = 1
int32 yoffset = 2
int32 width = 3
int32 height = 4
string base_frame_name = 7
optional base_tfrom_sensor = 5
'base_tfrom_sensor' defines the transform from the specific camera to the named base from. DEPRECATED as of 3.0.1 in favor of 'base_tform_sensor' which follows the intended naming convention and FrameTree directionality convention of the Spot system as defined in geometry.proto.
optional base_tform_sensor = 8
The transform from the named base frame to this specific camera
optional intrinsics = 6
message
logging.proto:53Description of image format.
Used in:
int32 width = 1
int32 height = 2
Image.PixelFormat format = 3
Possible stages of data acquisition.
Used in:
FAILED = 0
QUEUED = 1
the logpoint has been queued to be downloaded from the renderer
COMPLETE = 2
the logpoint is written to the disk
UNKNOWN = -1
Used in:
QUEUED_UNKNOWN = 0
QUEUED_RENDER = 1
The logpoint has been queued to be downloaded from the renderer
QUEUED_DISK = 2
The logpoint is in general ram, and will be written to the disk when
Possible types of media that can be stored.
Used in: , ,
STILLIMAGE = 0
message
network.proto:18Network configuration data.
Used in:
optional address = 2
a big-endian representation of an IPv4 address
optional netmask = 3
The mask used for defining the system's subnet
optional gateway = 4
A global routing is set up for the address defined below (if present)
optional mtu = 5
If MTU is present, and <16 bits wide, then it is set for the ethernet interface's MTU if not, the MTU is set to 1500
message
power.proto:18Power on or off of components of the SpotCam.
Used in: , , , ,
optional ptz = 2
these switches are 'true' for power-on, 'false' for power-off
optional aux1 = 3
optional aux2 = 4
optional external_mic = 5
message
ptz.proto:19PtzDescription provides information about a given PTZ. The name is usually all that's required to describe a PTZ, but ListPtzResponse will include more information.
Used in: , , , ,
string name = 1
Identifier of a particular controllable PTZ mechanism (real or virtual).
optional pan_limit = 2
If a limit is not set, all positions are valid
Limits in degrees.
optional tilt_limit = 3
Limits in degrees.
optional zoom_limit = 4
Limits in zoom level.
message
ptz.proto:24Limits for a single axis.
Used in:
optional min = 1
Units depend on the axis being controlled.
optional max = 2
Units depend on the axis being controlled.
message
ptz.proto:147focus commands only affect the mech EO camera
Used in: , , ,
PtzFocusState.PtzFocusMode mode = 1
optional focus_position = 2
focus_position only settable in PTZ_FOCUS_MANUAL mode this represents a precise lens position for the camera for repeatable operations
optional approx_distance = 3
approx_distance only settable in PTZ_FOCUS_MANUAL mode approx_distance is most accurate between 1.2m and 20m approx_distance is ignored on a Set operation if focus_position is included
Used in:
PTZ_FOCUS_UNDEFINED = 0
PTZ_FOCUS_AUTO = 1
PTZ_FOCUS_MANUAL = 2
message
ptz.proto:36Doubles as a description of current state, or a command for a new position.
Used in: , , , ,
optional ptz = 2
The "mech" ptz can pan [0, 360] degrees, tilt approximately [-30, 100] degrees where 0 is the horizon, IR and PTZ models differ and zoom between 1x and 30x.
optional pan = 3
degrees
optional tilt = 4
degrees
optional zoom = 5
zoom level
message
ptz.proto:47Doubles as a description of current state, or a command for a new velocity.
Used in: , ,
optional ptz = 2
The "mech" ptz cannot be used with Velocity.
optional pan = 3
degrees/second
optional tilt = 4
degrees/second
optional zoom = 5
zoom level/second
message
compositor.proto:20A "Screen" represents a particular layout of camera images used by the video stream.
Used in:
string name = 1
Unique identifier for a screen.
message
audio.proto:20Identifier for a playable sound.
Used in: , , ,
string name = 1
internally, sounds are stored in a flat table. This name is the identifier of a sound effect
message
streamquality.proto:19Parameters for how the video stream should be processed and compressed.
Used in: , ,
optional targetbitrate = 1
The compression level in target BPS
optional refreshinterval = 2
How often should the entire feed be refreshed? (in frames) Note: the feed is refreshed on a macroblock level; there are no full I-frames
optional idrinterval = 3
How often should an IDR message get sent? (in frames)
optional awb = 4
Optional setting of automatic white balancing mode.
oneof exposure
auto_exposure = 5
the AutoExposure option runs exposure independently on each of the ring cameras
sync_exposure = 6
the SyncAutoExposure option runs a single autoexposure algorithm that takes into account data from all ring cameras
manual_exposure = 7
manual exposure sets an exposure for all ring cameras.
message
streamquality.proto:48Used in:
(message has no fields)
message
streamquality.proto:42Wrapper for AwbModeEnum to allow it to be optionally set.
Used in:
AwbModeEnum awb = 1
Options for automatic white balancing mode.
Used in:
OFF = 0
AUTO = 1
INCANDESCENT = 2
FLUORESCENT = 3
WARM_FLUORESCENT = 4
DAYLIGHT = 5
CLOUDY = 6
TWILIGHT = 7
SHADE = 8
DARK = 9
message
streamquality.proto:55Used in:
optional exposure = 1
duration is required, and may be clamped depending on the parameters of the camera
optional gain = 2
if gain is omitted, it is assumed to be 1.0
message
streamquality.proto:49Used in:
optional brightness_target = 1
brightness_target is a value between 0 and 255 which controls the setpoint for the exposure control algorithm if brightness_target is not set, a sensible default is chosen by the system
message
health.proto:19The temperature of a particular component.
Used in:
string channel_name = 1
Identifier of the hardware measured.
int64 temperature = 2
Temperature is expressed in millidegrees C.