<reponame>guichristmann/PyDynamixel_v2
# -*- coding: utf-8 -*-

"""
PyDynamixel TauraBots Library Version 2.0
Supports both Protocol 1.0 and Protocol 2.0 dynamixels.
Most of the code here was taken from the dynamixel_sdk examples and previous 
PyDynamixel library.
"""

# Dynamixel functions
from dynamixel_sdk import *
# Control tables for different types of motors
from .DynamixelControlTables import *
from math import pi
import sys

# Return format for functions that retrieve joint angles. True for 
# radians, False for degrees
RADIAN = True
# If there are only motors of the same type connected in the bus the 
# variable below can be changed so you don't need to specify the 
# control table every time a new Joint object is created.
DEFAULT_MOTOR_CTRL_TABLE = ''

def setDefaultCtrlTable(ctrl_table):
    global DEFAULT_MOTOR_CTRL_TABLE
    DEFAULT_MOTOR_CTRL_TABLE = ctrl_table

class DxlComm(object):
    ''' This class implements low level
    communication with the dynamixel
    protocol.
    '''

    def __init__(self, port="/dev/ttyUSB0", baudnum=None, 
            protocol_version=None, baudrate=None):
        ''' Initializes DxlComm.
        port: the path to the serial device. Default is /dev/ttyUSB0.
        The constructor optionally takes a baudnum argument:
           baudrate = 2Mbps / (baudnum + 1)
        If no baudrate or baudnum is provided, the default baudrate is 57600.
        '''

        self.port           = port

        # Valid protocols are only 1 or 2
        assert protocol_version == 1 or protocol_version == 2
        self.protocol_version = protocol_version

        if baudrate:
            self.baudrate = baudrate
        elif baudnum != None:
            # Baudnum selected in dynamixel config in RoboPlus Software
            self.baudrate = int(2000000/(baudnum + 1))
        else:
            self.baudrate = 57600

        self.port_handler   = PortHandler(port)
        self.packet_handler = PacketHandler(self.protocol_version)

        self.joint_ids  = [] # All attached joint ids
        self.joints     = [] # All attached joints (whole class)
        self.total      = 0  # Total joints attached

        # Connection to declared serial port
        if self.port_handler.openPort():
            print("Succeeded to open the port")
        else:
            print("Failed to open the port")

        # Set port baudrate
        if self.port_handler.setBaudRate(self.baudrate):
            print("Succeeded to change the baudrate")
        else:
            print("Failed to change the baudrate")

        # Flag to enable/disable sync and bulk functions
        self.sync_enable = False

    def attach_joints(self, joints):
        ''' This method attaches a list of joints so that
        the communication can be handled by this class.
        '''
        for joint in joints:
            self._attach_joint(joint)

        # Every time a new joint is attached, the control tables for all 
        # attached joints are checked. If the control tables match then
        # initialize sync/bulk and read/write objects
        ref_table = self.joints[0].table # Use table of first joint as reference
        for joint in self.joints:
            if ref_table != joint.table:
                print("Different control tables detected. Synchronous functions\
                        won't work.")
                self.sync_enable = False # Disable sync functions
                return # End function here

        print("All control tables match. Setting up synchronous functions.")
        self.sync_enable = True
        self.ref_table = ref_table

        # Instantiates sync read and write objects 
        if self.protocol_version == 2:
            # Sync Read is only present in Protocol 2.0
            self.group_sync_read = GroupSyncRead(self.port_handler, 
                    self.packet_handler, 
                    self.ref_table.ADDR_PRESENT_POSITION, 
                    self.ref_table.LEN_PRESENT_POSITION)
        elif self.protocol_version == 1:
            # Use bulk read for protocol 1.0 instead
            self.group_bulk_read = GroupBulkRead(self.port_handler,
                    self.packet_handler)

        # Sync write works for both 1.0 and 2.0
        self.group_sync_write = GroupSyncWrite(self.port_handler, 
                self.packet_handler, 
                self.ref_table.ADDR_GOAL_POSITION, 
                self.ref_table.LEN_GOAL_POSITION)

    def attach_joint(self, joint):
        '''
            Simple wrapper to not lose functionality when attaching a single joint.
        '''
        joints = [joint]
        self.attach_joints(joints)

    def _attach_joint(self, joint):
        ''' This method attaches a single joint so
        that the communication can be handled by this class.
        '''
        # Registers the joint in the database
        self.joints.append(joint)
        self.joint_ids.append(joint.servo_id)
        joint._set_port_and_packet(self.port_handler, self.packet_handler, 
                self.protocol_version)
        self.total = self.total + 1
        self.joint_ids.sort()

    def broadcast_ping(self): # CHECK
        ''' Broadcast ping to all attached joints.
        Finally, checks if detected dynamixels are equal to previously attached
        joints.
        Only for Protocol 2.0.
        Return: list of detected dynamixels.
        '''
        if self.protocol_version == 2:
            detected_servos = []

            dxl_data_list, dxl_comm_result = self.packet_handler.broadcastPing(self.port_handler)

            if dxl_comm_result != COMM_SUCCESS:
                print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

            print("Detected Dynamixels: ")
            for servo_id in dxl_data_list:
                detected_servos.append(servo_id)
                print("[ID: %03d] model version: %d | firmware version: %d" % (servo_id, dxl_data_list.get(servo_id)[0], dxl_data_list.get(servo_id)[1]))

            if len(detected_servos) != self.total:
                print("Detected servos value different from total added joints. Check for connection issues.")

            return detected_servos
        else:
            print("Broadcast Ping only available for Protocol 2.0.")
            return False

    def send_angles(self, values=None, radian=RADIAN):
        ''' Sends goal position with sync write to all or desired servos.

        If no values are sent, then it gets which servos to send goal values to from
        their 'changed' param, which was modified by each joint set_goal_value() function.

        The 'values' dict should have the name length of current connected joints.
        Therefore, if you chose to send through the 'values' way, you will send angles
        to all connected dynamixels.

        Usage: (assuming 3 attached joints)
            self.send_angles({dyn1_id: 90, dyn3_id: 30, dyn2_id: 60})
            OR
            self.send_angles({dyn3_id: pi/2, dyn2_id: pi/6, dyn1_id: pi/3}, radian=True)
            OR
            self.joints[0].set_goal_value(90) OR self.joints[0].set_goal_value(pi/2, radian=True)
            self.send_angles()
        '''
        if values == None:
            ch_joints = [j for j in self.joints if j.changed is True]
            self._sync_write(servos=ch_joints)

            for i in ch_joints:
                i.changed = False
        else:
            if isinstance(values, dict): #this needs further checking
                list_values = [values[i] for i in sorted(values)] # sort dict by joint id
                if len(list_values) == len(self.joint_ids):
                    # list_values is sorted as is serial.joint_ids (from lowest to highest id)
                    self._sync_write(values=list_values, radian=radian)
            else:
                print("Make sure the values parameter is a list of the same length of connected dynamixels.")


    def _sync_write(self, servos=None, values=None, radian=RADIAN):
        ''' this is an adaptation from dynamixel's sdk for
            the sync_write '''
        if servos != None:
            for i, s in enumerate(servos):
                # goal_value = self.set_goal_value(s.goal_value, radian=radian)
                param_goal_position = [DXL_LOBYTE(DXL_LOWORD(s.goal_value)), DXL_HIBYTE(DXL_LOWORD(s.goal_value)), DXL_LOBYTE(DXL_HIWORD(s.goal_value)), DXL_HIBYTE(DXL_HIWORD(s.goal_value))]
                dxl_add_param_result = self.group_sync_write.addParam(s.servo_id, param_goal_position)
                if dxl_add_param_result != True:
                    print("[ID: %03d] groupSyncWrite addParam failed" %s.servo_id)
        elif values != None:
            for i, goal_value in enumerate(values):
                goal_value = self.set_goal_value(goal_value, radian=radian)
                servo_id = self.joint_ids[i]
                param_goal_position = [DXL_LOBYTE(DXL_LOWORD(goal_value)), DXL_HIBYTE(DXL_LOWORD(goal_value)), DXL_LOBYTE(DXL_HIWORD(goal_value)), DXL_HIBYTE(DXL_HIWORD(goal_value))]
                dxl_add_param_result = self.group_sync_write.addParam(servo_id, param_goal_position)
                if dxl_add_param_result != True:
                    print("[ID: %03d] groupSyncWrite addParam failed" % servo_id)

        dxl_comm_result = self.group_sync_write.txPacket() # sync write
        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

        self.group_sync_write.clearParam() # clears buffer

    def sync_write_goal_position(self):
        """
            Sync writes the ``.goal_value'' for all the joints attached to the 
            port.
        """

        set_joints = [j for j in self.joints if j.set_goal]
        for j in set_joints:
            if self.ref_table.LEN_GOAL_POSITION == 2:
                param_goal_position = [DXL_LOBYTE(j.goal_value), DXL_HIBYTE(j.goal_value)]
                j_id = j.servo_id
                dxl_add_param_result = self.group_sync_write.addParam(j_id, param_goal_position)
                if dxl_add_param_result != True:
                    print("[ID: %03d] groupSyncWrite addParam failed" % j_id)

            elif self.ref_table.LEN_GOAL_POSITION == 4:
                param_goal_position = [DXL_LOBYTE(DXL_LOWORD(j.goal_value)), 
                        DXL_HIBYTE(DXL_LOWORD(j.goal_value)), 
                        DXL_LOBYTE(DXL_HIWORD(j.goal_value)), 
                        DXL_HIBYTE(DXL_HIWORD(j.goal_value))]
                j_id = j.servo_id
                dxl_add_param_result = self.group_sync_write.addParam(j_id, param_goal_position)
                if dxl_add_param_result != True:
                    print("[ID: %03d] groupSyncWrite addParam failed" % j_id)

            # Unset flag
            j.set_goal = False

        dxl_comm_result = self.group_sync_write.txPacket()
        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

        self.group_sync_write.clearParam() # clears buffer

    def get_angles(self, radian=RADIAN):
        ''' Read angles from all attached joints.
        Only available in Protocol 2.0'''
        if self.protocol_version == 2:
            servos_angles = self._sync_read(self.ref_table.ADDR_PRESENT_POSITION, 
                    self.ref_table.LEN_PRESENT_POSITION,
                    radian=radian)
            return servos_angles
        else:
            # no sync read for Protocol 1.0
            for joint in self.joints:
                joint.get_angle(radian=radian)

    def _sync_read(self, addr, info_len, radian=RADIAN):
        ''' Sync read. Only available in Protocol 2.0
        '''
        if self.protocol_version == 2:
            for i, servo_id in enumerate(self.joint_ids):
                # add all servos to sync read request
                dxl_add_param_result = self.group_sync_read.addParam(servo_id)
                if dxl_add_param_result != COMM_SUCCESS:
                    #print("[ID: %03d] groupSyncRead addParam failed." % servo_id)
                    pass

            # SyncRead present position
            dxl_comm_result = self.group_sync_read.txRxPacket()
            if dxl_comm_result != COMM_SUCCESS:
                print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

            # check if sync read data from each dynamixel is available
            # then, get save that data
            servos_position = {}
            for i, servo_id in enumerate(self.joint_ids):
                dxl_getdata_result = self.group_sync_read.isAvailable(servo_id, addr, info_len)
                if dxl_getdata_result != True:
                    print("[ID:0%3d] groupSyncRead getdata failed." % servo_id)
                else:
                    dxl_present_position = self.group_sync_read.getData(servo_id, addr, info_len)
                    # put the returned value into a dict with all values and in the joints curr_value variable
                    if radian:
                        present_angle = (pi*dxl_present_position)/2048.0
                    else:
                        present_angle = (180*dxl_present_position)/2048.0
                    servos_position[servo_id] = present_angle
                    self.joints[i].curr_value = present_angle

            self.group_sync_read.clearParam()

            # return the dict
            return servos_position
        else:
            print("Sync Read is only available in Protocol 2.0.")
            return False

    def bulk_read_present_position(self, ids=[], radian=RADIAN):
        """
        Bulk reads the present position of the motors specified in the list of
        ids
        
        Arguments:
            ids: list of IDs of the motors.

        """

        if self.protocol_version == 2:
            print("[INFO] Manager is running on protocol 2.0, you can use \
                    sync_read instad.")

        if ids == []:
            ids = self.joint_ids

        # Mount the bulk read message
        for m_id in ids:
            addparam_result = self.group_bulk_read.addParam(m_id, 
                    self.ref_table.ADDR_PRESENT_POSITION, 
                    self.ref_table.LEN_PRESENT_POSITION)
            if addparam_result != True: 
                self.group_bulk_read.clearParam()
                raise RuntimeError("[ID:%03d] groupBulkRead addparam failed" % m_id)

        # Send it
        dxl_comm_result = self.group_bulk_read.txRxPacket()
        if dxl_comm_result != COMM_SUCCESS:
            self.group_bulk_read.clearParam()
            raise RuntimeError("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

        # Check that data is received
        for m_id in ids:
            getdata_res = self.group_bulk_read.isAvailable(m_id,
                    self.ref_table.ADDR_PRESENT_POSITION,
                    self.ref_table.LEN_PRESENT_POSITION)
            if getdata_res != True:
                self.group_bulk_read.clearParam()
                raise RuntimeError("[ID:%03d] groupBulkRead getdata failed" % m_id)

        # Retrieve data
        ppositions = []
        for m_id in ids:
            data = self.group_bulk_read.getData(m_id, 
                    self.ref_table.ADDR_PRESENT_POSITION, 
                    self.ref_table.LEN_PRESENT_POSITION)
            if radian:
                data = (pi*data)/2048.0
            else:
                data = (180*data)/2048.0
            ppositions.append(data)

        self.group_bulk_read.clearParam()
        return ppositions

    def enable_torques(self):
        ''' Enable torque for all motors connected
        in this port.
        '''
        self.packet_handler.write1ByteTxRx(self.port_handler, BROADCAST_ID, 
                self.ref_table.ADDR_TORQUE_ENABLE, 1)

    def disable_torques(self):
        ''' Disables torque for all motors connected
        to this port
        '''
        self.packet_handler.write1ByteTxRx(self.port_handler, BROADCAST_ID, 
                self.ref_table.ADDR_TORQUE_ENABLE, 0)

    def set_goal_value(self, angle, radian=RADIAN):
        '''Sets goal value (0 to 1024), from given goal angle.
        '''
        goal_angle = float(angle)
        if radian:
            goal_value = int(2048.0*angle/pi)
        else:
            goal_value = int(2048.0*angle/180)
        return goal_value

    def release(self):
        ''' This method should be called for
        the class to explicitly close the
        open port_handler
        '''
        self.port_handler.closePort()

class Joint(object):
    ''' This class represents a single Dynamixel servo motor.
    Contains functions to ping, reboot, get angles and send angles to the dynamixel.
    '''

    def __init__(self, servo_id, 
            control_table=None, center_value=0):
        ''' The constructor takes the servo id
        as the argument. Argument center_value
        can be set to calibrate the zero
        position of the servo.
        '''
        if control_table is None:
            control_table = DEFAULT_MOTOR_CTRL_TABLE

        if type(control_table) == str:
            valids = list(ctrltables_str_mappings.keys())
            if control_table not in valids:
                raise ValueError("Unrecognized control table ``{}''. Valids: {}".format(control_table, valids))
            self.table = ctrltables_str_mappings[control_table]
        else: # Assume the control table object was passed directly
            self.table = control_table

        self.servo_id = servo_id
        self.center_value = center_value
        self.goal_angle = -1
        # Used to flag joints for sync_write
        self.set_goal = False

    def _set_port_and_packet(self, port_handler, packet_handler, protocol_version):
        ''' This sets this joint's packet and port handlers to be equal to DxlComm ones.
        These variables are used to communicate with dynamixel.
        '''
        self.packet_handler = packet_handler
        self.port_handler = port_handler
        self.protocol_version = protocol_version

    def set_goal_value(self, angle, radian=RADIAN):
        '''Sets goal value (0 to 1024), from given goal angle.
        Usage:
            set_goal_value(90) -> angle in degrees
            set_goal_value(pi/2, radian=True) -> angle in radians
        '''
        self.goal_angle = float(angle)
        if radian:
            self.goal_value = int(2048.0*angle/pi) + self.center_value
        else:
            self.goal_value = int(2048.0*angle/180) + self.center_value
        self.set_goal = True

    def send_angle(self, angle, radian=RADIAN):
        ''' Sends a command to this specific servomotor to set
        its goal value from a degree or radian goal angle.
        Usage:
            send_angle(90) -> sends 90 degree angle
            OR
            send_angle(pi/2, radian=True) -> send 90 degree angle, but in radians
            OR
            set_goal_value(90) OR set_goal_value(pi/2, radian=True)
            send_angle()
        '''
        #if angle >= 0:
        if radian:
            goal_value = int(2048.0*angle/pi) + self.center_value
        else:
            goal_value = int(2048.0*angle/180) + self.center_value

        # Check length to choose how many bytes to write
        if self.table.LEN_GOAL_POSITION == 4:
            dxl_comm_result, dxl_error = self.packet_handler.write4ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_GOAL_POSITION, goal_value)
        elif self.table.LEN_GOAL_POSITION == 2:
            dxl_comm_result, dxl_error = self.packet_handler.write2ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_GOAL_POSITION, goal_value)

        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))

    def get_angle(self, radian=RADIAN):
        ''' Reads the current position of this
        servomotor alone. The read position is
        stored in both self.curr_angle and self.curr_value.
        However, only self.curr_angle is retorned by this function.
        '''
        if self.table.LEN_PRESENT_POSITION == 2:
            self.curr_value, dxl_comm_result, dxl_error = self.packet_handler.read2ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_PRESENT_POSITION)
        elif self.table.LEN_PRESENT_POSITION == 4:
            self.curr_value, dxl_comm_result, dxl_error = self.packet_handler.read4ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_PRESENT_POSITION)

        #self.curr_value -= self.center_value #TODO implement this in other functions

        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))

        if radian:
            self.curr_angle = pi*float(self.curr_value)/2048.0
        else:
            self.curr_angle = 180*float(self.curr_value)/2048.0

        return self.curr_angle

    def enable_torque(self):
        ''' Enables torque in this joint
        Usage: self.enable_torque()
        '''
        dxl_comm_result, dxl_error = self.packet_handler.write1ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_TORQUE_ENABLE, 1)
        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error != 0:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))

    def disable_torque(self):
        ''' Disables torque in this joint
        Usage:
            self.disable_torque()
        '''
        dxl_comm_result, dxl_error = self.packet_handler.write1ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_TORQUE_ENABLE, 0)

        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error != 0:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))

    def ping(self): # check
        ''' Ping this joint.
        Usage:
            self.ping()
        '''
        dxl_model_number, dxl_comm_result, dxl_error = self.packet_handler.ping(self.port_handler, self.servo_id)
        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error != 0:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))
        else:
            print("[ID: %03d] ping succeeded. Model number: %d" % (self.servo_id, dxl_model_number))
            return self.servo_id

    def reboot(self): # check
        ''' Reboots this joint.
        Only works in Protocol 2.0.
        Usage:
            self.reboot()
        '''
        if self.protocol_version == 2:
            dxl_comm_result, dxl_error = self.packet_handler.reboot(self.port_handler, self.servo_id)
            if dxl_comm_result != COMM_SUCCESS:
                print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
            elif dxl_error != 0:
                print("%s" % self.packet_handler.getRxPacketError(dxl_error))
            else:
                print("[ID: %03d] reboot succeeded" % self.servo_id)
        else:
            print("Reboot is only present in Protocol 2.0.")

