rf_rgb 0.8.0 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5159ee522b80b0230b43725004ea8f67ad0adbcc
-  data.tar.gz: cb0e2ccab51300a5a69cb7ff004921c277f54fc9
+  metadata.gz: 022a90cca27c54f809efb688194bb1acea19ce8b
+  data.tar.gz: 117569fefbe5f2b6ca5d179912029c1a8321ad79
 SHA512:
-  metadata.gz: 0bf1c0a4fe75adce0180ad4dc7a80906c97185499098563f713cb62574097219120831e4b8c71ee2ef924fc50b833dd22a3d08576225a634d5b8354920a8aebc
-  data.tar.gz: 622e71c6041b93d56b351f1d66b2539a9c37a7f7ffb3dde64128b8ca72c068066e3f13e7fee2faabbcb39c539d0c135d8dc619bfc6da440ec4653f44a32f2bfc
+  metadata.gz: 7bb21fbaf33c2fe1a9f1ca81aa0e135020f4a23eec58ebb301c7b1b9cd4d63d69318777348de46e54e979bf771d8b98a0aee80dbe47507c3b2a0d775a900cef1
+  data.tar.gz: 03b28f38f84e443f8236cedf88c3b465c0162c3df49bd5c8cc0fac61bd1d397f3ae26fdee3ab5d335875f8bf51ce3807ea1b7e97a642602e5c6e932111137d9c

data/README.md

@@ -31,6 +31,8 @@ Or install it yourself with:
 ## Usage
 
 ```ruby
+require 'rf_rgb'
+
 keyboard = nil
 begin
  # .new without an arg will automatically find and initialize the first Realforce RGB keyboard it finds.
@@ -38,8 +40,8 @@ begin
   keyboard = RfRgb::Keyboard.new
   
   keyboard.effect_rainbow_wave
-  # keyboard.effect_shooting_star("\xff\x00\xff", RfRgb::Protocol::INTERVAL_6)
-  # keyboard.effect_pressed_key("\xaa\xee\xff")
+  # keyboard.effect_shooting_star("ff00ff", RfRgb::Protocol::INTERVAL_6)
+  # keyboard.effect_pressed_key("aaeeff")
   # keyboard.disable_effect
   keyboard.brightness = RfRgb::Protocol::BRIGHTNESS_LOW
   keyboard.actuation_height = RfRgb::Protocol::HEIGHT_22
@@ -53,6 +55,8 @@ end
 OR
 
 ```ruby
+require 'rf_rgb'
+
 RfRgb::Keyboard.run_and_release do |keyboard|
   keyboard.effect_rainbow_wave
   keyboard.brightness = RfRgb::Protocol::BRIGHTNESS_LOW
