adam6050 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69f18923622d9707c07acccd6433cb10863a3d29
+  data.tar.gz: 29afcfd92332596de33ce33ebdf56b86b44ded07
+SHA512:
+  metadata.gz: 13850fe87f428fe8e5e9b17460a15cb20b7e5979bfce5a581e0cd0311ba87e0d48d10b2d1b04719da16c6186d50d6888d6c1a3440d590c22bc86efdfe8ddda57
+  data.tar.gz: 5363aeb733c37736a815ca087da62c63530de69757831d4996877a8e1fab22f9b853aaf13daed31bba18a811fdb0afc28086897bdf79362efbe2002ca3792311

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,64 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 2.4
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+Layout/IndentHeredoc:
+  EnforcedStyle: squiggly
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'test/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'test/**/*.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - x
+    - y
+    - i
+    - p
+    - n
+    - r
+    - g
+    - b
+    - to
+    - '_'

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in adam6050.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    adam6050 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    docile (1.3.1)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redcarpet (3.4.0)
+    rubocop (0.58.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.4.0)
+    yard (0.9.14)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adam6050!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  redcarpet (~> 3.4)
+  rubocop (~> 0.52)
+  simplecov (~> 0.16)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sebastian Lindberg
+
+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,49 @@
+# 🎛 ADAM6050
+
+[![Gem Version](https://badge.fury.io/rb/adam6050.svg)](https://badge.fury.io/rb/vissen-input)
+[![Build Status](https://travis-ci.org/seblindberg/ruby-adam6050.svg?branch=master)](https://travis-ci.org/seblindberg/ruby-adam6050)
+[![Inline docs](http://inch-ci.org/github/seblindberg/ruby-adam6050.svg?branch=master)](http://inch-ci.org/github/seblindberg/ruby-adam6050)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/adam6050/)
+
+This library implements a server that emulates the functionality of the network connected Advantech ADAM-6050 IO module.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adam6050'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adam6050
+
+## Usage
+
+```ruby
+require 'adam6050'
+
+server = ADAM6050::Server.new
+server.run do |state, prev_state|
+    # React to the new state
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seblindberg/ruby-adam6050.
+
+## 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,24 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new(:rubocop)
+
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.stats_options = %w[--list-undoc]
+  t.files = ['lib/**/*.rb', '-', 'CHANGELOG.md']
+end
+
+desc 'Generate Ruby documentation'
+task doc: %w[yard]
+
+task default: %w[test rubocop:auto_correct]

data/adam6050.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adam6050/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adam6050'
+  spec.version       = ADAM6050::VERSION
+  spec.authors       = ['Sebastian Lindberg']
+  spec.email         = ['seb.lindberg@gmail.com']
+
+  spec.summary       = 'Server implementation of the ADAM-6050 IO module.'
+  spec.description   = 'This library implements a server that emulates the ' \
+                       'Advantech ADAM-6050 IO module.'
+  spec.homepage      = 'https://github.com/seblindberg/ruby-adam6050'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) 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', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'adam6050'
+
+# 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/server

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'adam6050'
+
+server = ADAM6050::Server.new
+
+begin
+  server.run do |state|
+    puts ADAM6050::State.inspect(state)
+  end
+rescue Interrupt
+  puts 'Exiting...'
+end

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/adam6050/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  # This is the base class for all custom errors raised by the library.
+  class Error < StandardError
+  end
+end

data/lib/adam6050/handler/login.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  module Handler
+    # Allows senders to login.
+    class Login
+      include Handler
+
+      # @return [String] see Handler::MESSAGE_PREAMBLE.
+      MESSAGE_PREAMBLE = '$01PW'
+
+      # @param  password [String] the plain text password to use when validating
+      #   login requests. If no password is given every request will be granted.
+      def initialize(password = nil)
+        @password = Password.new password
+        freeze
+      end
+
+      # @param  msg [String] the incomming message.
+      # @param  state [Integer] the current state.
+      #
+      # @return [Array<Integer, String>] the next state and an optional reply.
+      def handle(msg, state, session, sender)
+        return state, nil unless @password == msg[6..-1]
+
+        session.register sender
+
+        [state, '>01']
+      end
+
+      # @return [false] the login handler does not require the sender to be
+      #   validated.
+      def validate?
+        false
+      end
+    end
+  end
+end

data/lib/adam6050/handler/read.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  module Handler
+    # Allows registed senders to read the state.
+    class Read
+      include Handler
+
+      # @return [String] see Handler::MESSAGE_PREAMBLE.
+      MESSAGE_PREAMBLE = '$016'
+
+      # @param  state [Integer] the current state.
+      # @return [Array<Integer, String>] the next state and an optional reply.
+      def handle(_, state, *)
+        # From the manual:
+        #   The first 2-character portion of the response (exclude the "!"
+        #   character) indicates the address of the ADAM-6000 module. The second
+        #   2-character portion of the response is reserved, and will always be
+        #   00 currently.
+        [state, '!0100' + State.to_bin(state)]
+      end
+    end
+  end
+end

data/lib/adam6050/handler/status.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  module Handler
+    # Allows registed senders to read the IO status.
+    class Status
+      include Handler
+
+      # @return [String] see Handler::MESSAGE_PREAMBLE.
+      MESSAGE_PREAMBLE = '$01C'
+
+      # @param  msg [String] the incomming message.
+      # @param  state [Integer] the current state.
+      # @return [Array<Integer, String>] the next state and an optional reply.
+      def handle(msg, state, *)
+        reply =
+          if msg == MESSAGE_PREAMBLE + "\r"
+            '!01' + '000000000000' + '000000000000' + '000000000000'
+          else
+            '>'
+          end
+
+        [state, reply]
+      end
+    end
+  end
+end

data/lib/adam6050/handler/write.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  module Handler
+    # Allows registed senders to change the output bits of the state.
+    #
+    # From the manual:
+    #   Name        Write Digital Output
+    #   Description This command sets a single or all digital output channels to
+    #               the specific ADAM-6000 module.
+    #   Syntax      #01bb(data)\r
+    #               bb is used to indicate which channel(s) you want to set.
+    #               Writing to all channels (write a byte): both characters
+    #               should be equal to zero (BB=00).
+    #               Writing to a single channel (write a bit): first character
+    #               is 1, second character indicates channel number which can
+    #               range from 0h to Fh.
+    class Write
+      include Handler
+
+      # @return [String] see Handler::MESSAGE_PREAMBLE.
+      MESSAGE_PREAMBLE = '#01'
+
+      # @param  msg [String] the incomming message.
+      # @param  state [Integer] the current state.
+      # @return [Array<Integer, String>] the next state and an optional reply.
+      def handle(msg, state, *)
+        channel, value = parse msg
+        next_state = if msg[3] == '1'
+                       State.update state, channel, value
+                     else
+                       State.update_all state, value
+                     end
+
+        [next_state, '>']
+      end
+
+      private
+
+      def parse(msg)
+        [
+          msg[4].to_i(16),
+          msg[5..6].to_i(16)
+        ]
+      end
+    end
+  end
+end

data/lib/adam6050/handler.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  # Handlers are, for the most part, simple transformations that accept a
+  # _state_, an incomming _message_, a _session_ and a _sender_ and produce a
+  # new state as well as an optional reply. The only
+  module Handler
+    # @return [String] the first letters of the message that should be used when
+    #   determining if the handler can handle it.
+    MESSAGE_PREAMBLE = '$01'
+
+    # @param  msg [String] the incomming message.
+    # @return [true] if the handler can handle the message.
+    # @return [false] otherwise.
+    def handles?(msg)
+      msg.start_with? self.class::MESSAGE_PREAMBLE
+    end
+
+    # @return [true] if the handler requires the sender to be validated.
+    def validate?
+      true
+    end
+  end
+end

data/lib/adam6050/password.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  # == Usage
+  # The following example creates a password and uses it to validate an encoded
+  # string.
+  #
+  #   password = Password.new 'b6TSkfr6'
+  #
+  #   password == 'b6TSkfr6' # => false
+  #   password == "]\tklTYM\t" # => true
+  #
+  # The next example creates a password that will match any string.
+  #
+  #   password = Password.new
+  #
+  #   password == 'anything' # => true
+  class Password
+    # Format errors should be raised whenever a plain text password longer than
+    # 8 characters is passed. Note that only ascii characters are supported.
+    class FormatError < Error
+      def initialize
+        super 'Only ascii passwords of length 8 or less are supported'
+      end
+    end
+
+    # @raise [FormatError] if the plain text password is longer than 8
+    #   characters.
+    #
+    # @param  plain [String] the plain text version of the password.
+    def initialize(plain = nil)
+      if plain
+        password = obfuscate plain
+        define_singleton_method(:==) { |text| password == text }
+      else
+        define_singleton_method(:==) { |_| true }
+      end
+
+      freeze
+    end
+
+    private
+
+    def obfuscate(plain)
+      codepoints = plain.codepoints
+
+      raise FormatError if codepoints.length > 8
+
+      password = Array.new(8, 0x0E)
+      codepoints.each_with_index do |c, i|
+        password[i] = (c & 0x40) | (~c & 0x3F)
+      end
+      password.pack 'c*'
+    end
+  end
+end

data/lib/adam6050/server.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  # The server listens to a speciefied UDP port and delegates incomming messages
+  # to the different handlers.
+  class Server
+    # @return [Integer] the dafault port of the UDP server.
+    DEFAULT_PORT = 1025
+
+    # @return [Logger] the logger used by the server.
+    attr_reader :logger
+
+    # @param  password [String] the plain text password to use when validating
+    #   new clients.
+    def initialize(password: nil, logger: Logger.new(STDOUT))
+      @session  = Session.new
+      @handlers = [
+        Handler::Login.new(password),
+        Handler::Status.new,
+        Handler::Read.new,
+        Handler::Write.new
+      ]
+      @state = State.initial
+      @state_lock = Mutex.new
+      @logger = logger
+    end
+
+    # @param  host [String] the host to listen on.
+    # @param  port [Integer] the UDP port to listen on.
+    def run(host: nil, port: DEFAULT_PORT, &block)
+      logger.info "Listening on port #{port}"
+
+      Socket.udp_server_loop host, port do |msg, sender|
+        logger.debug { "#{sender.remote_address} -> '#{msg}'" }
+        handler = @handlers.find { |h| h.handles? msg } || next
+
+        @state_lock.synchronize do
+          handle(handler, msg, sender, &block)
+        end
+      end
+    end
+
+    # Updates the state atomicly.
+    def update
+      @state_lock.synchronize do
+        @state = yield @state
+      end
+    end
+
+    private
+
+    def handle(handler, msg, sender, &block)
+      @session.validate! sender if handler.validate?
+
+      next_state, reply = handler.handle msg, @state, @session, sender
+
+      return if abort_state_change?(next_state, &block)
+
+      sender.reply reply + "\r" if reply
+      @state = next_state
+    rescue Session::InvalidSender => e
+      logger.warn e.message
+    end
+
+    def abort_state_change?(next_state)
+      return true if next_state == @state
+
+      commit = !block_given? || yield(next_state, @state)
+      commit == false
+    end
+  end
+end

data/lib/adam6050/session.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  # The session object is used by the server to keep track of authenticated
+  # clients. Once a client is registered with the session it will be reported as
+  # valid for a period of time, after which it is again marked as invalid and
+  # needs to register again. Any activity before the timeout will reset the
+  # countdown.
+  #
+  # == Usage
+  # The following example creates a session with a 10 second timeout and
+  # registers a sender. `#validate!` is then called at a later point in time to
+  # verify that the sender is still valid.
+  #
+  #   session = Session.new timeout: 10.0
+  #   session.register sender
+  #
+  #   # The following call will raise an exception if more
+  #   # than 10 seconds has passed.
+  #   session.validate! sender
+  #
+  class Session
+    # @return [Numeric] the default number of seconds a sender is valid with no
+    #   interaction.
+    DEFAULT_TIMEOUT = 60.0
+
+    # @return [Numeric] the default number of seconds to wait after one cleanup
+    #   before perfoming the next.
+    DEFAULT_CLEANUP_INTERVALL = 3600.0
+
+    # The invalid sender error is used to signify that a sender is not
+    # authenticated within the session. This can either be beacuse the sender
+    # has not yet logged in, or beacuse an old login has expired.
+    class InvalidSender < Error
+      def initialize(sender)
+        super "Invalid sender: #{sender}"
+      end
+    end
+
+    # The unknown sender error is used to signify that a sender has not yet
+    # authenticated within the session.
+    class UnknownSender < InvalidSender; end
+
+    # @param  timeout [Numeric] the number of seconds a sender is valid with no
+    #   interaction.
+    # @param  cleanup_interval [Numeric] the number of seconds to wait after one
+    #   cleanup before perfoming the next.
+    def initialize(timeout: DEFAULT_TIMEOUT,
+                   cleanup_interval: DEFAULT_CLEANUP_INTERVALL)
+      @session          = {}
+      @timeout          = timeout
+      @cleanup_interval = cleanup_interval
+      @next_cleanup     = 0.0
+    end
+
+    # @return [Integer] the number of senders currently known by the session.
+    #   Note that this may include invalid senders that have not yet been
+    #   cleaned up.
+    def size
+      @session.size
+    end
+
+    # Register a new sender as valid in the current session.
+    #
+    # @param  sender [Socket::UDPSource] the udp client.
+    # @param  time [Numeric] the current time. The current time will be used if
+    #   not specified.
+    # @return [nil]
+    def register(sender, time: monotonic_timestamp)
+      @session[session_key sender] = time
+      nil
+    end
+
+    # A sender is valid as long as it is registered and has not expired within
+    # the current session.
+    #
+    # @param  sender [Socket::UDPSource] the udp client.
+    # @param  time [Numeric] the current time. The current time will be used if
+    #   not specified.
+    # @return [true] if the sender has authenticated and has been active within
+    #   the configured timeout.
+    # @return [false] otherwise.
+    def valid?(sender, time: monotonic_timestamp)
+      !expired? @session.fetch(session_key(sender), 0.0), time, @timeout
+    end
+
+    # Renews the given sender if it is still valid within the session and raises
+    # an exception otherwise.
+    #
+    # @raise [UnknownSender] if the given sender is not registered.
+    # @raise [InvalidSender] if the given sender is not valid.
+    #
+    # @param  sender [Socket::UDPSource] the udp client.
+    # @param  time [Numeric] the current time. The current time will be used if
+    #   not specified.
+    # @return [nil]
+    def validate!(sender, time: monotonic_timestamp)
+      key = session_key sender
+      last_observed = @session.fetch(key) { raise UnknownSender, sender }
+      raise InvalidSender, sender if expired? last_observed, time, @timeout
+
+      @session[key] = time
+      nil
+    end
+
+    # Removes invalid senders from the session.
+    #
+    # @param  time [Numeric] the current time. The current time will be used if
+    #   not specified.
+    # @return [Numeric] the next time before which no cleanup will be performed.
+    def cleanup!(time: monotonic_timestamp)
+      return if time < @next_cleanup
+
+      remove_expired! time, @timeout
+
+      @next_cleanup = time + @cleanup_interval
+    end
+
+    private
+
+    def session_key(sender)
+      sender.remote_address.to_sockaddr
+    end
+
+    def monotonic_timestamp
+      Process.clock_gettime Process::CLOCK_MONOTONIC
+    end
+
+    def expired?(sess_time, time, timeout)
+      threshold = time - timeout
+      sess_time < threshold
+    end
+
+    def remove_expired!(time, timeout)
+      @session.delete_if { |_, t| expired? t, time, timeout }
+    end
+  end
+end

data/lib/adam6050/state.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  # The application state is stored as an integer an updated in an immutable
+  # fashion. This module includes helper functions that simplify reading and
+  # creating new states.
+  module State
+    # @return [Integer] the number of inputs.
+    NUM_INPUTS  = 12
+
+    # @return [Integer] the number of outputs.
+    NUM_OUTPUTS = 6
+
+    # @return [Integer] a binary mask selecting the bits of an integer used by
+    #   the state.
+    MASK = (1 << (NUM_INPUTS + NUM_OUTPUTS)) - 1
+
+    INPUT_MASK = (1 << NUM_INPUTS) - 1
+    OUTPUT_MASK = MASK - INPUT_MASK
+
+    private_constant :MASK, :INPUT_MASK, :OUTPUT_MASK
+
+    # @return [Integer] the initial state.
+    def initial
+      0
+    end
+
+    # @raise [RangeError] if the given channel index exceeds the number of
+    #   available input channels.
+    #
+    # @param  state [Integer] the current state.
+    # @param  input_channel [Integer] the input channel number.
+    # @return [true, false] the state of the specified input.
+    def input_set?(state, input_channel)
+      raise RangeError if input_channel >= NUM_INPUTS
+
+      state & (1 << input_channel) != 0
+    end
+
+    # @raise [RangeError] if the given channel index exceeds the number of
+    #   available output channels.
+    #
+    # @param  state [Integer] the current state.
+    # @param  output_channel [Integer] the output channel number.
+    # @return [true, false] the state of the specified output.
+    def output_set?(state, output_channel)
+      raise RangeError if output_channel >= NUM_OUTPUTS
+
+      state & (1 << output_channel + NUM_INPUTS) != 0
+    end
+
+    # @raise [RangeError] if the given channel index exceeds the number of
+    #   available output channels.
+    #
+    # @param  state [Integer] the current state.
+    # @param  output_channel [Integer] the output channel number.
+    # @param  value [0,Integer] the value to update with.
+    # @return [Integer] the next state.
+    def update(state, output_channel, value)
+      raise RangeError if output_channel >= NUM_OUTPUTS
+
+      mask = (1 << output_channel + NUM_INPUTS)
+      value.zero? ? state & ~mask : state | mask
+    end
+
+    # @param  state [Integer] the current state.
+    # @param  values [Integer] the next output values.
+    # @return [Integer] the next state.
+    def update_all(state, values)
+      state & INPUT_MASK | (values << NUM_INPUTS) & MASK
+    end
+
+    # @param  state [Integer] the current state.
+    # @return [String] a string representation of the state.
+    def inspect(state)
+      compact = format '%018b', state
+      compact[0...6] + ' ' + compact[6..-1]
+    end
+
+    # @param  state [Integer] the current state.
+    # @return [String] a binary representation expected by the protocol.
+    def to_bin(state)
+      format '%05X', (~state & MASK)
+    end
+
+    module_function :initial, :input_set?, :output_set?, :update, :update_all,
+                    :inspect, :to_bin
+  end
+end

data/lib/adam6050/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ADAM6050
+  # @return [String] the ADAM6050 library version number.
+  VERSION = '0.1.0'
+end

data/lib/adam6050.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'socket'
+
+require 'adam6050/error'
+require 'adam6050/password'
+require 'adam6050/session'
+require 'adam6050/state'
+
+require 'adam6050/handler'
+require 'adam6050/handler/login'
+require 'adam6050/handler/read'
+require 'adam6050/handler/status'
+require 'adam6050/handler/write'
+
+require 'adam6050/server'
+
+# This library implements a server that emulates the Advantech ADAM-6050 IO
+# module.
+module ADAM6050
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: adam6050
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Lindberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: This library implements a server that emulates the Advantech ADAM-6050
+  IO module.
+email:
+- seb.lindberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- adam6050.gemspec
+- bin/console
+- bin/server
+- bin/setup
+- lib/adam6050.rb
+- lib/adam6050/error.rb
+- lib/adam6050/handler.rb
+- lib/adam6050/handler/login.rb
+- lib/adam6050/handler/read.rb
+- lib/adam6050/handler/status.rb
+- lib/adam6050/handler/write.rb
+- lib/adam6050/password.rb
+- lib/adam6050/server.rb
+- lib/adam6050/session.rb
+- lib/adam6050/state.rb
+- lib/adam6050/version.rb
+homepage: https://github.com/seblindberg/ruby-adam6050
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Server implementation of the ADAM-6050 IO module.
+test_files: []