# -*- coding: utf-8 -*-

"""
PyDynamixel TauraBots Library Version 2.0
Supports both Protocol 1.0 and Protocol 2.0 dynamixels.
Most of the code here was taken from the dynamixel_sdk examples and previous 
PyDynamixel library.
"""

# Dynamixel functions
from dynamixel_sdk import *
# Control tables for different types of motors
from .DynamixelControlTables import *
from math import pi
import sys

# Return format for functions that retrieve joint angles. True for 
# radians, False for degrees
RADIAN = True
# If there are only motors of the same type connected in the bus the 
# variable below can be changed so you don't need to specify the 
# control table every time a new Joint object is created.
DEFAULT_MOTOR_CTRL_TABLE = ''

def setDefaultCtrlTable(ctrl_table):
    global DEFAULT_MOTOR_CTRL_TABLE
    DEFAULT_MOTOR_CTRL_TABLE = ctrl_table

class DxlComm(object):
    ''' This class implements low level
    communication with the dynamixel
    protocol.
    '''

    def __init__(self, port="/dev/ttyUSB0", baudnum=None, 
            protocol_version=None, baudrate=None):
        ''' Initializes DxlComm.
        port: the path to the serial device. Default is /dev/ttyUSB0.
        The constructor optionally takes a baudnum argument:
           baudrate = 2Mbps / (baudnum + 1)
        If no baudrate or baudnum is provided, the default baudrate is 57600.
        '''

        self.port           = port

        # Valid protocols are only 1 or 2
        assert protocol_version == 1 or protocol_version == 2
        self.protocol_version = protocol_version

        if baudrate:
            self.baudrate = baudrate
        elif baudnum != None:
            # Baudnum selected in dynamixel config in RoboPlus Software
            self.baudrate = int(2000000/(baudnum + 1))
        else:
            self.baudrate = 57600

        self.port_handler   = PortHandler(port)
        self.packet_handler = PacketHandler(self.protocol_version)

        self.joint_ids  = [] # All attached joint ids
        self.joints     = [] # All attached joints (whole class)
        self.total      = 0  # Total joints attached

        # Connection to declared serial port
        if self.port_handler.openPort():
            print("Succeeded to open the port")
        else:
            print("Failed to open the port")

        # Set port baudrate
        if self.port_handler.setBaudRate(self.baudrate):
            print("Succeeded to change the baudrate")
        else:
            print("Failed to change the baudrate")

        # Flag to enable/disable sync and bulk functions
        self.sync_enable = False

    def attach_joints(self, joints):
        ''' This method attaches a list of joints so that
        the communication can be handled by this class.
        '''
        for joint in joints:
            self._attach_joint(joint)

        # Every time a new joint is attached, the control tables for all 
        # attached joints are checked. If the control tables match then
        # initialize sync/bulk and read/write objects
        ref_table = self.joints[0].table # Use table of first joint as reference
        for joint in self.joints:
            if ref_table != joint.table:
                print("Different control tables detected. Synchronous functions\
                        won't work.")
                self.sync_enable = False # Disable sync functions
                return # End function here

        print("All control tables match. Setting up synchronous functions.")
        self.sync_enable = True
        self.ref_table = ref_table

        # Instantiates sync read and write objects 
        if self.protocol_version == 2:
            # Sync Read is only present in Protocol 2.0
            self.group_sync_read = GroupSyncRead(self.port_handler, 
                    self.packet_handler, 
                    self.ref_table.ADDR_PRESENT_POSITION, 
                    self.ref_table.LEN_PRESENT_POSITION)
        elif self.protocol_version == 1:
            # Use bulk read for protocol 1.0 instead
            self.group_bulk_read = GroupBulkRead(self.port_handler,
                    self.packet_handler)

        # Sync write works for both 1.0 and 2.0
        self.group_sync_write = GroupSyncWrite(self.port_handler, 
                self.packet_handler, 
                self.ref_table.ADDR_GOAL_POSITION, 
                self.ref_table.LEN_GOAL_POSITION)

    def attach_joint(self, joint):
        '''
            Simple wrapper to not lose functionality when attaching a single joint.
        '''
        joints = [joint]
        self.attach_joints(joints)

    def _attach_joint(self, joint):
        ''' This method attaches a single joint so
        that the communication can be handled by this class.
        '''
        # Registers the joint in the database
        self.joints.append(joint)
        self.joint_ids.append(joint.servo_id)
        joint._set_port_and_packet(self.port_handler, self.packet_handler, 
                self.protocol_version)
        self.total = self.total + 1
        self.joint_ids.sort()

    def broadcast_ping(self): # CHECK
        ''' Broadcast ping to all attached joints.
        Finally, checks if detected dynamixels are equal to previously attached
        joints.
        Only for Protocol 2.0.
        Return: list of detected dynamixels.
        '''
        if self.protocol_version == 2:
            detected_servos = []

            dxl_data_list, dxl_comm_result = self.packet_handler.broadcastPing(self.port_handler)

            if dxl_comm_result != COMM_SUCCESS:
                print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

            print("Detected Dynamixels: ")
            for servo_id in dxl_data_list:
                detected_servos.append(servo_id)
                print("[ID: %03d] model version: %d | firmware version: %d" % (servo_id, dxl_data_list.get(servo_id)[0], dxl_data_list.get(servo_id)[1]))

            if len(detected_servos) != self.total:
                print("Detected servos value different from total added joints. Check for connection issues.")

            return detected_servos
        else:
            print("Broadcast Ping only available for Protocol 2.0.")
            return False

    def send_angles(self, values=None, radian=RADIAN):
        ''' Sends goal position with sync write to all or desired servos.

        If no values are sent, then it gets which servos to send goal values to from
        their 'changed' param, which was modified by each joint set_goal_value() function.

        The 'values' dict should have the name length of current connected joints.
        Therefore, if you chose to send through the 'values' way, you will send angles
        to all connected dynamixels.

        Usage: (assuming 3 attached joints)
            self.send_angles({dyn1_id: 90, dyn3_id: 30, dyn2_id: 60})
            OR
            self.send_angles({dyn3_id: pi/2, dyn2_id: pi/6, dyn1_id: pi/3}, radian=True)
            OR
            self.joints[0].set_goal_value(90) OR self.joints[0].set_goal_value(pi/2, radian=True)
            self.send_angles()
        '''
        if values == None:
            ch_joints = [j for j in self.joints if j.changed is True]
            self._sync_write(servos=ch_joints)

            for i in ch_joints:
                i.changed = False
        else:
            if isinstance(values, dict): #this needs further checking
                list_values = [values[i] for i in sorted(values)] # sort dict by joint id
                if len(list_values) == len(self.joint_ids):
                    # list_values is sorted as is serial.joint_ids (from lowest to highest id)
                    self._sync_write(values=list_values, radian=radian)
            else:
                print("Make sure the values parameter is a list of the same length of connected dynamixels.")


    def _sync_write(self, servos=None, values=None, radian=RADIAN):
        ''' this is an adaptation from dynamixel's sdk for
            the sync_write '''
        if servos != None:
            for i, s in enumerate(servos):
                # goal_value = self.set_goal_value(s.goal_value, radian=radian)
                param_goal_position = [DXL_LOBYTE(DXL_LOWORD(s.goal_value)), DXL_HIBYTE(DXL_LOWORD(s.goal_value)), DXL_LOBYTE(DXL_HIWORD(s.goal_value)), DXL_HIBYTE(DXL_HIWORD(s.goal_value))]
                dxl_add_param_result = self.group_sync_write.addParam(s.servo_id, param_goal_position)
                if dxl_add_param_result != True:
                    print("[ID: %03d] groupSyncWrite addParam failed" %s.servo_id)
        elif values != None:
            for i, goal_value in enumerate(values):
                goal_value = self.set_goal_value(goal_value, radian=radian)
                servo_id = self.joint_ids[i]
                param_goal_position = [DXL_LOBYTE(DXL_LOWORD(goal_value)), DXL_HIBYTE(DXL_LOWORD(goal_value)), DXL_LOBYTE(DXL_HIWORD(goal_value)), DXL_HIBYTE(DXL_HIWORD(goal_value))]
                dxl_add_param_result = self.group_sync_write.addParam(servo_id, param_goal_position)
                if dxl_add_param_result != True:
                    print("[ID: %03d] groupSyncWrite addParam failed" % servo_id)

        dxl_comm_result = self.group_sync_write.txPacket() # sync write
        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

        self.group_sync_write.clearParam() # clears buffer

    def sync_write_goal_position(self):
        """
            Sync writes the ``.goal_value'' for all the joints attached to the 
            port.
        """

        set_joints = [j for j in self.joints if j.set_goal]
        for j in set_joints:
            if self.ref_table.LEN_GOAL_POSITION == 2:
                param_goal_position = [DXL_LOBYTE(j.goal_value), DXL_HIBYTE(j.goal_value)]
                j_id = j.servo_id
                dxl_add_param_result = self.group_sync_write.addParam(j_id, param_goal_position)
                if dxl_add_param_result != True:
                    print("[ID: %03d] groupSyncWrite addParam failed" % j_id)

            elif self.ref_table.LEN_GOAL_POSITION == 4:
                param_goal_position = [DXL_LOBYTE(DXL_LOWORD(j.goal_value)), 
                        DXL_HIBYTE(DXL_LOWORD(j.goal_value)), 
                        DXL_LOBYTE(DXL_HIWORD(j.goal_value)), 
                        DXL_HIBYTE(DXL_HIWORD(j.goal_value))]
                j_id = j.servo_id
                dxl_add_param_result = self.group_sync_write.addParam(j_id, param_goal_position)
                if dxl_add_param_result != True:
                    print("[ID: %03d] groupSyncWrite addParam failed" % j_id)

            # Unset flag
            j.set_goal = False

        dxl_comm_result = self.group_sync_write.txPacket()
        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

        self.group_sync_write.clearParam() # clears buffer

    def get_angles(self, radian=RADIAN):
        ''' Read angles from all attached joints.
        Only available in Protocol 2.0'''
        if self.protocol_version == 2:
            servos_angles = self._sync_read(self.ref_table.ADDR_PRESENT_POSITION, 
                    self.ref_table.LEN_PRESENT_POSITION,
                    radian=radian)
            return servos_angles
        else:
            # no sync read for Protocol 1.0
            for joint in self.joints:
                joint.get_angle(radian=radian)

    def _sync_read(self, addr, info_len, radian=RADIAN):
        ''' Sync read. Only available in Protocol 2.0
        '''
        if self.protocol_version == 2:
            for i, servo_id in enumerate(self.joint_ids):
                # add all servos to sync read request
                dxl_add_param_result = self.group_sync_read.addParam(servo_id)
                if dxl_add_param_result != COMM_SUCCESS:
                    #print("[ID: %03d] groupSyncRead addParam failed." % servo_id)
                    pass

            # SyncRead present position
            dxl_comm_result = self.group_sync_read.txRxPacket()
            if dxl_comm_result != COMM_SUCCESS:
                print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

            # check if sync read data from each dynamixel is available
            # then, get save that data
            servos_position = {}
            for i, servo_id in enumerate(self.joint_ids):
                dxl_getdata_result = self.group_sync_read.isAvailable(servo_id, addr, info_len)
                if dxl_getdata_result != True:
                    print("[ID:0%3d] groupSyncRead getdata failed." % servo_id)
                else:
                    dxl_present_position = self.group_sync_read.getData(servo_id, addr, info_len)
                    # put the returned value into a dict with all values and in the joints curr_value variable
                    if radian:
                        present_angle = (pi*dxl_present_position)/2048.0
                    else:
                        present_angle = (180*dxl_present_position)/2048.0
                    servos_position[servo_id] = present_angle
                    self.joints[i].curr_value = present_angle

            self.group_sync_read.clearParam()

            # return the dict
            return servos_position
        else:
            print("Sync Read is only available in Protocol 2.0.")
            return False

    def bulk_read_present_position(self, ids=[], radian=RADIAN):
        """
        Bulk reads the present position of the motors specified in the list of
        ids
        
        Arguments:
            ids: list of IDs of the motors.

        """

        if self.protocol_version == 2:
            print("[INFO] Manager is running on protocol 2.0, you can use \
                    sync_read instad.")

        if ids == []:
            ids = self.joint_ids

        # Mount the bulk read message
        for m_id in ids:
            addparam_result = self.group_bulk_read.addParam(m_id, 
                    self.ref_table.ADDR_PRESENT_POSITION, 
                    self.ref_table.LEN_PRESENT_POSITION)
            if addparam_result != True: 
                self.group_bulk_read.clearParam()
                raise RuntimeError("[ID:%03d] groupBulkRead addparam failed" % m_id)

        # Send it
        dxl_comm_result = self.group_bulk_read.txRxPacket()
        if dxl_comm_result != COMM_SUCCESS:
            self.group_bulk_read.clearParam()
            raise RuntimeError("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))

        # Check that data is received
        for m_id in ids:
            getdata_res = self.group_bulk_read.isAvailable(m_id,
                    self.ref_table.ADDR_PRESENT_POSITION,
                    self.ref_table.LEN_PRESENT_POSITION)
            if getdata_res != True:
                self.group_bulk_read.clearParam()
                raise RuntimeError("[ID:%03d] groupBulkRead getdata failed" % m_id)

        # Retrieve data
        ppositions = []
        for m_id in ids:
            data = self.group_bulk_read.getData(m_id, 
                    self.ref_table.ADDR_PRESENT_POSITION, 
                    self.ref_table.LEN_PRESENT_POSITION)
            if radian:
                data = (pi*data)/2048.0
            else:
                data = (180*data)/2048.0
            ppositions.append(data)

        self.group_bulk_read.clearParam()
        return ppositions

    def enable_torques(self):
        ''' Enable torque for all motors connected
        in this port.
        '''
        self.packet_handler.write1ByteTxRx(self.port_handler, BROADCAST_ID, 
                self.ref_table.ADDR_TORQUE_ENABLE, 1)

    def disable_torques(self):
        ''' Disables torque for all motors connected
        to this port
        '''
        self.packet_handler.write1ByteTxRx(self.port_handler, BROADCAST_ID, 
                self.ref_table.ADDR_TORQUE_ENABLE, 0)

    def set_goal_value(self, angle, radian=RADIAN):
        '''Sets goal value (0 to 1024), from given goal angle.
        '''
        goal_angle = float(angle)
        if radian:
            goal_value = int(2048.0*angle/pi)
        else:
            goal_value = int(2048.0*angle/180)
        return goal_value

    def release(self):
        ''' This method should be called for
        the class to explicitly close the
        open port_handler
        '''
        self.port_handler.closePort()

class Joint(object):
    ''' This class represents a single Dynamixel servo motor.
    Contains functions to ping, reboot, get angles and send angles to the dynamixel.
    '''

    def __init__(self, servo_id, 
            control_table=None, center_value=0):
        ''' The constructor takes the servo id
        as the argument. Argument center_value
        can be set to calibrate the zero
        position of the servo.
        '''
        if control_table is None:
            control_table = DEFAULT_MOTOR_CTRL_TABLE

        if type(control_table) == str:
            valids = list(ctrltables_str_mappings.keys())
            if control_table not in valids:
                raise ValueError("Unrecognized control table ``{}''. Valids: {}".format(control_table, valids))
            self.table = ctrltables_str_mappings[control_table]
        else: # Assume the control table object was passed directly
            self.table = control_table

        self.servo_id = servo_id
        self.center_value = center_value
        self.goal_angle = -1
        # Used to flag joints for sync_write
        self.set_goal = False

    def _set_port_and_packet(self, port_handler, packet_handler, protocol_version):
        ''' This sets this joint's packet and port handlers to be equal to DxlComm ones.
        These variables are used to communicate with dynamixel.
        '''
        self.packet_handler = packet_handler
        self.port_handler = port_handler
        self.protocol_version = protocol_version

    def set_goal_value(self, angle, radian=RADIAN):
        '''Sets goal value (0 to 1024), from given goal angle.
        Usage:
            set_goal_value(90) -> angle in degrees
            set_goal_value(pi/2, radian=True) -> angle in radians
        '''
        self.goal_angle = float(angle)
        if radian:
            self.goal_value = int(2048.0*angle/pi) + self.center_value
        else:
            self.goal_value = int(2048.0*angle/180) + self.center_value
        self.set_goal = True

    def send_angle(self, angle, radian=RADIAN):
        ''' Sends a command to this specific servomotor to set
        its goal value from a degree or radian goal angle.
        Usage:
            send_angle(90) -> sends 90 degree angle
            OR
            send_angle(pi/2, radian=True) -> send 90 degree angle, but in radians
            OR
            set_goal_value(90) OR set_goal_value(pi/2, radian=True)
            send_angle()
        '''
        #if angle >= 0:
        if radian:
            goal_value = int(2048.0*angle/pi) + self.center_value
        else:
            goal_value = int(2048.0*angle/180) + self.center_value

        # Check length to choose how many bytes to write
        if self.table.LEN_GOAL_POSITION == 4:
            dxl_comm_result, dxl_error = self.packet_handler.write4ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_GOAL_POSITION, goal_value)
        elif self.table.LEN_GOAL_POSITION == 2:
            dxl_comm_result, dxl_error = self.packet_handler.write2ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_GOAL_POSITION, goal_value)

        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))

    def get_angle(self, radian=RADIAN):
        ''' Reads the current position of this
        servomotor alone. The read position is
        stored in both self.curr_angle and self.curr_value.
        However, only self.curr_angle is retorned by this function.
        '''
        if self.table.LEN_PRESENT_POSITION == 2:
            self.curr_value, dxl_comm_result, dxl_error = self.packet_handler.read2ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_PRESENT_POSITION)
        elif self.table.LEN_PRESENT_POSITION == 4:
            self.curr_value, dxl_comm_result, dxl_error = self.packet_handler.read4ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_PRESENT_POSITION)

        #self.curr_value -= self.center_value #TODO implement this in other functions

        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))

        if radian:
            self.curr_angle = pi*float(self.curr_value)/2048.0
        else:
            self.curr_angle = 180*float(self.curr_value)/2048.0

        return self.curr_angle

    def enable_torque(self):
        ''' Enables torque in this joint
        Usage: self.enable_torque()
        '''
        dxl_comm_result, dxl_error = self.packet_handler.write1ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_TORQUE_ENABLE, 1)
        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error != 0:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))

    def disable_torque(self):
        ''' Disables torque in this joint
        Usage:
            self.disable_torque()
        '''
        dxl_comm_result, dxl_error = self.packet_handler.write1ByteTxRx(self.port_handler, self.servo_id, self.table.ADDR_TORQUE_ENABLE, 0)

        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error != 0:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))

    def ping(self): # check
        ''' Ping this joint.
        Usage:
            self.ping()
        '''
        dxl_model_number, dxl_comm_result, dxl_error = self.packet_handler.ping(self.port_handler, self.servo_id)
        if dxl_comm_result != COMM_SUCCESS:
            print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
        elif dxl_error != 0:
            print("%s" % self.packet_handler.getRxPacketError(dxl_error))
        else:
            print("[ID: %03d] ping succeeded. Model number: %d" % (self.servo_id, dxl_model_number))
            return self.servo_id

    def reboot(self): # check
        ''' Reboots this joint.
        Only works in Protocol 2.0.
        Usage:
            self.reboot()
        '''
        if self.protocol_version == 2:
            dxl_comm_result, dxl_error = self.packet_handler.reboot(self.port_handler, self.servo_id)
            if dxl_comm_result != COMM_SUCCESS:
                print("%s" % self.packet_handler.getTxRxResult(dxl_comm_result))
            elif dxl_error != 0:
                print("%s" % self.packet_handler.getRxPacketError(dxl_error))
            else:
                print("[ID: %03d] reboot succeeded" % self.servo_id)
        else:
            print("Reboot is only present in Protocol 2.0.")
# -*- coding: utf-8 -*- PyDynamixel TauraBots Library Version 2.0 Supports both Protocol 1.0 and Protocol 2.0 dynamixels. Most of the code here was taken from the dynamixel_sdk examples and previous  PyDynamixel library. # Dynamixel functions # Control tables for different types of motors # Return format for functions that retrieve joint angles. True for # radians, False for degrees # If there are only motors of the same type connected in the bus the # variable below can be changed so you don't need to specify the # control table every time a new Joint object is created. This class implements low level     communication with the dynamixel     protocol. Initializes DxlComm.         port: the path to the serial device. Default is /dev/ttyUSB0.         The constructor optionally takes a baudnum argument:            baudrate = 2Mbps / (baudnum + 1)         If no baudrate or baudnum is provided, the default baudrate is 57600. # Valid protocols are only 1 or 2 # Baudnum selected in dynamixel config in RoboPlus Software # All attached joint ids # All attached joints (whole class) # Total joints attached # Connection to declared serial port # Set port baudrate # Flag to enable/disable sync and bulk functions This method attaches a list of joints so that         the communication can be handled by this class. # Every time a new joint is attached, the control tables for all # attached joints are checked. If the control tables match then # initialize sync/bulk and read/write objects # Use table of first joint as reference # Disable sync functions # End function here # Instantiates sync read and write objects # Sync Read is only present in Protocol 2.0 # Use bulk read for protocol 1.0 instead # Sync write works for both 1.0 and 2.0 Simple wrapper to not lose functionality when attaching a single joint. This method attaches a single joint so         that the communication can be handled by this class. # Registers the joint in the database # CHECK Broadcast ping to all attached joints.         Finally, checks if detected dynamixels are equal to previously attached         joints.         Only for Protocol 2.0.         Return: list of detected dynamixels. Sends goal position with sync write to all or desired servos.          If no values are sent, then it gets which servos to send goal values to from         their 'changed' param, which was modified by each joint set_goal_value() function.          The 'values' dict should have the name length of current connected joints.         Therefore, if you chose to send through the 'values' way, you will send angles         to all connected dynamixels.          Usage: (assuming 3 attached joints)             self.send_angles({dyn1_id: 90, dyn3_id: 30, dyn2_id: 60})             OR             self.send_angles({dyn3_id: pi/2, dyn2_id: pi/6, dyn1_id: pi/3}, radian=True)             OR             self.joints[0].set_goal_value(90) OR self.joints[0].set_goal_value(pi/2, radian=True)             self.send_angles() #this needs further checking # sort dict by joint id # list_values is sorted as is serial.joint_ids (from lowest to highest id) this is an adaptation from dynamixel's sdk for             the sync_write # goal_value = self.set_goal_value(s.goal_value, radian=radian) # sync write # clears buffer Sync writes the ``.goal_value'' for all the joints attached to the              port. # Unset flag # clears buffer Read angles from all attached joints.         Only available in Protocol 2.0 # no sync read for Protocol 1.0 Sync read. Only available in Protocol 2.0 # add all servos to sync read request #print("[ID: %03d] groupSyncRead addParam failed." % servo_id) # SyncRead present position # check if sync read data from each dynamixel is available # then, get save that data # put the returned value into a dict with all values and in the joints curr_value variable # return the dict Bulk reads the present position of the motors specified in the list of         ids                  Arguments:             ids: list of IDs of the motors. # Mount the bulk read message # Send it # Check that data is received # Retrieve data Enable torque for all motors connected         in this port. Disables torque for all motors connected         to this port Sets goal value (0 to 1024), from given goal angle. This method should be called for         the class to explicitly close the         open port_handler This class represents a single Dynamixel servo motor.     Contains functions to ping, reboot, get angles and send angles to the dynamixel. The constructor takes the servo id         as the argument. Argument center_value         can be set to calibrate the zero         position of the servo. # Assume the control table object was passed directly # Used to flag joints for sync_write This sets this joint's packet and port handlers to be equal to DxlComm ones.         These variables are used to communicate with dynamixel. Sets goal value (0 to 1024), from given goal angle.         Usage:             set_goal_value(90) -> angle in degrees             set_goal_value(pi/2, radian=True) -> angle in radians Sends a command to this specific servomotor to set         its goal value from a degree or radian goal angle.         Usage:             send_angle(90) -> sends 90 degree angle             OR             send_angle(pi/2, radian=True) -> send 90 degree angle, but in radians             OR             set_goal_value(90) OR set_goal_value(pi/2, radian=True)             send_angle() #if angle >= 0: # Check length to choose how many bytes to write Reads the current position of this         servomotor alone. The read position is         stored in both self.curr_angle and self.curr_value.         However, only self.curr_angle is retorned by this function. #self.curr_value -= self.center_value #TODO implement this in other functions Enables torque in this joint         Usage: self.enable_torque() Disables torque in this joint         Usage:             self.disable_torque() # check Ping this joint.         Usage:             self.ping() # check Reboots this joint.         Only works in Protocol 2.0.         Usage:             self.reboot()