franka_rust 0.1.14

Rust bindings for the Franka Emika Panda robot
Documentation
use robot_behavior::{
    ControlType, CxxArmState, LoadState, MotionType, behavior::*, cxx_arm_behavior, cxx_arm_param,
    cxx_arm_preplanned_motion, cxx_arm_preplanned_motion_ext, cxx_arm_preplanned_motion_impl,
    cxx_arm_real_time_control, cxx_arm_real_time_control_ext, cxx_arm_streaming_handle,
    cxx_arm_streaming_motion, cxx_robot_behavior,
};

use crate::{FrankaGripper, model::FrankaModel};

struct FrankaEmika(crate::FrankaEmika);
struct FrankaFR3(crate::FrankaFR3);
struct FrankaHandle(crate::robot::FrankaHandle);

#[cxx::bridge]
mod franka_rust {
    pub struct CxxMotionType {
        pub mode: CxxMotionTypeMode,
        pub values: Vec<f64>,
    }
    pub enum CxxMotionTypeMode {
        Joint,
        JointVel,
        Cartesian,
        CartesianVel,
        Position,
        PositionVel,
        Stop,
    }
    pub struct CxxControlType {
        pub mode: CxxControlTypeMode,
        pub values: Vec<f64>,
    }
    pub enum CxxControlTypeMode {
        Zero,
        Torque,
    }
    pub struct CxxLoadState {
        pub m: f64,
        pub x: [f64; 3],
        pub i: [f64; 9],
    }
    extern "Rust" {
        type FrankaEmika;

        #[Self = "FrankaEmika"]
        fn attach(ip: &str) -> Box<FrankaEmika>;
        #[Self = "FrankaEmika"]
        fn create() -> Box<FrankaEmika>;
        fn connect(&mut self, ip: &str);

        #[Self = "FrankaEmika"]
        fn version() -> String;
        fn init(&mut self) -> Result<()>;
        fn shutdown(&mut self) -> Result<()>;
        fn enable(&mut self) -> Result<()>;
        fn disable(&mut self) -> Result<()>;
        fn reset(&mut self) -> Result<()>;
        fn is_moving(&mut self) -> bool;
        fn stop(&mut self) -> Result<()>;
        fn pause(&mut self) -> Result<()>;
        fn resume(&mut self) -> Result<()>;
        fn emergency_stop(&mut self) -> Result<()>;
        fn clear_emergency_stop(&mut self) -> Result<()>;

        // fn state(&mut self)
        fn set_load(&mut self, load: CxxLoadState) -> Result<()>;
        // fn set_coord
        // fn with_coord(&mut self)
        fn set_speed(&mut self, speed: f64) -> Result<()>;
        fn with_speed(&mut self, speed: f64) -> &mut FrankaEmika;
        unsafe fn with_velocity<'a>(&'a mut self, joint_vel: &[f64; 7]) -> &'a mut FrankaEmika;
        unsafe fn with_acceleration<'a>(&'a mut self, joint_acc: &[f64; 7]) -> &'a mut FrankaEmika;
        unsafe fn with_jerk<'a>(&'a mut self, joint_jerk: &[f64; 7]) -> &'a mut FrankaEmika;
        fn with_cartesian_velocity(&mut self, cartesian_vel: f64) -> &mut FrankaEmika;
        fn with_cartesian_acceleration(&mut self, cartesian_acc: f64) -> &mut FrankaEmika;
        fn with_cartesian_jerk(&mut self, cartesian_jerk: f64) -> &mut FrankaEmika;
        fn with_rotation_velocity(&mut self, rotation_vel: f64) -> &mut FrankaEmika;
        fn with_rotation_acceleration(&mut self, rotation_acc: f64) -> &mut FrankaEmika;
        fn with_rotation_jerk(&mut self, rotation_jerk: f64) -> &mut FrankaEmika;

        fn move_joint(&mut self, target: &[f64; 7]) -> Result<()>;
        fn move_joint_async(&mut self, target: &[f64; 7]) -> Result<()>;
        fn move_cartesian(&mut self, target: &[f64]) -> Result<()>;
        fn move_cartesian_async(&mut self, target: &[f64]) -> Result<()>;

        fn move_to(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_to_async(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_rel(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_rel_async(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_int(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_int_async(&mut self, target: CxxMotionType) -> Result<()>;
        // fn move_path(&mut self, path: Vec<CxxMotionType>) -> Result<()>;
        // fn move_path_async(&mut self, path: Vec<CxxMotionType>) -> Result<()>;
        // fn move_path_prepare(&mut self, path: Vec<CxxMotionType>) -> Result<()>;
        fn move_path_start(&mut self, start: CxxMotionType) -> Result<()>;

        fn move_joint_rel(&mut self, target: &[f64; 7]) -> Result<()>;
        fn move_joint_rel_async(&mut self, target: &[f64; 7]) -> Result<()>;
        // fn move_joint_path(&mut self, path: Vec<[f64; 6]>) -> Result<()>;
        // fn move_cartesian_rel(&mut self, target: &Pose) -> Result<()>;
        // fn move_cartesian_rel_async(&mut self, target: &Pose) -> Result<()>;
        // fn move_cartesian_int(&mut self, target: &Pose) -> Result<()>;
        // fn move_cartesian_int_async(&mut self, target: &Pose) -> Result<()>;
        // fn move_cartesian_path(&mut self, path: Vec<Pose>) -> Result<()>;/
        fn move_linear_with_euler(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_async(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_rel(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_rel_async(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_int(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_int_async(&mut self, pose: [f64; 6]) -> Result<()>;
        // fn move_linear_with_quat(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_async(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_rel(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_rel_async(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_int(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_int_async(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        fn move_linear_with_homo(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_async(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_rel(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_rel_async(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_int(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_int_async(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_path_prepare_from_file(&mut self, path: &str) -> Result<()>;
        fn move_path_from_file(&mut self, path: &str) -> Result<()>;

        fn start_streaming(&mut self) -> Result<Box<FrankaHandle>>;
        fn end_streaming(&mut self) -> Result<()>;
        // fn move_to_target(&mut self) -> Arc<Mutex<Option<CxxMotionType>>>;
        // fn control_with_target(&mut self) -> Arc<Mutex<Option<ControlType<6>>>>;
    }
    extern "Rust" {
        type FrankaFR3;

        #[Self = "FrankaFR3"]
        fn attach(ip: &str) -> Box<FrankaFR3>;
        #[Self = "FrankaFR3"]
        fn create() -> Box<FrankaFR3>;
        fn connect(&mut self, ip: &str);

        #[Self = "FrankaFR3"]
        fn version() -> String;
        fn init(&mut self) -> Result<()>;
        fn shutdown(&mut self) -> Result<()>;
        fn enable(&mut self) -> Result<()>;
        fn disable(&mut self) -> Result<()>;
        fn reset(&mut self) -> Result<()>;
        fn is_moving(&mut self) -> bool;
        fn stop(&mut self) -> Result<()>;
        fn pause(&mut self) -> Result<()>;
        fn resume(&mut self) -> Result<()>;
        fn emergency_stop(&mut self) -> Result<()>;
        fn clear_emergency_stop(&mut self) -> Result<()>;

        // fn state(&mut self)
        fn set_load(&mut self, load: CxxLoadState) -> Result<()>;
        // fn set_coord
        // fn with_coord(&mut self)
        fn set_speed(&mut self, speed: f64) -> Result<()>;
        fn with_speed(&mut self, speed: f64) -> &mut FrankaFR3;
        unsafe fn with_velocity<'a>(&'a mut self, joint_vel: &[f64; 7]) -> &'a mut FrankaFR3;
        unsafe fn with_acceleration<'a>(&'a mut self, joint_acc: &[f64; 7]) -> &'a mut FrankaFR3;
        unsafe fn with_jerk<'a>(&'a mut self, joint_jerk: &[f64; 7]) -> &'a mut FrankaFR3;
        fn with_cartesian_velocity(&mut self, cartesian_vel: f64) -> &mut FrankaFR3;
        fn with_cartesian_acceleration(&mut self, cartesian_acc: f64) -> &mut FrankaFR3;
        fn with_cartesian_jerk(&mut self, cartesian_jerk: f64) -> &mut FrankaFR3;
        fn with_rotation_velocity(&mut self, rotation_vel: f64) -> &mut FrankaFR3;
        fn with_rotation_acceleration(&mut self, rotation_acc: f64) -> &mut FrankaFR3;
        fn with_rotation_jerk(&mut self, rotation_jerk: f64) -> &mut FrankaFR3;

        fn move_joint(&mut self, target: &[f64; 7]) -> Result<()>;
        fn move_joint_async(&mut self, target: &[f64; 7]) -> Result<()>;
        fn move_cartesian(&mut self, target: &[f64]) -> Result<()>;
        fn move_cartesian_async(&mut self, target: &[f64]) -> Result<()>;

        fn move_to(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_to_async(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_rel(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_rel_async(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_int(&mut self, target: CxxMotionType) -> Result<()>;
        fn move_int_async(&mut self, target: CxxMotionType) -> Result<()>;
        // fn move_path(&mut self, path: Vec<CxxMotionType>) -> Result<()>;
        // fn move_path_async(&mut self, path: Vec<CxxMotionType>) -> Result<()>;
        // fn move_path_prepare(&mut self, path: Vec<CxxMotionType>) -> Result<()>;
        fn move_path_start(&mut self, start: CxxMotionType) -> Result<()>;

        fn move_joint_rel(&mut self, target: &[f64; 7]) -> Result<()>;
        fn move_joint_rel_async(&mut self, target: &[f64; 7]) -> Result<()>;
        // fn move_joint_path(&mut self, path: Vec<[f64; 6]>) -> Result<()>;
        // fn move_cartesian_rel(&mut self, target: &Pose) -> Result<()>;
        // fn move_cartesian_rel_async(&mut self, target: &Pose) -> Result<()>;
        // fn move_cartesian_int(&mut self, target: &Pose) -> Result<()>;
        // fn move_cartesian_int_async(&mut self, target: &Pose) -> Result<()>;
        // fn move_cartesian_path(&mut self, path: Vec<Pose>) -> Result<()>;/
        fn move_linear_with_euler(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_async(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_rel(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_rel_async(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_int(&mut self, pose: [f64; 6]) -> Result<()>;
        fn move_linear_with_euler_int_async(&mut self, pose: [f64; 6]) -> Result<()>;
        // fn move_linear_with_quat(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_async(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_rel(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_rel_async(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_int(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        // fn move_linear_with_quat_int_async(&mut self, target: &na::Isometry3<f64>) -> Result<()>;
        fn move_linear_with_homo(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_async(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_rel(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_rel_async(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_int(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_linear_with_homo_int_async(&mut self, target: [f64; 16]) -> Result<()>;
        fn move_path_prepare_from_file(&mut self, path: &str) -> Result<()>;
        fn move_path_from_file(&mut self, path: &str) -> Result<()>;

        fn start_streaming(&mut self) -> Result<Box<FrankaHandle>>;
        fn end_streaming(&mut self) -> Result<()>;
        // fn move_to_target(&mut self) -> Arc<Mutex<Option<CxxMotionType>>>;
        // fn control_with_target(&mut self) -> Arc<Mutex<Option<ControlType<6>>>>;
    }

    extern "Rust" {
        type FrankaHandle;

        fn last_motion(&self) -> CxxMotionType;
        fn move_to(&mut self, target: CxxMotionType) -> Result<()>;
        fn last_control(&self) -> CxxControlType;
        fn control_with(&mut self, control: CxxControlType) -> Result<()>;
    }
    extern "Rust" {
        type FrankaGripper;
        pub fn homing(&mut self) -> Result<bool>;
        pub fn grasp(&mut self, width: f64, speed: f64, force: f64) -> Result<bool>;
        pub fn move_gripper(&mut self, width: f64, speed: f64) -> Result<bool>;
        pub fn stop(&mut self) -> Result<bool>;
        // pub fn read_state(&mut self) -> Result<GripperState>;
    }
    extern "Rust" {
        type FrankaModel;
    }
}

pub use franka_rust::*;

impl FrankaEmika {
    pub fn attach(ip: &str) -> Box<Self> {
        Box::new(FrankaEmika(crate::FrankaEmika::new(ip)))
    }
    pub fn create() -> Box<Self> {
        Box::new(FrankaEmika(crate::FrankaEmika::default()))
    }
    pub fn connect(&mut self, ip: &str) {
        self.0.connect(ip);
    }
}

impl FrankaEmika {
    cxx_robot_behavior!(FrankaEmika(crate::FrankaEmika));
    cxx_arm_behavior!(FrankaEmika<{7}>(crate::FrankaEmika));
    cxx_arm_param!(FrankaEmika<{7}>(crate::FrankaEmika));
    cxx_arm_preplanned_motion_impl!(FrankaEmika<{7}>(crate::FrankaEmika));
    cxx_arm_preplanned_motion!(FrankaEmika<{7}>(crate::FrankaEmika));
    cxx_arm_preplanned_motion_ext!(FrankaEmika<{7}>(crate::FrankaEmika));
    cxx_arm_streaming_motion!(FrankaEmika<{7}>(crate::FrankaEmika) -> FrankaHandle);
    cxx_arm_real_time_control!(FrankaEmika<{7}>(crate::FrankaEmika));
    cxx_arm_real_time_control_ext!(FrankaEmika<{7}>(crate::FrankaEmika));
}

impl FrankaFR3 {
    pub fn attach(ip: &str) -> Box<Self> {
        Box::new(FrankaFR3(crate::FrankaFR3::new(ip)))
    }
    pub fn create() -> Box<Self> {
        Box::new(FrankaFR3(crate::FrankaFR3::default()))
    }
    pub fn connect(&mut self, ip: &str) {
        self.0.connect(ip);
    }
}

impl FrankaFR3 {
    cxx_robot_behavior!(FrankaFR3(FrankaFR3));
    cxx_arm_behavior!(FrankaFR3<{7}>(crate::FrankaFR3));
    cxx_arm_param!(FrankaFR3<{7}>(crate::FrankaFR3));
    cxx_arm_preplanned_motion_impl!(FrankaFR3<{7}>(crate::FrankaFR3));
    cxx_arm_preplanned_motion!(FrankaFR3<{7}>(crate::FrankaFR3));
    cxx_arm_preplanned_motion_ext!(FrankaFR3<{7}>(crate::FrankaFR3));
    cxx_arm_streaming_motion!(FrankaFR3<{7}>(crate::FrankaFR3) -> FrankaHandle);
    cxx_arm_real_time_control!(FrankaFR3<{7}>(crate::FrankaFR3));
    cxx_arm_real_time_control_ext!(FrankaFR3<{7}>(crate::FrankaFR3));
}

impl FrankaHandle {
    cxx_arm_streaming_handle!(FrankaRobotHandle<{7}>(crate::FrankaHandle));
}

impl<const N: usize> From<CxxMotionType> for MotionType<N> {
    fn from(cxx: CxxMotionType) -> Self {
        match cxx.mode {
            CxxMotionTypeMode::Joint => MotionType::Joint(cxx.values.try_into().unwrap()),
            CxxMotionTypeMode::JointVel => MotionType::JointVel(cxx.values.try_into().unwrap()),
            CxxMotionTypeMode::Cartesian => MotionType::Cartesian(cxx.values.into()),
            CxxMotionTypeMode::CartesianVel => {
                MotionType::CartesianVel(cxx.values.try_into().unwrap())
            }
            CxxMotionTypeMode::Position => MotionType::Position(cxx.values.try_into().unwrap()),
            CxxMotionTypeMode::PositionVel => {
                MotionType::PositionVel(cxx.values.try_into().unwrap())
            }
            CxxMotionTypeMode::Stop => MotionType::Stop,
            _ => panic!("Invalid mode for MotionType"),
        }
    }
}

impl<const N: usize> From<MotionType<N>> for CxxMotionType {
    fn from(motion: MotionType<N>) -> Self {
        match motion {
            MotionType::Joint(v) => {
                CxxMotionType { mode: CxxMotionTypeMode::Joint, values: v.to_vec() }
            }
            MotionType::JointVel(v) => {
                CxxMotionType { mode: CxxMotionTypeMode::JointVel, values: v.to_vec() }
            }
            MotionType::Cartesian(v) => {
                CxxMotionType { mode: CxxMotionTypeMode::Cartesian, values: v.into() }
            }
            MotionType::CartesianVel(v) => {
                CxxMotionType { mode: CxxMotionTypeMode::CartesianVel, values: v.to_vec() }
            }
            MotionType::Position(v) => {
                CxxMotionType { mode: CxxMotionTypeMode::Position, values: v.to_vec() }
            }
            MotionType::PositionVel(v) => {
                CxxMotionType { mode: CxxMotionTypeMode::PositionVel, values: v.to_vec() }
            }
            MotionType::Stop => CxxMotionType {
                mode: CxxMotionTypeMode::Position, // Use Position as a placeholder for Stop
                values: vec![],
            },
        }
    }
}

impl<const N: usize> From<CxxControlType> for ControlType<N> {
    fn from(cxx: CxxControlType) -> Self {
        match cxx.mode {
            CxxControlTypeMode::Zero => ControlType::Zero,
            CxxControlTypeMode::Torque => ControlType::Torque(cxx.values.try_into().unwrap()),
            _ => panic!("Invalid mode for ControlType"),
        }
    }
}

impl<const N: usize> From<ControlType<N>> for CxxControlType {
    fn from(control: ControlType<N>) -> Self {
        match control {
            ControlType::Zero => CxxControlType { mode: CxxControlTypeMode::Zero, values: vec![] },
            ControlType::Torque(v) => {
                CxxControlType { mode: CxxControlTypeMode::Torque, values: v.to_vec() }
            }
        }
    }
}

impl From<CxxLoadState> for LoadState {
    fn from(cxx: CxxLoadState) -> Self {
        LoadState { m: cxx.m, x: cxx.x, i: cxx.i }
    }
}