-
Notifications
You must be signed in to change notification settings - Fork 114
Expand file tree
/
Copy pathspot_ros2.py
More file actions
3186 lines (2858 loc) · 138 KB
/
Copy pathspot_ros2.py
File metadata and controls
3186 lines (2858 loc) · 138 KB
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
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# Debug
# from ros_helpers import *
import functools
import logging
import os
import tempfile
import threading
import time
import traceback
import typing
import weakref
from collections.abc import Sequence
from dataclasses import dataclass
from enum import Enum
from typing import Any, Callable, Dict, List, Optional, Tuple, Union
import builtin_interfaces.msg
import numpy as np
import rclpy
import rclpy.duration
import rclpy.time
from rclpy.qos import QoSProfile, ReliabilityPolicy, HistoryPolicy, DurabilityPolicy
import synchros2.process as ros_process
import tf2_ros
from bondpy.bondpy import Bond
from bosdyn.api import (
arm_command_pb2,
arm_surface_contact_pb2,
geometry_pb2,
gripper_camera_param_pb2,
lease_pb2,
manipulation_api_pb2,
point_cloud_pb2,
robot_command_pb2,
trajectory_pb2,
world_object_pb2,
)
from bosdyn.api.geometry_pb2 import Quaternion, SE2VelocityLimit
from bosdyn.api.manipulation_api_pb2 import WalkGazeMode
from bosdyn.api.spot import robot_command_pb2 as spot_command_pb2
from bosdyn.api.spot.choreography_sequence_pb2 import Animation, ChoreographySequence, ChoreographyStatusResponse
from bosdyn.client import math_helpers
from bosdyn.client.async_tasks import AsyncPeriodicQuery
from bosdyn.client.exceptions import InternalServerError
from bosdyn.client.lease import Lease, LeaseWallet
from bosdyn.util import set_clock_source
from bosdyn_api_msgs.math_helpers import bosdyn_localization_to_pose_msg, bosdyn_pose_to_tf
from bosdyn_msgs.conversions import convert
from bosdyn_msgs.msg import (
ArmCommandFeedback,
ArmVelocityCommandRequest,
Camera,
FullBodyCommand,
FullBodyCommandFeedback,
GripperCommandFeedback,
Logpoint,
ManipulationApiFeedbackResponse,
MobilityCommandFeedback,
MobilityParamsStairsMode,
PtzDescription,
RobotCommand,
RobotCommandFeedback,
RobotCommandFeedbackStatusStatus,
)
from geometry_msgs.msg import Pose, PoseStamped, TransformStamped, TwistStamped, Twist
from rclpy import Parameter
from rclpy.action import ActionServer
from rclpy.action.server import ServerGoalHandle
from rclpy.callback_groups import CallbackGroup, MutuallyExclusiveCallbackGroup
from rclpy.clock import Clock
from rclpy.impl import rcutils_logger
from rclpy.publisher import Publisher
from sensor_msgs.msg import JointState, PointCloud2, PointField
from std_srvs.srv import Trigger
from synchros2.node import Node
from synchros2.service import Serviced
from synchros2.single_goal_action_server import SingleGoalActionServer
from synchros2.single_goal_multiple_action_servers import SingleGoalMultipleActionServers
import spot_driver.robot_command_util as robot_command_util
# DEBUG/RELEASE: RELATIVE PATH NOT WORKING IN DEBUG
# Release
from spot_driver.ros_helpers import TriggerServiceWrapper, get_from_env_and_fall_back_to_param
from spot_msgs.action import ( # type: ignore
ArmSurfaceContact,
ExecuteDance,
Manipulation,
NavigateTo,
Trajectory,
)
from spot_msgs.action import ( # type: ignore
RobotCommand as RobotCommandAction,
)
from spot_msgs.msg import ( # type: ignore
Feedback,
LeaseArray,
LeaseResource,
Metrics,
MobilityParams,
)
from spot_msgs.srv import ( # type: ignore
AcquireLease,
ChoreographyRecordedStateToAnimation,
ChoreographyStartRecordingState,
ChoreographyStopRecordingState,
ClearBehaviorFault,
DeleteLogpoint,
DeleteSound,
Dock,
GetChoreographyStatus,
GetGripperCameraParameters,
GetLEDBrightness,
GetLogpointStatus,
GetPtzPosition,
GetVolume,
GraphNavClearGraph,
GraphNavGetLocalizationPose,
GraphNavSetLocalization,
GraphNavUploadGraph,
InitializeLens,
ListAllDances,
ListAllMoves,
ListCameras,
ListGraph,
ListLogpoints,
ListPtz,
ListSounds,
ListWorldObjects,
LoadSound,
OverrideGraspOrCarry,
PlaySound,
RetrieveLogpoint,
ReturnLease,
SetGripperAngle,
SetGripperCameraParameters,
SetLEDBrightness,
SetLocomotion,
SetPtzPosition,
SetStairsMode,
SetStandHeight,
SetVelocity,
SetVolume,
StoreLogpoint,
TagLogpoint,
UploadAnimation,
UploadSequence,
)
from spot_msgs.srv import RobotCommand as RobotCommandService # type: ignore
from spot_wrapper.cam_wrapper import SpotCamCamera, SpotCamWrapper
from spot_wrapper.spot_leash import SpotLeashContextProtocol, SpotLeashProtocol
from spot_wrapper.wrapper import SpotWrapper
MAX_DURATION = 1e6
COLOR_END = "\33[0m"
COLOR_GREEN = "\33[32m"
COLOR_YELLOW = "\33[33m"
@dataclass
class Request:
id: str
data: Any
@dataclass
class Response:
message: str
success: bool
class GoalResponse(Enum):
FAILED = -1
IN_PROGRESS = False
SUCCESS = True
class WaitForGoal(object):
def __init__(
self,
clock: Clock,
duration: Union[float, rclpy.time.Duration],
callback: Optional[Callable] = None,
) -> None:
self._at_goal = False
self._callback = callback
self._clock = clock
if not isinstance(duration, rclpy.duration.Duration):
duration = rclpy.duration.Duration(seconds=duration)
self._duration: rclpy.duration.Duration = duration
self._thread = threading.Thread(target=self._run)
self._thread.start()
@property
def at_goal(self) -> bool:
return self._at_goal
def _run(self) -> None:
self._clock.sleep_for(self._duration)
self._at_goal = True
def set_node_parameter_from_parameter_list(
node: Node, parameter_list: Optional[typing.List[Parameter]], parameter_name: str
) -> None:
"""Set parameters when the node starts not from a launch file."""
if parameter_list is not None:
node.set_parameters([parameter for parameter in parameter_list if parameter.name == parameter_name])
class SpotProxyLeash(SpotLeashProtocol):
class Context(SpotLeashContextProtocol):
def __init__(self, leash: SpotLeashProtocol, logger: logging.Logger):
self._leash = leash
self._logger = logger
self._lock = threading.Lock()
self._num_entries = 0
def _decorate(self, action: Callable) -> Callable:
@functools.wraps(action)
def _wrapper(*args: Any, **kwargs: Any) -> Any:
try:
with self._lock:
if self._num_entries == 0:
self._leash.grab()
self._num_entries += 1
try:
return action(*args, **kwargs)
finally:
with self._lock:
self._num_entries -= 1
if self._num_entries == 0:
self._leash.yield_()
except Exception:
self._logger.error(traceback.format_exc())
raise
return _wrapper
def bind(self, target: Any, actions: Sequence[Callable], passive: bool = False) -> None:
for action in actions:
setattr(target, action.__name__, self._decorate(action))
def __init__(self, node: Node, logger: logging.Logger) -> None:
self._node = node
self._logger = logger
self._lock = threading.Lock()
self._claim_leases = Serviced(Trigger, "claim_leases", node)
self._acquire_lease = Serviced(AcquireLease, "acquire_lease", node)
self._return_lease = Serviced(ReturnLease, "return_lease", node)
self._release_leases = Serviced(Trigger, "release_leases", node)
self._lease_wallet: Optional[LeaseWallet] = None
self._keepalive_bond: Optional[Bond] = None
self._lease: Optional[Lease] = None
def claim(self) -> bool:
with self._lock:
if self._lease_wallet is None:
raise RuntimeError("leash not tied to wrapper")
self._claim_leases()
return True
def grab(self, force: bool = False) -> Tuple[bool, Optional[Lease]]:
with self._lock:
if self._lease_wallet is None:
raise RuntimeError("leash not tied to wrapper")
if self._lease is not None and not force:
return False, self._lease
request = AcquireLease.Request()
request.client_name = self._lease_wallet.client_name
request.force = force
response = self._acquire_lease(request)
lease_proto = lease_pb2.Lease()
convert(response.lease, lease_proto)
lease = Lease(lease_proto)
self._lease_wallet.add(lease)
have_new_lease = self._lease is None or str(lease.lease_proto) != str(self._lease.lease_proto)
if self._keepalive_bond is not None:
self._keepalive_bond.shutdown()
self._keepalive_bond = Bond(self._node, "bonds", self._lease_wallet.client_name)
self._keepalive_bond.start()
self._lease = lease
return have_new_lease, lease
def yield_(self) -> None:
with self._lock:
if self._lease_wallet is None:
raise RuntimeError("leash not tied to wrapper")
if self._lease is None:
raise RuntimeError("no lease to yield")
request = ReturnLease.Request()
convert(self._lease.lease_proto, request.lease)
self._return_lease(request)
self._lease_wallet.remove(self._lease)
if self._keepalive_bond is not None:
self._keepalive_bond.shutdown()
self._keepalive_bond = None
self._lease = None
def release(self) -> None:
with self._lock:
if self._lease_wallet is None:
raise RuntimeError("leash not tied to wrapper")
self._release_leases()
if self._keepalive_bond is not None:
self._keepalive_bond.shutdown()
self._keepalive_bond = None
if self._lease is not None:
self._lease_wallet.remove(self._lease)
self._lease = None
def tie(self, wrapper: Any) -> SpotLeashContextProtocol:
self._lease_wallet = wrapper._robot.lease_wallet
return SpotProxyLeash.Context(self, self._logger)
@property
def lease(self) -> Optional[Lease]:
return self._lease
@property
def resources(self) -> List[lease_pb2.LeaseResource]:
raise NotImplementedError("Not available, only over status/leases topic")
@property
def async_tasks(self) -> List[AsyncPeriodicQuery]:
return []
def set_spot_sdk_clock_source(clock: Clock) -> None:
"""Set the given ROS clock as Spot SDK clock source.
Note that the Python SDK for Spot (unlike its C++ counterpart) is rather inconsistent
in its use of clock sources. It will often just call time.time() directly instead of
using bosdyn.util.now_sec() or derivatives. Simulation must handle time synchronization
services and even then you may still run into timing issues. Use at your own risk.
"""
clock_ref = weakref.ref(clock)
def _clock_time() -> float:
clock = clock_ref()
if clock is None:
return time.time()
return clock.now().nanoseconds / 1e9
set_clock_source(_clock_time)
class SpotROS(Node):
"""Parent class for using the wrapper. Defines all callbacks and keeps the wrapper alive"""
TRAJECTORY_BATCH_SIZE_PARAM = "trajectory_batch_size"
TRAJECTORY_BATCH_OVERLAPPING_POINTS_PARAM = "trajectory_batch_overlapping_points"
def __init__(self, parameter_list: Optional[typing.List[Parameter]] = None, **kwargs: typing.Any) -> None:
"""
Main function for the SpotROS class. Gets config from ROS and initializes the wrapper.
Holds lease from wrapper and updates all async tasks at the ROS rate
"""
super().__init__("spot_ros2", **kwargs)
self.run_navigate_to: Optional[bool] = None
self._printed_once: bool = False
self.get_logger().info(COLOR_GREEN + "Hi from spot_driver." + COLOR_END)
self.callbacks: Dict[str, Callable] = {}
"""Dictionary listing what callback to use for what data task"""
self.callbacks["metrics"] = self.metrics_callback
self.group: CallbackGroup = MutuallyExclusiveCallbackGroup()
self.graph_nav_callback_group: CallbackGroup = MutuallyExclusiveCallbackGroup()
self.declare_parameter("auto_claim", False)
self.declare_parameter("auto_power_on", False)
self.declare_parameter("auto_stand", False)
self.declare_parameter("use_take_lease", True)
self.declare_parameter("get_lease_on_action", True)
self.declare_parameter("continually_try_stand", False)
self.declare_parameter("estop_timeout", 9.0)
self.declare_parameter("cmd_duration", 0.125)
self.declare_parameter("arm_cmd_duration", 1.0)
self.declare_parameter("start_estop", False)
self.declare_parameter("rgb_cameras", True)
# Declare rates for command polling
self.declare_parameter("poll_rate", 10.0)
# Declare rates for the spot_ros2 publishers, which are combined to a dictionary
self.declare_parameter("metrics_rate", 0.04)
self.declare_parameter("world_objects_rate", 20.0)
self.declare_parameter("graph_nav_pose_rate", 10.0)
self.declare_parameter("publish_graph_nav_pose", False)
self.declare_parameter("graph_nav_seed_frame", "graph_nav_map")
self.declare_parameter("initialize_spot_cam", False)
self.declare_parameter("spot_name", "")
self.declare_parameter("frame_prefix", Parameter.Type.STRING)
self.declare_parameter("mock_enable", False)
self.declare_parameter("gripperless", False)
self.declare_parameter("use_velodyne", False)
self.declare_parameter("velodyne_rate", 10.0)
# When we send very long trajectories to Spot, we create batches of
# given size. If we do not batch a long trajectory, Spot will reject it.
self.declare_parameter(self.TRAJECTORY_BATCH_SIZE_PARAM, 100)
self.trajectory_batch_size: Parameter = self.get_parameter(self.TRAJECTORY_BATCH_SIZE_PARAM).value
# When we send very long trajectories to Spot, we create overlapping
# batches. Overlapping trajectories is very important because we want
# the robot to stitch them smoothly. A batch is sent before the
# previous one has completed, to work around network latency. The
# following default value has been determined empirically.
self.declare_parameter(self.TRAJECTORY_BATCH_OVERLAPPING_POINTS_PARAM, 20)
self.trajectory_batch_overlapping_points: Parameter = self.get_parameter(
self.TRAJECTORY_BATCH_OVERLAPPING_POINTS_PARAM
).value
# If `mock_enable:=True`, then there are additional parameters. We must set this one separately.
set_node_parameter_from_parameter_list(self, parameter_list, "mock_enable")
if self.get_parameter("mock_enable").value:
self.declare_parameter("mock_has_arm", rclpy.Parameter.Type.BOOL)
# used for setting when not using launch file
if parameter_list is not None:
self.set_parameters(parameter_list)
self.auto_claim: Parameter = self.get_parameter("auto_claim")
self.auto_power_on: Parameter = self.get_parameter("auto_power_on")
self.auto_stand: Parameter = self.get_parameter("auto_stand")
self.start_estop: Parameter = self.get_parameter("start_estop")
self.use_take_lease: Parameter = self.get_parameter("use_take_lease")
self.get_lease_on_action: Parameter = self.get_parameter("get_lease_on_action")
self.continually_try_stand: Parameter = self.get_parameter("continually_try_stand")
self.rgb_cameras: Parameter = self.get_parameter("rgb_cameras")
self.publish_graph_nav_pose: Parameter = self.get_parameter("publish_graph_nav_pose")
self.graph_nav_seed_frame: str = self.get_parameter("graph_nav_seed_frame").value
self.initialize_spot_cam: bool = self.get_parameter("initialize_spot_cam").value
self.gripperless: bool = self.get_parameter("gripperless").value
self._wait_for_goal: Optional[WaitForGoal] = None
self.goal_handle: Optional[ServerGoalHandle] = None
self.rates = {
"metrics": self.get_parameter("metrics_rate").value,
"world_objects": self.get_parameter("world_objects_rate").value,
"graph_nav_pose": self.get_parameter("graph_nav_pose_rate").value,
}
self.use_velodyne = self.get_parameter("use_velodyne").value
if self.use_velodyne:
self.callbacks["lidar_points"] = self.velodyne_callback
self.velodyne_pub: Publisher = self.create_publisher(PointCloud2, "velodyne/points", 10)
self.velodyne_static_tf_broadcaster = tf2_ros.StaticTransformBroadcaster(self)
self.rates["point_cloud"] = self.get_parameter("velodyne_rate").value
max_task_rate = float(max(self.rates.values()))
self.declare_parameter("async_tasks_rate", max_task_rate)
# This is only done from parameter because it should be passed by the launch file
self.name: Optional[str] = self.get_parameter("spot_name").value
if not self.name:
self.name = None
self.mock: bool = self.get_parameter("mock_enable").value
self.mock_has_arm: Optional[bool] = None
if self.mock:
self.mock_has_arm = self.get_parameter("mock_has_arm").value
self.estop_timeout: Parameter = self.get_parameter("estop_timeout")
self.async_tasks_rate: float = self.get_parameter("async_tasks_rate").value
if self.async_tasks_rate < max_task_rate:
self.get_logger().warn(
COLOR_YELLOW
+ f"The maximum individual task rate is {max_task_rate} Hz. You have manually set the async_tasks_rate"
f" to {self.async_tasks_rate} which is lower and will decrease the frequency of one of the periodic"
" tasks being run."
+ COLOR_END
)
self.cmd_duration: float = self.get_parameter("cmd_duration").value
self.arm_cmd_duration: float = self.get_parameter("arm_cmd_duration").value
self.username: str = get_from_env_and_fall_back_to_param("BOSDYN_CLIENT_USERNAME", self, "username", "user")
self.password: str = get_from_env_and_fall_back_to_param("BOSDYN_CLIENT_PASSWORD", self, "password", "password")
self.ip: str = get_from_env_and_fall_back_to_param("SPOT_IP", self, "hostname", "10.0.0.3")
self.port: int = get_from_env_and_fall_back_to_param("SPOT_PORT", self, "port", 0)
self.certificate: Optional[str] = (
get_from_env_and_fall_back_to_param("SPOT_CERTIFICATE", self, "certificate", "") or None
)
self.frame_prefix: Optional[str] = self.get_parameter_or("frame_prefix", None).value
if self.frame_prefix is None:
self.frame_prefix = self.name + "/" if self.name is not None else ""
self.tf_name_graph_nav_body: str = self.frame_prefix + "body"
# logger for spot wrapper
name_with_dot = ""
if self.name is not None:
name_with_dot = self.name + "."
logging.basicConfig(format="[%(filename)s:%(lineno)d] %(message)s", level=logging.ERROR)
self.wrapper_logger = logging.getLogger(f"{name_with_dot}spot_wrapper")
self.leash_interface: Optional[SpotLeashProtocol] = None
self.leasing_mode = self.declare_parameter("leasing_mode", "direct").value
if self.leasing_mode == "proxied":
if self.use_take_lease:
self.get_logger().error(
"Should 'use_take_lease' but proxy leasing won't under normal operation, ignoring"
)
if not self.get_lease_on_action:
self.get_logger().error(
"Should not 'get_lease_on_action' but proxy leasing "
"must as it operates with temporary subleases, ignoring"
)
self.leash_interface = SpotProxyLeash(self, self.wrapper_logger)
else:
if self.leasing_mode != "direct":
self.get_logger().warn(f"Unknown '{self.leasing_mode}' leasing mode, falling back to 'direct'")
self.lease_pub: Publisher = self.create_publisher(LeaseArray, "status/leases", 1)
self.rates["lease"] = self.declare_parameter("lease_rate", 1.0).value
self.callbacks["lease"] = self.lease_callback
name_str = ""
if self.name is not None:
name_str = " for " + self.name
mocking_designator = " (mocked)" if self.mock else ""
self.get_logger().info("Starting ROS driver for Spot" + name_str + mocking_designator)
# testing with Robot
if self.mock:
self.spot_wrapper: Optional[SpotWrapper] = None
self.cam_wrapper: Optional[SpotCamWrapper] = None
else:
# Set the Spot SDK clock
set_spot_sdk_clock_source(self.get_clock())
# create SpotWrapper if not mocking
self.spot_wrapper = SpotWrapper(
username=self.username,
password=self.password,
hostname=self.ip,
port=self.port,
robot_name=self.name,
frame_prefix=self.frame_prefix,
logger=self.wrapper_logger,
start_estop=self.start_estop.value,
estop_timeout=self.estop_timeout.value,
rates=self.rates,
callbacks=self.callbacks,
leash_interface=self.leash_interface,
use_take_lease=self.use_take_lease.value,
get_lease_on_action=self.get_lease_on_action.value,
continually_try_stand=self.continually_try_stand.value,
rgb_cameras=self.rgb_cameras.value,
cert_resource_glob=self.certificate,
gripperless=self.gripperless,
)
if not self.spot_wrapper.is_valid:
return
self.spot_cam_wrapper = None
if self.initialize_spot_cam:
try:
self.cam_logger = rcutils_logger.RcutilsLogger(name=f"{name_with_dot}spot_cam_wrapper")
self.spot_cam_wrapper = SpotCamWrapper(
hostname=self.ip,
username=self.username,
password=self.password,
port=self.port,
logger=self.cam_logger,
cert_resource_glob=self.certificate,
)
except SystemError:
self.spot_cam_wrapper = None
if self.frame_prefix != self.spot_wrapper.frame_prefix:
error_msg = (
f"ERROR: disagreement between `self.frame_prefix` ({self.frame_prefix}) and"
f" `self.spot_wrapper.frame_prefix` ({self.spot_wrapper.frame_prefix})"
)
self.get_logger().error(error_msg)
raise ValueError(error_msg)
self.has_arm = self.mock_has_arm
if self.spot_wrapper is not None:
self.has_arm = self.spot_wrapper.has_arm()
if self.publish_graph_nav_pose.value:
# graph nav pose will be published both on a topic
# and as a TF transform from graph_nav_map to body.
self.graph_nav_pose_pub = self.create_publisher(PoseStamped, "graph_nav/body_pose", 1)
self.graph_nav_pose_transform_broadcaster = tf2_ros.StaticTransformBroadcaster(self)
self.create_timer(
1 / self.rates["graph_nav_pose"],
self.publish_graph_nav_pose_callback,
callback_group=self.graph_nav_callback_group,
)
self.declare_parameter("has_arm", self.has_arm)
# Status Publishers #
self.dynamic_broadcaster: tf2_ros.TransformBroadcaster = tf2_ros.TransformBroadcaster(self)
self.metrics_pub: Publisher = self.create_publisher(Metrics, "status/metrics", 1)
self.feedback_pub: Publisher = self.create_publisher(Feedback, "status/feedback", 1)
self.mobility_params_pub: Publisher = self.create_publisher(MobilityParams, "status/mobility_params", 1)
# Recommended QoS for Joy/Teleop commands
JOY_TELEOP_QOS = QoSProfile(
# Best Effort - prioritizes low latency over guaranteed delivery
# Perfect for real-time control where latest command matters most
reliability=ReliabilityPolicy.BEST_EFFORT,
# Keep Last with small depth - only care about most recent commands
# History of 1-5 is typical, 1 is often sufficient for teleop
history=HistoryPolicy.KEEP_LAST,
depth=1, # Only keep the latest command
# Volatile - don't persist commands after node restart
# Teleop commands shouldn't be replayed from before restart
durability=DurabilityPolicy.VOLATILE
)
self.create_subscription(Twist, "cmd_vel", self.cmd_velocity_callback, JOY_TELEOP_QOS, callback_group=self.group)
self.create_subscription(TwistStamped, "cmd_vel_stamped", self.cmd_velocity_stamped_callback, JOY_TELEOP_QOS, callback_group=self.group)
self.create_subscription(Pose, "body_pose", self.body_pose_callback, 1, callback_group=self.group)
self.create_trigger_services()
if self.has_arm:
self.create_subscription(
JointState, "arm_joint_commands", self.arm_joint_cmd_callback, JOY_TELEOP_QOS, callback_group=self.group
)
self.create_subscription(
PoseStamped, "arm_pose_commands", self.arm_pose_cmd_callback, 100, callback_group=self.group
)
self.create_subscription(
ArmVelocityCommandRequest,
"arm_velocity_commands",
self.arm_velocity_cmd_callback,
JOY_TELEOP_QOS,
callback_group=self.group,
)
if not self.gripperless:
self.create_service(
SetGripperAngle,
"set_gripper_angle",
lambda request, response: self.service_wrapper(
"set_gripper_angle", self.handle_gripper_angle, request, response
),
callback_group=self.group,
)
self.create_service(
SetStandHeight,
"set_stand_height",
lambda request, response: self.service_wrapper(
"set_stand_height", self.handle_stand_height, request, response
),
callback_group=self.group,
)
self.create_service(
SetStairsMode,
"stairs_mode",
lambda request, response: self.service_wrapper("stairs_mode", self.handle_stair_mode, request, response),
callback_group=self.group,
)
self.create_service(
SetLocomotion,
"locomotion_mode",
lambda request, response: self.service_wrapper(
"locomotion_mode", self.handle_locomotion_mode, request, response
),
callback_group=self.group,
)
self.create_service(
SetVelocity,
"max_velocity",
lambda request, response: self.service_wrapper("max_velocity", self.handle_max_vel, request, response),
callback_group=self.group,
)
self.create_service(
ClearBehaviorFault,
"clear_behavior_fault",
lambda request, response: self.service_wrapper(
"clear_behavior_fault",
self.handle_clear_behavior_fault,
request,
response,
),
callback_group=self.group,
)
self.create_service(
UploadAnimation,
"upload_animation",
lambda request, response: self.service_wrapper(
"upload_animation", self.handle_upload_animation, request, response
),
callback_group=self.group,
)
self.create_service(
UploadSequence,
"upload_sequence",
lambda request, response: self.service_wrapper(
"upload_sequence", self.handle_upload_sequence, request, response
),
callback_group=self.group,
)
self.create_service(
ListAllDances,
"list_all_dances",
lambda request, response: self.service_wrapper(
"list_all_dances", self.handle_list_all_dances, request, response
),
callback_group=self.group,
)
self.create_service(
ListAllMoves,
"list_all_moves",
lambda request, response: self.service_wrapper(
"list_all_moves", self.handle_list_all_moves, request, response
),
callback_group=self.group,
)
self.create_service(
ChoreographyRecordedStateToAnimation,
"recorded_state_to_animation",
lambda request, response: self.service_wrapper(
"recorded_state_to_animation", self.handle_recorded_state_to_animation, request, response
),
callback_group=self.group,
)
self.create_service(
ChoreographyStartRecordingState,
"start_recording_state",
lambda request, response: self.service_wrapper(
"start_recording_state", self.handle_start_recording_state, request, response
),
callback_group=self.group,
)
self.create_service(
ChoreographyStopRecordingState,
"stop_recording_state",
lambda request, response: self.service_wrapper(
"stop_recording_state", self.handle_stop_recording_state, request, response
),
callback_group=self.group,
)
self.create_service(
GetChoreographyStatus,
"get_choreography_status",
lambda request, response: self.service_wrapper(
"get_choreography_status", self.handle_get_choreography_status, request, response
),
callback_group=self.group,
)
self.create_service(
ListSounds,
"list_sounds",
lambda request, response: self.service_wrapper("list_sounds", self.handle_list_sounds, request, response),
callback_group=self.group,
)
self.create_service(
LoadSound,
"load_sound",
lambda request, response: self.service_wrapper("load_sound", self.handle_load_sound, request, response),
callback_group=self.group,
)
self.create_service(
PlaySound,
"play_sound",
lambda request, response: self.service_wrapper("play_sound", self.handle_play_sound, request, response),
callback_group=self.group,
)
self.create_service(
DeleteSound,
"delete_sound",
lambda request, response: self.service_wrapper("delete_sound", self.handle_delete_sound, request, response),
callback_group=self.group,
)
self.create_service(
GetVolume,
"get_volume",
lambda request, response: self.service_wrapper("get_volume", self.handle_get_volume, request, response),
callback_group=self.group,
)
self.create_service(
SetVolume,
"set_volume",
lambda request, response: self.service_wrapper("set_volume", self.handle_set_volume, request, response),
callback_group=self.group,
)
self.create_service(
ListPtz,
"list_ptz",
lambda request, response: self.service_wrapper("list_ptz", self.handle_list_ptz, request, response),
callback_group=self.group,
)
self.create_service(
GetPtzPosition,
"get_ptz_position",
lambda request, response: self.service_wrapper(
"get_ptz_position", self.handle_get_ptz_position, request, response
),
callback_group=self.group,
)
self.create_service(
SetPtzPosition,
"set_ptz_position",
lambda request, response: self.service_wrapper(
"set_ptz_position", self.handle_set_ptz_position, request, response
),
callback_group=self.group,
)
self.create_service(
InitializeLens,
"initialize_lens",
lambda request, response: self.service_wrapper(
"initialize_lens", self.handle_initialize_lens, request, response
),
callback_group=self.group,
)
self.create_service(
ListCameras,
"list_cameras",
lambda request, response: self.service_wrapper("list_cameras", self.handle_list_cameras, request, response),
callback_group=self.group,
)
self.create_service(
ListLogpoints,
"list_logpoints",
lambda request, response: self.service_wrapper(
"list_logpoints", self.handle_list_logpoints, request, response
),
callback_group=self.group,
)
self.create_service(
RetrieveLogpoint,
"retrieve_logpoint",
lambda request, response: self.service_wrapper(
"retrieve_logpoint", self.handle_retrieve_logpoint, request, response
),
callback_group=self.group,
)
self.create_service(
GetLogpointStatus,
"get_logpoint_status",
lambda request, response: self.service_wrapper(
"get_logpoint_status", self.handle_get_logpoint_status, request, response
),
callback_group=self.group,
)
self.create_service(
DeleteLogpoint,
"delete_logpoint",
lambda request, response: self.service_wrapper(
"get_logpoint_status", self.handle_delete_logpoint, request, response
),
callback_group=self.group,
)
self.create_service(
StoreLogpoint,
"store_logpoint",
lambda request, response: self.service_wrapper(
"store_logpoint", self.handle_store_logpoint, request, response
),
callback_group=self.group,
)
self.create_service(
TagLogpoint,
"tag_logpoint",
lambda request, response: self.service_wrapper("tag_logpoint", self.handle_tag_logpoint, request, response),
callback_group=self.group,
)
self.create_service(
GetLEDBrightness,
"get_led_brightness",
lambda request, response: self.service_wrapper(
"get_led_brightness", self.handle_get_led_brightness, request, response
),
callback_group=self.group,
)
self.create_service(
SetLEDBrightness,
"set_led_brightness",
lambda request, response: self.service_wrapper(
"set_led_brightness", self.handle_set_led_brightness, request, response
),
callback_group=self.group,
)
self.create_service(
ListGraph,
"list_graph",
lambda request, response: self.service_wrapper("list_graph", self.handle_list_graph, request, response),
callback_group=self.group,
)
self.create_service(
Dock,
"dock",
lambda request, response: self.service_wrapper("dock", self.handle_dock, request, response),
callback_group=self.group,
)
# This doesn't use the service wrapper because it's not a trigger, and we want different mock responses
self.create_service(ListWorldObjects, "list_world_objects", self.handle_list_world_objects)
self.create_service(
GraphNavUploadGraph,
"graph_nav_upload_graph",
self.handle_graph_nav_upload_graph,
callback_group=self.group,
)
self.create_service(
GraphNavClearGraph,
"graph_nav_clear_graph",
self.handle_graph_nav_clear_graph,
callback_group=self.group,
)
self.create_service(
GraphNavGetLocalizationPose,
"graph_nav_get_localization_pose",
self.handle_graph_nav_get_localization_pose,
callback_group=self.group,
)
self.create_service(
GraphNavSetLocalization,
"graph_nav_set_localization",
self.handle_graph_nav_set_localization,
callback_group=self.group,
)
if self.has_arm and not self.gripperless:
self.create_service(
GetGripperCameraParameters,
"get_gripper_camera_parameters",
lambda request, response: self.service_wrapper(
"get_gripper_camera_parameters",
self.handle_get_gripper_camera_parameters,
request,
response,
),
callback_group=self.group,
)
self.create_service(
SetGripperCameraParameters,
"set_gripper_camera_parameters",
lambda request, response: self.service_wrapper(
"set_gripper_camera_parameters",
self.handle_set_gripper_camera_parameters,
request,
response,
),
callback_group=self.group,
)
self.create_service(
OverrideGraspOrCarry,
"override_grasp_or_carry",
lambda request, response: self.service_wrapper(
"override_grasp_or_carry",
self.handle_override_grasp_or_carry,
request,
response,
),
callback_group=self.group,
)
self.execute_dance_as = ActionServer(
self,
ExecuteDance,
"execute_dance",
self.handle_execute_dance,
)
self.navigate_as = ActionServer(
self,
NavigateTo,
"navigate_to",
self.handle_navigate_to,
)
# spot_ros.navigate_as.start() # As is online
self.trajectory_server = ActionServer(
self,