|
| VersionInformation | getPolyscopeVersion () |
| |
| void | setPolyscopeVersion (const std::string &version) |
| |
| | TestableDashboardClient (const std::string &host) |
| |
| void | assertVersion (const std::string &e_series_min_ver, const std::string &cb3_min_ver, const std::string &required_call) |
| | Makes sure that the dashboard_server's version is above the required version. More...
|
| |
| bool | commandAddToLog (const std::string &log_text) |
| | Send text to log. More...
|
| |
| bool | commandBrakeRelease () |
| | Send Brake release command. More...
|
| |
| bool | commandClearOperationalMode () |
| | Send Clear operational mode command. More...
|
| |
| bool | commandClosePopup () |
| | Send Close popup command. More...
|
| |
| bool | commandCloseSafetyPopup () |
| | Send Close safety popup command. More...
|
| |
| bool | commandGenerateFlightReport (const std::string &report_type) |
| | Send Generate flight report command. More...
|
| |
| bool | commandGenerateSupportFile (const std::string &dir_path) |
| | Send Generate support file command. More...
|
| |
| bool | commandGetLoadedProgram (std::string &loaded_program) |
| | Get Loaded Program. More...
|
| |
| bool | commandGetOperationalMode (std::string &operational_mode) |
| | Get Operational mode. More...
|
| |
| bool | commandGetRobotModel (std::string &robot_model) |
| | Get Robot model. More...
|
| |
| bool | commandGetSerialNumber (std::string &serial_number) |
| | Get Serial number. More...
|
| |
| bool | commandGetUserRole (std::string &user_role) |
| | Send Get user role command (Only available for CB3) More...
|
| |
| bool | commandIsInRemoteControl () |
| | Send "Is in remote control" query command. More...
|
| |
| bool | commandIsProgramSaved () |
| | Send "Is program saved" request command. More...
|
| |
| bool | commandLoadInstallation (const std::string &installation_file_name) |
| | Send Load installation command. More...
|
| |
| bool | commandLoadProgram (const std::string &program_file_name) |
| | Send Load program command. More...
|
| |
| bool | commandPause () |
| | Send Pause program command. More...
|
| |
| bool | commandPlay () |
| | Send Play program command. More...
|
| |
| bool | commandPolyscopeVersion (std::string &polyscope_version) |
| | Get Polyscope version. More...
|
| |
| bool | commandPopup (const std::string &popup_text) |
| | Send popup command. More...
|
| |
| bool | commandPowerOff () |
| | Send Power off command. More...
|
| |
| bool | commandPowerOn (const std::chrono::duration< double > timeout=std::chrono::seconds(300)) |
| | Send Power on command. More...
|
| |
| bool | commandProgramState (std::string &program_state) |
| | Get Program state. More...
|
| |
| bool | commandQuit () |
| | Send Quit command. More...
|
| |
| bool | commandRestartSafety () |
| | Send Restart Safety command. More...
|
| |
| bool | commandRobotMode (std::string &robot_mode) |
| | Get Robot mode. More...
|
| |
| bool | commandRunning () |
| | Send Running command. More...
|
| |
| bool | commandSafetyMode (std::string &safety_mode) |
| | Get Safety mode. More...
|
| |
| bool | commandSafetyStatus (std::string &safety_status) |
| | Get Safety status. More...
|
| |
| bool | commandSaveLog () |
| | Flush the polyscope log to the log_history.txt file. More...
|
| |
| bool | commandSetOperationalMode (const std::string &operational_mode) |
| | Send Set operational mode command (Only available for e-series) More...
|
| |
| bool | commandSetUserRole (const std::string &user_role) |
| | Send Set user role command (Only available for CB3) More...
|
| |
| bool | commandShutdown () |
| | Send Shutdown command. More...
|
| |
| bool | commandStop () |
| | Send Stop program command. More...
|
| |
| bool | commandUnlockProtectiveStop () |
| | Send Unlock Protective stop popup command. More...
|
| |
| bool | connect (const size_t max_num_tries=0, const std::chrono::milliseconds reconnection_time=std::chrono::seconds(10)) |
| | Opens a connection to the dashboard server on the host as specified in the constructor. More...
|
| |
| | DashboardClient ()=delete |
| |
| | DashboardClient (const std::string &host) |
| | Constructor that shall be used by default. More...
|
| |
| void | disconnect () |
| | Makes sure no connection to the dashboard server is held inside the object. More...
|
| |
| timeval | getConfiguredReceiveTimeout () const |
| | Gets the configured receive timeout. If receive timeout is unconfigured "normal" socket timeout of 1 second will be returned. More...
|
| |
| bool | retryCommand (const std::string &requestCommand, const std::string &requestExpectedResponse, const std::string &waitRequest, const std::string &waitExpectedResponse, const std::chrono::duration< double > timeout, const std::chrono::duration< double > retry_period=std::chrono::seconds(1)) |
| | Keep Sending the requesting Command and wait until it returns the expected answer. More...
|
| |
| std::string | sendAndReceive (const std::string &command) |
| | Sends a command through the socket and waits for an answer. More...
|
| |
| bool | sendRequest (const std::string &command, const std::string &expected) |
| | Sends command and compare it with the expected answer. More...
|
| |
| std::string | sendRequestString (const std::string &command, const std::string &expected) |
| | Sends command and compare it with the expected answer. More...
|
| |
| bool | waitForReply (const std::string &command, const std::string &expected, std::chrono::duration< double > timeout=std::chrono::seconds(30)) |
| | brief Sends a command and wait until it returns the expected answer More...
|
| |
| virtual | ~DashboardClient ()=default |
| |
| void | close () |
| | Closes the connection to the socket. More...
|
| |
| std::string | getIP () const |
| | Determines the local IP address of the currently configured socket. More...
|
| |
| socket_t | getSocketFD () |
| | Getter for the file descriptor of the socket. More...
|
| |
| SocketState | getState () |
| | Getter for the state of the socket. More...
|
| |
| bool | read (char *character) |
| | Reads one byte from the socket. More...
|
| |
| bool | read (uint8_t *buf, const size_t buf_len, size_t &read) |
| | Reads data from the socket. More...
|
| |
| void | setReceiveTimeout (const timeval &timeout) |
| | Setup Receive timeout used for this socket. More...
|
| |
| void | setReconnectionTime (const std::chrono::milliseconds reconnection_time) |
| | Set reconnection time, if the server is unavailable during connection this will set the time before trying connect to the server again. More...
|
| |
| | TCPSocket () |
| | Creates a TCPSocket object. More...
|
| |
| bool | write (const uint8_t *buf, const size_t buf_len, size_t &written) |
| | Writes to the socket. More...
|
| |
| virtual | ~TCPSocket () |
| |
Public Member Functions inherited from urcl::DashboardClient