ffi-snap7 0.1.0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+.ruby-*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ffi-snap7.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,167 @@
+Copyright (c) 2015 Andy Rohr
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,77 @@
+# FFI Snap7
+
+FFI Ruby wrapper for Snap7 (http://snap7.sourceforge.net/)
+
+## Installation
+
+Under Ubuntu 14.04 (the environment I tested, but may apply to others as well), perform the following steps:
+
+1. Download and compile Snap7 (see according documentation)
+2. Copy libsnap7.so to /usr/local/lib
+
+
+Add this line to your application's Gemfile:
+
+    gem 'ffi-snap7'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ffi-snap7
+
+
+## Usage
+
+See examples/
+
+Server:
+
+    server = Snap7::Server.new
+    server.register_db 1, 16
+    server.register_db 2, 16
+    server.start
+    puts 'started'
+
+    run = true
+    trap('INT') do
+      puts 'stopping'
+      server.stop
+      run = false
+    end
+
+    while run
+      sleep 0.1
+    end
+    puts 'done'
+
+Startup:
+
+    authbind --deep ./examples/server.rb
+
+
+
+Client:
+
+    client = Snap7::Client.new
+    client.connect '127.0.0.1', 0, 2
+    p client.db_read  1, 0, 4
+    client.db_write 1, 0, 4, [7, 15, 31, 63]
+    p client.db_read  1, 0, 4
+    client.disconnect
+
+Startup:
+
+    ./examples/client.rb
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/arohr/ffi-snap7/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/examples/client.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'lib/ffi-snap7'
+
+  client = Snap7::Client.new
+  client.connect '127.0.0.1', 0, 2
+p client.db_read  1, 0, 4
+  client.db_write 1, 0, 4, [7, 15, 31, 63]
+p client.db_read  1, 0, 4
+  client.disconnect
+

data/examples/server.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'lib/ffi-snap7'
+
+server = Snap7::Server.new
+server.register_db 1, 16
+server.register_db 2, 16
+server.start
+puts 'started'
+
+run = true
+trap('INT') do
+  puts 'stopping'
+  server.stop
+  run = false
+end
+
+while run
+  sleep 0.1
+end
+puts 'done'

data/ffi-snap7.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffi-snap7/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ffi-snap7'
+  spec.version       = Snap7::VERSION
+  spec.authors       = ['Andy Rohr']
+  spec.email         = ['andy.rohr@mindclue.ch']
+  spec.summary       = %q{FFI Ruby wrapper for Snap7 (http://snap7.sourceforge.net/)}
+  spec.description   = %q{Access to Siemens PLCs, Simulation of Siemens PLCs}
+  spec.homepage      = 'https://github.com/arohr/ffi-snap7'
+  spec.license       = 'LGPLv3'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'ffi'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

data/lib/ffi-snap7.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'ffi'
+
+module Snap7
+  extend FFI::Library
+  ffi_lib 'libsnap7.so'
+
+  # S7Object
+  typedef :pointer, :s7obj
+end
+
+require 'lib/ffi-snap7/version'
+require 'lib/ffi-snap7/client/client'
+require 'lib/ffi-snap7/server/server'

data/lib/ffi-snap7/client/client.rb

@@ -0,0 +1,57 @@
+require 'lib/ffi-snap7/client/wrapper'
+
+module Snap7
+
+  class Client
+
+    def initialize
+      @cli = Snap7.cli_create
+    end
+
+
+    def connect(address, rack, slot)
+      check_rc Snap7.cli_connect_to(@cli, address, rack, slot)
+    end
+
+
+    def disconnect
+      Snap7.cli_disconnect @cli
+    end
+
+
+    def db_read(db_number, start, size)
+      p_usr_data = FFI::MemoryPointer.new :uchar, size
+      check_rc Snap7.cli_db_read(@cli, db_number, start, size, p_usr_data)
+      p_usr_data.get_array_of_uint8 0, size
+    end
+
+
+    def db_write(db_number, start, size, data)
+      p_usr_data = FFI::MemoryPointer.new :uchar, size
+      p_usr_data.put_array_of_uint8 0, data
+      check_rc Snap7.cli_db_write(@cli, db_number, start, size, p_usr_data)
+    end
+
+
+    private
+
+
+    def check_rc(rc)
+      fail error_text(rc) unless rc == 0
+    end
+
+
+    def error_text(error)
+      text_len = 1024
+      text_ptr = FFI::MemoryPointer.new :pointer, text_len
+      if Snap7.cli_error_text(error, text_ptr, text_len) == 0
+        text_ptr.read_string
+      else
+        fail "Error getting error text for error no #{error}"
+      end
+    end
+
+
+  end
+
+end

data/lib/ffi-snap7/client/wrapper.rb

@@ -0,0 +1,26 @@
+module Snap7
+
+  # EXPORTSPEC S7Object S7API Cli_Create();
+  attach_function :cli_create, :Cli_Create, [], :s7obj
+
+  # EXPORTSPEC void S7API Cli_Destroy(S7Object &Client);
+  # FIXME crashes MRI
+  # attach_function :cli_destroy, :Cli_Destroy, [:s7obj], :void
+
+  # EXPORTSPEC int S7API Cli_ConnectTo(S7Object Client, const char *Address, int Rack, int Slot);
+  attach_function :cli_connect_to, :Cli_ConnectTo, [:s7obj, :string, :int, :int], :int
+
+  # EXPORTSPEC int S7API Cli_Disconnect(S7Object Client);
+  attach_function :cli_disconnect, :Cli_Disconnect, [:s7obj], :int
+
+  # EXPORTSPEC int S7API Cli_DBRead(S7Object Client, int DBNumber, int Start, int Size, void *pUsrData);
+  attach_function :cli_db_read, :Cli_DBRead, [:s7obj, :int, :int, :int, :pointer], :int
+
+  # EXPORTSPEC int S7API Cli_DBWrite(S7Object Client, int DBNumber, int Start, int Size, void *pUsrData);
+  attach_function :cli_db_write, :Cli_DBWrite, [:s7obj, :int, :int, :int, :pointer], :int
+
+  # EXPORTSPEC int S7API Cli_ErrorText(int Error, char *Text, int TextLen);
+  attach_function :cli_error_text, :Cli_ErrorText, [:int, :pointer, :int], :int
+
+
+end

data/lib/ffi-snap7/server/server.rb

@@ -0,0 +1,62 @@
+require 'lib/ffi-snap7/server/wrapper'
+
+module Snap7
+
+  class Server
+
+    S7AreaPE = 0
+    S7AreaPA = 1
+    S7AreaMK = 2
+    S7AreaCT = 3
+    S7AreaTM = 4
+    S7AreaDB = 5
+
+
+    def initialize
+      @srv = Snap7.srv_create
+    end
+
+
+    def start
+      check_rc Snap7.srv_start(@srv)
+    end
+
+
+    def stop
+      check_rc Snap7.srv_stop(@srv)
+    end
+
+
+    def register_area(area_code, index, size)
+      p_usr_data = FFI::MemoryPointer.new :uchar, size
+      check_rc Snap7.srv_register_area @srv, area_code, index, p_usr_data, size
+    end
+
+
+    def register_db(index, size)
+      register_area S7AreaDB, index, size
+    end
+
+
+    private
+
+
+    def check_rc(rc)
+      fail error_text(rc) unless rc == 0
+    end
+
+
+    def error_text(error)
+      text_len = 1024
+      text_ptr = FFI::MemoryPointer.new :pointer, text_len
+      if Snap7.srv_error_text(error, text_ptr, text_len) == 0
+        text_ptr.read_string
+      else
+        fail "Error getting error text for error no #{error}"
+      end
+    end
+
+  end
+
+end
+

data/lib/ffi-snap7/server/wrapper.rb

@@ -0,0 +1,37 @@
+module Snap7
+
+  # EXPORTSPEC int S7API Srv_ErrorText(int Error, char *Text, int TextLen);
+  attach_function :srv_error_text, :Srv_ErrorText, [:int, :pointer, :int], :int
+
+  # EXPORTSPEC S7Object S7API Srv_Create();
+  attach_function :srv_create, :Srv_Create, [], :s7obj
+
+  # EXPORTSPEC void S7API Srv_Destroy(S7Object &Server);
+  # FIXME crashes MRI
+  # attach_function :srv_destroy, :Srv_Destroy, [:s7obj], :void
+
+  # EXPORTSPEC int S7API Srv_GetParam(S7Object Server, int ParamNumber, void *pValue);
+
+  # EXPORTSPEC int S7API Srv_SetParam(S7Object Server, int ParamNumber, void *pValue);
+
+  # EXPORTSPEC int S7API Srv_Start(S7Object Server);
+  attach_function :srv_start, :Srv_Start, [:s7obj], :int
+
+  # EXPORTSPEC int S7API Srv_StartTo(S7Object Server, const char *Address);
+  # attach_function :srv_start_to, :Srv_StartTo, [:s7obj, :string], :int
+
+  # EXPORTSPEC int S7API Srv_Stop(S7Object Server);
+  attach_function :srv_stop, :Srv_Stop, [:s7obj], :int
+
+  # EXPORTSPEC int S7API Srv_RegisterArea(S7Object Server, int AreaCode, word Index, void *pUsrData, int Size);
+  attach_function :srv_register_area, :Srv_RegisterArea, [:s7obj, :int, :int16, :pointer, :int], :int
+
+  # EXPORTSPEC int S7API Srv_UnregisterArea(S7Object Server, int AreaCode, word Index);
+  # attach_function :srv_unregister_area, :Srv_UnregisterArea, [:s7obj, :int, :int16], :int
+
+  # EXPORTSPEC int S7API Srv_LockArea(S7Object Server, int AreaCode, word Index);
+
+  # EXPORTSPEC int S7API Srv_UnlockArea(S7Object Server, int AreaCode, word Index);
+
+
+end

data/lib/ffi-snap7/version.rb

@@ -0,0 +1,3 @@
+module Snap7
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: ffi-snap7
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andy Rohr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2015-03-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  name: ffi
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  requirement: *id002
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  name: rake
+description: Access to Siemens PLCs, Simulation of Siemens PLCs
+email: 
+- andy.rohr@mindclue.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/client.rb
+- examples/server.rb
+- ffi-snap7.gemspec
+- lib/ffi-snap7.rb
+- lib/ffi-snap7/client/client.rb
+- lib/ffi-snap7/client/wrapper.rb
+- lib/ffi-snap7/server/server.rb
+- lib/ffi-snap7/server/wrapper.rb
+- lib/ffi-snap7/version.rb
+homepage: https://github.com/arohr/ffi-snap7
+licenses: 
+- LGPLv3
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.29
+signing_key: 
+specification_version: 3
+summary: FFI Ruby wrapper for Snap7 (http://snap7.sourceforge.net/)
+test_files: []
+