@@ -62,6 +66,8 @@ RfRgb::Keyboard.run_and_release do |keyboard|
 end
 ```
 
+Additional examples can be found in the `examples` directory.
+
 See `lib/rf_rgb/keyboard.rb` for effects and arguments, and
 `lib/rf_rgb/protocol.rb` for any needed constants.
 
@@ -84,7 +90,7 @@ be read from IN endpoint #3, but this module ignores these responses completely
 time of writing.
 
 Some effects have a User 1-3 setting in the Windows UI. It's not clear what these
-are actually for, and are ignored in this module for now.
+are actually for, and are mostly ignored in this module for now.
 
 ## Development
 

data/examples/readme_1.rb

@@ -0,0 +1,19 @@
+require 'rf_rgb'
+
+keyboard = nil
+begin
+  # .new without an arg will automatically find and initialize the first Realforce RGB keyboard it finds.
+  # Keyboard cannot be used at this point, as it's owned by this program until .release_to_os is called.
+  keyboard = RfRgb::Keyboard.new
+
+  keyboard.effect_rainbow_wave
+  # keyboard.effect_shooting_star("ff00ff", RfRgb::Protocol::INTERVAL_6)
+  # keyboard.effect_pressed_key("aaeeff")
+  # keyboard.disable_effect
+  keyboard.brightness = RfRgb::Protocol::BRIGHTNESS_LOW
+  keyboard.actuation_height = RfRgb::Protocol::HEIGHT_22
+  keyboard.swap_caps_ctrl
+  keyboard.save
+ensure
+  keyboard&.release_to_os
+end

data/examples/readme_2.rb

@@ -0,0 +1,9 @@
+require 'rf_rgb'
+
+RfRgb::Keyboard.run_and_release do |keyboard|
+  keyboard.effect_rainbow_wave
+  keyboard.brightness = RfRgb::Protocol::BRIGHTNESS_LOW
+  keyboard.actuation_height = RfRgb::Protocol::HEIGHT_22
+  keyboard.swap_caps_ctrl
+  keyboard.save
+end

data/examples/set_colors_all.rb

@@ -0,0 +1,118 @@
+require 'rf_rgb'
+
+# full listing of keys for per-key color settings
+colors = {
+  a: '000000',
+  actuation: '000000',
+  apostrophe: '000000',
+  b: '000000',
+  backslash: '000000',
+  backspace: '000000',
+  c: '000000',
+  capslock: '000000',
+  comma: '000000',
+  d: '000000',
+  del: '000000',
+  down: '000000',
+  e: '000000',
+  eight: '000000',
+  end: '000000',
+  enter: '000000',
+  equals: '000000',
+  esc: '000000',
+  f: '000000',
+  f1: '000000',
+  f10: '000000',
+  f11: '000000',
+  f12: '000000',
+  f2: '000000',
+  f3: '000000',
+  f4: '000000',
+  f5: '000000',
+  f6: '000000',
+  f7: '000000',
+  f8: '000000',
+  f9: '000000',
+  five: '000000',
+  fn: '000000',
+  four: '000000',
+  g: '000000',
+  grave: '000000',
+  h: '000000',
+  home: '000000',
+  hyphen: '000000',
+  i: '000000',
+  ins: '000000',
+  j: '000000',
+  k: '000000',
+  l: '000000',
+  lalt: '000000',
+  lbracket: '000000',
+  lctrl: '000000',
+  left: '000000',
+  lshift: '000000',
+  lwin: '000000',
+  m: '000000',
+  mute: '000000',
+  n: '000000',
+  nine: '000000',
+  np_div: '000000',
+  np_dot: '000000',
+  np_eight: '000000',
+  np_enter: '000000',
+  np_five: '000000',
+  np_four: '000000',
+  np_minus: '000000',
+  np_mult: '000000',
+  np_nine: '000000',
+  np_one: '000000',
+  np_plus: '000000',
+  np_seven: '000000',
+  np_six: '000000',
+  np_three: '000000',
+  np_two: '000000',
+  np_zero: '000000',
+  numlk: '000000',
+  o: '000000',
+  one: '000000',
+  p: '000000',
+  pause: '000000',
+  period: '000000',
+  pgdn: '000000',
+  pgup: '000000',
+  prtsc: '000000',
+  q: '000000',
+  r: '000000',
+  ralt: '000000',
+  rbracket: '000000',
+  rctrl: '000000',
+  right: '000000',
+  rshift: '000000',
+  rwin: '000000',
+  s: '000000',
+  scrlk: '000000',
+  semicolon: '000000',
+  seven: '000000',
+  six: '000000',
+  slash: '000000',
+  space: '000000',
+  t: '000000',
+  tab: '000000',
+  three: '000000',
+  two: '000000',
+  u: '000000',
+  up: '000000',
+  v: '000000',
+  voldown: '000000',
+  volup: '000000',
+  w: '000000',
+  x: '000000',
+  y: '000000',
+  z: '000000',
+  zero: '000000'
+}
+
+RfRgb::Keyboard.run_and_release do |keyboard|
+  keyboard.colors = colors
+  keyboard.save
+end

data/examples/set_colors_circus.rb

@@ -0,0 +1,122 @@
+require 'rf_rgb'
+
+# set each key to a random color
+names = [
+  :a,
+  :actuation,
+  :apostrophe,
+  :b,
+  :backslash,
+  :backspace,
+  :c,
+  :capslock,
+  :comma,
+  :d,
+  :del,
+  :down,
+  :e,
+  :eight,
+  :end,
+  :enter,
+  :equals,
+  :esc,
+  :f,
+  :f1,
+  :f10,
+  :f11,
+  :f12,
+  :f2,
+  :f3,
+  :f4,
+  :f5,
+  :f6,
+  :f7,
+  :f8,
+  :f9,
+  :five,
+  :fn,
+  :four,
+  :g,
+  :grave,
+  :h,
+  :home,
+  :hyphen,
+  :i,
+  :ins,
+  :j,
+  :k,
+  :l,
+  :lalt,
+  :lbracket,
+  :lctrl,
+  :left,
+  :lshift,
+  :lwin,
+  :m,
+  :mute,
+  :n,
+  :nine,
+  :np_div,
+  :np_dot,
+  :np_eight,
+  :np_enter,
+  :np_five,
+  :np_four,
+  :np_minus,
+  :np_mult,
+  :np_nine,
+  :np_one,
+  :np_plus,
+  :np_seven,
+  :np_six,
+  :np_three,
+  :np_two,
+  :np_zero,
+  :numlk,
+  :o,
+  :one,
+  :p,
+  :pause,
+  :period,
+  :pgdn,
+  :pgup,
+  :prtsc,
+  :q,
+  :r,
+  :ralt,
+  :rbracket,
+  :rctrl,
+  :right,
+  :rshift,
+  :rwin,
+  :s,
+  :scrlk,
+  :semicolon,
+  :seven,
+  :six,
+  :slash,
+  :space,
+  :t,
+  :tab,
+  :three,
+  :two,
+  :u,
+  :up,
+  :v,
+  :voldown,
+  :volup,
+  :w,
+  :x,
+  :y,
+  :z,
+  :zero
+]
+
+colors = names.each_with_object({}) do |color, ob|
+  ob[color] = '%06x' % (rand * 0xffffff)
+end
+
+RfRgb::Keyboard.run_and_release do |keyboard|
+  keyboard.colors = colors
+  keyboard.save
+end

data/examples/set_colors_complex.rb

@@ -0,0 +1,23 @@
+require 'rf_rgb'
+
+# Set all keys based on a passed-in mapping
+colors = {
+  # Any key not specified will be set to the default value of the mapping.
+  # If no default is set in the mapping, will default to 000000 (i.e. not lit)
+  default: '11aa43',
+
+  a: 'ff00ff',
+  s: 'ff00ff',
+  d: 'ff00ff',
+  f: 'ff00ff',
+
+  j: '00ffff',
+  k: '00ffff',
+  l: '00ffff',
+  semicolon: '00ffff'
+}
+
+RfRgb::Keyboard.run_and_release do |keyboard|
+  keyboard.colors = colors
+  keyboard.save
+end

data/examples/set_colors_simple.rb

@@ -0,0 +1,7 @@
+require 'rf_rgb'
+
+# Set all keys to a single color
+RfRgb::Keyboard.run_and_release do |keyboard|
+  keyboard.colors = '11aa43'
+  keyboard.save
+end

data/lib/rf_rgb/keyboard.rb

@@ -47,6 +47,18 @@ module RfRgb
       send_message RfRgb::Protocol.disable_effects
     end
 
+    def colors=(new_colors)
+      if new_colors.is_a? String
+        new_colors = {default: new_colors}
+      end
+
+      calls = RfRgb::Protocol.user_specified_colors(new_colors)
+      reset_effect
+      calls.each do |call|
+        send_message call
+      end
+    end
+
     def effect_rainbow_wave
       reset_effect
       send_message RfRgb::Protocol.rainbow_wave

data/lib/rf_rgb/protocol.rb

@@ -35,14 +35,28 @@ module RfRgb
       "\xaa\xaa\x04".force_encoding(Encoding::BINARY).freeze
     end
 
+    def self.user_specified_colors(mapping, user = USER_1)
+      m = lambda { |sym| color_transform(mapping[sym]) || color_transform(mapping[:default]) || "\x00\x00\x00" }
+
+      [
+        "\xaa\xaa\x40\x41\x3a#{user}\x00\x00\x00#{m[:grave]}#{m[:one]}#{m[:two]}#{m[:three]}#{m[:four]}#{m[:five]}#{m[:six]}#{m[:seven]}#{m[:eight]}#{m[:nine]}#{m[:zero]}#{m[:hyphen]}#{m[:equals]}\x00\x00\x00#{m[:backspace]}#{m[:tab]}#{m[:q]}#{m[:w]}\x00".force_encoding(Encoding::BINARY).freeze,
+        "\xaa\xaa\x40\x82\x3a#{user}#{m[:e]}#{m[:r]}#{m[:t]}#{m[:y]}#{m[:u]}#{m[:i]}#{m[:o]}#{m[:p]}#{m[:lbracket]}#{m[:rbracket]}#{m[:backslash]}#{m[:capslock]}#{m[:a]}#{m[:s]}#{m[:d]}#{m[:f]}#{m[:g]}#{m[:h]}#{m[:j]}\x00".force_encoding(Encoding::BINARY).freeze,
+        "\xaa\xaa\x40\x83\x3a#{user}#{m[:k]}#{m[:l]}#{m[:semicolon]}#{m[:apostrophe]}\x00\x00\x00#{m[:enter]}#{m[:lshift]}\x00\x00\x00#{m[:z]}#{m[:x]}#{m[:c]}#{m[:v]}#{m[:b]}#{m[:n]}#{m[:m]}#{m[:comma]}#{m[:period]}#{m[:slash]}\x00\x00\x00\x00".force_encoding(Encoding::BINARY).freeze,
+        "\xaa\xaa\x40\x84\x3a#{user}#{m[:rshift]}#{m[:lctrl]}\x00\x00\x00#{m[:lalt]}#{m[:space]}#{m[:ralt]}\x00\x00\x00#{m[:rctrl]}\x00\x00\x00\x00\x00\x00\x00\x00\x00#{m[:lwin]}#{m[:rwin]}#{m[:fn]}#{m[:mute]}#{m[:voldown]}#{m[:volup]}#{m[:actuation]}#{m[:ins]}\x00".force_encoding(Encoding::BINARY).freeze,
+        "\xaa\xaa\x40\x85\x3a#{user}#{m[:del]}\x00\x00\x00\x00\x00\x00#{m[:left]}#{m[:home]}#{m[:end]}\x00\x00\x00#{m[:up]}#{m[:down]}#{m[:pgup]}#{m[:pgdn]}\x00\x00\x00\x00\x00\x00#{m[:right]}#{m[:numlk]}#{m[:np_seven]}#{m[:np_four]}#{m[:np_one]}\x00\x00\x00\x00".force_encoding(Encoding::BINARY).freeze,
+        "\xaa\xaa\x40\x86\x3a#{user}#{m[:np_div]}#{m[:np_eight]}#{m[:np_five]}#{m[:np_two]}#{m[:np_zero]}#{m[:np_mult]}#{m[:np_nine]}#{m[:np_six]}#{m[:np_three]}#{m[:np_dot]}#{m[:np_minus]}#{m[:np_plus]}\x00\x00\x00#{m[:np_enter]}\x00\x00\x00#{m[:esc]}\x00\x00\x00#{m[:f1]}#{m[:f2]}\x00".force_encoding(Encoding::BINARY).freeze,
+        "\xaa\xaa\x40\xc7\x2b#{user}#{m[:f3]}#{m[:f4]}#{m[:f5]}#{m[:f6]}#{m[:f7]}#{m[:f8]}#{m[:f9]}#{m[:f10]}#{m[:f11]}#{m[:f12]}#{m[:prtsc]}#{m[:scrlk]}#{m[:pause]}\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00".force_encoding(Encoding::BINARY).freeze
+      ]
+    end
+
     def self.pressed_key_lighting(rgb_hex, user = :user0)
       # byte number 6 (just before rgb) determines user. 0x00-0x03
-      "\xaa\xaa\x62\x00\x04\x00#{rgb_hex}".force_encoding(Encoding::BINARY).freeze
+      "\xaa\xaa\x62\x00\x04\x00#{color_transform rgb_hex}".force_encoding(Encoding::BINARY).freeze
     end
 
     # Backlight color can't be changed AFAICT. Always white.
     def self.pressed_key_lighting_with_backlight(rgb_hex, user = :user0)
-      "\xaa\xaa\x63\x00\x04\x00#{rgb_hex}".force_encoding(Encoding::BINARY).freeze
+      "\xaa\xaa\x63\x00\x04\x00#{color_transform rgb_hex}".force_encoding(Encoding::BINARY).freeze
     end
 
     def self.rainbow_wave
@@ -92,5 +106,11 @@ module RfRgb
     def self.unswap_caps_ctrl
       "\xaa\xaa\x84\x00\x01\x00".force_encoding(Encoding::BINARY).freeze
     end
+
+    def self.color_transform(color)
+      return nil unless color
+      return color unless color.length == 6 # rrggbb string
+      [color].pack('H*').force_encoding(Encoding::UTF_8)
+    end
   end
 end

data/lib/rf_rgb/version.rb

@@ -1,3 +1,3 @@
 module RfRgb
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.8.5'.freeze
 end

data/rf_rgb.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/xxx/rf_rgb"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = ">= 2.3"
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rf_rgb
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.5
 platform: ruby
 authors:
 - mpd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-19 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libusb
@@ -84,6 +84,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/readme_1.rb
+- examples/readme_2.rb
+- examples/set_colors_all.rb
+- examples/set_colors_circus.rb
+- examples/set_colors_complex.rb
+- examples/set_colors_simple.rb
 - lib/rf_rgb.rb
 - lib/rf_rgb/keyboard.rb
 - lib/rf_rgb/protocol.rb
@@ -102,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="