ruby_can 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34917f037360fc7facd58f677a301b0e9200247e
+  data.tar.gz: e6efea3519074cf3446274797ace18d943ece679
+SHA512:
+  metadata.gz: 14ddcbefc3a915a5032277c0f6052eddfce91334bcf10f288a08a73b0456ce7231d663550468d38c0ef7476bc76c86b2de26ef29642c25732dc0056faac6ce04
+  data.tar.gz: 7643f41d962e799dcc28d49deaafa80bc0c7aea77148452019fb889c006d7a240779718c4ae0331062375295aa09fc6138ce531be10245dcece946489a9e2e78

data/.gitignore

@@ -0,0 +1,17 @@
+.vagrant/
+Gemfile.lock
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+

data/Gemfile

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

data/README.md

@@ -0,0 +1,16 @@
+As an example, to start listening on vcan0 do the following
+
+1. git clone https://github.com/tomekr/ruby-can.git
+1. cd ruby-can/
+1. bundle install
+1. ruby lib/ruby_can.rb
+
+Gem Setup
+---
+`gem build ruby_can.gemspec`
+`gem install ruby_can-0.0.1.gem`
+
+
+Cucumber Tests
+---
+bundle exec cucumber

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty" # Any valid command line option can go here.
+end

data/Vagrantfile

@@ -0,0 +1,13 @@
+Vagrant.configure(2) do |config|
+  config.vm.box = "puphpet/ubuntu1404-x64"
+
+  config.ssh.forward_agent = true
+
+  config.vm.provider "virtualbox" do |vb|
+  #   # Customize the amount of memory on the VM:
+      vb.memory = "1024"
+  end
+
+  config.vm.provision :shell, :path => "vagrant_scripts/bootstrap.sh"
+  config.vm.provision :shell, :path => "vagrant_scripts/install-rvm.sh"
+end

data/features/ruby_can.feature

@@ -0,0 +1,10 @@
+Feature: Raw CAN Access for reading and writing CAN Packets
+  I want to be able to read raw CAN packets as well as write
+  to CAN devices.  I want to be able to setup listeners and
+  handle ISO-TP style packets.
+
+  Scenario: See CAN traffic
+   Given A steady stream of CAN traffic is on "vcan0" with ID of "312" and data of "010203" is on the network
+    When I create a listening socket on "vcan0"
+    Then I should see a packet with ID of "312" with a size of 3 and data of "010203"
+     And the stream stops

data/features/step_definitions/ruby_can_steps.rb

@@ -0,0 +1,22 @@
+Given(/^A steady stream of CAN traffic is on "([^"]*)" with ID of "([^"]*)" and data of "([^"]*)" is on the network$/) do |dev, id, data|
+  ifup = false
+  playing_data = false
+  ifup = true if File.exists? "/sys/class/net/#{dev}"
+  playing_data = system "cangen #{dev} -I #{id} -L #{data.size / 2} -D #{data} &"
+  ifup and playing_data
+end
+
+When(/^I create a listening socket on "([^"]*)"$/) do |dev|
+  @socket = RubyCan::CanSocket.new( dev )
+  not @socket == nil
+end
+
+Then(/^I should see a packet with ID of "([^"]*)" with a size of (\d+) and data of "([^"]*)"$/) do |id, dlc, data|
+  can_packet = RubyCan::CanPacket.read(@socket.read(16))
+  can_packet.can_id == id and can_packet.can_dlc == dlc and can_packet.data.to_s == data
+end
+
+Then(/^the stream stops$/) do
+  system "killall cangen"
+end
+

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require "ruby_can"
+
+#ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+#LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+#  @original_rubylib = ENV['RUBYLIB']
+#  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+#  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/ruby_can.rb

@@ -0,0 +1,8 @@
+require 'socket'
+require 'ruby_can/version'
+require 'ruby_can/can_socket'
+require 'ruby_can/can_packet'
+
+module RubyCan
+
+end

data/lib/ruby_can/can_packet.rb

@@ -0,0 +1,16 @@
+require 'bindata'
+
+module RubyCan
+  class CanPacket < BinData::Record
+    endian :little
+
+    uint32 :can_id
+    uint8  :can_dlc
+
+    # The data section is byte aligned so we have 3 bytes here that are not
+    # used.
+    uint8  :unused, :length => 3
+
+    array  :data, :type => :uint8, :initial_length => :can_dlc
+  end
+end

data/lib/ruby_can/can_socket.rb

@@ -0,0 +1,39 @@
+# CREDIT: Bart Duchesne
+# https://github.com/bduc/raspcan/blob/master/raspcan_test.rb
+module RubyCan
+  class CanSocket < Socket
+  
+    PF_CAN=29
+    AF_CAN=PF_CAN
+    CAN_RAW=1
+    SIOCGIFINDEX=0x8933
+  
+    def initialize( can_interface_name )
+  
+      super(PF_CAN, Socket::SOCK_RAW, CAN_RAW)
+  
+      # struct ifreq in net/if.h
+      if_idx_req = can_interface_name.ljust(16,"\0")+[0].pack("L")
+      ioctl(SIOCGIFINDEX, if_idx_req )
+  
+      if_name,if_index = if_idx_req.unpack("A16L")
+  
+      # sockaddr_can from linux/can.h
+      #struct sockaddr_can {
+      #  __kernel_sa_family_t can_family;                                     S
+      #  int         can_ifindex;                                             l
+      #  union {
+      #    /* transport protocol class address information (e.g. ISOTP) */
+      #    struct { canid_t rx_id, tx_id; } tp;                               LL
+      #
+      #    /* reserved for future CAN protocols address information */
+      #  } can_addr;
+      #};
+      # align on 16 byte -> pad with 2 bytes exta                             S
+  
+      sockaddr_can = [AF_CAN,if_index,0,0,0].pack("SlLLS")
+  
+      bind(sockaddr_can)
+    end
+  end
+end

data/lib/ruby_can/version.rb

@@ -0,0 +1,3 @@
+module RubyCan 
+  VERSION = "0.0.2"
+end

data/ruby_can.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_can/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_can"
+  spec.version       = RubyCan::VERSION
+  spec.authors       = ["Tomek Rabczak","Craig Smith"]
+  spec.email         = ["craig@theailabs.com"]
+  spec.summary       = %q{ruby_can - Raw CAN Bus Module}
+  spec.description   = %q{ruby_can - Raw library for listening and sending CAN bus packets over SocketCAN}
+  spec.homepage      = ""
+  spec.license       = "GPLv3"
+
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "cucumber", "~> 2.0"
+
+  # Not just for dev, but used by cucumber
+  spec.add_development_dependency('bindata', '~> 2.1')
+
+end

data/vagrant_scripts/bootstrap.sh

@@ -0,0 +1,9 @@
+sudo apt-get update
+
+sudo apt-get install -y can-utils git 2> /dev/null
+
+# Setup the vcan0 interface
+sudo modprobe can
+sudo modprobe vcan
+sudo ip link add dev vcan0 type vcan
+sudo ip link set up vcan0

data/vagrant_scripts/install-rvm.sh

@@ -0,0 +1,5 @@
+ #!/usr/bin/env bash
+
+su - vagrant -c 'gem install bundler'
+su - vagrant -c 'gem install pry'
+su - vagrant -c '(cd /vagrant &&  bundle install)'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ruby_can
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tomek Rabczak
+- Craig Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: cucumber
+  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: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: ruby_can - Raw library for listening and sending CAN bus packets over
+  SocketCAN
+email:
+- craig@theailabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- Vagrantfile
+- features/ruby_can.feature
+- features/step_definitions/ruby_can_steps.rb
+- features/support/env.rb
+- lib/ruby_can.rb
+- lib/ruby_can/can_packet.rb
+- lib/ruby_can/can_socket.rb
+- lib/ruby_can/version.rb
+- ruby_can.gemspec
+- vagrant_scripts/bootstrap.sh
+- vagrant_scripts/install-rvm.sh
+homepage: ''
+licenses:
+- GPLv3
+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.4.6
+signing_key: 
+specification_version: 4
+summary: ruby_can - Raw CAN Bus Module
+test_files:
+- features/ruby_can.feature
+- features/step_definitions/ruby_can_steps.rb
+- features/support/env.rb