Renamed Ruby-plc to Machines

tallakt · Mar 13, 2009 · c25906b · c25906b
1 parent e154668
commit c25906b
Show file tree

Hide file tree

Showing 35 changed files with 101 additions and 75 deletions.
diff --git a/README.rdoc b/README.rdoc
@@ -1,22 +1,48 @@
-= ruby-plc
+= machines
 
-* FIX (url)
+* http://github.com/tallakt/machines
 
 == DESCRIPTION:
 
-FIX (describe your package)
+A library for creating machine controllers (typically controlled by a PLC)
+in Ruby.
+
+The aim is not to replicate the ways you would work with a PLC, but to 
+provide tools to implement these tasks using Ruby in a Ruby way.
+
+The Plan is to support the following aspects
+
+* Continuous signals discrete and analog with callback updates
+* Common timers
+* Possibility to run tests i accelelrated time
+* Machine state persistence in ActiveRecord - update code while running or have hot standbys
+* Rails like scripts to create machine skeletons and install them on their servers
+* State machines
+* Modbus communication with PLCs and remote IO stations, modbus server options
+
+Future functionality
+
+* OPC UA SOAP and binary conenctivity
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+This is still a proof of concept stage library. Although I make an effort to
+test code automatically as I go along, there are currently no systems in use
+based on this library.
+
+Much functionality is still missing. The library structure will change 
+frequently in future releases. Code is not commented - this will be 
+performed if this turns out to be a viable concept.
 
 == SYNOPSIS:
 
   FIX (code sample of usage)
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+* rbtree
+
+...probably some more
 
 == INSTALL:
 
@@ -45,4 +71,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/lib/ruby-plc.rb → lib/machines.rb b/lib/ruby-plc.rb → lib/machines.rb
@@ -1,6 +1,6 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-module RubyPlc
+module Machines
   VERSION = '0.0.1'
 end
diff --git a/lib/ruby-plc/etc/notify.rb → lib/machines/etc/notify.rb b/lib/ruby-plc/etc/notify.rb → lib/machines/etc/notify.rb
diff --git a/lib/ruby-plc/io/io_access.rb → lib/machines/io/io_access.rb b/lib/ruby-plc/io/io_access.rb → lib/machines/io/io_access.rb
@@ -1,4 +1,4 @@
-module RubyPlc
+module Machines
   module IO
     module IOAccess
       io_buffer = {}

diff --git a/lib/ruby-plc/physical/interlocks.rb → lib/machines/physical/interlocks.rb b/lib/ruby-plc/physical/interlocks.rb → lib/machines/physical/interlocks.rb
@@ -1,4 +1,4 @@
-module RubyPlc
+module Machines
   module Physical
     class Interlock
       def initialize

diff --git a/lib/ruby-plc/physical/motor.rb → lib/machines/physical/motor.rb b/lib/ruby-plc/physical/motor.rb → lib/machines/physical/motor.rb
@@ -1,4 +1,4 @@
-module RubyPlc
+module Machines
   module Physical
     class Motor
       attr_reader :name, :description, :interlocks

diff --git a/lib/ruby-plc/physical/valve.rb → lib/machines/physical/valve.rb b/lib/ruby-plc/physical/valve.rb → lib/machines/physical/valve.rb
@@ -1,4 +1,4 @@
-module RubyPlc
+module Machines
   module Physical
     class Valve
       attr_reader :name, :description, :interlocks

diff --git a/lib/ruby-plc/sequences/choose_one.rb → lib/machines/sequences/choose_one.rb b/lib/ruby-plc/sequences/choose_one.rb → lib/machines/sequences/choose_one.rb
@@ -1,6 +1,6 @@
 include 'ruby_plc/sequences/step_base'
 
-module RubyPlc
+module Machines
   module Sequences
     class ChooseOne
       include StepBase

diff --git a/lib/ruby-plc/sequences/in_parallel.rb → lib/machines/sequences/in_parallel.rb b/lib/ruby-plc/sequences/in_parallel.rb → lib/machines/sequences/in_parallel.rb
@@ -1,6 +1,6 @@
 include 'ruby_plc/sequences/step_base'
 
-module RubyPlc
+module Machines
   module Sequences
     class InParallel
       include StepBase

diff --git a/lib/ruby-plc/sequences/sequence.rb → lib/machines/sequences/sequence.rb b/lib/ruby-plc/sequences/sequence.rb → lib/machines/sequences/sequence.rb
@@ -1,9 +1,9 @@
-include 'ruby-plc/sequences/step_base'
+include 'machines/sequences/step_base'
-include 'ruby-plc/timedomain/wait_step'
+include 'machines/timedomain/wait_step'
-include 'ruby-plc/timedomain/timer'
+include 'machines/timedomain/timer'
-include 'ruby-plc/timedomain/sequencer'
+include 'machines/timedomain/sequencer'
 
-mmodule RubyPlc
+mmodule Machines
   module Sequences
     class Sequence
       include StepBase

diff --git a/lib/ruby-plc/sequences/stack_sequence.rb → lib/machines/sequences/stack_sequence.rb b/lib/ruby-plc/sequences/stack_sequence.rb → lib/machines/sequences/stack_sequence.rb
@@ -1,7 +1,7 @@
 include 'ruby_plc/sequences/step_base'
-include 'ruby-plc/sequences/sequence'
+include 'machines/sequences/sequence'
 
-module RubyPlc
+module Machines
   module Sequences
     class StackSequence
       include StepBase

diff --git a/lib/ruby-plc/sequences/step.rb → lib/machines/sequences/step.rb b/lib/ruby-plc/sequences/step.rb → lib/machines/sequences/step.rb
@@ -1,6 +1,6 @@
-require 'ruby-plc/sequences/step_base'
+require 'machines/sequences/step_base'
 
-module RubyPlc
+module Machines
   module Sequences
     class Step < StepBase
       attr_reader :name

diff --git a/lib/ruby-plc/sequences/step_base.rb → lib/machines/sequences/step_base.rb b/lib/ruby-plc/sequences/step_base.rb → lib/machines/sequences/step_base.rb
@@ -1,7 +1,7 @@
-require 'ruby-plc/etc/notify.rb'
+require 'machines/etc/notify.rb'
-require 'ruby-plc/timedomain/discrete'
+require 'machines/timedomain/discrete'
 
-module RubyPlc
+module Machines
   module Sequences
     class StepBase
       extend Notify

diff --git a/lib/ruby-plc/sequences/wait_step.rb → lib/machines/sequences/wait_step.rb b/lib/ruby-plc/sequences/wait_step.rb → lib/machines/sequences/wait_step.rb
@@ -1,4 +1,4 @@
-module RubyPlc
+module Machines
   module Sequences
     class WaitStep < Step
       attr_accessor :timeout

diff --git a/lib/ruby-plc/timedomain/analog.rb → lib/machines/timedomain/analog.rb b/lib/ruby-plc/timedomain/analog.rb → lib/machines/timedomain/analog.rb
@@ -1,7 +1,7 @@
-require 'ruby-plc/timedomain/timer'
+require 'machines/timedomain/timer'
-require 'ruby-plc/etc/notify'
+require 'machines/etc/notify'
 
-module RubyPlc
+module Machines
   module TimeDomain
     class Analog
       extend Notify

diff --git a/lib/ruby-plc/timedomain/analog_attr.rb → lib/machines/timedomain/analog_attr.rb b/lib/ruby-plc/timedomain/analog_attr.rb → lib/machines/timedomain/analog_attr.rb
@@ -1,4 +1,4 @@
-require 'ruby-plc/timedomain/analog.rb'
+require 'machines/timedomain/analog.rb'
 
 class Object
   def analog_attr(name)

diff --git a/lib/ruby-plc/timedomain/analog_constant.rb → lib/machines/timedomain/analog_constant.rb b/lib/ruby-plc/timedomain/analog_constant.rb → lib/machines/timedomain/analog_constant.rb
@@ -1,6 +1,6 @@
-include 'ruby-plc/timedomain/analog'
+include 'machines/timedomain/analog'
 
-module RubyPlc
+module Machines
   module Physical
     class AnalogConstant < Analog
       attr_reader :v

diff --git a/lib/ruby-plc/timedomain/analog_value.rb → lib/machines/timedomain/analog_value.rb b/lib/ruby-plc/timedomain/analog_value.rb → lib/machines/timedomain/analog_value.rb
@@ -1,8 +1,8 @@
-include 'ruby-plc/timedomain/analog'
+include 'machines/timedomain/analog'
-include 'ruby-plc/timedomain/timer'
+include 'machines/timedomain/timer'
-include 'ruby-plc/etc/notify'
+include 'machines/etc/notify'
 
-module RubyPlc
+module Machines
   module Physical
     module AnalogValue < Analog
       extend Notify

diff --git a/...ruby-plc/timedomain/binary_op_discrete.rb → ...machines/timedomain/binary_op_discrete.rb b/...ruby-plc/timedomain/binary_op_discrete.rb → ...machines/timedomain/binary_op_discrete.rb
@@ -1,6 +1,6 @@
-require 'ruby-plc/timedomain/discrete_base'
+require 'machines/timedomain/discrete_base'
 
-module RubyPlc
+module Machines
   module TimeDomain 
     class DiscreteBase #:nodoc:
       # forward Declaration

diff --git a/lib/ruby-plc/timedomain/discrete.rb → lib/machines/timedomain/discrete.rb b/lib/ruby-plc/timedomain/discrete.rb → lib/machines/timedomain/discrete.rb
@@ -1,6 +1,6 @@
-require 'ruby-plc/timedomain/discrete_base'
+require 'machines/timedomain/discrete_base'
 
-module RubyPlc
+module Machines
   module TimeDomain
     class Discrete < DiscreteBase
       def initialize(vv = false)

diff --git a/lib/ruby-plc/timedomain/discrete_base.rb → lib/machines/timedomain/discrete_base.rb b/lib/ruby-plc/timedomain/discrete_base.rb → lib/machines/timedomain/discrete_base.rb
@@ -1,9 +1,9 @@
-require 'ruby-plc/timedomain/timer'
+require 'machines/timedomain/timer'
-require 'ruby-plc/timedomain/binary_op_discrete'
+require 'machines/timedomain/binary_op_discrete'
-require 'ruby-plc/timedomain/negated_discrete'
+require 'machines/timedomain/negated_discrete'
-require 'ruby-plc/etc/notify'
+require 'machines/etc/notify'
 
-module RubyPlc
+module Machines
   module TimeDomain
     class DiscreteBase
       extend Notify

diff --git a/lib/ruby-plc/timedomain/discrete_sink.rb → lib/machines/timedomain/discrete_sink.rb b/lib/ruby-plc/timedomain/discrete_sink.rb → lib/machines/timedomain/discrete_sink.rb
@@ -1,6 +1,6 @@
-require 'ruby-plc/timedomain/discrete_base'
+require 'machines/timedomain/discrete_base'
 
-module RubyPlc
+module Machines
   module TimeDomain
     class DiscreteSink < DiscreteBase
       attr_reader :source

diff --git a/lib/ruby-plc/timedomain/negated_discrete.rb → lib/machines/timedomain/negated_discrete.rb b/lib/ruby-plc/timedomain/negated_discrete.rb → lib/machines/timedomain/negated_discrete.rb
@@ -1,6 +1,6 @@
-require 'ruby-plc/timedomain/discrete_base'
+require 'machines/timedomain/discrete_base'
 
-module RubyPlc
+module Machines
   module TimeDomain 
     class DiscreteBase #:nodoc:
       # forward Declaration

diff --git a/lib/ruby-plc/timedomain/pid.rb → lib/machines/timedomain/pid.rb b/lib/ruby-plc/timedomain/pid.rb → lib/machines/timedomain/pid.rb
@@ -1,7 +1,7 @@
-require 'ruby-plc/timedomain/sampler.rb'
+require 'machines/timedomain/sampler.rb'
-require 'ruby-plc/timedomain/analog_attr.rb'
+require 'machines/timedomain/analog_attr.rb'
 
-module RubyPlc
+module Machines
   module Physical
     class PID
       analog_attr :p, :i, :d, :sample_time, :out_max, :out_min, :setpoint, :input

diff --git a/lib/ruby-plc/timedomain/sampler.rb → lib/machines/timedomain/sampler.rb b/lib/ruby-plc/timedomain/sampler.rb → lib/machines/timedomain/sampler.rb
@@ -1,7 +1,7 @@
-include 'ruby-plc/etc/notify'
+include 'machines/etc/notify'
-include 'ruby-plc/timedomain/sequencer'
+include 'machines/timedomain/sequencer'
 
-module RubyPlc
+module Machines
   module TimeDomain
 
     # The Sample class will notify all listeners to the #on_sample function 

diff --git a/lib/ruby-plc/timedomain/scheduler.rb → lib/machines/timedomain/scheduler.rb b/lib/ruby-plc/timedomain/scheduler.rb → lib/machines/timedomain/scheduler.rb
@@ -1,7 +1,7 @@
 require 'rbtree'
 require 'monitor'
 
-module RubyPlc
+module Machines
   module TimeDomain
     class Scheduler
       class Entry

diff --git a/lib/ruby-plc/timedomain/timer.rb → lib/machines/timedomain/timer.rb b/lib/ruby-plc/timedomain/timer.rb → lib/machines/timedomain/timer.rb
@@ -1,7 +1,7 @@
-require 'ruby-plc/timedomain/scheduler'
+require 'machines/timedomain/scheduler'
-require 'ruby-plc/etc/notify'
+require 'machines/etc/notify'
 
-module RubyPlc
+module Machines
   module TimeDomain
     class Timer
       extend Notify

diff --git a/spec/analog_spec.rb b/spec/analog_spec.rb
@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
-require 'ruby-plc/timedomain/analog'
+require 'machines/timedomain/analog'
 
-include RubyPlc::TimeDomain
+include Machines::TimeDomain
 
 
 describe 'Analog signals' do

diff --git a/spec/discrete_spec.rb b/spec/discrete_spec.rb
@@ -1,8 +1,8 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
-require 'ruby-plc/timedomain/discrete'
+require 'machines/timedomain/discrete'
-require 'ruby-plc/timedomain/discrete_sink'
+require 'machines/timedomain/discrete_sink'
 
-include RubyPlc::TimeDomain
+include Machines::TimeDomain
 
 
 describe 'Discrete signals' do

diff --git a/spec/notify_spec.rb b/spec/notify_spec.rb
@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
-require 'ruby-plc/etc/notify.rb'
+require 'machines/etc/notify.rb'
 
 class NotifyTestEmpty
   extend Notify

diff --git a/spec/scheduler_nowait_spec.rb b/spec/scheduler_nowait_spec.rb
@@ -1,9 +1,9 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
-require 'ruby-plc/timedomain/scheduler.rb'
+require 'machines/timedomain/scheduler.rb'
 require 'benchmark'
 require 'timeout'
 
-include RubyPlc::TimeDomain
+include Machines::TimeDomain
 
 describe Scheduler do
   before(:each) do

diff --git a/spec/scheduler_spec.rb b/spec/scheduler_spec.rb
@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
-require 'ruby-plc/timedomain/scheduler.rb'
+require 'machines/timedomain/scheduler.rb'
 require 'benchmark'
 require 'timeout'
 

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -7,4 +7,4 @@
 end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'ruby-plc'
+require 'machines'
diff --git a/spec/step_base_spec.rb b/spec/step_base_spec.rb
@@ -1,9 +1,9 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
-require 'ruby-plc/sequences/step_base'
+require 'machines/sequences/step_base'
-require 'ruby-plc/sequences/step'
+require 'machines/sequences/step'
 
-include RubyPlc::Sequences
+include Machines::Sequences
-include RubyPlc::TimeDomain
+include Machines::TimeDomain
 
 describe StepBase do
   before(:each) do

diff --git a/spec/timer_spec.rb b/spec/timer_spec.rb
@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
-require 'ruby-plc/timedomain/timer'
+require 'machines/timedomain/timer'
 
-include RubyPlc::TimeDomain
+include Machines::TimeDomain
 
 describe Timer do
   before(:each) do