mc_protocol_e 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b36cc1712b0d48b344b81c44b982cb5f5d55dc0bb392416cd39ef74ea625943a
+  data.tar.gz: b87f147713b5ecb2170ae12858d59fef773cec849a3d34858eae14b873b20a2b
+SHA512:
+  metadata.gz: cf757452f3bf39db9311d5de2a1da4538d599e8b37c5e69da93cd5220b09e8a7e616e8b1906684cec05920c54ee88b7a95858da005106e051380dcc4d3f2b6a9
+  data.tar.gz: b0905894fafd044aa1c01068d1f2f82d4d7c9569d15ecda2e4cdedf6929bcb9cad6fd7b8d42a355d0ff5d323054e8ec4028b1c483ab2295d1e80d3b55126d6c3

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.idea/
+/vendor/
+.rubocop-*
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+inherit_from:
+  - https://gist.githubusercontent.com/commis1059/5ce7db028de5fe00fe88392ff7a95278/raw/c00065917dada0e4aa40669fcde90411e70ce82c/.rubocop.yml

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yusuke.saito@smartscape.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mc_protocol_e.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    mc_protocol_e (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  mc_protocol_e!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 yusuke.saito
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# McProtocolE
+
+McProtocolE is an implementation of MC protocol client over ethernet by Ruby. MC protocol is communication protocol to access MELSEC (PLC). See below for details.
+
+https://dl.mitsubishielectric.com/dl/fa/document/manual/plc/sh080008/sh080008x.pdf
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mc_protocol_e'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mc_protocol_e
+
+## Example
+Below is an example of use for this library.
+
+```ruby
+require 'optparse'
+require_relative 'frame_1e/request'
+require_relative 'frame_1e/access_route'
+require_relative 'frame_1e/device_range'
+require_relative 'frame_3e/request'
+require_relative 'frame_3e/access_route'
+require_relative 'frame_3e/device_range'
+
+opts = ARGV.getopts("h:p:f:", "rw:", "device_num:", "device_points:", "values:")
+raise ArgumentError, "required option is not specified" unless %w[h p f device_num device_points].all? {|key| opts[key] }
+
+req =
+  case opts["f"]
+  when "1e"
+    case opts["rw"]
+    when "r"
+      McProtocolE::Frame1e::Request.batch_read_in_word(
+        access_route: McProtocolE::Frame1e::AccessRoute.own_station,
+        wait_sec: 3,
+        device_range: McProtocolE::Frame1e::DeviceRange.data_register(device_num: opts["device_num"].to_i, device_points: opts["device_points"].to_i)
+      )
+    when "w"
+      raise ArgumentError, "values is required" unless opts["values"]
+
+      McProtocolE::Frame1e::Request.batch_write_in_word(
+        access_route: McProtocolE::Frame1e::AccessRoute.own_station,
+        wait_sec: 3,
+        device_range: McProtocolE::Frame1e::DeviceRange.data_register(device_num: opts["device_num"].to_i, device_points: opts["device_points"].to_i),
+        values: opts["values"].split(",").map(&:to_i),
+      )
+    else
+      raise ArgumentError
+    end
+  when "3e"
+    case opts["rw"]
+    when "r"
+      McProtocolE::Frame3e::Request.batch_read_in_word(
+        access_route: McProtocolE::Frame3e::AccessRoute.own_station,
+        wait_sec: 3,
+        device_range: McProtocolE::Frame3e::DeviceRange.data_register(device_num: opts["device_num"].to_i, device_points: opts["device_points"].to_i)
+      )
+    when "w"
+      raise ArgumentError, "values is required" unless opts["values"]
+
+      McProtocolE::Frame3e::Request.batch_write_in_word(
+        access_route: McProtocolE::Frame3e::AccessRoute.own_station,
+        wait_sec: 3,
+        device_range: McProtocolE::Frame3e::DeviceRange.data_register(device_num: opts["device_num"].to_i, device_points: opts["device_points"].to_i),
+        values: opts["values"].split(",").map(&:to_i),
+      )
+    else
+      raise ArgumentError
+    end
+  else
+    raise ArgumentError
+  end
+
+McProtocolE::Client.start(address: opts["h"], port: opts["p"].to_i) {|client|
+  pp req.to_b
+  res = client.request(req)
+  pp res.map {|raw| raw.unpack("s").first }
+}
+
+```
+
+## Limitations
+
+* Support only TCP.
+* Support only binary code.
+* Support only below frames.
+    * 3E frame
+    * 1E frame
+* Support only below commands.
+    * Batch read in word units (0401)
+    * Batch write in word units (1401)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mc_protocol_e"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mc_protocol_e.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "mc_protocol_e/client"
+require "mc_protocol_e/version"

data/lib/mc_protocol_e/client.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'socket'
+
+module McProtocolE
+  # This client shows a MC protocol client.
+  class Client
+
+    class NotStartedError < StandardError; end
+
+    DEFAULT_OPEN_TIMEOUT = 3
+    DEFAULT_READ_TIMEOUT = 3
+
+    # Constructor.
+    # @param [String] address server IP address
+    # @param [Integer] port server port number
+    # @param [Numeric] open_timeout second of open timeout
+    # @param [Numeric] read_timeout second of read timeout
+    def initialize(address:, port:, open_timeout: DEFAULT_OPEN_TIMEOUT, read_timeout: DEFAULT_READ_TIMEOUT)
+      @address = address
+      @port = port
+      @open_timeout = open_timeout
+      @read_timeout = read_timeout
+      @socket = nil
+    end
+
+    # Starts MC protocol communication.
+    # @param [String] address IP address
+    # @param [Integer] port port number
+    # @param [Numeric] open_timeout second of open timeout
+    # @param [Numeric] read_timeout second of read timeout
+    # @yield [client] MC protocol client
+    def self.start(address:, port:, open_timeout: DEFAULT_OPEN_TIMEOUT, read_timeout: DEFAULT_READ_TIMEOUT, &block)
+      client = new(address: address, port: port, open_timeout: open_timeout, read_timeout: read_timeout)
+
+      if block_given?
+        client.start(&block)
+      else
+        client
+      end
+    end
+
+    # Closes MC protocol communication.
+    def close
+      socket.close if started?
+    end
+
+    # Sends request.
+    # @param [Request] req request
+    # @return [Object] response
+    # @raise [NotStartedError] when not started
+    def request(req)
+      raise NotStartedError, "not started" unless started?
+
+      req.exec(socket, read_timeout)
+    end
+
+    # Starts MC protocol communication.
+    def start
+      @socket = Socket.tcp(address, port, connect_timeout: open_timeout) unless started?
+
+      if block_given?
+        begin
+          yield self
+        ensure
+          close
+        end
+      else
+        self
+      end
+    end
+
+    # Returns true if communication has started.
+    def started?
+      socket && !socket.closed?
+    end
+
+    private
+
+    attr_reader :address, :port, :open_timeout, :read_timeout, :socket
+
+  end
+end

data/lib/mc_protocol_e/frame_1e/access_route.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module McProtocolE
+  module Frame1e
+    # This class shows a access route.
+    class AccessRoute
+
+      OWN_PC_NUM = 255
+
+      attr_reader :pc_num
+
+      # Constructor.
+      # @param [Integer] pc_num PC number
+      def initialize(pc_num:)
+        @pc_num = pc_num
+      end
+
+      # Returns instance of own station.
+      # @return [AccessRoute] a access route to own station
+      def self.own_station
+        new(pc_num: OWN_PC_NUM)
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        [pc_num].pack("v")[0]
+      end
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_1e/batch_read_in_word.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module McProtocolE
+  module Frame1e
+    # This class shows a command to batch read in word.
+    class BatchReadInWord
+      extend Forwardable
+
+      REQUEST_HEADER = "\x01".b
+      RESPONSE_HEADER = "\x81".b
+
+      attr_reader :request_header
+      def_delegators :@device_range, :to_b
+
+      # Constructor.
+      # @param [DeviceRange] device_range device range
+      def initialize(device_range:)
+        @request_header = REQUEST_HEADER
+        @device_range = device_range
+      end
+
+      # Returns array of word.
+      # @param [Response] res response
+      # @return[Array] array of word
+      def parse(res)
+        res.data&.each_char&.each_slice(2)&.map(&:join)
+      end
+
+      private
+
+      attr_reader :device_range
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_1e/batch_write_in_word.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module McProtocolE
+  module Frame1e
+    # This class shows a command to batch read in word.
+    class BatchWriteInWord
+      extend Forwardable
+
+      REQUEST_HEADER = "\x03".b
+      RESPONSE_HEADER = "\x83".b
+
+      attr_reader :request_header
+
+      # Constructor.
+      # @param [DeviceRange] device_range device range
+      # @param [Array<Integer>] values values to write
+      # @raise [ArgumentError] when arguments is invalid
+      def initialize(device_range:, values:)
+        @request_header = REQUEST_HEADER
+        @device_range = device_range
+        @values = values
+
+        validate
+      end
+
+      # Returns array of word.
+      # @param [Response] res response
+      # @return[Array] array of word
+      def parse(res)
+        res.data&.each_char&.each_slice(2)&.map(&:join)
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        @to_b ||= device_range.to_b + values.pack("v*")
+      end
+
+      private
+
+      attr_reader :device_range, :values
+
+      def validate
+        raise ArgumentError, "device points have to equal values size" unless device_range.size == values.size
+        raise ArgumentError, "all value have to be an integer" unless values.all? {|value| value.is_a?(Integer) }
+
+        true
+      end
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_1e/device_range.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module McProtocolE
+  module Frame1e
+    # This class shows a device range.
+    class DeviceRange
+
+      FIXED_VALUE = "\x00".b
+
+      module DeviceCode
+        DATA_REGISTER = "\x20\x44".b
+      end
+
+      # Constructor.
+      # @param [String] device_code device code
+      # @param [Integer] device_num first device number in range
+      # @param [Integer] device_points number in range
+      def initialize(device_code:, device_num:, device_points:)
+        @device_code = device_code
+        @device_num = device_num
+        @device_points = device_points
+      end
+
+      # Returns device range of data register.
+      # @param [Integer] device_num first device number in range
+      # @param [Integer] device_points number in range
+      def self.data_register(device_num:, device_points:)
+        new(device_code: DeviceCode::DATA_REGISTER, device_num: device_num, device_points: device_points)
+      end
+
+      # Returns range size.
+      # @return [Integer] range size
+      def size
+        device_points
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        [[device_num].pack("V"), device_code, [device_points].pack("v")[0], FIXED_VALUE].join
+      end
+
+      private
+
+      attr_reader :device_code, :device_num, :device_points
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_1e/request.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative 'batch_read_in_word'
+require_relative 'batch_write_in_word'
+require_relative 'response'
+
+module McProtocolE
+  module Frame1e
+    # This class shows a request of MC protocol.
+    class Request
+
+      DEFAULT_READ_TIMEOUT = 3
+
+      # Constructor.
+      # @param [AccessRoute] access_route access route
+      # @param [Numeric] wait_sec waiting second
+      # @param [Object] command command of MC protocol
+      def initialize(access_route:, wait_sec:, command:)
+        @sub_header = command.request_header
+        @access_route = access_route
+        @wait_sec = WaitSec.new(wait_sec)
+        @command = command
+      end
+
+      # Returns a request to batch read.
+      # @param [AccessRoute] access_route access route
+      # @param [Numeric] wait_sec waiting second
+      # @param [DeviceRange] device_range device_range
+      def self.batch_read_in_word(access_route:, wait_sec:, device_range:)
+        new(access_route: access_route, wait_sec: wait_sec, command: BatchReadInWord.new(device_range: device_range))
+      end
+
+      # Returns a request to batch write.
+      # @param [AccessRoute] access_route access route
+      # @param [Numeric] wait_sec waiting second
+      # @param [DeviceRange] device_range device_range
+      # @param [Array] values values to write
+      def self.batch_write_in_word(access_route:, wait_sec:, device_range:, values:)
+        new(access_route: access_route, wait_sec: wait_sec, command: BatchWriteInWord.new(device_range: device_range, values: values))
+      end
+
+      # Writes and returns a response.
+      # @param [IO] socket TCP socket
+      # @param [Integer] read_timeout read timeout second
+      # @return [Object] responce
+      def exec(socket, read_timeout = DEFAULT_READ_TIMEOUT)
+        socket.write(to_b)
+        res = Response.recv(socket, read_timeout)
+        command.parse(res)
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        sub_header + access_route.to_b + wait_sec.to_b + command.to_b
+      end
+
+      private
+
+      attr_reader :sub_header, :access_route, :wait_sec, :command
+
+    end
+
+    # This class shows waiting second for MC protocol.
+    class WaitSec
+
+      def initialize(sec)
+        @sec = sec
+      end
+
+      def to_b
+        return @binary if @binary
+
+        quarter_sec = (sec * 4).to_i
+        @binary = [quarter_sec].pack("v")
+      end
+
+      private
+
+      attr_reader :sec
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_1e/response.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+module McProtocolE
+  module Frame1e
+    # This class shows a responce of MC protocol.
+    class Response
+
+      class TimeoutError < Timeout::Error; end
+
+      DEFAULT_READ_TIMEOUT = 3
+      MAX_RECV_LEN = 1024 * 1024
+      SUCCEED_CODE = 0
+
+      attr_reader :data
+
+      # Constructor.
+      # @param [String] raw_res binary string of response
+      def initialize(raw_res)
+        @sub_header = raw_res[0]
+        @code = raw_res[1].unpack1("C")
+        @data = raw_res[2..-1] || ""
+      end
+
+      # Receives responce and returns.
+      # @param [IO] socket TCP socket
+      # @param [Integer] read_timeout read timeout second
+      # @return [Responce] received a response
+      def self.recv(socket, read_timeout = DEFAULT_READ_TIMEOUT)
+        selected = IO.select([socket], nil, nil, read_timeout)
+        raise TimeoutError unless selected
+
+        raw_res = socket.recv(MAX_RECV_LEN)
+        new(raw_res)
+      end
+
+      # Returns true if a command succeed.
+      def succeed?
+        code == SUCCEED_CODE
+      end
+
+      # Returns true if a command failed.
+      def failed?
+        !succeed?
+      end
+
+      private
+
+      attr_reader :code
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_3e/access_route.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module McProtocolE
+  module Frame3e
+    # This class shows a access route.
+    class AccessRoute
+
+      OWN_NETWORK_NUM = 0
+      OWN_PC_NUM = 255
+      NORMAL_UNIT_IO_NUM = 1023
+      NORMAL_UNIT_STATION_NUM = 0
+
+      attr_reader :network_num, :pc_num, :unit_io_num, :unit_station_num
+
+      # Constructor.
+      # @param [Integer] network_num network number
+      # @param [Integer] pc_num PC number
+      # @param [Integer] unit_io_num unit io number
+      # @param [Integer] unit_station_num unit station number
+      def initialize(network_num:, pc_num:, unit_io_num:, unit_station_num:)
+        @network_num = network_num
+        @pc_num = pc_num
+        @unit_io_num = unit_io_num
+        @unit_station_num = unit_station_num
+      end
+
+      # Returns instance from binary string.
+      # @param [String] raw binary string showing a access route
+      # @return [AccessRoute] a access route
+      def self.from_raw(raw)
+        raise ArgumentError, "raw string is not access route" unless raw && raw.size >= 5
+
+        new(
+          network_num: raw[0].unpack1("C"),
+          pc_num: raw[1].unpack1("C"),
+          unit_io_num: raw[2..3].unpack1("v"),
+          unit_station_num: raw[4].unpack1("C"),
+        )
+      end
+
+      # Returns instance of own station.
+      # @return [AccessRoute] a access route to own station
+      def self.own_station
+        new(network_num: OWN_NETWORK_NUM, pc_num: OWN_PC_NUM, unit_io_num: NORMAL_UNIT_IO_NUM, unit_station_num: NORMAL_UNIT_STATION_NUM)
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        [
+          [network_num].pack("v")[0],
+          [pc_num].pack("v")[0],
+          [unit_io_num].pack("v"),
+          [unit_station_num].pack("v")[0],
+        ].join
+      end
+
+      # Returns string.
+      # @return [String] string
+      def to_s
+        "network num: #{network_num} pc num: #{pc_num} unit io num: #{unit_io_num} unit station num: #{unit_station_num}"
+      end
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_3e/base_command.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'error_info'
+
+module McProtocolE
+  module Frame3e
+
+    class CommandError < StandardError; end
+
+    class BaseCommand
+
+      def initialize(command)
+        @command = command
+      end
+
+      def parse(res)
+        raise CommandError, ErrorInfo.new(res.code, res.data, self).to_s unless res.succeed?
+      end
+
+      private
+
+      attr_reader :command
+
+    end
+
+  end
+end

data/lib/mc_protocol_e/frame_3e/batch_read_in_word.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'base_command'
+
+module McProtocolE
+  module Frame3e
+    # This class shows a command to batch read in word.
+    class BatchReadInWord < BaseCommand
+
+      COMMAND = "\x01\x04\x00\x00".b
+
+      # Constructor.
+      # @param [DeviceRange] device_range device range
+      def initialize(device_range:)
+        super(COMMAND)
+        @device_range = device_range
+      end
+
+      # Returns array of word.
+      # @param [Response] res response
+      # @return[Array] array of word
+      def parse(res)
+        super(res)
+
+        res.data&.each_char&.each_slice(2)&.map(&:join)
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        @to_b ||= command + device_range.to_b
+      end
+
+      private
+
+      attr_reader :device_range
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_3e/batch_write_in_word.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'base_command'
+
+module McProtocolE
+  module Frame3e
+    # This class shows a command to batch write in word.
+    class BatchWriteInWord < BaseCommand
+
+      COMMAND = "\x01\x14\x00\x00".b
+
+      # Constructor.
+      # @param [DeviceRange] device_range device range
+      # @param [Array<Integer>] values values to write
+      # @raise [ArgumentError] when arguments is invalid
+      def initialize(device_range:, values:)
+        super(COMMAND)
+        @device_range = device_range
+        @values = values
+
+        validate
+      end
+
+      # Returns array of word.
+      # @param [Response] res response
+      # @return[Array] array of word
+      def parse(res)
+        super(res)
+
+        res.data&.each_char&.each_slice(2)&.map(&:join)
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        @to_b ||= command + device_range.to_b + values.pack("v*")
+      end
+
+      private
+
+      attr_reader :device_range, :values
+
+      def validate
+        raise ArgumentError, "device points have to equal values size" unless device_range.size == values.size
+        raise ArgumentError, "all value have to be an integer" unless values.all? {|value| value.is_a?(Integer) }
+
+        true
+      end
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_3e/device_range.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module McProtocolE
+  module Frame3e
+    # This class shows a device range.
+    class DeviceRange
+
+      module DeviceCode
+        DATA_REGISTER = "\xA8".b
+      end
+
+      # Constructor.
+      # @param [String] device_code device code
+      # @param [Integer] device_num first device number in range
+      # @param [Integer] device_points number in range
+      def initialize(device_code:, device_num:, device_points:)
+        @device_code = device_code
+        @device_num = device_num
+        @device_points = device_points
+      end
+
+      # Returns device range of data register.
+      # @param [Integer] device_num first device number in range
+      # @param [Integer] device_points number in range
+      def self.data_register(device_num:, device_points:)
+        new(device_code: DeviceCode::DATA_REGISTER, device_num: device_num, device_points: device_points)
+      end
+
+      # Returns range size.
+      # @return [Integer] range size
+      def size
+        device_points
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        [[device_num].pack("V")[0..2], device_code, [device_points].pack("v")].join
+      end
+
+      private
+
+      attr_reader :device_code, :device_num, :device_points
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_3e/error_info.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'access_route'
+
+module McProtocolE
+  module Frame3e
+    # This class shows a error information.
+    class ErrorInfo
+
+      # Constructor.
+      # @param [Integer] code MC protocol error code
+      # @param [String] data response
+      # @param [Object] command command
+      def initialize(code, data, command)
+        @code = code
+        @access_route = AccessRoute.from_raw(data[0..4])
+        @command = command
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_s
+        "code: #{code} command: #{command.class.name} #{access_route}"
+      end
+
+      private
+
+      attr_reader :code, :access_route, :command
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_3e/request.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require_relative 'batch_read_in_word'
+require_relative 'batch_write_in_word'
+require_relative 'response'
+
+module McProtocolE
+  module Frame3e
+    # This class shows a request of MC protocol.
+    class Request
+
+      DEFAULT_READ_TIMEOUT = 3
+      SUB_HEADER = "\x50\x00".b
+
+      # Constructor.
+      # @param [AccessRoute] access_route access route
+      # @param [Numeric] wait_sec waiting second
+      # @param [Object] command command of MC protocol
+      def initialize(access_route:, wait_sec:, command:)
+        @sub_header = SUB_HEADER
+        @access_route = access_route
+        @wait_sec = WaitSec.new(wait_sec)
+        @command = command
+      end
+
+      # Returns a request to batch read.
+      # @param [AccessRoute] access_route access route
+      # @param [Numeric] wait_sec waiting second
+      # @param [DeviceRange] device_range device_range
+      def self.batch_read_in_word(access_route:, wait_sec:, device_range:)
+        new(access_route: access_route, wait_sec: wait_sec, command: BatchReadInWord.new(device_range: device_range))
+      end
+
+      # Returns a request to batch write.
+      # @param [AccessRoute] access_route access route
+      # @param [Numeric] wait_sec waiting second
+      # @param [DeviceRange] device_range device_range
+      # @param [Array] values values to write
+      def self.batch_write_in_word(access_route:, wait_sec:, device_range:, values:)
+        new(access_route: access_route, wait_sec: wait_sec, command: BatchWriteInWord.new(device_range: device_range, values: values))
+      end
+
+      # Writes and returns a response.
+      # @param [IO] socket TCP socket
+      # @param [Integer] read_timeout read timeout second
+      # @return [Object] responce
+      def exec(socket, read_timeout = DEFAULT_READ_TIMEOUT)
+        socket.write(to_b)
+        res = Response.recv(socket, read_timeout)
+        command.parse(res)
+      end
+
+      # Returns binary string.
+      # @return [String] binary string
+      def to_b
+        sub_header + access_route.to_b + request_len_to_b + wait_sec.to_b + command.to_b
+      end
+
+      private
+
+      attr_reader :sub_header, :access_route, :wait_sec, :command
+
+      def request_len_to_b
+        [wait_sec.to_b.size + command.to_b.size].pack("v")
+      end
+
+    end
+
+    # This class shows waiting second for MC protocol.
+    class WaitSec
+
+      def initialize(sec)
+        @sec = sec
+      end
+
+      def to_b
+        return @binary if @binary
+
+        quarter_sec = (sec * 4).to_i
+        @binary = [quarter_sec].pack("v")
+      end
+
+      private
+
+      attr_reader :sec
+
+    end
+  end
+end

data/lib/mc_protocol_e/frame_3e/response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+module McProtocolE
+  module Frame3e
+    # This class shows a responce of MC protocol.
+    class Response
+
+      class TimeoutError < Timeout::Error; end
+
+      DEFAULT_READ_TIMEOUT = 3
+      SUB_HEADER = "\xD0\x00".b
+      MAX_RECV_LEN = 1024 * 1024
+      SUCCEED_CODE = 0
+
+      attr_reader :data
+
+      # Constructor.
+      # @param [String] raw_res binary string of response
+      def initialize(raw_res)
+        @sub_header = raw_res[0..1]
+        @access_route = raw_res[2..6]
+        @response_len = raw_res[7..8]
+        @code = raw_res[9..10].unpack1("v")
+        @data = raw_res[11..-1] || ""
+      end
+
+      # Receives responce and returns.
+      # @param [IO] socket TCP socket
+      # @param [Integer] read_timeout read timeout second
+      # @return [Responce] received a response
+      def self.recv(socket, read_timeout = DEFAULT_READ_TIMEOUT)
+        selected = IO.select([socket], nil, nil, read_timeout)
+        raise TimeoutError unless selected
+
+        raw_res = socket.recv(MAX_RECV_LEN)
+        new(raw_res)
+      end
+
+      # Returns true if a command succeed.
+      def succeed?
+        code == SUCCEED_CODE
+      end
+
+      # Returns true if a command failed.
+      def failed?
+        !succeed?
+      end
+
+      private
+
+      attr_reader :code
+
+    end
+  end
+end

data/lib/mc_protocol_e/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module McProtocolE
+  VERSION = "0.1.0"
+end

data/mc_protocol_e.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mc_protocol_e/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mc_protocol_e"
+  spec.version       = McProtocolE::VERSION
+  spec.authors       = ["commis1059"]
+  spec.email         = ["commis.1059@gmail.com"]
+
+  spec.summary       = %q{A Ruby implementation of a MC protocol client on the ethernet.}
+  spec.homepage      = "https://github.com/commis1059"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/commis1059"
+    spec.metadata["changelog_uri"] = "https://github.com/commis1059"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: mc_protocol_e
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- commis1059
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- commis.1059@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mc_protocol_e.rb
+- lib/mc_protocol_e/client.rb
+- lib/mc_protocol_e/frame_1e/access_route.rb
+- lib/mc_protocol_e/frame_1e/batch_read_in_word.rb
+- lib/mc_protocol_e/frame_1e/batch_write_in_word.rb
+- lib/mc_protocol_e/frame_1e/device_range.rb
+- lib/mc_protocol_e/frame_1e/request.rb
+- lib/mc_protocol_e/frame_1e/response.rb
+- lib/mc_protocol_e/frame_3e/access_route.rb
+- lib/mc_protocol_e/frame_3e/base_command.rb
+- lib/mc_protocol_e/frame_3e/batch_read_in_word.rb
+- lib/mc_protocol_e/frame_3e/batch_write_in_word.rb
+- lib/mc_protocol_e/frame_3e/device_range.rb
+- lib/mc_protocol_e/frame_3e/error_info.rb
+- lib/mc_protocol_e/frame_3e/request.rb
+- lib/mc_protocol_e/frame_3e/response.rb
+- lib/mc_protocol_e/version.rb
+- mc_protocol_e.gemspec
+homepage: https://github.com/commis1059
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/commis1059
+  source_code_uri: https://github.com/commis1059
+  changelog_uri: https://github.com/commis1059
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby implementation of a MC protocol client on the ethernet.
+test_files: []