ur-kotlin/com.wolfscowl.ur_client.core/URDashBoard

URDashBoard

interface URDashBoard

Inheritors

Functions

Link copied to clipboard
abstract suspend fun fetchIsRunning(): Result<String>

Queries the execution state of the loaded program (*.urp) or URScript via the dashboard server.

Link copied to clipboard
abstract suspend fun fetchLoadedProgram(): Result<String>

Queries the path to loaded program file via the Dashboard Server.

Link copied to clipboard
abstract suspend fun fetchPolyscopeVersion(): Result<String>

Queries the Polyscope version via the dashboard server.

Link copied to clipboard
abstract suspend fun fetchProgramState(): Result<String>

Queries the state of the loaded program (*.urp) in polyscope via the dashboard server.

Link copied to clipboard
abstract suspend fun fetchRobotMode(): Result<String>

Queries the robot mode via the dashboard server.

Link copied to clipboard
abstract suspend fun fetchRobotModel(): Result<String>

Queries the model of the robot via the dashboard server.

Link copied to clipboard
abstract suspend fun fetchSafetyStatus(): Result<String>

Queries the safety status via the dashboard server.

Link copied to clipboard
abstract suspend fun fetchSerialNumber(): Result<String>

Queries the serial number of the robot.

Link copied to clipboard
abstract suspend fun load(program: String): Result<String>

Loads a program (*.urp) in Polyscope via the dashboard server.

Link copied to clipboard
abstract suspend fun loadInstallation(installation: String): Result<String>

Loads a specified installation file in Polyscope via the dashboard server. This command suspends until the load has completed or failed. The command fails if the associated installation requires confirmation of safety.

Link copied to clipboard
abstract suspend fun pause(): Result<String>

Pauses the current running program via the dashboard server.

Link copied to clipboard
abstract suspend fun play(): Result<String>

Runs the current program (*.urp) in Polyscope via the dashboard server.

Link copied to clipboard
abstract suspend fun powerOff(): Result<String>

Powers off the robot arm via the dashboard server.

Link copied to clipboard
abstract suspend fun powerOn(): Result<String>

Powers on the robot arm and releases the brakes to reach "normal mode" via the Dashboard Server.

Link copied to clipboard
abstract suspend fun shutdown(): Result<String>

Shuts down and turns off robot and controller via the dashboard server.

Link copied to clipboard
abstract suspend fun stop(): Result<String>

Stops the current running program via the dashboard server (URScript or Polyscope *.urp file).

Link copied to clipboard
abstract suspend fun unlockProtectiveStop(): Result<String>

Closes the current popup (Polyscope) and unlocks protective stop via the dashboard server. The unlock protective stop command fails if less than 5 seconds has passed since the protective stop occurred.

Generated by Dokka
© 2026 Copyright