lg-lcd 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 theldoria
+
+MIT License
+
+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,33 @@
+# LgLcd
+
+Ruby binding to the 'Logitech LCD SDK Package'
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lg-lcd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lg-lcd
+
+## Usage
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2012 theldoria. See LICENSE for further details.

data/bin/lglcd

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'lg-lcd/lglcd'
+
+LgLcd::LgLcd.new do |lg_lcd|
+   puts "-" * 80
+
+   lg_lcd.connect("Ruby") do |ctx|
+      puts "Connection: #{ctx.connection}"
+      puts "-" * 40
+
+      dd = LgLcd::Lib::DeviceDesc.new
+      index = 0
+      while 0 == ret = LgLcd::Lib.enumerate(ctx.connection, index, dd)
+         puts "Index: #{index}"
+         puts "Family id: #{dd[:family_id]}"
+         puts "Display name: #{dd[:display_name]}"
+         puts "Width: #{dd[:width]}"
+         puts "Height: #{dd[:height]}"
+         puts "Bpp: #{dd[:bpp]}"
+         puts "Buttons: #{dd[:num_soft_buttons]}"
+         index = index + 1
+      end
+      STDOUT.flush
+   end
+end

data/features/lglcd.feature

@@ -0,0 +1,7 @@
+Feature: lblcd
+  bundle exec cucumber features/
+
+  @announce
+  Scenario: Run
+    When I run `lglcd`
+    Then the output should contain "Display name: Logitech Monochrome LCD"

data/features/support/env.rb

@@ -0,0 +1,4 @@
+require 'aruba/cucumber'
+
+PROJECT_ROOT = File.join(File.dirname(__FILE__),'..','..')
+ENV['PATH'] = "#{File.join(PROJECT_ROOT,'bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"

data/lib/lg-lcd.rb

@@ -0,0 +1,5 @@
+require "lg-lcd/version"
+
+module LgLcd
+   # Your code goes here...
+end

data/lib/lg-lcd/connection.rb

@@ -0,0 +1,39 @@
+require 'ffi'
+require_relative 'lib'
+require_relative 'open'
+
+module LgLcd
+   class Connection
+      def initialize name
+         @ctx = Lib::ConnectionContext.new
+         @ctx[:app_friendly_name] = string_pointer(name)
+         @ctx[:is_persistent] = false
+         @ctx[:is_autostartable] = false
+         @ctx[:connection] = Lib::LGLCD_INVALID_CONNECTION
+
+         raise "Connecting failed" unless Lib::LGLCD_RET_OK == Lib.connect(@ctx)
+
+         begin
+            yield(self)
+         ensure
+            Lib.disconnect(connection)
+         end
+      end
+
+      def connection
+         return @ctx[:connection]
+      end
+
+      def open &block
+         return Open.new(connection, &block)
+      end
+
+      private
+
+      def string_pointer string
+         mem_buf = FFI::MemoryPointer.new(:char, string.size)
+         mem_buf.put_bytes(0, string)
+         return mem_buf
+      end
+   end
+end

data/lib/lg-lcd/lglcd.rb

@@ -0,0 +1,20 @@
+require_relative 'lib'
+require_relative 'connection'
+
+module LgLcd
+   class LgLcd
+      def initialize
+         raise "Initialization failed" unless Lib::LGLCD_RET_OK == Lib.init()
+
+         begin
+            yield(self)
+         ensure
+            Lib.deinit()
+         end
+      end
+
+      def connect name, &block
+         return Connection.new(name, &block)
+      end
+   end
+end

data/lib/lg-lcd/lib.rb

