Flexiv TDK APIs 1.7
Loading...
Searching...
No Matches
flexiv::tdk::TeleopStatus Struct Reference

Snapshot of teleoperation health for one robot pair. More...

#include <data.hpp>

Collaboration diagram for flexiv::tdk::TeleopStatus:

Public Attributes

bool initialized = false
bool started = false
bool engaged = false
bool stopped = true
bool fault = false
bool motion_restricted = false
double latency_ms = 0.0
double latency_threshold_ms = 0.0
TeleopIssue primary
std::vector< TeleopIssue > issues

Detailed Description

[primary] is the issue the host should show first: the highest-level active issue, or the last significant event if nothing is active. [issues] lists every condition that is active right now.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 393 of file data.hpp.

Member Data Documentation

◆ engaged

bool flexiv::tdk::TeleopStatus::engaged = false

False if the operator has not engaged, or if the controller force-disengaged (high latency, disconnect, or clock mismatch). Check [issues] / [primary] for CLOCK_MISMATCH when [latency_ms] is negative.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 406 of file data.hpp.

◆ fault

bool flexiv::tdk::TeleopStatus::fault = false

LAN: true if either robot in the pair is in fault state. WAN: true if the local robot is.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 412 of file data.hpp.

◆ initialized

bool flexiv::tdk::TeleopStatus::initialized = false

True if Init() or InitWithIdx() has completed for this robot pair.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 396 of file data.hpp.

◆ issues

std::vector<TeleopIssue> flexiv::tdk::TeleopStatus::issues

All currently active issues. Empty when the system is healthy.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 430 of file data.hpp.

◆ latency_ms

double flexiv::tdk::TeleopStatus::latency_ms = 0.0

Estimated one-way message latency in milliseconds. WAN only; 0 on LAN. Negative means clock mismatch. A very large value means not connected.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 421 of file data.hpp.

◆ latency_threshold_ms

double flexiv::tdk::TeleopStatus::latency_threshold_ms = 0.0

Configured latency threshold in milliseconds. WAN only.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 424 of file data.hpp.

◆ motion_restricted

bool flexiv::tdk::TeleopStatus::motion_restricted = false

True if the robot currently holds pose to avoid a limit or singularity.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 415 of file data.hpp.

◆ primary

TeleopIssue flexiv::tdk::TeleopStatus::primary

Highest-priority issue to display. [primary.code] is NONE when nothing is wrong.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 427 of file data.hpp.

◆ started

bool flexiv::tdk::TeleopStatus::started = false

True if the teleoperation control loop has been started.

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 399 of file data.hpp.

◆ stopped

bool flexiv::tdk::TeleopStatus::stopped = true

True if the teleoperation control loop is not running. Always the inverse of [started].

Examples
transparent_cartesian_teleop_lan.cpp, transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 409 of file data.hpp.


The documentation for this struct was generated from the following file: