Scan Movement

`SM_01`: Pan Left

Version: 1.0.0
Interface: scan_movement
Action: sm_01

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_02`: Pan Right

Version: 1.0.0
Interface: scan_movement
Action: sm_02

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_03`: Pan Up

Version: 1.0.0
Interface: scan_movement
Action: sm_03

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_04`: Pan Down

Version: 1.0.0
Interface: scan_movement
Action: sm_04

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_05`: Pan Sensitivity

Version: 1.0.0
Interface: scan_movement
Action: sm_05

Payload Definition

Type: `SliderValue`

{
  "Version": "String",
  "Value": "Float"
}

Example definition

Type: `SliderValue`

{
  "Version": "1.0.0",
  "Value": 0
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_06`: Zoom In

Version: 1.0.0
Interface: scan_movement
Action: sm_06

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_07`: Zoom Out

Version: 1.0.0
Interface: scan_movement
Action: sm_07

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_08`: Zoom Sensitivity

Version: 1.0.0
Interface: scan_movement
Action: sm_08

Payload Definition

Type: `SliderValue`

{
  "Version": "String",
  "Value": "Float"
}

Example definition

Type: `SliderValue`

{
  "Version": "1.0.0",
  "Value": 0
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_09`: Rotate (3D Movement)

Version: 1.0.0
Interface: scan_movement
Action: sm_09

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_10`: Rotation Sensitivity

Version: 1.0.0
Interface: scan_movement
Action: sm_10

Payload Definition

Type: `SliderValue`

{
  "Version": "String",
  "Value": "Float"
}

Example definition

Type: `SliderValue`

{
  "Version": "1.0.0",
  "Value": 0
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_11`: Rotate 3D Camera without moving Scan Volume

Version: 1.0.0
Interface: scan_movement
Action: sm_11

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`SM_12`: Camera Rotate Sensitivity

Version: 1.0.0
Interface: scan_movement
Action: sm_12

Payload Definition

Type: `SliderValue`

{
  "Version": "String",
  "Value": "Float"
}

Example definition

Type: `SliderValue`

{
  "Version": "1.0.0",
  "Value": 0
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid