Kinematic_Reader.pyi

from typing import Any, NoReturn
from numpy import ndarray
from .iCub_Interface import ANNiCub_wrapper
 
 
class PyKinematicReader:
    """ """
    @classmethod
    def __init__(cls, *args, **kwargs) -> None: ...
 
    def block_links(self, blocked_joints) -> Any:
        """Block specific set of joints in the kinematic chain.
 
        Parameters
        ----------
        blocked_joints : list
            joints that should be blocked
 
        Returns
        -------
 
        """
        ...
 
    def close(self, iCub: ANNiCub_wrapper) -> NoReturn:
        """Close the module
 
        Parameters
        ----------
        iCub : ANNiCub_wrapper
            main interface wrapper
 
        Returns
        -------
 
        """
        ...
 
    def get_DOF(self) -> int:
        """Return the DOF of the kinematic chain
 
        Parameters
        ----------
 
        Returns
        -------
        type
            int: degree of freedom (DOF) of the kinematic chain
        """
        ...
 
    def get_DOF_links(self) -> ndarray:
        """Get joints being part of active kinematic chain.
 
        Parameters
        ----------
 
        Returns
        -------
        NDarray
            vector with the active joints
        """
        ...
 
    def get_blocked_links(self) -> ndarray:
        """Get blocked links.
 
        Parameters
        ----------
 
        Returns
        -------
        NDarray
            vector containing the blocked links
        """
        ...
 
    def get_handposition(self) -> ndarray:
        """Get End-Effector cartesian position.
 
        Parameters
        ----------
 
        Returns
        -------
        NDarray
            Cartesian position of the end-effector in robot reference frame
        """
        ...
 
    def get_jointangles(self, radians=True) -> ndarray:
        """Get current joint angles of active kinematic chain -> radians.
 
        Parameters
        ----------
        radians : bool
            control the format (radians/degrees) of the returned angles
        Returns
        -------
        NDarray
            joint angles in radians
        """
        ...
 
    def get_jointposition(self, joint: int) -> ndarray:
        """Get cartesian position for the given joint.
 
        Parameters
        ----------
        joint : unsigned int
            joint number of the robot part
 
        Returns
        -------
        NDarray
            Cartesian position of the joint in robot reference frame
        """
        ...
 
    def init(self, iCub: ANNiCub_wrapper, name: str, part: str, version: float, ini_path: str = ..., offline_mode=...) -> bool:
        """Initialize the Kinematic Reader with given parameters
 
        Parameters
        ----------
        iCub : ANNiCub_wrapper
            main interface wrapper
        name : str
            individual name for the kinematic reader
        part : str
            string representing the robot part, has to match iCub part naming {left_(arm/leg), right_(arm/leg), head, torso}
        version : float
            version of the robot hardware
        ini_path : str
            path to the interface ini-file. (Default value = "../data/")
        offline_mode : bool
            flag, if iCub network is offline. (Default value = False)
 
        Returns
        -------
        bool
            return True/False, indicating success/failure
        """
        ...
 
    def init_grpc(self, iCub: ANNiCub_wrapper, name: str, part: str, version: float, ini_path: str = ...,
                  ip_address: str = ..., port: int = ..., offline_mode=...) -> bool:
        """Initialize the Kinematic Reader with given parameters, including the gRPC based connection.
 
        Parameters
        ----------
        iCub : ANNiCub_wrapper
            main interface wrapper
        name : str
            individual name for the kinematic reader
        part : str
            string representing the robot part, has to match iCub part naming {left_(arm/leg), right_(arm/leg), head, torso}
        version : float
            version of the robot hardware
        ini_path : str
            path to the interface ini-file. (Default value = "../data/")
        ip_address : str
            gRPC server ip address. (Default value = "0.0.0.0")
        port : unsigned int
            gRPC server port. (Default value = 50020)
        offline_mode : bool
            flag, if iCub network is offline. (Default value = False)
 
        Returns
        -------
        bool
            return True/False, indicating success/failure
        """
        ...
 
    def release_links(self, release_joints) -> Any:
        """Release links of kinematic chain
 
        Parameters
        ----------
        release_joints : list
            joints that should be released
 
        Returns
        -------
 
        """
        ...
 
    def set_jointangles(self, joint_angles, radians=True) -> ndarray:
        """Set joint angles for forward kinematic in offline mode.
 
        Parameters
        ----------
        joint_angles : list/NDarray
            joint angles in radians
        radians : bool
            if true, the angles are given in radians, otherwise the angles should be given in degrees
 
        Returns
        -------
        NDarray
            actual set joint angles in radians/degrees -> evaluted constraints
        """
        ...