Versions Compared

Version Old Version 2 New Version Current
Changes made by

Shun Gao

Alex Soler

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following messages define the RapidSense 2.x API.

For REST interface endpoints, use port number 11235. For example, http://localhost:11235/volumes.

Volumes

General description

...

Excerpt
nameScanScene ASCII

Structure

Code Block
ScanScene

CSV Arguments + Description

The mode by which to scan the scene:

Snapshot = 0

  • Start streaming = 1

  • Stop streaming = 2

  • Clear = 3

YAML Arguments + Description

  • Snapshot = “snapshot”

  • Start streaming = “start_streaming”

  • Stop streaming = “stop_streaming”

  • Clear = “clear”

Function Description

This command changes the scanning mode for RapidSense.

Response Details

Whether the system is set to the requested mode.

Example CSV Request

Code Block
ScanScene,1

Example CSV Response

Code Block
ScanScene,1,0 // success
ScanScene,1,5102 // failure

Example YAML Request

Code Block
{topic: ScanScene, data: {type: "snapshotstart_streaming"}}

Example YAML Response

Code Block
{topic: ScanScene, response: {}}

...