@@ -0,0 +1,273 @@
+require 'ffi'
+
+module LgLcd
+   module Lib
+      extend FFI::Library
+
+      LGLCD_RET_OK = 0
+
+      # Invalid handle definitions
+      LGLCD_INVALID_CONNECTION = -1
+      LGLCD_INVALID_DEVICE     = -1
+
+      # Common Soft-Buttons available through the SDK
+      LGLCDBUTTON_LEFT                    = 0x00000100
+      LGLCDBUTTON_RIGHT                   = 0x00000200
+      LGLCDBUTTON_OK                      = 0x00000400
+      LGLCDBUTTON_CANCEL                  = 0x00000800
+      LGLCDBUTTON_UP                      = 0x00001000
+      LGLCDBUTTON_DOWN                    = 0x00002000
+      LGLCDBUTTON_MENU                    = 0x00004000
+
+      # Soft-Button masks. Kept for backwards compatibility
+      LGLCDBUTTON_BUTTON0                 = 0x00000001
+      LGLCDBUTTON_BUTTON1                 = 0x00000002
+      LGLCDBUTTON_BUTTON2                 = 0x00000004
+      LGLCDBUTTON_BUTTON3                 = 0x00000008
+      LGLCDBUTTON_BUTTON4                 = 0x00000010
+      LGLCDBUTTON_BUTTON5                 = 0x00000020
+      LGLCDBUTTON_BUTTON6                 = 0x00000040
+      LGLCDBUTTON_BUTTON7                 = 0x00000080
+
+      # Bitmap
+      LGLCD_BMP_FORMAT_160x43x1           = 0x00000001
+      LGLCD_BMP_FORMAT_QVGAx32            = 0x00000003
+      LGLCD_BW_BMP_WIDTH                  = 160
+      LGLCD_BW_BMP_HEIGHT                 = 43
+      LGLCD_BW_BMP_BPP                    = 1
+      LGLCD_QVGA_BMP_WIDTH                = 320
+      LGLCD_QVGA_BMP_HEIGHT               = 240
+      LGLCD_QVGA_BMP_BPP                  = 4
+
+      # Priorities
+      LGLCD_PRIORITY_IDLE_NO_SHOW                 = 0
+      LGLCD_PRIORITY_BACKGROUND                   = 64
+      LGLCD_PRIORITY_NORMAL                       = 128
+      LGLCD_PRIORITY_ALERT                        = 255
+      LGLCD_SYNC_UPDATE                           = 0x80000000
+      LGLCD_SYNC_COMPLETE_WITHIN_FRAME            = 0xC0000000
+      LGLCD_ASYNC_UPDATE                          = 0
+
+      # Foreground mode for client applications
+      LGLCD_LCD_FOREGROUND_APP_NO                 = 0
+      LGLCD_LCD_FOREGROUND_APP_YES                = 1
+
+      # Device family definitions
+      LGLCD_DEVICE_FAMILY_BW_160x43_GAMING        = 0x00000001
+      LGLCD_DEVICE_FAMILY_KEYBOARD_G15            = 0x00000001
+      LGLCD_DEVICE_FAMILY_BW_160x43_AUDIO         = 0x00000002
+      LGLCD_DEVICE_FAMILY_SPEAKERS_Z10            = 0x00000002
+      LGLCD_DEVICE_FAMILY_JACKBOX                 = 0x00000004
+      LGLCD_DEVICE_FAMILY_BW_160x43_BASIC         = 0x00000008
+      LGLCD_DEVICE_FAMILY_LCDEMULATOR_G15         = 0x00000008
+      LGLCD_DEVICE_FAMILY_RAINBOW                 = 0x00000010
+      LGLCD_DEVICE_FAMILY_QVGA_BASIC              = 0x00000020
+      LGLCD_DEVICE_FAMILY_QVGA_GAMING             = 0x00000040
+      LGLCD_DEVICE_FAMILY_GAMEBOARD_G13           = 0x00000080
+      LGLCD_DEVICE_FAMILY_KEYBOARD_G510           = 0x00000100
+      LGLCD_DEVICE_FAMILY_OTHER                   = 0x80000000
+
+      # Combinations of device families (device clans?)
+      LGLCD_DEVICE_FAMILY_ALL_BW_160x43           = (LGLCD_DEVICE_FAMILY_BW_160x43_GAMING |
+         LGLCD_DEVICE_FAMILY_BW_160x43_AUDIO |
+         LGLCD_DEVICE_FAMILY_JACKBOX |
+         LGLCD_DEVICE_FAMILY_BW_160x43_BASIC |
+         LGLCD_DEVICE_FAMILY_RAINBOW |
+         LGLCD_DEVICE_FAMILY_GAMEBOARD_G13 |
+         LGLCD_DEVICE_FAMILY_KEYBOARD_G510)
+
+      LGLCD_DEVICE_FAMILY_ALL_QVGA                = (LGLCD_DEVICE_FAMILY_QVGA_BASIC |
+         LGLCD_DEVICE_FAMILY_QVGA_GAMING)
+
+      LGLCD_DEVICE_FAMILY_ALL                     = (LGLCD_DEVICE_FAMILY_ALL_BW_160x43 |
+         LGLCD_DEVICE_FAMILY_ALL_QVGA)
+
+      # Capabilities of applets connecting to LCD Manager.
+      LGLCD_APPLET_CAP_BASIC                          = 0x00000000
+      LGLCD_APPLET_CAP_BW                             = 0x00000001
+      LGLCD_APPLET_CAP_QVGA                           = 0x00000002
+
+      # Notifications sent by LCD Manager to applets connected to it.
+      LGLCD_NOTIFICATION_DEVICE_ARRIVAL               = 0x00000001
+      LGLCD_NOTIFICATION_DEVICE_REMOVAL               = 0x00000002
+      LGLCD_NOTIFICATION_CLOSE_CONNECTION             = 0x00000003
+      LGLCD_NOTIFICATION_APPLET_DISABLED              = 0x00000004
+      LGLCD_NOTIFICATION_APPLET_ENABLED               = 0x00000005
+      LGLCD_NOTIFICATION_TERMINATE_APPLET             = 0x00000006
+
+      # Device types used in notifications
+      LGLCD_DEVICE_BW                                 = 0x00000001
+      LGLCD_DEVICE_QVGA                               = 0x00000002
+
+      # From WinDef.h
+      MAX_PATH = 260
+
+      # struct lgLcdConfigureContext
+      class ConfigureContext < FFI::Struct
+         layout config_callback: :pointer,
+         config_context: :pointer
+      end
+
+      # struct lgLcdNotificationContext
+      class NotificationContext < FFI::Struct
+         layout notification_callback: :pointer,
+         notification_context: :pointer
+      end
+
+      # struct lgLcdConnectContextExA
+      class ConnectionContext < FFI::Struct
+         # "Friendly name" display in the listing
+         # LPCSTR
+         layout app_friendly_name: :pointer,
+         # isPersistent determines whether this connection persists in the list
+         is_persistent: :bool,
+         # isAutostartable determines whether the client can be started by
+         # LCDMon
+         is_autostartable: :bool,
+         on_configure: ConfigureContext,
+         # Need this x, otherwise connection is not filled.
+         # Possibly a padding problem...
+         x: :int,
+         # --> Connection handle
+         connection: :int,
+         # Or'd combination of LGLCD_APPLET_CAP_... defines
+         applet_capabilities_supported: :long,
+         reserved: :long,
+         on_notify: NotificationContext
+      end
+
+      # struct lgLcdDeviceDescExA
+      class DeviceDesc < FFI::Struct
+         layout family_id: :long,
+         display_name: [:uint8, MAX_PATH],
+         width: :long,
+         height: :long,
+         bpp: :long,
+         num_soft_buttons: :long,
+         reserved1: :long,
+         reserved2: :long
+      end
+
+      class SoftbuttonsChangedContext < FFI::Struct
+         # Set to NULL if no softbutton notifications are needed
+         layout softbuttons_changed_callback: :pointer,
+         softbuttons_changed_context: :pointer
+      end
+
+      class OpenContext < FFI::Struct
+         layout connection: :int,
+         # Device type to open (either LGLCD_DEVICE_BW or LGLCD_DEVICE_QVGA)
+         index: :int,
+         on_softbuttons_changed: SoftbuttonsChangedContext,
+         # --> Device handle
+         device: :int
+      end
+
+      class OpenByTypeContext < FFI::Struct
+         layout connection: :int,
+         # Device type to open (either LGLCD_DEVICE_BW or LGLCD_DEVICE_QVGA)
+         device_type: :int,
+         on_softbuttons_changed: SoftbuttonsChangedContext,
+         # --> Device handle
+         device: :int
+      end
+
+      class BitmapHeader < FFI::Struct
+         layout format: :long
+      end
+
+      class Bitmap160x43x1 < FFI::Struct
+         layout hdr: BitmapHeader, # LGLCD_BMP_FORMAT_160x43x1
+         pixels: [:uint8, LGLCD_BW_BMP_WIDTH * LGLCD_BW_BMP_HEIGHT * LGLCD_BW_BMP_BPP]
+      end
+
+      ffi_lib File.join(File.dirname(__FILE__), '..\..\ext\LgLcdDll')
+      ffi_convention :stdcall
+
+      attach_function :init, :lgLcdInit, [], :long
+      attach_function :deinit, :lgLcdDeInit, [], :long
+
+      attach_function :connect, :lgLcdConnectExA, [:pointer], :long
+      attach_function :disconnect, :lgLcdDisconnect, [:int], :long
+
+      attach_function :open_by_type, :lgLcdOpenByType, [:pointer], :long
+      attach_function :close, :lgLcdClose, [:int], :long
+
+      attach_function :set_as_lcd_foreground_app, :lgLcdSetAsLCDForegroundApp, [:int, :int], :long
+      attach_function :update_bitmap, :lgLcdUpdateBitmap, [:int, :pointer, :long], :long
+
+      # Deprecated
+      attach_function :enumerate, :lgLcdEnumerateExA, [:int, :int, :pointer], :long
+   end
+
+   class Open
+      def initialize connection
+         @ctx = Lib::OpenByTypeContext.new
+         @ctx[:connection] = connection
+         @ctx[:device_type] = Lib::LGLCD_DEVICE_BW
+         @ctx[:device] = Lib::LGLCD_INVALID_DEVICE
+         raise "Open by type failes" unless Lib::LGLCD_RET_OK == Lib.open_by_type(@ctx)
+
+         begin
+            yield(self)
+         ensure
+            puts "Close"
+            Lib.close(@ctx[:device])
+         end
+      end
+
+      def device
+         return @ctx[:device]
+      end
+   end
+
+   class Connection
+      def initialize name
+         @ctx = Lib::ConnectionContext.new
+         @ctx[:app_friendly_name] = string_pointer(name)
+         @ctx[:is_persistent] = false
+         @ctx[:is_autostartable] = false
+         @ctx[:connection] = Lib::LGLCD_INVALID_CONNECTION
+
+         raise "Connecting failed" unless Lib::LGLCD_RET_OK == Lib.connect(@ctx)
+
+         begin
+            yield(self)
+         ensure
+            Lib.disconnect(connection)
+         end
+      end
+
+      def connection
+         return @ctx[:connection]
+      end
+
+      def open &block
+         return Open.new(connection, &block)
+      end
+
+      private
+
+      def string_pointer string
+         mem_buf = FFI::MemoryPointer.new(:char, string.size)
+         mem_buf.put_bytes(0, string)
+         return mem_buf
+      end
+   end
+
+   class LgLcd
+      def initialize
+         raise "Initialization failed" unless Lib::LGLCD_RET_OK == Lib.init()
+
+         begin
+            yield(self)
+         ensure
+            Lib.deinit()
+         end
+      end
+
+      def connect name, &block
+         return Connection.new(name, &block)
+      end
+   end
+end

