libftdi-ruby 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,10 @@
+## Description
+
 Ruby bindings for [libftdi](http://www.intra2net.com/en/developer/libftdi/index.php) - an open source library to talk to [FTDI](http://www.ftdichip.com/) chips.
 
-You must install libftdi itself in addition to this gem.
+## Prerequisites
+
+You must install `libftdi` itself in addition to this gem.
 
 ## Synopsys
 

data/example/bitread.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'ftdi'
+
+ctx = Ftdi::Context.new
+
+begin
+  ctx.usb_open(0x0403, 0x6001)
+
+  begin
+    ctx.set_bitmode(0x00, :bitbang)
+    #ctx.baudrate = 250000
+
+    100.times do
+      p ctx.read_pins
+      sleep 0.5
+    end
+  ensure
+    ctx.set_bitmode(0x00, :reset)
+    ctx.usb_close
+  end
+rescue Ftdi::Error => e
+  $stderr.puts e.to_s
+end

data/example/blink.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'ftdi'
+
+ctx = Ftdi::Context.new
+
+begin
+  ctx.usb_open(0x0403, 0x6001)
+
+  begin
+    ctx.set_bitmode(0xff, :bitbang)
+    #ctx.baudrate = 250000
+
+    10.times do
+      ctx.write_data [0xff]
+      sleep 0.5
+      ctx.write_data [0x00]
+      sleep 0.5
+    end
+  ensure
+    ctx.set_bitmode(0xff, :reset)
+    ctx.usb_close
+  end
+rescue Ftdi::Error => e
+  $stderr.puts e.to_s
+end

data/lib/ftdi.rb

@@ -37,6 +37,9 @@ module Ftdi
   # @see Ftdi::Context#interface=
   Interface = enum(:interface_any, :interface_a, :interface_b, :interface_c, :interface_d)
 
+  # Bitbang mode for {Ftdi::Context#set_bitmode}.
+  BitbangMode = enum(:reset, :bitbang, :mpsse, :syncbb, :mcu, :opto, :cbus, :syncff)
+
   # Flow control: disable
   # @see Ftdi::Context#flowctrl=
   SIO_DISABLE_FLOW_CTRL = 0x0
@@ -267,6 +270,15 @@ module Ftdi
       new_flowctrl
     end
 
+    # Set Bitbang mode for ftdi chip.
+    # @param [Fixnum] bitmask to configure lines. HIGH/ON value configures a line as output.
+    # @param [BitbangMode] mode Bitbang mode: use the values defined in {Ftdi::Context#BitbangMode}
+    # @return [NilClass] nil
+    # @see BitbangMode
+    def set_bitmode(bitmask, mode)
+      check_result(Ftdi.ftdi_set_bitmode(ctx, bitmask, mode))
+    end
+
     # Gets write buffer chunk size.
     # @return [Fixnum] Write buffer chunk size.
     # @raise [StatusCodeError] libftdi reports error.
@@ -339,6 +351,16 @@ module Ftdi
       r
     end
 
+    # Directly read pin state, circumventing the read buffer. Useful for bitbang mode.
+    # @return [Fixnum] Pins state
+    # @raise [StatusCodeError] libftdi reports error.
+    # @see #set_bitmode
+    def read_pins
+      p = FFI::MemoryPointer.new(:uchar, 1)
+      check_result(Ftdi.ftdi_read_pins(ctx, p))
+      p.read_uchar
+    end
+
     # Gets used interface of the device.
     # @return [Interface] Used interface of the device.
     def interface
@@ -385,5 +407,7 @@ module Ftdi
   attach_function :ftdi_read_data_set_chunksize, [ :pointer, :uint ], :int
   attach_function :ftdi_read_data_get_chunksize, [ :pointer, :pointer ], :int
   attach_function :ftdi_set_interface, [ :pointer, Interface ], :int
+  attach_function :ftdi_set_bitmode, [ :pointer,  :int,  :int ], :int
+  attach_function :ftdi_read_pins, [ :pointer,  :pointer ], :int
 end
 

data/lib/ftdi/version.rb

@@ -1,5 +1,5 @@
 module Ftdi
   # Gem version.
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libftdi-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-12 00:00:00.000000000 Z
+date: 2012-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &2153402300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153402300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2153401800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *2153401800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2153401340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +53,12 @@ dependencies:
         version: 1.17.2
   type: :development
   prerelease: false
-  version_requirements: *2153401340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.17.2
 description: libftdi library bindings to talk to FTDI chips
 email:
 - akzhan.abdulin@gmail.com
@@ -57,6 +72,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- example/bitread.rb
+- example/blink.rb
 - lib/ftdi.rb
 - lib/ftdi/version.rb
 - libftdi-ruby.gemspec
@@ -81,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: libftdi-ruby
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: libftdi library bindings