File size: 39,965 Bytes
ef17c16 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */
/*
Author(s): Anton Deguet
Created on: 2013-05-17
(C) Copyright 2013-2025 Johns Hopkins University (JHU), All Rights Reserved.
--- begin cisst license - do not edit ---
This software is provided "as is" under an open source license, with
no warranty. The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.
--- end cisst license ---
*/
#include <sawIntuitiveResearchKit/system.h>
#include <cisstCommon/cmnRandomSequence.h>
#include <cisstCommon/cmnObjectRegister.h>
#include <cisstOSAbstraction/osaSleep.h>
#include <cisstMultiTask/mtsInterfaceProvided.h>
#include <cisstMultiTask/mtsInterfaceRequired.h>
#include <cisstMultiTask/mtsManagerLocal.h>
#include <cisstInteractive/ireTask.h>
#include <cisstParameterTypes/prmKeyValue.h>
#include <sawTextToSpeech/mtsTextToSpeech.h>
#include <sawIntuitiveResearchKit/sawIntuitiveResearchKitConfig.h>
#include <sawIntuitiveResearchKit/sawIntuitiveResearchKitRevision.h>
#include <sawIntuitiveResearchKit/mtsIntuitiveResearchKit.h>
#include <sawIntuitiveResearchKit/IO_proxy.h>
#include <sawIntuitiveResearchKit/arm_proxy.h>
#include <sawIntuitiveResearchKit/console.h>
#include <sawIntuitiveResearchKit/teleop_PSM_proxy.h>
#include <sawIntuitiveResearchKit/teleop_ECM_proxy.h>
#include <sawIntuitiveResearchKit/mtsDaVinciEndoscopeFocus.h>
#include <json/json.h>
typedef dvrk::system dvrk_system;
CMN_IMPLEMENT_SERVICES_DERIVED_ONEARG(dvrk_system, mtsTaskFromSignal, std::string);
dvrk::system::system(const std::string & componentName):
mtsTaskFromSignal(componentName, 100),
m_configured(false),
mTimeOfLastErrorBeep(0.0)
{
// configure search path
m_config_path.Add(cmnPath::GetWorkingDirectory());
// add path to source/share directory to find common files. This
// will work as long as this component is located in the same
// parent directory as the "shared" directory.
m_config_path.Add(std::string(sawIntuitiveResearchKit_SOURCE_CONFIG_DIR), cmnPath::TAIL);
// default installation directory
m_config_path.Add(mtsIntuitiveResearchKit::DefaultInstallationDirectory, cmnPath::TAIL);
m_interface = AddInterfaceProvided("Main");
if (m_interface) {
m_interface->AddMessageEvents();
m_interface->AddCommandVoid(&system::power_off, this,
"power_off");
m_interface->AddCommandVoid(&system::power_on, this,
"power_on");
m_interface->AddCommandVoid(&system::home, this,
"home");
m_interface->AddEventWrite(events.arm_current_state,
"arm_current_state", prmKeyValue());
// audio
m_interface->AddCommandWrite(&system::set_volume, this,
"set_volume", m_audio_volume);
m_interface->AddCommandWrite(&system::beep, this,
"beep", vctDoubleVec());
m_interface->AddCommandWrite(&system::string_to_speech, this,
"string_to_speech", std::string());
m_interface->AddEventWrite(audio.volume,
"volume", m_audio_volume);
// misc.
m_interface->AddCommandRead(&system::calibration_mode, this,
"calibration_mode", false);
// Following is Read instead of VoidReturn because it is called before the component
// is created (i.e., thread not yet running)
m_interface->AddCommandRead(&system::ConnectInternal, this,
"connect", false);
}
}
void dvrk::system::set_calibration_mode(const bool mode)
{
m_calibration_mode = mode;
if (m_calibration_mode) {
std::stringstream message;
message << "set_calibration_mode:" << std::endl
<< "----------------------------------------------------" << std::endl
<< " Warning:" << std::endl
<< " You're running the dVRK console in calibration mode." << std::endl
<< " You should only do this if you are currently calibrating" << std::endl
<< " potentiometers." << std::endl
<< "----------------------------------------------------";
std::cerr << "system::" << message.str() << std::endl;
CMN_LOG_CLASS_INIT_WARNING << message.str() << std::endl;
}
for (auto IO_proxy : m_IO_proxies) {
IO_proxy.second->set_calibration_mode(mode);
}
}
void dvrk::system::set_embedded_python(const std::string & _IRE_shell)
{
m_IRE_shell = _IRE_shell;
}
const bool & dvrk::system::calibration_mode(void) const
{
return m_calibration_mode;
}
void dvrk::system::calibration_mode(bool & result) const
{
result = m_calibration_mode;
}
void dvrk::system::Configure(const std::string & filename)
{
m_configured = false;
std::ifstream json_stream;
json_stream.open(filename.c_str());
Json::Value json_config, json_value;
Json::Reader json_reader;
if (!json_reader.parse(json_stream, json_config)) {
CMN_LOG_CLASS_INIT_ERROR << "Configure: failed to parse configuration" << std::endl
<< "File: " << filename << std::endl << "Error(s):" << std::endl
<< json_reader.getFormattedErrorMessages();
exit(EXIT_FAILURE);
}
CMN_LOG_CLASS_INIT_VERBOSE << "Configure: " << this->GetName()
<< " using file \"" << filename << "\"" << std::endl
<< "----> content of configuration file: " << std::endl
<< json_config << std::endl
<< "<----" << std::endl;
// id & version check
const std::string id = json_config["$id"].asString();
const std::string id_expected = "dvrk-system.schema.json";
if (id != id_expected) {
CMN_LOG_CLASS_INIT_ERROR << "Configure: file " << filename
<< " has incorrect or missing $id, found \"" << id
<< "\", expected \"" << id_expected << "\"" << std::endl;
exit(EXIT_FAILURE);
}
const std::string version = json_config["$version"].asString();
if (version != "1") {
CMN_LOG_CLASS_INIT_ERROR << "Configure: file " << filename
<< " has incorrect or missing $version, found \"" << version
<< "\", expected \"1\"" << std::endl;
exit(EXIT_FAILURE);
}
// base component configuration
mtsComponent::ConfigureJSON(json_config);
// extract path of main json config file to search other files relative to it
std::string fullname = m_config_path.Find(filename);
std::string config_dir = fullname.substr(0, fullname.find_last_of('/'));
m_config_path.Add(config_dir, cmnPath::TAIL);
mtsComponentManager * manager = mtsComponentManager::GetInstance();
// Json parse and load values, will complain if a field with no
// default is not provided (e.g. "name")
cmnDataDeSerializeTextJSON(m_config, json_config);
CMN_LOG_CLASS_INIT_VERBOSE << "Configure, loaded:" << std::endl
<< "------>" << std::endl
<< cmnDataSerializeTextJSON(m_config) << std::endl
<< "<------" << std::endl;
// add user defined path
for (const auto & d : m_config.settings.path) {
m_config_path.Add(d);
}
// create all custom components and connections, i.e. dynamic loading and creation
if (!m_config.component_manager.empty()) {
if (!manager->ConfigureJSON(m_config.component_manager, m_config_path)) {
CMN_LOG_CLASS_INIT_ERROR << "Configure: failed to configure component-manager" << std::endl;
exit(EXIT_FAILURE);
}
}
// add text to speech component for the whole system
m_text_to_speech = std::make_unique<mtsTextToSpeech>();
manager->AddComponent(m_text_to_speech.get());
mtsInterfaceRequired * textToSpeechInterface = this->AddInterfaceRequired("TextToSpeech");
textToSpeechInterface->AddFunction("Beep", audio.beep);
textToSpeechInterface->AddFunction("StringToSpeech", audio.string_to_speech);
m_audio_volume = m_config.settings.audio_volume;
// find all IOs
for (auto & IO_config : m_config.IOs) {
const auto iter = m_IO_proxies.find(IO_config.name);
if (iter == m_IO_proxies.end()) {
// create a new IO proxy if needed
auto IO_proxy = std::make_shared<dvrk::IO_proxy>(IO_config.name, this, &IO_config);
m_IO_proxies[IO_config.name] = IO_proxy;
IO_proxy->post_configure();
IO_proxy->set_calibration_mode(m_calibration_mode);
} else {
CMN_LOG_CLASS_INIT_ERROR << "Configure: failed to configure IO "
<< IO_config.name << ", IO already exists" << std::endl;
exit(EXIT_FAILURE);
}
}
// create ISI focus controller if needed
if (m_config.ISI_focus_controller.IO_file != "") {
const auto focus_IO_file = this->find_file(m_config.ISI_focus_controller.IO_file);
if (focus_IO_file == "") {
CMN_LOG_CLASS_INIT_ERROR << "Configure: failed to find focus controller IO file "
<< m_config.ISI_focus_controller.IO_file << " for focus controller: "
<< m_config.ISI_focus_controller.name << std::endl;
exit(EXIT_FAILURE);
}
m_ISI_focus_controller = std::make_unique<mtsDaVinciEndoscopeFocus>(m_config.ISI_focus_controller.name);
manager->AddComponent(m_ISI_focus_controller.get());
}
// find all arms
for (auto & arm_config : m_config.arms) {
const auto iter = m_arm_proxies.find(arm_config.name);
if (iter == m_arm_proxies.end()) {
// create a new arm proxy if needed
auto arm_proxy = std::make_shared<dvrk::arm_proxy>(arm_config.name, this, &arm_config);
m_arm_proxies[arm_config.name] = arm_proxy;
arm_proxy->post_configure();
} else {
CMN_LOG_CLASS_INIT_ERROR << "Configure: failed to configure arm "
<< arm_config.name << ", arm already exists" << std::endl;
exit(EXIT_FAILURE);
}
}
// find all consoles
for (auto & console_config : m_config.consoles) {
const auto iter = m_consoles.find(console_config.name);
if (iter == m_consoles.end()) {
// create a new console if needed
auto console = std::make_shared<dvrk::console>(console_config.name, this, &console_config);
m_consoles[console_config.name] = console;
console->post_configure();
} else {
CMN_LOG_CLASS_INIT_ERROR << "Configure: failed to configure console "
<< console_config.name << ", console already exists" << std::endl;
exit(EXIT_FAILURE);
}
}
// first, create the IO components
for (auto & iter : m_IO_proxies) {
auto & IO_proxy = iter.second;
IO_proxy->create_IO();
IO_proxy->set_calibration_mode(m_calibration_mode);
add_IO_interfaces(IO_proxy);
}
// configure IO for focus controller
if (m_config.ISI_focus_controller.IO != "") {
configure_IO(m_config.ISI_focus_controller);
const std::string controller = m_config.ISI_focus_controller.name;
const std::string IO = m_config.ISI_focus_controller.IO;
m_connections.Add(controller, "endoscope_focus_in",
IO, "endoscope_focus_in");
m_connections.Add(controller, "endoscope_focus_out",
IO, "endoscope_focus_out");
m_connections.Add(controller, "focus_in",
IO, "focus_plus");
m_connections.Add(controller, "focus_out",
IO, "focus_minus");
}
// now we can configure PID and Arms
for (auto & iter : m_arm_proxies) {
auto & arm_proxy = iter.second;
// create arm first to initialize generation
arm_proxy->create_arm();
arm_proxy->configure_IO();
arm_proxy->create_PID();
add_arm_interfaces(arm_proxy);
}
// load consoles if any
for (auto & iter : m_consoles) {
auto & console = iter.second;
console->create_components();
add_console_interfaces(console);
}
// search for SUJs, real, not Fixed
for (auto & iter : m_arm_proxies) {
auto & arm_proxy = iter.second;
if ((arm_proxy->m_config->type == dvrk::arm_type::SUJ_Classic)
|| (arm_proxy->m_config->type == dvrk::arm_type::SUJ_Si)) {
m_SUJ = arm_proxy;
}
}
if (m_SUJ) {
for (auto & iter : m_arm_proxies) {
const std::string & name = iter.first;
auto & arm_proxy = iter.second;
// only for PSM and ECM when not simulated
if ((arm_proxy->m_config->native_or_derived_PSM()
|| arm_proxy->m_config->native_or_derived_ECM()
)
&& (arm_proxy->m_config->simulation == dvrk::simulation::SIMULATION_NONE)
) {
arm_proxy->SUJInterfaceRequiredFromIO = this->AddInterfaceRequired("SUJ_clutch_" + name + "_IO");
arm_proxy->SUJInterfaceRequiredFromIO->AddEventHandlerWrite(&dvrk::arm_proxy::SUJ_clutch_event_handler_from_IO,
arm_proxy.get(), "Button");
if (arm_proxy->generation() == dvrk::generation::Si) {
arm_proxy->SUJInterfaceRequiredFromIO2 = this->AddInterfaceRequired("SUJ_clutch_2_" + name + "_IO");
arm_proxy->SUJInterfaceRequiredFromIO2->AddEventHandlerWrite(&dvrk::arm_proxy::SUJ_clutch_event_handler_from_IO,
arm_proxy.get(), "Button");
}
arm_proxy->SUJInterfaceRequiredToSUJ = this->AddInterfaceRequired("SUJ_clutch_" + name);
arm_proxy->SUJInterfaceRequiredToSUJ->AddFunction("clutch", arm_proxy->SUJ_clutch);
}
}
}
// create embedded Python interpreter
if (m_IRE_shell != "") {
std::string _ire_cmd;
// more cisst libraries
for (const auto lib : {"Vector", "ParameterTypes"}) {
_ire_cmd.append(std::string("import cisst") + lib + "Python as cisst" + lib + ";");
}
// create interface for system
_ire_cmd.append(this->GetName() + " = cisstMultiTask.mtsCreateClientInterface(clientName = 'system_Python', serverName = '" + this->GetName() + "', interfaceName = 'Main');");
// create interfaces for all arms
for (auto & iter : m_arm_proxies) {
const std::string name = iter.first;
_ire_cmd.append(name + " = cisstMultiTask.mtsCreateClientInterface(clientName = 'system_Python', serverName = '" + name + "', interfaceName = 'Arm');");
}
// create interfaces for all consoles
for (auto & iter : m_consoles) {
const std::string name = iter.first;
_ire_cmd.append(name + " = cisstMultiTask.mtsCreateClientInterface(clientName = 'system_Python', serverName = '" + this->GetName() + "', interfaceName = '" + name + "');");
for (auto & t_iter : iter.second->m_teleop_proxies) {
const std::string t_name = t_iter.first;
_ire_cmd.append(name + "_" + t_name + " = cisstMultiTask.mtsCreateClientInterface(clientName = 'system_Python', serverName = '" + t_name + "', interfaceName = 'Setting');");
}
}
// log and start
CMN_LOG_CLASS_INIT_VERBOSE << "Configure, create embedded Python (IRE task) with: "
<< _ire_cmd << std::endl;
m_IRE_component = std::make_unique<ireTask>("IRE", IRE_ShellFromString(m_IRE_shell), _ire_cmd);
cmnObjectRegister::Register("component_manager", manager);
manager->AddComponent(m_IRE_component.get());
}
m_configured = true;
}
const bool & dvrk::system::Configured(void) const
{
return m_configured;
}
void dvrk::system::Startup(void)
{
std::string message = this->GetName();
message.append(" started, dVRK ");
message.append(sawIntuitiveResearchKit_VERSION);
message.append(" / cisst ");
message.append(cisst_VERSION);
m_interface->SendStatus(message);
// close all relays if needed
for (auto & iter : m_IO_proxies) {
if (iter.second->m_config->close_all_relays) {
iter.second->close_all_relays();
}
}
// emit events for consoles
for (auto iter : m_consoles) {
auto & console = iter.second;
console->Startup();
}
// emit volume event
audio.volume(m_audio_volume);
if (m_config.settings.chatty) {
// someone is going to hate me for this :-)
std::vector<std::string> prompts;
prompts.push_back("Hello");
prompts.push_back("It will not work!");
prompts.push_back("It might work");
prompts.push_back("It will work!");
prompts.push_back("Are we there yet?");
prompts.push_back("When is that paper deadline?");
prompts.push_back("Don't you have something better to do?");
prompts.push_back("Today is the day!");
prompts.push_back("It's free software, what did you expect?");
prompts.push_back("I didn't do it!");
prompts.push_back("Be careful!");
prompts.push_back("Peter will fix it");
prompts.push_back("Ask Google");
prompts.push_back("Did you forget to re-compile?");
prompts.push_back("Reboot me");
prompts.push_back("Coffee break?");
prompts.push_back("If you can hear this, the code compiles!");
prompts.push_back("I'm a bit tired");
prompts.push_back("Commit often, always pull!");
prompts.push_back("Feel free to fix it");
prompts.push_back("What's the weather like outside?");
prompts.push_back("Call your parents");
prompts.push_back("Maybe we should use ROS control");
prompts.push_back("Use with caution");
prompts.push_back("It's about time");
prompts.push_back("When did you last commit your changes?");
prompts.push_back("Some documentation would be nice");
prompts.push_back("ROS 2!");
prompts.push_back("It's free, what did you expect?");
int index;
cmnRandomSequence & randomSequence = cmnRandomSequence::GetInstance();
cmnRandomSequence::SeedType seed
= static_cast<cmnRandomSequence::SeedType>(mtsManagerLocal::GetInstance()->GetTimeServer().GetRelativeTime() * 100000.0);
randomSequence.SetSeed(seed % 1000);
randomSequence.ExtractRandomValue<int>(0, prompts.size() - 1, index);
audio.string_to_speech(prompts.at(index));
}
}
void dvrk::system::Run(void)
{
ProcessQueuedCommands();
ProcessQueuedEvents();
}
void dvrk::system::Cleanup(void)
{
CMN_LOG_CLASS_INIT_VERBOSE << "Cleanup" << std::endl;
}
bool dvrk::system::add_IO_interfaces(std::shared_ptr<dvrk::IO_proxy> _IO)
{
_IO->m_interface_required = AddInterfaceRequired(_IO->m_name);
if (_IO->m_interface_required) {
auto itf = _IO->m_interface_required;
itf->AddFunction("close_all_relays", _IO->close_all_relays);
itf->AddEventHandlerWrite(&system::error_event_handler, this, "error");
itf->AddEventHandlerWrite(&system::warning_event_handler, this, "warning");
itf->AddEventHandlerWrite(&system::status_event_handler, this, "status");
m_connections.Add(this->GetName(), _IO->m_name,
_IO->m_name, "Configuration");
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_IO_interfaces: failed to create IO required interface" << std::endl;
return false;
}
return true;
}
bool dvrk::system::add_arm_interfaces(std::shared_ptr<dvrk::arm_proxy> _arm)
{
// IO
if (_arm->m_config->expects_IO()) {
const std::string interface_IO_name = "IO_" + _arm->m_name;
_arm->m_IO_interface_required = AddInterfaceRequired(interface_IO_name);
if (_arm->m_IO_interface_required) {
auto itf = _arm->m_IO_interface_required;
itf->AddEventHandlerWrite(&system::error_event_handler, this, "error");
itf->AddEventHandlerWrite(&system::warning_event_handler, this, "warning");
itf->AddEventHandlerWrite(&system::status_event_handler, this, "status");
m_connections.Add(this->GetName(), interface_IO_name,
_arm->m_IO_component_name, _arm->m_config->name_on_IO);
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_arm_interfaces: failed to add IO interface for arm \""
<< _arm->m_name << "\"" << std::endl;
return false;
}
// is the arm is a PSM, since it has an IO, it also has a
// Dallas chip interface and we want to see the messages
if (_arm->m_config->native_or_derived_PSM()) {
const std::string interface_IO_Dallas_name = "IO_dallas_" + _arm->m_name;
_arm->m_IO_dallas_interface_required = AddInterfaceRequired(interface_IO_Dallas_name);
if (_arm->m_IO_dallas_interface_required) {
auto itf = _arm->m_IO_dallas_interface_required;
itf->AddEventHandlerWrite(&system::error_event_handler, this, "error");
itf->AddEventHandlerWrite(&system::warning_event_handler, this, "warning");
itf->AddEventHandlerWrite(&system::status_event_handler, this, "status");
m_connections.Add(this->GetName(), interface_IO_Dallas_name,
_arm->m_IO_component_name, _arm->m_config->name_on_IO + "_dallas");
} else {
CMN_LOG_CLASS_INIT_ERROR << "AddArmInterfaces: failed to add IO Dallas interface for arm \""
<< _arm->m_name << "\"" << std::endl;
return false;
}
}
}
// PID
if (_arm->m_config->expects_PID()) {
const std::string interface_PID_name = "PID_" + _arm->m_name;
_arm->m_PID_interface_required = AddInterfaceRequired(interface_PID_name);
if (_arm->m_PID_interface_required) {
auto itf = _arm->m_PID_interface_required;
itf->AddEventHandlerWrite(&system::error_event_handler, this, "error");
itf->AddEventHandlerWrite(&system::warning_event_handler, this, "warning");
itf->AddEventHandlerWrite(&system::status_event_handler, this, "status");
m_connections.Add(this->GetName(), interface_PID_name,
_arm->m_name + "_PID", "Controller");
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_arm_interfaces: failed to add PID interface for arm \""
<< _arm->m_name << "\"" << std::endl;
return false;
}
}
// arm interface
const std::string interface_arm_name = _arm->m_name;
_arm->m_arm_interface_required = AddInterfaceRequired(interface_arm_name);
if (_arm->m_arm_interface_required) {
auto itf = _arm->m_arm_interface_required;
itf->AddFunction("state_command", _arm->state_command);
if (!_arm->m_config->SUJ()) {
itf->AddFunction("hold", _arm->hold, MTS_OPTIONAL);
}
itf->AddEventHandlerWrite(&system::error_event_handler, this, "error");
itf->AddEventHandlerWrite(&system::warning_event_handler, this, "warning");
itf->AddEventHandlerWrite(&system::status_event_handler, this, "status");
itf->AddEventHandlerWrite(&arm_proxy::current_state_event_handler,
_arm.get(), "operating_state");
m_connections.Add(this->GetName(), interface_arm_name,
_arm->m_arm_component_name, _arm->m_arm_interface_name);
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_arm_interfaces: failed to add Main interface for arm \""
<< _arm->m_name << "\"" << std::endl;
return false;
}
return true;
}
bool dvrk::system::add_console_interfaces(std::shared_ptr<dvrk::console> _console)
{
// main interface
_console->m_interface_provided = this->AddInterfaceProvided(_console->m_name);
if (_console->m_interface_provided) {
auto itf = _console->m_interface_provided;
itf->AddMessageEvents();
itf->AddCommandWrite(&console::teleop_enable, _console.get(),
"teleop_enable", false);
itf->AddCommandWrite(&console::set_scale, _console.get(),
"set_scale",
mtsIntuitiveResearchKit::TeleOperationPSM::Scale);
itf->AddCommandWrite(&console::select_teleop, _console.get(),
"select_teleop", std::string());
itf->AddCommandWrite(&console::unselect_teleop, _console.get(),
"unselect_teleop", std::string());
itf->AddCommandWrite(&console::operator_present_event_handler, _console.get(),
"emulate_operator_present", prmEventButton());
itf->AddCommandWrite(&console::clutch_event_handler, _console.get(),
"emulate_clutch", prmEventButton());
itf->AddCommandWrite(&console::camera_event_handler, _console.get(),
"emulate_camera", prmEventButton());
itf->AddEventWrite(_console->events.teleop_enabled,
"teleop_enabled", false);
itf->AddEventWrite(_console->events.scale,
"scale", 0.5);
itf->AddEventWrite(_console->events.teleop_selected,
"teleop_selected", std::string());
itf->AddEventWrite(_console->events.teleop_unselected,
"teleop_unselected", std::string());
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_console_interfaces: failed to add interface for console \""
<< _console->m_name << "\"" << std::endl;
return false;
}
// add a required interface to the system object to get console messages
mtsInterfaceRequired * itf = AddInterfaceRequired(_console->m_name + "_required");
if (itf) {
itf->AddEventHandlerWrite(&system::error_event_handler, this, "error");
itf->AddEventHandlerWrite(&system::warning_event_handler, this, "warning");
itf->AddEventHandlerWrite(&system::status_event_handler, this, "status");
// that's funny
m_connections.Add(this->GetName(), _console->m_name,
this->GetName(), _console->m_name + "_required");
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_console_interfaces: failed to add required interface for \""
<< _console->m_name << "\"" << std::endl;
return false;
}
// inputs
if (_console->m_config->input_type != console_input_type::SIMULATED) {
mtsInterfaceRequired * interface_required;
// clutch
interface_required = AddInterfaceRequired(_console->m_name + "/required_clutch");
if (interface_required) {
interface_required->AddEventHandlerWrite(&console::clutch_event_handler, _console.get(), "Button");
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_console_interfaces: failed to add clutch required interface for console \""
<< _console->m_name << "\"" << std::endl;
return false;
}
m_connections.Add(this->GetName(), _console->m_name + "/required_clutch",
_console->m_config->clutch.component,
_console->m_config->clutch.interface);
// camera
interface_required = AddInterfaceRequired(_console->m_name + "/required_camera");
if (interface_required) {
interface_required->AddEventHandlerWrite(&console::camera_event_handler, _console.get(), "Button");
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_console_interfaces: failed to add camera required interface for console \""
<< _console->m_name << "\"" << std::endl;
return false;
}
m_connections.Add(this->GetName(), _console->m_name + "/required_camera",
_console->m_config->camera.component,
_console->m_config->camera.interface);
// operator_present
interface_required = AddInterfaceRequired(_console->m_name + "/required_operator_present");
if (interface_required) {
interface_required->AddEventHandlerWrite(&console::operator_present_event_handler, _console.get(), "Button");
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_console_interfaces: failed to add operator_present required interface for console \""
<< _console->m_name << "\"" << std::endl;
return false;
}
m_connections.Add(this->GetName(), _console->m_name + "/required_operator_present",
_console->m_config->operator_present.component,
_console->m_config->operator_present.interface);
}
// propagate inputs
mtsInterfaceProvided * interface_provided = this->AddInterfaceProvided(_console->m_name + "/clutch");
if (interface_provided) {
interface_provided->AddEventWrite(_console->events.clutch, "Button", prmEventButton());
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_console_interfaces: failed to add clutch provided interface for _console \""
<< _console->m_name << "\"" << std::endl;
return false;
}
interface_provided = this->AddInterfaceProvided(_console->m_name + "/camera");
if (interface_provided) {
interface_provided->AddEventWrite(_console->events.camera, "Button", prmEventButton());
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_console_interfaces: failed to add camera provided interface for console \""
<< _console->m_name << "\"" << std::endl;
return false;
}
interface_provided = this->AddInterfaceProvided(_console->m_name + "/operator_present");
if (interface_provided) {
interface_provided->AddEventWrite(_console->events.operator_present, "Button", prmEventButton());
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_console_interfaces: failed to add operator_present provided interface for console \""
<< _console->m_name << "\"" << std::endl;
return false;
}
return true;
}
bool dvrk::system::add_teleop_interfaces(std::shared_ptr<dvrk::teleop_proxy> _teleop_proxy)
{
_teleop_proxy->m_interface_required = this->AddInterfaceRequired(_teleop_proxy->m_name);
if (_teleop_proxy->m_interface_required) {
auto itf = _teleop_proxy->m_interface_required;
itf->AddFunction("state_command", _teleop_proxy->state_command);
itf->AddFunction("set_scale", _teleop_proxy->set_scale);
itf->AddEventHandlerWrite(&system::error_event_handler, this, "error");
itf->AddEventHandlerWrite(&system::warning_event_handler, this, "warning");
itf->AddEventHandlerWrite(&system::status_event_handler, this, "status");
} else {
CMN_LOG_CLASS_INIT_ERROR << "add_teleop_interfaces: failed to add main interface for teleop \""
<< _teleop_proxy->m_name << "\"" << std::endl;
return false;
}
return true;
}
void dvrk::system::configure_IO(const dvrk::IO_configuration & _IO_config)
{
// registered?
auto iter = m_IO_proxies.find(_IO_config.IO);
if (iter == m_IO_proxies.end()) {
CMN_LOG_INIT_ERROR << "system::configure_IO for \""
<< _IO_config.name << "\", \""
<< _IO_config.IO << "\" is not defined in \"IOs\"" << std::endl;
exit(EXIT_FAILURE);
}
// locate file
if (_IO_config.IO_file == "") {
CMN_LOG_INIT_ERROR << "system::configure_IO for \""
<< _IO_config.name << "\", IO_file is not defined" << std::endl;
exit(EXIT_FAILURE);
}
const std::string full_file = find_file( _IO_config.IO_file);
if (full_file == "") {
CMN_LOG_INIT_ERROR << "system::configure_IO for \""
<< _IO_config.name << "\", \""
<< _IO_config.IO_file << "\" not found" << std::endl;
exit(EXIT_FAILURE);
}
// and finally configure
iter->second->configure(full_file);
}
bool dvrk::system::Connect(void)
{
mtsManagerLocal * component_manager = mtsManagerLocal::GetInstance();
// connect console for audio feedback
component_manager->Connect(this->GetName(), "TextToSpeech",
m_text_to_speech->GetName(), "Commands");
// arms
for (const auto & iter : m_arm_proxies) {
std::shared_ptr<dvrk::arm_proxy> arm = iter.second;
// arm specific interfaces
arm->connect();
// connect to SUJ if needed
if (arm->SUJInterfaceRequiredFromIO) {
component_manager->Connect(this->GetName(), arm->SUJInterfaceRequiredFromIO->GetName(),
arm->m_IO_component_name, arm->m_name + "_SUJ_clutch");
}
if (arm->SUJInterfaceRequiredFromIO2) {
component_manager->Connect(this->GetName(), arm->SUJInterfaceRequiredFromIO2->GetName(),
arm->m_IO_component_name, arm->m_name + "_SUJ_clutch_2");
}
if (arm->SUJInterfaceRequiredToSUJ) {
component_manager->Connect(this->GetName(), arm->SUJInterfaceRequiredToSUJ->GetName(),
"SUJ", arm->m_name);
}
}
m_connections.Connect();
return true;
}
// ConnectInternal is called before the thread is running, and therefore we force it (by using const_cast)
// to have the signature of a CommandRead, so that it can be executed in the caller's thread.
void dvrk::system::ConnectInternal(bool &ret) const
{
ret = const_cast<system *>(this)->Connect();
}
std::string dvrk::system::find_file(const std::string & filename) const
{
return m_config_path.Find(filename);
}
void dvrk::system::power_off(void)
{
for (auto & console : m_consoles) {
console.second->teleop_enable(false);
}
for (auto & arm : m_arm_proxies) {
arm.second->state_command(std::string("disable"));
}
}
void dvrk::system::power_on(void)
{
disable_faulty_arms();
for (auto & arm : m_arm_proxies) {
arm.second->state_command(std::string("enable"));
}
}
void dvrk::system::home(void)
{
disable_faulty_arms();
bool allArmsEnabled = true;
// enable all arms that need it
for (auto & arm : m_arm_proxies) {
auto armState = m_arm_states.find(arm.first);
if (// search if we already have a state
(armState != m_arm_states.end())
// and the arm is disabled
&& (armState->second.State() == prmOperatingState::DISABLED) ) {
arm.second->state_command(std::string("enable"));
allArmsEnabled = false;
}
}
if (!allArmsEnabled) {
osaSleep(1.0 * cmn_s);
}
for (auto & arm : m_arm_proxies) {
arm.second->state_command(std::string("home"));
}
}
void dvrk::system::disable_faulty_arms(void)
{
for (auto & arm : m_arm_proxies) {
auto armState = m_arm_states.find(arm.first);
if (// search if we already have a state
(armState != m_arm_states.end())
// and the arm is faulty
&& (armState->second.State() == prmOperatingState::FAULT) ) {
arm.second->state_command(std::string("disable"));
}
}
}
void dvrk::system::set_volume(const double & volume)
{
if (volume > 1.0) {
m_audio_volume = 1.0;
} else if (volume < 0.0) {
m_audio_volume = 0.0;
} else {
m_audio_volume = volume;
}
std::stringstream message;
message << this->GetName() << ": volume set to " << static_cast<int>(volume * 100.0) << "%";
m_interface->SendStatus(message.str());
audio.volume(m_audio_volume);
}
void dvrk::system::beep(const vctDoubleVec & values)
{
const size_t size = values.size();
if ((size == 0) || (size > 3)) {
m_interface->SendError(this->GetName() + ": beep expect up to 3 values (duration, frequency, volume)");
return;
}
vctDoubleVec result(3);
result.Assign(0.3, 3000.0, m_audio_volume);
result.Ref(size).Assign(values); // overwrite with data sent
// check duration
bool durationError = false;
if (result[0] < 0.1) {
result[0] = 0.1;
durationError = true;
} else if (result[0] > 60.0) {
result[0] = 60.0;
durationError = true;
}
if (durationError) {
m_interface->SendWarning(this->GetName() + ": beep, duration must be between 0.1 and 60s");
}
// check volume
bool volumeError = false;
if (result[2] < 0.0) {
result[2] = 0.0;
volumeError = true;
} else if (result[2] > 1.0) {
result[2] = 1.0;
volumeError = true;
}
if (volumeError) {
m_interface->SendWarning(this->GetName() + ": beep, volume must be between 0 and 1");
}
// convert to fixed size vector and send
audio.beep(vct3(result));
}
void dvrk::system::string_to_speech(const std::string & text)
{
audio.string_to_speech(text);
}
void dvrk::system::emit_events_console(void)
{
}
void dvrk::system::error_event_handler(const mtsMessage & message)
{
m_interface->SendError(message.Message);
// throttle error beeps
double currentTime = mtsManagerLocal::GetInstance()->GetTimeServer().GetRelativeTime();
if ((currentTime - mTimeOfLastErrorBeep) > 2.0 * cmn_s) {
audio.beep(vct3(0.3, 3000.0, m_audio_volume));
mTimeOfLastErrorBeep = currentTime;
}
}
void dvrk::system::warning_event_handler(const mtsMessage & message)
{
m_interface->SendWarning(message.Message);
}
void dvrk::system::status_event_handler(const mtsMessage & message)
{
m_interface->SendStatus(message.Message);
}
void dvrk::system::set_arm_current_state(const std::string & _arm_name,
const prmOperatingState & _current_state)
{
// if (mTeleopDesired && !mTeleopEnabled) {
// teleop_enable(true);
// }
// save state
m_arm_states[_arm_name] = _current_state;
// emit event (for Qt GUI)
std::string payload = "";
if (_current_state.IsEnabledAndHomed()) {
payload = "ENABLED";
} else if (_current_state.State() == prmOperatingState::FAULT) {
payload = "FAULT";
}
events.arm_current_state(prmKeyValue(_arm_name, payload));
}
bool dvrk::system::find_conflicting_teleops(const std::shared_ptr<dvrk::teleop_proxy> _teleop, const bool _unselect)
{
bool result = false;
for (auto iter : m_consoles) {
result |= iter.second->find_conflicting_teleops(_teleop, _unselect);
}
return result;
}
|