data/lib/lg-lcd/open.rb

@@ -0,0 +1,24 @@
+require_relative 'lib'
+
+module LgLcd
+   class Open
+      def initialize connection
+         @ctx = Lib::OpenByTypeContext.new
+         @ctx[:connection] = connection
+         @ctx[:device_type] = Lib::LGLCD_DEVICE_BW
+         @ctx[:device] = Lib::LGLCD_INVALID_DEVICE
+         raise "Open by type failes" unless Lib::LGLCD_RET_OK == Lib.open_by_type(@ctx)
+
+         begin
+            yield(self)
+         ensure
+            puts "Close"
+            Lib.close(@ctx[:device])
+         end
+      end
+
+      def device
+         return @ctx[:device]
+      end
+   end
+end

data/lib/lg-lcd/version.rb

@@ -0,0 +1,3 @@
+module LgLcd
+   VERSION = "0.0.1"
+end

data/test/test.rb

@@ -0,0 +1,24 @@
+require_relative '../lib/lg-lcd/lib'
+
+LgLcd::LgLcd.new do |lg_lcd|
+   puts "-" * 80
+
+   lg_lcd.connect("Ruby") do |ctx|
+      puts "Connection: #{ctx.connection}"
+      puts "-" * 40
+
+      dd = LgLcd::Lib::DeviceDesc.new
+      index = 0
+      while 0 == ret = LgLcd::Lib.enumerate(ctx.connection, index, dd)
+         puts "Index: #{index}"
+         puts "Family id: #{dd[:family_id]}"
+         puts "Display name: #{dd[:display_name]}"
+         puts "Width: #{dd[:width]}"
+         puts "Height: #{dd[:height]}"
+         puts "Bpp: #{dd[:bpp]}"
+         puts "Buttons: #{dd[:num_soft_buttons]}"
+         index = index + 1
+      end
+      STDOUT.flush
+   end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: lg-lcd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- theldoria
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby binding to the 'Logitech LCD SDK Package'
+email:
+- theldoria@hotmail.com
+executables:
+- lglcd
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lg-lcd/connection.rb
+- lib/lg-lcd/lglcd.rb
+- lib/lg-lcd/lib.rb
+- lib/lg-lcd/open.rb
+- lib/lg-lcd/version.rb
+- lib/lg-lcd.rb
+- ext/LgLcdDll.dll
+- bin/lglcd
+- README.md
+- LICENSE
+- test/test.rb
+- features/lglcd.feature
+- features/support/env.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This binding provides low level access to the LCD of some Logitech products
+  like the G19, G15 or G510
+test_files:
+- test/test.rb
+- features/lglcd.feature
+- features/support/env.rb
+has_rdoc: