ur-sock 0.3.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54d9351d7f44499bd4dada3e3a015c23d75901518451ae817b663b0b0ccf4255
-  data.tar.gz: ac3846b9dd6bae74131d2eaa3e0190b4d041e614f7335952d3d6f72084064e07
+  metadata.gz: a78431f336bb9dec101ac249d78b1ff36e0d40846b8beeec19a837e1a9e2fdee
+  data.tar.gz: 727b583ef420264d83698d0632f51853d684cd28d2bca074ab431b50990304e3
 SHA512:
-  metadata.gz: 78c4b31e86ea096df4a53cb38454ad866da02115cbcaf2e93ef0ef049ee42d746668d60cc841af189b2b1630f73664f7d2a1288a00870dda06393d4e98a128a9
-  data.tar.gz: e61971e886631b1a6aac252f7aab31ceeb5d11deee2c331bc1c207f1641354d0dc2216f97e0c039cb237e754dd2f21669aa8f28b5579d860675561134d78d586
+  metadata.gz: 98cae8207b8fcdbe4db0e99716a9b634a576bcb0384b9968e5729d49445d7ab356006f73b2818f70a04263908097f8f25728d49d3a9bbc0e492efd267dc9c6c6
+  data.tar.gz: 07d59722f52e3215ac3076837dd6bb85543e90dbc1be743b94dbb039516aed6dc6994bd57f4e6807bbccc33977ad4e1cf8965096e55cc4792d2d5f3d7c47765d

data/README.md

@@ -2,6 +2,11 @@
 
 Universal robot interface implementation in ruby. This library provides functions using different interfaces of the universal robot. Primary this was designed for the new e-series.
 
+## Requirements
+
+This software requires URControl version newer than 5.1.
+Latest supported URControl vresion: 5.5
+
 ## Getting Started
 
 This library uses 3 interfaces of the universal robot:
@@ -79,7 +84,7 @@ Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c6
 * **Florian Pauker**
 * **Jürgen Mangler**
 
-See also the list of [contributors](https://intra.acdp.at/gogs/fpauker/ua4ur/contributors) who participated in this project.
+See also the list of [contributors](https://github.com/fpauker/ua4ur/contributors) who participated in this project.
 
 ## License
 

data/lib/dashboard.rb

@@ -6,6 +6,8 @@ require 'uri'
 module UR
 
   class Dash
+    class Reconnect < Exception; end
+
     module ConnectionState
       DISCONNECTED = 'DISCONNECTED'
       CONNECTED = 'CONNECTED'
@@ -77,17 +79,16 @@ module UR
     end
 
     def load_program (programname)
-      @logger.info "loadprogram"
+      @logger.debug "loadprogram"
       send = "load " + programname + ".urp\n"
-      puts send
-      @sock.write (send)
+      @sock.write send
       line = @sock.gets.strip
-      if line.match(/^./) == 'L'
-        @logger.info line
+      if line.match(/^L/)
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Dashboard server down or not in Remote Mode')
       end
     end
 
@@ -95,11 +96,11 @@ module UR
       @sock.write("play\n")
       line = @sock.gets.strip
       if line == "Starting program"
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Dashboard server down or not in Remote Mode')
       end
     end
 
@@ -107,118 +108,140 @@ module UR
       @sock.write("stop\n")
       line = @sock.gets.strip
       if line == "Stopped"
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Dashboard server down or not in Remote Mode')
       end
     end
 
     def pause_program
       @sock.write("pause\n")
+      line = @sock.gets.strip
       if line == "Pausing program"
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Dashboard server down or not in Remote Mode')
       end
     end
 
     def shutdown
       @sock.write("shutdown\n")
+      line = @sock.gets.strip
       if line == "Shutting down"
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Dashboard server down or not in Remote Mode')
       end
     end
 
     def running?
       @sock.write("running\n")
+      line = @sock.gets.strip
       if line == "Program running: True"
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Dashboard server down or not in Remote Mode')
       end
     end
 
     def get_robotmode
       @sock.write("robotmode\n")
       line = @sock.gets.strip
-      @logger.info line
+      @logger.debug line
       result = $1.strip if line.match(/^Robotmode:\s(.+)/)
     end
 
     def get_loaded_program
-      @sock.write ("get loaded program\n")
-      line = @sock.gets.strip
+      begin
+        @sock.write ("get loaded program\n")
+        line = @sock.gets.strip
+      rescue
+        raise UR::Dash::Reconnect.new('Loaded program can not be got. Dashboard server down or not in Remote Mode')
+      end
+      @logger.debug line
       if line.match(/^Loaded program:\s(.+)/)
-        @logger.info line
-        path = $1.strip
-      else
-        @logger.error line
+        $1.strip
+      elsif line.match(/^No program loaded/)
         nil
+      else
+        raise UR::Dash::Reconnect.new('Loaded program can not be got. Dashboard server down or not in Remote Mode')
       end
     end
 
     def open_popupmessage(message)
       @sock.write ("popup " + message.to_s + "\n")
-      @logger.info @sock.gets.strip
+      @logger.debug @sock.gets.strip
     end
 
     def close_popupmessage
       @sock.write ("close popup\n")
-      @logger.info @sock.gets.strip
+      @logger.debug @sock.gets.strip
     end
 
     def add_to_log(message)
       @sock.write ("addToLog " + message.to_s + "\n")
       line = @sock.gets.strip
       if line.match(/^Added log message/)
-        @logger.info line
+        @logger.debug line
       else
         @logger.error line
+        raise UR::Dash::Reconnect.new('Dashboard server down or not in Remote Mode')
       end
     end
 
     def is_program_saved?
       @sock.write("isProgramSaved\n")
+      line = @sock.gets.strip
       if line == "True"
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Cant determine if program is saved. Dashboard server down or not in Remote Mode')
       end
     end
 
     def get_program_state
       @sock.write("programState\n")
       line = @sock.gets.strip
-      @logger.info line
+      @logger.debug line
       line
     end
 
     def get_polyscope_version
       @sock.write("PolyscopeVersion\n")
       line = @sock.gets.strip
-      @logger.info line
+      @logger.debug line
       line
     end
 
+    def set_operation_mode_manual
+      @sock.write("set operational mode manual\n")
+      line = @sock.gets.strip
+      if line.match(/^S/)
+        @logger.debug line
+      else
+        @logger.error line
+        raise UR::Dash::Reconnect.new('Cant set operation mode manual. Dashboard server down or not in Remote Mode')
+      end
+    end
+
     def set_operation_mode_auto
       @sock.write("set operational mode automatic\n")
       line = @sock.gets.strip
       if line.match(/^S/)
-        @logger.info line
+        @logger.debug line
       else
         @logger.error line
+        raise UR::Dash::Reconnect.new('Cant set operation mode automatic. Dashboard server down or not in Remote Mode')
       end
     end
 
@@ -226,96 +249,169 @@ module UR
       @sock.write("clear operational mode\n")
       line = @sock.gets.strip
       if line.match(/^operational/)
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
+        raise UR::Dash::Reconnect.new('Cant clear operation mode. Dashboard server down or not in Remote Mode')
       end
     end
 
     def power_on
       @sock.write("power on\n")
+      line = @sock.gets.strip
       if line.match(/^Powering/)
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Cant power on. Dashboard server down or not in Remote Mode')
       end
     end
 
     def power_off
       @sock.write("power off\n")
+      line = @sock.gets.strip
       if line.match(/^Powering/)
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Cant power off. Dashboard server down or not in Remote Mode')
       end
     end
 
     def break_release
       @sock.write("brake release\n")
+      line = @sock.gets.strip
       if line.match(/^Brake/)
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Cant release breaks. Dashboard server down or not in Remote Mode')
       end
     end
 
     def get_safety_mode
       @sock.write("safetymode\n")
       line = @sock.gets.strip
-      @logger.info line
+      @logger.debug line
       result = $1.strip if line.match(/^Safetymode:\s(.+)/)
     end
 
     def unlock_protective_stop
       @sock.write("unlock protective stop\n")
+      line = @sock.gets.strip
       if line.match(/^Protective/)
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Cant unlock protective stop. Dashboard server down or not in Remote Mode')
       end
     end
 
     def close_safety_popup
       @sock.write("close safety popup\n")
+      line = @sock.gets.strip
       if line.match(/^closing/)
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Cant close safety popup. Dashboard server down or not in Remote Mode')
       end
     end
 
     def load_installation
       @sock.write("load installation\n")
+      line = @sock.gets.strip
       if line.match(/^Loading/)
-        @logger.info line
+        @logger.debug line
         true
       else
         @logger.error line
-        nil
+        raise UR::Dash::Reconnect.new('Cant load installation. Dashboard server down or not in Remote Mode')
       end
     end
 
     def restart_safety
       @sock.write("restart safety\n")
+      line = @sock.gets.strip
       if line.match(/^Brake/)
-        @logger.info line
+        @logger.debug line
         true
+      elsif line.match(/^could not understand/)
+        @logger.warn'Could not execute restart_safety: Please upgrade to current version'
+        nil
       else
         @logger.error line
+        raise UR::Dash::Reconnect.new('Cant restart safety. Dashboard server down or not in Remote Mode')
+      end
+    end
+
+    def get_operational_mode
+      @sock.write("get operational mode\n")
+      line = @sock.gets.strip
+      if line == "MANUAL" || line == "AUTOMATIC"
+        @logger.debug line
+        line
+      elsif line == "NONE"
+        @logger.warn'No password set, so no modes variable is available'
+        nil
+      elsif line.match(/^could not understand/)
+        @logger.warn'Could not execute get_operational_mode: Please upgrade to current version'
         nil
+      else
+        @logger.error line
+        raise UR::Dash::Reconnect.new('Cant get operational mode. Dashboard server down or not in Remote Mode')
       end
     end
 
+    def is_in_remote_control
+      @sock.write("is in remote control\n")
+      line = @sock.gets.strip
+      if line.match(/^could not understand/)
+        @logger.warn'Could not execute is_in_remote_control: Please upgrade to current version'
+        nil
+      elsif line == 'true' || line == 'false'
+        @logger.debug line
+        line
+      else
+        @logger.error line
+        raise UR::Dash::Reconnect.new('Cant determine if robot is in remote control mode. Dashboard server down maybe down')
+      end
+    end
+
+    def get_serial_number
+      @sock.write("get serial number\n")
+      line = @sock.gets.strip
+      if line.match(/^could not understand/)
+        @logger.warn'Could not execute get_serial_number: Please upgrade to current version'
+        nil
+      elsif line.match(/^\d+$/)
+        @logger.debug line
+        line
+      else
+        @logger.error line
+        raise UR::Dash::Reconnect.new('Cant get serial number. Dashboard server down maybe down or not in Remote Mode')
+      end
+    end
+
+    def get_robot_model
+      @sock.write("get robot model\n")
+      line = @sock.gets.strip
+      if line.match(/^could not understand/)
+        @logger.warn'Could not execute get_robot_model: Please upgrade to current version'
+        nil
+      elsif line.match(/^UR/)
+        @logger.debug line
+        line
+      else
+        @logger.error line
+        raise UR::Dash::Reconnect.new('Cant get robot model. Dashboard server down maybe down or not in Remote Mode')
+      end
+    end
   end
 end

data/lib/psi.rb

@@ -41,18 +41,27 @@ module UR
         @sock.close
         @sock = nil
         @conn_state = ConnectionState::DISCONNECTED
-        @logger.info "Connection closed " + @hostname + ":" + @port.to_s
+        @logger.info 'Connection closed ' + @hostname + ':' + @port.to_s
       end
     end
 
-    def transfer(filename)
+    def execute_ur_script_file(filename)
+      @logger.info 'Executing UR Script File: ' + filename
       File.open(filename) do |file|
         while not file.eof?
-          @sock.write(file.read(1024))
+          @sock.write(file.readline)
+          line = @sock.gets.strip
+          @logger.debug line
         end
       end
     end
 
+    def execute_ur_script(str)
+      @logger.info 'Executing UR Script ...'
+      @sock.write(str)
+      line = @sock.gets.strip
+      @logger.debug line
+    end
   end
 
 end

data/lib/rtde.rb

@@ -7,17 +7,66 @@ module UR
 
   class Rtde
     PROTOCOL_VERSION = 2
-    @@robotmode = {-1 => 'No Controller',
-                  0 => 'Disconnected',
-                  1 => 'Confirm Safety',
-                  2 => 'Booting',
-                  3 => 'Power Off',
-                  4 => 'Power On',
-                  5 => 'Idle',
-                  6 => 'Backdrive',
-                  7 => 'Running',
-                  8 => 'Updating Firmware'
-                }
+    ROBOTMODE = {
+      -1 => 'No Controller',
+       0 => 'Disconnected',
+       1 => 'Confirm Safety',
+       2 => 'Booting',
+       3 => 'Power Off',
+       4 => 'Power On',
+       5 => 'Idle',
+       6 => 'Backdrive',
+       7 => 'Running',
+       8 => 'Updating Firmware'
+    }
+    PROGRAMSTATE = {
+      1 => 'Stopped',
+      2 => 'Playing',
+      4 => 'Paused'
+    }
+    JOINTMODE = {
+      235 => 'JOINT_MODE_RESET',
+      236 => 'JOINT_MODE_SHUTTING_DOWN',
+      237 => 'JOINT_PART_D_CALIBRATION_MODE (INTERNAL USE ONLY)',
+      238 => 'JOINT_MODE_BACKDRIVE',
+      239 => 'JOINT_MODE_POWER_OFF',
+      240 => 'JOINT_MODE_READY_FOR_POWER_OFF (FROM VERSION 5.1)',
+      245 => 'JOINT_MODE_NOT_RESPONDING',
+      246 => 'JOINT_MODE_MOTOR_INITIALISATION',
+      247 => 'JOINT_MODE_BOOTING',
+      248 => 'JOINT_PART_D_CALIBRATION_ERROR_MODE (INTERNAL USE ONLY)',
+      249 => 'JOINT_MODE_BOOTLOADER',
+      250 => 'JOINT_CALIBRATION_MODE (INTERNAL USE ONLY)',
+      251 => 'JOINT_MODE_VIOLATION',
+      252 => 'JOINT_MODE_FAULT',
+      253 => 'JOINT_MODE_RUNNING',
+      255 => 'JOINT_MODE_IDLE'
+    }
+    SAFETYMODE = {
+      11 => 'SAFETY_MODE_UNDEFINED_SAFETY_MODE',
+      10 => 'SAFETY_MODE_VALIDATE_JOINT_ID',
+      9 => 'SAFETY_MODE_FAULT',
+      8 => 'SAFETY_MODE_VIOLATION',
+      7 => 'SAFETY_MODE_ROBOT_EMERGENCY_STOP',
+      6 => 'SAFETY_MODE_SYSTEM_EMERGENCY_STOP',
+      5 => 'SAFETY_MODE_SAFEGUARD_STOP',
+      4 => 'SAFETY_MODE_RECOVERY',
+      3 => 'SAFETY_MODE_PROTECTIVE_STOP',
+      2 => 'SAFETY_MODE_REDUCED',
+      1 => 'SAFETY_MODE_NORMAL'
+    }
+
+    TOOLMODE = {
+      235 => 'JOINT_MODE_RESET',
+      236 => 'JOINT_MODE_SHUTTING_DOWN',
+      239 => 'JOINT_MODE_POWER_OFF',
+      245 => 'JOINT_MODE_NOT_RESPONDING',
+      247 => 'JOINT_MODE_BOOTING',
+      249 => 'JOINT_MODE_BOOTLOADER',
+      252 => 'JOINT_MODE_FAULT',
+      253 => 'JOINT_MODE_RUNNING',
+      255 => 'JOINT_MODE_IDLE'
+    }
 
     module Command #{{{
       RTDE_REQUEST_PROTOCOL_VERSION = 86        # ASCII V
@@ -37,10 +86,6 @@ module UR
       PAUSED = 3
     end #}}}
 
-    def get_robotmode
-      @@robotmode
-    end
-
     def initialize(host, logger=Logger.new(STDOUT,level: :INFO)) #{{{
       host = '//' + host if host !~ /\/\//
       uri = URI::parse(host)
@@ -56,7 +101,7 @@ module UR
     def connect #{{{
       return if @sock
 
-      @buf = '' # buffer data in binary format
+      @buf = ''.b # buffer data in binary format
       begin
         @sock = Socket.new Socket::AF_INET, Socket::SOCK_STREAM
         @sock.setsockopt Socket::SOL_SOCKET, Socket::SO_REUSEADDR, 1
@@ -114,18 +159,18 @@ module UR
         @logger.error 'Cannot send when RTDE synchroinization is inactive'
         return
       end
-      if not @input_config.key?(input_data.recipe_id)
+      if not @input_config.include? input_data.recipe_id
         @logger.error 'Input configuration id not found: ' + @input_data.recipe_id
         return
       end
       config = @input_config[input_data.recipe_id]
       send_all Command::RTDE_DATA_PACKAGE, config.pack(input_data)
     end #}}}
-    def send_and_receive(cmd, payload = '') #{{{
+    def send_and_receive(cmd, payload = ''.b) #{{{
       @logger.debug 'Start send_and_receive'
       send_all(cmd, payload) ? recv(cmd) : nil
     end #}}}
-    def send_all(command, payload = '') #{{{
+    def send_all(command, payload = ''.b) #{{{
       fmt = 'S>C'
       size = ([0,0].pack fmt).length + payload.length
       buf = [size, command].pack(fmt) + payload
@@ -216,16 +261,16 @@ module UR
       return true
     end #}}}
 
-    def receive #{{{
+    def receive(binary=false) #{{{
       @logger.debug 'Start receive'
       if !@output_config
         @logger.error 'Output configuration not initialized'
         nil
       end
       return nil if @conn_state != ConnectionState::STARTED
-      recv Command::RTDE_DATA_PACKAGE
+      recv Command::RTDE_DATA_PACKAGE, binary
     end #}}}
-    def recv(command) #{{{
+    def recv(command, binary=false) #{{{
       @logger.debug 'Start recv' + @buf.to_s
       while connected?
         readable, _, xlist = IO.select([@sock], [], [@sock])
@@ -266,7 +311,7 @@ module UR
             end
             if packet_header.command == command
               @logger.debug 'returning becuase of packet_header.command == command'
-              return data
+              return  binary ? packet[1..-1] : data
             else
               @logger.info 'skipping package(2)'
             end

data/lib/serialize.rb

@@ -64,6 +64,8 @@ module UR
         data[offset...offset+size].map(&:to_i)
       elsif data_type == 'INT32' or data_type == 'UINT8'
         data[offset].to_i
+      elsif data_type == 'BOOL'
+        data[offset].to_i > 0 ? true : false
       else
         raise TypeError.new('unpack_field: unknown data type: ' + data_type)
       end
@@ -131,7 +133,6 @@ module UR
         rmd.id = buf.unpack('C')[0]
         rmd.types = buf[1..-1].split(',')
         rmd.fmt = 'C'
-        #p rmd.types
         rmd.types.each do |i|
           if i == 'INT32'
             rmd.fmt += 'i>'
@@ -151,10 +152,12 @@ module UR
             rmd.fmt += 'Q>'
           elsif i == 'UINT8'
             rmd.fmt += 'C'
+          elsif i == 'BOOL'
+            rmd.fmt += '?'
           elsif i == 'IN_USE'
-            raise TypeError 'An input parameter is already in use.'
+            #raise TypeError 'An input parameter is already in use.'
           else
-            raise TypeError 'Unknown data type: ' + i
+            #raise TypeError 'Unknown data type: ' + i
           end
         end
         rmd

data/ur-sock.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "ur-sock"
-  s.version          = "0.3.2"
+  s.version          = "1.0.2"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0"
   s.summary          = "Preliminary release of Universal Robot (UR) Socket Communication."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ur-sock
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.2
 platform: ruby
 authors:
 - Florian Pauker
@@ -9,28 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-smart
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.6
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.6
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: see https://github.com/fpauker/ur-sock
 email: florian.pauker@gmail.com
 executables: []
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Preliminary release of Universal Robot (UR) Socket Communication.