mirror of
https://github.com/SHC-ASTRA/rover-ros2.git
synced 2026-04-20 11:51:16 -05:00
Compare commits
6 Commits
docker
...
b388275bba
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b388275bba | ||
|
|
5c0194c543 | ||
|
|
809ca71208 | ||
|
|
225700bb86 | ||
|
|
4459886fc1 | ||
|
|
18fce2c19b |
@@ -1,4 +0,0 @@
|
|||||||
.git
|
|
||||||
*.log
|
|
||||||
build/
|
|
||||||
install/
|
|
||||||
1
.envrc
1
.envrc
@@ -1 +1,2 @@
|
|||||||
use flake
|
use flake
|
||||||
|
[[ -d install ]] && source install/setup.$(echo $0 | grep -oE '[^/]+$')
|
||||||
|
|||||||
12
README.md
12
README.md
@@ -11,7 +11,6 @@ You will use these packages to launch all rover-side ROS2 nodes.
|
|||||||
- [Software Prerequisites](#software-prerequisites)
|
- [Software Prerequisites](#software-prerequisites)
|
||||||
- [Nix](#nix)
|
- [Nix](#nix)
|
||||||
- [ROS2 Humble + rosdep](#ros2-humble--rosdep)
|
- [ROS2 Humble + rosdep](#ros2-humble--rosdep)
|
||||||
- [Docker](#docker)
|
|
||||||
- [Running](#running)
|
- [Running](#running)
|
||||||
- [Testing Serial](#testing-serial)
|
- [Testing Serial](#testing-serial)
|
||||||
- [Connecting the GuliKit Controller](#connecting-the-gulikit-controller)
|
- [Connecting the GuliKit Controller](#connecting-the-gulikit-controller)
|
||||||
@@ -48,17 +47,6 @@ $ cd path/to/rover-ros2
|
|||||||
$ rosdep install --from-paths src -y --ignore-src
|
$ rosdep install --from-paths src -y --ignore-src
|
||||||
```
|
```
|
||||||
|
|
||||||
### Docker
|
|
||||||
|
|
||||||
Using the docker compose file automatically builds the workspace and allows you to choose between running on the CPU or GPU for applications like Rviz2 and Gazebo:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run on CPU
|
|
||||||
$ docker compose run --rm --name rover-ros2-container cpu
|
|
||||||
# Run on GPU (NVidia only)
|
|
||||||
$ docker compose run --rm --name rover-ros2-container gpu
|
|
||||||
```
|
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -1,38 +0,0 @@
|
|||||||
services:
|
|
||||||
cpu:
|
|
||||||
image: moveit/moveit2:${DOCKER_IMAGE}
|
|
||||||
container_name: moveit2_container
|
|
||||||
privileged: true
|
|
||||||
network_mode: host
|
|
||||||
command: ["bash", "-c", "colcon build --symlink-install && source /ros2_ws/install/setup.bash && exec bash"]
|
|
||||||
volumes:
|
|
||||||
- ./:/ros2_ws
|
|
||||||
- /tmp/.X11-unix:/tmp/.X11-unix
|
|
||||||
- $XAUTHORITY:/root/.Xauthority
|
|
||||||
working_dir: /ros2_ws
|
|
||||||
environment:
|
|
||||||
QT_X11_NO_MITSHM: 1
|
|
||||||
DISPLAY: $DISPLAY
|
|
||||||
gpu:
|
|
||||||
image: moveit/moveit2:${DOCKER_IMAGE}
|
|
||||||
container_name: moveit2_container
|
|
||||||
privileged: true
|
|
||||||
network_mode: host
|
|
||||||
command: ["bash", "-c", "colcon build --symlink-install && source /ros2_ws/install/setup.bash && exec bash"]
|
|
||||||
deploy:
|
|
||||||
resources:
|
|
||||||
reservations:
|
|
||||||
devices:
|
|
||||||
- driver: nvidia
|
|
||||||
count: 1
|
|
||||||
capabilities: [gpu]
|
|
||||||
volumes:
|
|
||||||
- ./:/ros2_ws
|
|
||||||
- /tmp/.X11-unix:/tmp/.X11-unix
|
|
||||||
- $XAUTHORITY:/root/.Xauthority
|
|
||||||
working_dir: /ros2_ws
|
|
||||||
environment:
|
|
||||||
QT_X11_NO_MITSHM: 1
|
|
||||||
DISPLAY: $DISPLAY
|
|
||||||
NVIDIA_VISIBLE_DEVICES: all
|
|
||||||
NVIDIA_DRIVER_CAPABILITIES: all
|
|
||||||
@@ -28,6 +28,7 @@
|
|||||||
(python313.withPackages (
|
(python313.withPackages (
|
||||||
p: with p; [
|
p: with p; [
|
||||||
pyserial
|
pyserial
|
||||||
|
python-can
|
||||||
pygame
|
pygame
|
||||||
scipy
|
scipy
|
||||||
crccheck
|
crccheck
|
||||||
|
|||||||
@@ -1,29 +1,26 @@
|
|||||||
import rclpy
|
import rclpy
|
||||||
from rclpy.node import Node
|
from rclpy.node import Node
|
||||||
from rclpy.executors import ExternalShutdownException
|
from rclpy.executors import ExternalShutdownException
|
||||||
from std_srvs.srv import Empty
|
from rcl_interfaces.msg import ParameterDescriptor, ParameterType
|
||||||
|
|
||||||
import signal
|
import signal
|
||||||
import time
|
|
||||||
import atexit
|
import atexit
|
||||||
|
|
||||||
import serial
|
from .connector import (
|
||||||
import serial.tools.list_ports
|
Connector,
|
||||||
import os
|
MockConnector,
|
||||||
|
SerialConnector,
|
||||||
|
CANConnector,
|
||||||
|
NoValidDeviceException,
|
||||||
|
NoWorkingDeviceException,
|
||||||
|
)
|
||||||
|
from .convert import string_to_viccan
|
||||||
import sys
|
import sys
|
||||||
import threading
|
import threading
|
||||||
import glob
|
|
||||||
|
|
||||||
from std_msgs.msg import String, Header
|
from std_msgs.msg import String, Header
|
||||||
from astra_msgs.msg import VicCAN
|
from astra_msgs.msg import VicCAN
|
||||||
|
|
||||||
KNOWN_USBS = [
|
|
||||||
(0x2E8A, 0x00C0), # Raspberry Pi Pico
|
|
||||||
(0x1A86, 0x55D4), # Adafruit Feather ESP32 V2
|
|
||||||
(0x10C4, 0xEA60), # DOIT ESP32 Devkit V1
|
|
||||||
(0x1A86, 0x55D3), # ESP32 S3 Development Board
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
class Anchor(Node):
|
class Anchor(Node):
|
||||||
"""
|
"""
|
||||||
@@ -42,132 +39,61 @@ class Anchor(Node):
|
|||||||
- For testing without an actual MCU, publish strings here as if they came from an MCU
|
- For testing without an actual MCU, publish strings here as if they came from an MCU
|
||||||
* /anchor/to_vic/relay
|
* /anchor/to_vic/relay
|
||||||
- Core, Arm, and Bio publish VicCAN messages to this topic to send to the MCU
|
- Core, Arm, and Bio publish VicCAN messages to this topic to send to the MCU
|
||||||
* /anchor/to_vic/relay_string
|
|
||||||
- Publish raw strings to this topic to send directly to the MCU for debugging
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
connector: Connector
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
# Initalize node with name
|
super().__init__("anchor_node")
|
||||||
super().__init__("anchor_node") # previously 'serial_publisher'
|
|
||||||
|
|
||||||
self.serial_port: str | None = None # e.g., "/dev/ttyUSB0"
|
logger = self.get_logger()
|
||||||
|
|
||||||
# Serial port override
|
self.declare_parameter(
|
||||||
if port_override := os.getenv("PORT_OVERRIDE"):
|
"connector",
|
||||||
self.serial_port = port_override
|
"auto",
|
||||||
|
ParameterDescriptor(
|
||||||
##################################################
|
name="connector",
|
||||||
# Serial MCU Discovery
|
description="Declares which MCU connector should be used. Defaults to 'auto'.",
|
||||||
|
type=ParameterType.PARAMETER_STRING,
|
||||||
# If there was not a port override, look for a MCU over USB for Serial.
|
additional_constraints="Must be 'serial', 'can', 'mock', or 'auto'.",
|
||||||
if self.serial_port is None:
|
),
|
||||||
comports = serial.tools.list_ports.comports()
|
|
||||||
real_ports = list(
|
|
||||||
filter(
|
|
||||||
lambda p: p.vid is not None
|
|
||||||
and p.pid is not None
|
|
||||||
and p.device is not None,
|
|
||||||
comports,
|
|
||||||
)
|
)
|
||||||
)
|
|
||||||
recog_ports = list(filter(lambda p: (p.vid, p.pid) in KNOWN_USBS, comports))
|
|
||||||
|
|
||||||
if len(recog_ports) == 1: # Found singular recognized MCU
|
# Determine which connector to use. Options are Mock, Serial, and CAN
|
||||||
found_port = recog_ports[0]
|
connector_select = (
|
||||||
self.get_logger().info(
|
self.get_parameter("connector").get_parameter_value().string_value
|
||||||
f"Selecting MCU '{found_port.description}' at {found_port.device}."
|
|
||||||
)
|
)
|
||||||
self.serial_port = found_port.device # String, location of device file; e.g., '/dev/ttyACM0'
|
|
||||||
elif len(recog_ports) > 1: # Found multiple recognized MCUs
|
|
||||||
# Kinda jank log message
|
|
||||||
self.get_logger().error(
|
|
||||||
f"Found multiple recognized MCUs: {[p.device for p in recog_ports].__str__()}"
|
|
||||||
)
|
|
||||||
# Don't set self.serial_port; later if-statement will exit()
|
|
||||||
elif (
|
|
||||||
len(recog_ports) == 0 and len(real_ports) > 0
|
|
||||||
): # Found real ports but none recognized; i.e. maybe found an IMU or camera but not a MCU
|
|
||||||
self.get_logger().error(
|
|
||||||
f"No recognized MCUs found; instead found {[p.device for p in real_ports].__str__()}."
|
|
||||||
)
|
|
||||||
# Don't set self.serial_port; later if-statement will exit()
|
|
||||||
else: # Found jack shit
|
|
||||||
self.get_logger().error("No valid Serial ports specified or found.")
|
|
||||||
# Don't set self.serial_port; later if-statement will exit()
|
|
||||||
|
|
||||||
# We still don't have a serial port; fall back to legacy discovery (Areeb's code)
|
match connector_select:
|
||||||
# Loop through all serial devices on the computer to check for the MCU
|
case "serial":
|
||||||
if self.serial_port is None:
|
logger.info("using serial connector")
|
||||||
self.get_logger().warning("Falling back to legacy MCU discovery...")
|
self.connector = SerialConnector(self.get_logger())
|
||||||
ports = Anchor.list_serial_ports()
|
case "can":
|
||||||
for _ in range(4):
|
logger.info("using CAN connector")
|
||||||
if self.serial_port is not None:
|
self.connector = CANConnector(self.get_logger())
|
||||||
break
|
case "mock":
|
||||||
for port in ports:
|
logger.info("using mock connector")
|
||||||
|
self.connector = MockConnector(self.get_logger())
|
||||||
|
case "auto":
|
||||||
|
logger.info("automatically determining connector")
|
||||||
try:
|
try:
|
||||||
# connect and send a ping command
|
logger.info("trying CAN connector")
|
||||||
ser = serial.Serial(port, 115200, timeout=1)
|
self.connector = CANConnector(self.get_logger())
|
||||||
# (f"Checking port {port}...")
|
except (NoValidDeviceException, NoWorkingDeviceException, TypeError):
|
||||||
ser.write(b"ping\n")
|
logger.info("CAN connector failed, trying serial connector")
|
||||||
response = ser.read_until(bytes("\n", "utf8"))
|
self.connector = SerialConnector(self.get_logger())
|
||||||
|
case _:
|
||||||
# if pong is in response, then we are talking with the MCU
|
self.get_logger().fatal(
|
||||||
if b"pong" in response:
|
f"invalid value for connector parameter: {connector_select}"
|
||||||
self.serial_port = port
|
|
||||||
self.get_logger().info(f"Found MCU at {self.serial_port}!")
|
|
||||||
break
|
|
||||||
except:
|
|
||||||
pass
|
|
||||||
|
|
||||||
# If port is still None then we ain't finding no mcu
|
|
||||||
if self.serial_port is None:
|
|
||||||
self.get_logger().error("Unable to find MCU. Exiting...")
|
|
||||||
time.sleep(1)
|
|
||||||
sys.exit(1)
|
|
||||||
# Found a Serial port, try to open it; above code has not officially opened a Serial port
|
|
||||||
else:
|
|
||||||
self.get_logger().debug(
|
|
||||||
f"Attempting to open Serial port '{self.serial_port}'..."
|
|
||||||
)
|
|
||||||
try:
|
|
||||||
self.serial_interface = serial.Serial(
|
|
||||||
self.serial_port, 115200, timeout=1
|
|
||||||
)
|
)
|
||||||
|
exit(1)
|
||||||
|
|
||||||
# Attempt to get name of connected MCU
|
# Close devices on exit
|
||||||
self.serial_interface.write(
|
|
||||||
b"can_relay_mode,on\n"
|
|
||||||
) # can_relay_ready,[mcu]
|
|
||||||
mcu_name: str = ""
|
|
||||||
for _ in range(4):
|
|
||||||
response = self.serial_interface.read_until(bytes("\n", "utf8"))
|
|
||||||
try:
|
|
||||||
if b"can_relay_ready" in response:
|
|
||||||
args: list[str] = response.decode("utf8").strip().split(",")
|
|
||||||
if len(args) == 2:
|
|
||||||
mcu_name = args[1]
|
|
||||||
break
|
|
||||||
except UnicodeDecodeError:
|
|
||||||
pass # ignore malformed responses
|
|
||||||
self.get_logger().info(
|
|
||||||
f"MCU '{mcu_name}' is ready at '{self.serial_port}'."
|
|
||||||
)
|
|
||||||
|
|
||||||
except serial.SerialException as e:
|
|
||||||
self.get_logger().error(
|
|
||||||
f"Could not open Serial port '{self.serial_port}' for reason:"
|
|
||||||
)
|
|
||||||
self.get_logger().error(e.strerror)
|
|
||||||
time.sleep(1)
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
# Close serial port on exit
|
|
||||||
atexit.register(self.cleanup)
|
atexit.register(self.cleanup)
|
||||||
|
|
||||||
##################################################
|
|
||||||
# ROS2 Topic Setup
|
# ROS2 Topic Setup
|
||||||
|
|
||||||
# New pub/sub with VicCAN
|
# Publishers
|
||||||
self.fromvic_debug_pub_ = self.create_publisher(
|
self.fromvic_debug_pub_ = self.create_publisher(
|
||||||
String, "/anchor/from_vic/debug", 20
|
String, "/anchor/from_vic/debug", 20
|
||||||
)
|
)
|
||||||
@@ -181,163 +107,45 @@ class Anchor(Node):
|
|||||||
VicCAN, "/anchor/from_vic/bio", 20
|
VicCAN, "/anchor/from_vic/bio", 20
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Subscribers
|
||||||
|
self.tovic_sub_ = self.create_subscription(
|
||||||
|
VicCAN, "/anchor/to_vic/relay", self.connector.write, 20
|
||||||
|
)
|
||||||
self.mock_mcu_sub_ = self.create_subscription(
|
self.mock_mcu_sub_ = self.create_subscription(
|
||||||
String, "/anchor/from_vic/mock_mcu", self.on_mock_fromvic, 20
|
String, "/anchor/from_vic/mock_mcu", self.on_mock_fromvic, 20
|
||||||
)
|
)
|
||||||
self.tovic_sub_ = self.create_subscription(
|
|
||||||
VicCAN, "/anchor/to_vic/relay", self.on_relay_tovic_viccan, 20
|
|
||||||
)
|
|
||||||
self.tovic_debug_sub_ = self.create_subscription(
|
|
||||||
String, "/anchor/to_vic/relay_string", self.on_relay_tovic_string, 20
|
|
||||||
)
|
|
||||||
|
|
||||||
# Create publishers
|
def cleanup(self):
|
||||||
self.arm_pub = self.create_publisher(String, "/anchor/arm/feedback", 10)
|
self.connector.cleanup()
|
||||||
self.core_pub = self.create_publisher(String, "/anchor/core/feedback", 10)
|
|
||||||
self.bio_pub = self.create_publisher(String, "/anchor/bio/feedback", 10)
|
|
||||||
|
|
||||||
self.debug_pub = self.create_publisher(String, "/anchor/debug", 10)
|
|
||||||
|
|
||||||
# Create a subscriber
|
|
||||||
self.relay_sub = self.create_subscription(
|
|
||||||
String, "/anchor/relay", self.on_relay_tovic_string, 10
|
|
||||||
)
|
|
||||||
|
|
||||||
def read_MCU(self):
|
def read_MCU(self):
|
||||||
"""Check the USB serial port for new data from the MCU, and publish string to appropriate topics"""
|
"""Check the USB serial port for new data from the MCU, and publish string to appropriate topics"""
|
||||||
try:
|
output = self.connector.read()
|
||||||
output = str(self.serial_interface.readline(), "utf8")
|
|
||||||
|
|
||||||
if output:
|
if not output:
|
||||||
self.relay_fromvic(output)
|
|
||||||
# All output over debug temporarily
|
|
||||||
# self.get_logger().info(f"[MCU] {output}")
|
|
||||||
msg = String()
|
|
||||||
msg.data = output
|
|
||||||
self.debug_pub.publish(msg)
|
|
||||||
if output.startswith("can_relay_fromvic,core"):
|
|
||||||
self.core_pub.publish(msg)
|
|
||||||
elif output.startswith("can_relay_fromvic,arm") or output.startswith(
|
|
||||||
"can_relay_fromvic,digit"
|
|
||||||
): # digit for voltage readings
|
|
||||||
self.arm_pub.publish(msg)
|
|
||||||
if output.startswith("can_relay_fromvic,citadel") or output.startswith(
|
|
||||||
"can_relay_fromvic,digit"
|
|
||||||
): # digit for SHT sensor
|
|
||||||
self.bio_pub.publish(msg)
|
|
||||||
# msg = String()
|
|
||||||
# msg.data = output
|
|
||||||
# self.debug_pub.publish(msg)
|
|
||||||
return
|
return
|
||||||
except serial.SerialException as e:
|
|
||||||
print(f"SerialException: {e}")
|
self.relay_fromvic(output)
|
||||||
print("Closing serial port.")
|
|
||||||
try:
|
def relay_fromvic(self, msg: VicCAN):
|
||||||
if self.serial_interface.is_open:
|
"""Relay a string message from the MCU to the appropriate VicCAN topic"""
|
||||||
self.serial_interface.close()
|
msg.header = Header(stamp=self.get_clock().now().to_msg(), frame_id="from_vic")
|
||||||
except:
|
|
||||||
pass
|
if msg.mcu_name == "core":
|
||||||
exit(1)
|
self.fromvic_core_pub_.publish(msg)
|
||||||
except TypeError as e:
|
elif msg.mcu_name == "arm" or msg.mcu_name == "digit":
|
||||||
print(f"TypeError: {e}")
|
self.fromvic_arm_pub_.publish(msg)
|
||||||
print("Closing serial port.")
|
elif msg.mcu_name == "citadel" or msg.mcu_name == "digit":
|
||||||
try:
|
self.fromvic_bio_pub_.publish(msg)
|
||||||
if self.serial_interface.is_open:
|
|
||||||
self.serial_interface.close()
|
|
||||||
except:
|
|
||||||
pass
|
|
||||||
exit(1)
|
|
||||||
except Exception as e:
|
|
||||||
print(f"Exception: {e}")
|
|
||||||
# print("Closing serial port.")
|
|
||||||
# if self.ser.is_open:
|
|
||||||
# self.ser.close()
|
|
||||||
# exit(1)
|
|
||||||
|
|
||||||
def on_mock_fromvic(self, msg: String):
|
def on_mock_fromvic(self, msg: String):
|
||||||
"""For testing without an actual MCU, publish strings here as if they came from an MCU"""
|
viccan = string_to_viccan(
|
||||||
# self.get_logger().info(f"Got command from mock MCU: {msg}")
|
msg.data,
|
||||||
self.relay_fromvic(msg.data)
|
"mock",
|
||||||
|
self.get_logger(),
|
||||||
def on_relay_tovic_viccan(self, msg: VicCAN):
|
|
||||||
"""Relay a VicCAN message to the MCU"""
|
|
||||||
output: str = f"can_relay_tovic,{msg.mcu_name},{msg.command_id}"
|
|
||||||
for num in msg.data:
|
|
||||||
output += f",{round(num, 7)}" # limit to 7 decimal places
|
|
||||||
output += "\n"
|
|
||||||
# self.get_logger().info(f"VicCAN relay to MCU: {output}")
|
|
||||||
self.serial_interface.write(bytes(output, "utf8"))
|
|
||||||
|
|
||||||
def relay_fromvic(self, msg: str):
|
|
||||||
"""Relay a string message from the MCU to the appropriate VicCAN topic"""
|
|
||||||
self.fromvic_debug_pub_.publish(String(data=msg))
|
|
||||||
parts = msg.strip().split(",")
|
|
||||||
if len(parts) > 0 and parts[0] != "can_relay_fromvic":
|
|
||||||
self.get_logger().debug(f"Ignoring non-VicCAN message: '{msg.strip()}'")
|
|
||||||
return
|
|
||||||
|
|
||||||
# String validation
|
|
||||||
malformed: bool = False
|
|
||||||
malformed_reason: str = ""
|
|
||||||
if len(parts) < 3 or len(parts) > 7:
|
|
||||||
malformed = True
|
|
||||||
malformed_reason = (
|
|
||||||
f"invalid argument count (expected [3,7], got {len(parts)})"
|
|
||||||
)
|
)
|
||||||
elif parts[1] not in ["core", "arm", "digit", "citadel", "broadcast"]:
|
if viccan:
|
||||||
malformed = True
|
self.relay_fromvic(viccan)
|
||||||
malformed_reason = f"invalid mcu_name '{parts[1]}'"
|
|
||||||
elif not (parts[2].isnumeric()) or int(parts[2]) < 0:
|
|
||||||
malformed = True
|
|
||||||
malformed_reason = f"command_id '{parts[2]}' is not a non-negative integer"
|
|
||||||
else:
|
|
||||||
for x in parts[3:]:
|
|
||||||
try:
|
|
||||||
float(x)
|
|
||||||
except ValueError:
|
|
||||||
malformed = True
|
|
||||||
malformed_reason = f"data '{x}' is not a float"
|
|
||||||
break
|
|
||||||
|
|
||||||
if malformed:
|
|
||||||
self.get_logger().warning(
|
|
||||||
f"Ignoring malformed from_vic message: '{msg.strip()}'; reason: {malformed_reason}"
|
|
||||||
)
|
|
||||||
return
|
|
||||||
|
|
||||||
# Have valid VicCAN message
|
|
||||||
|
|
||||||
output = VicCAN()
|
|
||||||
output.mcu_name = parts[1]
|
|
||||||
output.command_id = int(parts[2])
|
|
||||||
if len(parts) > 3:
|
|
||||||
output.data = [float(x) for x in parts[3:]]
|
|
||||||
output.header = Header(
|
|
||||||
stamp=self.get_clock().now().to_msg(), frame_id="from_vic"
|
|
||||||
)
|
|
||||||
|
|
||||||
# self.get_logger().info(f"Relaying from MCU: {output}")
|
|
||||||
if output.mcu_name == "core":
|
|
||||||
self.fromvic_core_pub_.publish(output)
|
|
||||||
elif output.mcu_name == "arm" or output.mcu_name == "digit":
|
|
||||||
self.fromvic_arm_pub_.publish(output)
|
|
||||||
elif output.mcu_name == "citadel" or output.mcu_name == "digit":
|
|
||||||
self.fromvic_bio_pub_.publish(output)
|
|
||||||
|
|
||||||
def on_relay_tovic_string(self, msg: String):
|
|
||||||
"""Relay a raw string message to the MCU for debugging"""
|
|
||||||
message = msg.data
|
|
||||||
# self.get_logger().info(f"Sending command to MCU: {msg}")
|
|
||||||
self.serial_interface.write(bytes(message, "utf8"))
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def list_serial_ports():
|
|
||||||
return glob.glob("/dev/ttyUSB*") + glob.glob("/dev/ttyACM*")
|
|
||||||
|
|
||||||
def cleanup(self):
|
|
||||||
print("Cleaning up before terminating...")
|
|
||||||
if self.serial_interface.is_open:
|
|
||||||
self.serial_interface.close()
|
|
||||||
|
|
||||||
|
|
||||||
def main(args=None):
|
def main(args=None):
|
||||||
|
|||||||
189
src/anchor_pkg/anchor_pkg/connector.py
Normal file
189
src/anchor_pkg/anchor_pkg/connector.py
Normal file
@@ -0,0 +1,189 @@
|
|||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from astra_msgs.msg import VicCAN
|
||||||
|
from rclpy.impl.rcutils_logger import RcutilsLogger
|
||||||
|
from .convert import string_to_viccan
|
||||||
|
|
||||||
|
# CAN
|
||||||
|
import can
|
||||||
|
import can.interfaces.socketcan
|
||||||
|
|
||||||
|
# Serial
|
||||||
|
import serial
|
||||||
|
import serial.tools.list_ports
|
||||||
|
|
||||||
|
KNOWN_USBS = [
|
||||||
|
(0x2E8A, 0x00C0), # Raspberry Pi Pico
|
||||||
|
(0x1A86, 0x55D4), # Adafruit Feather ESP32 V2
|
||||||
|
(0x10C4, 0xEA60), # DOIT ESP32 Devkit V1
|
||||||
|
(0x1A86, 0x55D3), # ESP32 S3 Development Board
|
||||||
|
]
|
||||||
|
BAUD_RATE = 115200
|
||||||
|
|
||||||
|
|
||||||
|
class NoValidDeviceException(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class NoWorkingDeviceException(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class MultipleValidDevicesException(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class DeviceClosedException(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class Connector(ABC):
|
||||||
|
logger: RcutilsLogger
|
||||||
|
|
||||||
|
def __init__(self, logger: RcutilsLogger):
|
||||||
|
self.logger = logger
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def read(self) -> VicCAN | None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def write(self, msg: VicCAN):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def cleanup(self):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class SerialConnector(Connector):
|
||||||
|
port: str
|
||||||
|
mcu_name: str
|
||||||
|
serial_interface: serial.Serial
|
||||||
|
override: bool
|
||||||
|
|
||||||
|
def __init__(self, logger: RcutilsLogger):
|
||||||
|
super().__init__(logger)
|
||||||
|
|
||||||
|
ports = self._find_ports()
|
||||||
|
|
||||||
|
if len(ports) <= 0:
|
||||||
|
raise NoValidDeviceException("no valid serial device found")
|
||||||
|
if (l := len(ports)) > 1:
|
||||||
|
raise MultipleValidDevicesException(
|
||||||
|
f"too many ({l}) valid serial devices found"
|
||||||
|
)
|
||||||
|
|
||||||
|
# check each of our ports to make sure one of them is responding
|
||||||
|
port = ports[0]
|
||||||
|
mcu_name = self._get_name(port)
|
||||||
|
if not mcu_name:
|
||||||
|
raise NoWorkingDeviceException(
|
||||||
|
f"found {port}, but it did not respond with its name"
|
||||||
|
)
|
||||||
|
|
||||||
|
self.port = port
|
||||||
|
self.mcu_name = mcu_name
|
||||||
|
|
||||||
|
# if we fail at this point, it should crash because we've already tested the port
|
||||||
|
self.serial_interface = serial.Serial(self.port, BAUD_RATE, timeout=1)
|
||||||
|
|
||||||
|
def _find_ports(self) -> list[str]:
|
||||||
|
"""
|
||||||
|
Finds all valid ports but does not test them
|
||||||
|
|
||||||
|
returns: all valid ports
|
||||||
|
"""
|
||||||
|
comports = serial.tools.list_ports.comports()
|
||||||
|
valid_ports = list(
|
||||||
|
map( # get just device strings
|
||||||
|
lambda p: p.device,
|
||||||
|
filter( # make sure we have a known device
|
||||||
|
lambda p: (p.vid, p.pid) in KNOWN_USBS and p.device is not None,
|
||||||
|
comports,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
self.logger.info(f"found valid MCU ports: [ {', '.join(valid_ports)} ]")
|
||||||
|
return valid_ports
|
||||||
|
|
||||||
|
def _get_name(self, port: str) -> str | None:
|
||||||
|
"""
|
||||||
|
Get the name of the MCU (if it works)
|
||||||
|
|
||||||
|
returns: str name of the MCU, None if it doesn't work
|
||||||
|
"""
|
||||||
|
# attempt to open the serial port
|
||||||
|
serial_interface: serial.Serial
|
||||||
|
try:
|
||||||
|
self.logger.info(f"asking {port} for its name")
|
||||||
|
serial_interface = serial.Serial(port, BAUD_RATE, timeout=1)
|
||||||
|
|
||||||
|
serial_interface.write(b"can_relay_mode,on\n")
|
||||||
|
|
||||||
|
for i in range(4):
|
||||||
|
self.logger.debug(f"attempt {i + 1} of 4 asking {port} for its name")
|
||||||
|
response = serial_interface.read_until(bytes("\n", "utf8"))
|
||||||
|
try:
|
||||||
|
if b"can_relay_ready" in response:
|
||||||
|
args: list[str] = response.decode("utf8").strip().split(",")
|
||||||
|
if len(args) == 2:
|
||||||
|
self.logger.info(f"we are talking to {args[1]}")
|
||||||
|
return args[1]
|
||||||
|
break
|
||||||
|
except UnicodeDecodeError as e:
|
||||||
|
self.logger.info(
|
||||||
|
f"ignoring UnicodeDecodeError when asking for MCU name: {e}"
|
||||||
|
)
|
||||||
|
|
||||||
|
if serial_interface.is_open:
|
||||||
|
serial_interface.close()
|
||||||
|
except serial.SerialException as e:
|
||||||
|
self.logger.error(f"SerialException when asking for MCU name: {e}")
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
def read(self) -> VicCAN | None:
|
||||||
|
try:
|
||||||
|
raw = str(self.serial_interface.readline(), "utf8")
|
||||||
|
|
||||||
|
if not raw:
|
||||||
|
return None
|
||||||
|
|
||||||
|
return string_to_viccan(raw, self.mcu_name, self.logger)
|
||||||
|
except serial.SerialException as e:
|
||||||
|
self.logger.error(f"SerialException: {e}")
|
||||||
|
raise DeviceClosedException(f"serial port {self.port} closed unexpectedly")
|
||||||
|
except TypeError as e:
|
||||||
|
self.logger.error(f"TypeError: {e}")
|
||||||
|
raise DeviceClosedException(f"serial port {self.port} closed unexpectedly")
|
||||||
|
except Exception:
|
||||||
|
pass # pretty much no other error matters
|
||||||
|
|
||||||
|
def write(self, msg: VicCAN):
|
||||||
|
# go from [ w, x, y, z ] -> "w,x,y,z" & round to 7 digits max
|
||||||
|
data = ",".join([str(round(x, 7)) for x in msg.data])
|
||||||
|
output = f"can_relay_tovic,{msg.mcu_name},{msg.command_id},{data}\n"
|
||||||
|
self.serial_interface.write(bytes(output, "utf8"))
|
||||||
|
|
||||||
|
def cleanup(self):
|
||||||
|
self.logger.info(f"closing serial port if open {self.port}")
|
||||||
|
try:
|
||||||
|
if self.serial_interface.is_open:
|
||||||
|
self.serial_interface.close()
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(e)
|
||||||
|
|
||||||
|
|
||||||
|
class CANConnector(Connector):
|
||||||
|
def __init__(self, logger: RcutilsLogger):
|
||||||
|
super().__init__(logger)
|
||||||
|
|
||||||
|
|
||||||
|
class MockConnector(Connector):
|
||||||
|
def __init__(self, logger: RcutilsLogger):
|
||||||
|
super().__init__(logger)
|
||||||
|
|
||||||
|
def read(self) -> VicCAN | None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
def write(self, msg: VicCAN):
|
||||||
|
print(msg)
|
||||||
42
src/anchor_pkg/anchor_pkg/convert.py
Normal file
42
src/anchor_pkg/anchor_pkg/convert.py
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
from astra_msgs.msg import VicCAN
|
||||||
|
from rclpy.impl.rcutils_logger import RcutilsLogger
|
||||||
|
|
||||||
|
def string_to_viccan(msg: str, mcu_name: str, logger: RcutilsLogger):
|
||||||
|
"""
|
||||||
|
Converts the serial string VicCAN format to a ROS2 VicCAN message.
|
||||||
|
Does not fill out the Header of the message.
|
||||||
|
On a failure, it will log at a debug level why it failed.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
* msg: str
|
||||||
|
- The message in serial VicCAN format
|
||||||
|
* mcu_name: str
|
||||||
|
- The name of the MCU (e.g. core, citadel, arm)
|
||||||
|
* logger: RcutilsLogger
|
||||||
|
- A logger retrieved from node.get_logger()
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
* VicCAN | None
|
||||||
|
- The VicCAN message on a success or None on a failure
|
||||||
|
"""
|
||||||
|
|
||||||
|
parts: list[str] = msg.split(",")
|
||||||
|
|
||||||
|
# don't need an extra check because len of .split output is always >= 1
|
||||||
|
if parts[0] != "can_relay_fromvic":
|
||||||
|
logger.debug(f"got non-CAN data from {mcu_name}: {msg}")
|
||||||
|
return None
|
||||||
|
elif len(parts) < 3:
|
||||||
|
logger.debug(
|
||||||
|
f"got garbage (not enough parts) CAN data from {mcu_name}: {msg}"
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
elif len(parts) > 7:
|
||||||
|
logger.debug(f"got garbage (too many parts) CAN data from {mcu_name}: {msg}")
|
||||||
|
return None
|
||||||
|
|
||||||
|
return VicCAN(
|
||||||
|
mcu_name=parts[1],
|
||||||
|
command_id=int(parts[2]),
|
||||||
|
data=[float(x) for x in parts[3:]],
|
||||||
|
)
|
||||||
@@ -3,13 +3,14 @@
|
|||||||
<package format="3">
|
<package format="3">
|
||||||
<name>anchor_pkg</name>
|
<name>anchor_pkg</name>
|
||||||
<version>0.0.0</version>
|
<version>0.0.0</version>
|
||||||
<description>TODO: Package description</description>
|
<description>Anchor -- ROS and CAN relay node</description>
|
||||||
<maintainer email="tristanmcginnis26@gmail.com">tristan</maintainer>
|
<maintainer email="rjm0037@uah.edu">Riley</maintainer>
|
||||||
<license>AGPL-3.0-only</license>
|
<license>AGPL-3.0-only</license>
|
||||||
|
|
||||||
<depend>rclpy</depend>
|
<depend>rclpy</depend>
|
||||||
<depend>common_interfaces</depend>
|
<depend>common_interfaces</depend>
|
||||||
<depend>python3-serial</depend>
|
<depend>python3-serial</depend>
|
||||||
|
<depend>python3-can</depend>
|
||||||
|
|
||||||
<build_depend>black</build_depend>
|
<build_depend>black</build_depend>
|
||||||
|
|
||||||
|
|||||||
@@ -43,12 +43,16 @@
|
|||||||
#include <control_msgs/msg/joint_jog.hpp>
|
#include <control_msgs/msg/joint_jog.hpp>
|
||||||
#include <std_srvs/srv/trigger.hpp>
|
#include <std_srvs/srv/trigger.hpp>
|
||||||
#include <moveit_msgs/msg/planning_scene.hpp>
|
#include <moveit_msgs/msg/planning_scene.hpp>
|
||||||
|
#include <rclcpp/client.hpp>
|
||||||
|
#include <rclcpp/experimental/buffers/intra_process_buffer.hpp>
|
||||||
#include <rclcpp/node.hpp>
|
#include <rclcpp/node.hpp>
|
||||||
#include <rclcpp/publisher.hpp>
|
#include <rclcpp/publisher.hpp>
|
||||||
#include <rclcpp/subscription.hpp>
|
|
||||||
#include <rclcpp/qos.hpp>
|
#include <rclcpp/qos.hpp>
|
||||||
|
#include <rclcpp/qos_event.hpp>
|
||||||
|
#include <rclcpp/subscription.hpp>
|
||||||
#include <rclcpp/time.hpp>
|
#include <rclcpp/time.hpp>
|
||||||
|
#include <rclcpp/utilities.hpp>
|
||||||
|
#include <thread>
|
||||||
|
|
||||||
// We'll just set up parameters here
|
// We'll just set up parameters here
|
||||||
const std::string JOY_TOPIC = "/joy";
|
const std::string JOY_TOPIC = "/joy";
|
||||||
@@ -100,9 +104,8 @@ std::map<Button, double> BUTTON_DEFAULTS;
|
|||||||
* @return return true if you want to publish a Twist, false if you want to publish a JointJog
|
* @return return true if you want to publish a Twist, false if you want to publish a JointJog
|
||||||
*/
|
*/
|
||||||
bool convertJoyToCmd(const std::vector<float>& axes, const std::vector<int>& buttons,
|
bool convertJoyToCmd(const std::vector<float>& axes, const std::vector<int>& buttons,
|
||||||
std::unique_ptr<geometry_msgs::msg::TwistStamped>& twist
|
std::unique_ptr<geometry_msgs::msg::TwistStamped>& twist,
|
||||||
// std::unique_ptr<control_msgs::msg::JointJog>& joint
|
std::unique_ptr<control_msgs::msg::JointJog>& joint)
|
||||||
)
|
|
||||||
{
|
{
|
||||||
// // Give joint jogging priority because it is only buttons
|
// // Give joint jogging priority because it is only buttons
|
||||||
// // If any joint jog command is requested, we are only publishing joint commands
|
// // If any joint jog command is requested, we are only publishing joint commands
|
||||||
@@ -233,7 +236,7 @@ public:
|
|||||||
updateCmdFrame(frame_to_publish_, msg->buttons);
|
updateCmdFrame(frame_to_publish_, msg->buttons);
|
||||||
|
|
||||||
// Convert the joystick message to Twist or JointJog and publish
|
// Convert the joystick message to Twist or JointJog and publish
|
||||||
if (convertJoyToCmd(msg->axes, msg->buttons, twist_msg))
|
if (convertJoyToCmd(msg->axes, msg->buttons, twist_msg, joint_msg))
|
||||||
{
|
{
|
||||||
// publish the TwistStamped
|
// publish the TwistStamped
|
||||||
twist_msg->header.frame_id = frame_to_publish_;
|
twist_msg->header.frame_id = frame_to_publish_;
|
||||||
|
|||||||
Reference in New Issue
Block a user