qmk-cli 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 915b0f8e03509b8c776660b1a9f335441707e1b4
-  data.tar.gz: f4541bde947171682ffa95db7b2d92084d458a5a
+  metadata.gz: a5e5a93c0d7e2f5455b441ab6856220e0d433695
+  data.tar.gz: 1580ecbbbb8f93abce2c79b1332fe8ed130e1b7e
 SHA512:
-  metadata.gz: 9aa6510c0fbad4586d251fab54ae968ee74542c83c596b87cf32e9480d54e3b68a44a017531a878afa19e0efa866b4ce6a57f8308ae679b2e86bf0dbb0229567
-  data.tar.gz: 1d0050383637fc83085fd80fd91a7e9f32049695df559abc0e14d5bed3e7a0d42dcc2f3269e3dc78891dc712e07436b8ae33b63e56917b4e380ae007fef31e35
+  metadata.gz: 1fee8427995c73f2abec6c245cd6749de414a23c8823360e7fb07f0d26976169a24bfd6a002265cbb1538307bd60e9359125c0dfb77b5a7b41d14e95af38371b
+  data.tar.gz: 2830b17e5ad2e3fc2567b1bec4c5fffe85b2486cf8dd0e2dcd3ef6d2a0007622d00497cf8838051e7fc660912a73121c503e1ab70f1fd56b20134408704628e8

data/Makefile

@@ -6,6 +6,10 @@ build: clean
 install:
 	@gem install *.gem
 
+.PHONY: uninstall
+uninstall:
+	@gem install qmk-cli
+
 .PHONY: publish
 publish: build
 	@gem push *.gem
@@ -13,3 +17,7 @@ publish: build
 .PHONY: clean
 clean:
 	@rm -f *.gem
+
+.PHONY: test
+test:
+	@ruby -Ilib -e 'ARGV.each { |f| require f }' ./test/test*.rb

data/README.md

@@ -1,6 +1,6 @@
 # qmk-cli
 
-A thin wrapper around QMK's `make` to make common tasks easier.
+A wrapper around QMK's `make` to make common tasks easier. **This is a proof of concept and should be considered unstable.**
 
 ## Why use this?
 
@@ -31,6 +31,27 @@ A thin wrapper around QMK's `make` to make common tasks easier.
 
 View [nicinabox/keymaps](https://github.com/nicinabox/keymaps) for a complete example on how standalone keymaps should be organized.
 
+### .qmk
+
+This file tells qmk-cli that the directory contains keymaps only, with the directory named after the keyboard it supports. This works well for common cases, but there are a number of cases in which you may want to organize differently and supply a configuration.
+
+Here is an example configuration. All fields are optional.
+
+```yaml
+# Specify your keymap name. Uses `whoami` by default.
+keymap: nic
+
+# Map local keyboard directories to qmk keyboard directories if needed.
+keyboards:
+  bananasplit_blocked: bananasplit
+  clueboard: clueboard/66
+  nh60: handwired/nh60
+
+keymaps:
+  # Override keymap names that differ from your keymap setting above.
+  nh60: default
+```
+
 ## Platforms
 
 - [x] macOS

data/lib/cli.rb

@@ -21,9 +21,9 @@ module QMK
     def initialize(args)
       @options = parser(args)
       command, keyboard = args
-      @firmware = Firmware.new(keyboard, @options[:keymap], keymaps_only?)
+      @firmware = Firmware.new(keyboard, @options[:keymap], config)
 
-      self.send(parse_command(command || 'help'))
+      command and self.send(parse_command(command))
     end
 
     def setup
@@ -51,10 +51,6 @@ module QMK
       puts @firmware.keyboards
     end
 
-    def help
-      puts @options[:help]
-    end
-
     private
     def parser(args)
       options = {}
@@ -62,13 +58,20 @@ module QMK
       OptionParser.new do |parser|
         parser.banner = USAGE
 
-        options[:keymap] = keymaps_only? ? `whoami`.strip : nil
+        options[:keymap] = config[:keymap]
         parser.on("-k", "--keymap KEYMAP", "Your keymap name (default: #{options[:keymap]})") do |v|
           options[:keymap] = v
         end
 
+        parser.on("-v", "--version", "Show qmk-cli version") do
+          spec = Gem::Specification::load("qmk_cli.gemspec")
+          puts spec.version
+        end
+
         options[:help] = parser
-        parser.on("-h", "--help", "Show this help message")
+        parser.on("-h", "--help", "Show this help message") do
+          puts parser
+        end
       end.parse!
 
       options
@@ -78,12 +81,32 @@ module QMK
       cmd.gsub(/\-/, '_').downcase
     end
 
-    def keymaps_only?
+    def config
+      defaults = {
+        standalone_keymaps: standalone_keymaps?,
+        keyboards: [],
+        keymaps: [],
+        keymap: `whoami`.strip
+      }
+
+      if standalone_keymaps?
+        c = YAML.load_file('.qmk')
+                .each_with_object({}) do |(k,v), memo|
+                  memo[k.to_sym] = v
+                end
+
+        return defaults.merge c
+      end
+
+      return defaults
+    end
+
+    def standalone_keymaps?
       File.exists? '.qmk'
     end
 
     def method_missing(*args)
-      help
+      puts @options[:help]
     end
   end
 end

data/lib/firmware.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'open3'
+require 'yaml'
 require 'programmer'
 require 'git'
 
@@ -7,15 +8,18 @@ LIB_PATH = "/usr/local/lib/qmk_firmware"
 
 module QMK
   class Firmware
-    def initialize(keyboard, keymap, keymaps_only)
+    def initialize(keyboard, keymap, config)
+      @config = config
+
       @keyboard = keyboard
-      @keymap = keymap
+      @qmk_keyboard = get_keyboard keyboard
+      @keymap = get_keymap(keyboard) || keymap
+
       @repo = Git.new(LIB_PATH)
-      @keymaps_only = keymaps_only
     end
 
     def make(target = nil)
-      if @keymaps_only
+      if @config[:standalone_keymaps]
         prepare_firmware
       end
 
@@ -53,7 +57,7 @@ module QMK
     end
 
     def keyboards
-      if @keymaps_only
+      if @config[:standalone_keymaps]
         standalone_keyboards
       else
         qmk_keyboards @keymap
@@ -66,7 +70,7 @@ module QMK
         .sort
     end
 
-    def qmk_keyboards(keymap=nil)
+    def qmk_keyboards(keymap = nil)
       Dir["#{keyboards_path}/**/#{keymap}/keymap.c"]
         .map {|path|
           File.dirname(path)
@@ -79,15 +83,19 @@ module QMK
         .sort
     end
 
-    def keyboard_name
-      @keyboard.gsub(/\/rev.*/, '')
-    end
-
     def programmer
       Programmer.new(keyboard_path).flasher
     end
 
     private
+    def get_keyboard(local_keyboard)
+      @config[:keyboards][local_keyboard] || local_keyboard
+    end
+
+    def get_keymap(keyboard)
+      @config[:keymaps][keyboard]
+    end
+
     def in_repo(&block)
       @repo.in_repo &block
     end
@@ -97,12 +105,16 @@ module QMK
         while line = stdout.gets
           puts line
         end
+
+        while line = stderr.gets
+          puts line
+        end
       end
     end
 
     def prepare_firmware
-      keyboard_path = File.expand_path "./#{keyboard_name}"
-      files = Dir.glob "#{keyboard_path}/*"
+      local_keyboard_path = File.expand_path "./#{@keyboard}"
+      files = Dir.glob "#{local_keyboard_path}/*"
 
       FileUtils.mkdir_p keymap_path
       FileUtils.cp_r files, keymap_path
@@ -110,7 +122,8 @@ module QMK
 
     def make_target(target = nil)
       return target unless @keyboard
-      [@keyboard, @keymap, target].compact.join(':')
+
+      [@qmk_keyboard, @keymap, target].compact.join(':')
     end
 
     def keyboards_path
@@ -118,19 +131,23 @@ module QMK
     end
 
     def keyboard_path
-      "#{keyboards_path}/#{keyboard_name}"
+      "#{keyboards_path}/#{@qmk_keyboard}"
     end
 
     def keymap_path
-      if handwired?
-        keyboard_path
-      else
-        "#{keyboard_path}/keymaps/#{@keymap}"
+      if /handwired/ =~ @qmk_keyboard
+        return handwired_keymap_path
       end
+
+      standard_keymap_path
+    end
+
+    def standard_keymap_path
+      "#{keyboard_path}/keymaps/#{@keymap}"
     end
 
-    def handwired?
-      @keyboard =~ /handwired/
+    def handwired_keymap_path
+      keyboard_path
     end
   end
 end

data/lib/makefile.rb

@@ -3,24 +3,25 @@ require 'tempfile'
 class Makefile
   def initialize(include_makefile)
     @include_makefile = include_makefile
-    @file = Tempfile.new('makefile')
+    @file = write
+  end
 
-    write
+  def get(variable)
+    output = run variable
+    _, value = parse output
+    value
   end
 
+  private
   def write
-    @file.write contents
-    @file.close
+    file = Tempfile.new('makefile')
+    file.write contents
+    file.close
+    file
   end
 
   def run(variable)
-    `make -f #{@file.path} -f #{@include_makefile} print-#{variable.upcase}`
-  end
-
-  def value(variable)
-    output = run variable
-    _, value = parse output
-    value
+    `make -f #{@file.path} -f #{@include_makefile} print-#{variable.to_s.upcase}`
   end
 
   def parse(output)

data/lib/programmer.rb

@@ -24,26 +24,26 @@ class Programmer
 
   def flasher
     bootloader and FLASHERS.each do |k, v|
-      break k if v.include? bootloader.downcase
+      break k.to_s if v.include? bootloader.downcase
     end
   end
 
   private
   def bootloader_from_size(size)
     size and BOOTLOADERS.each do |k, v|
-      break k.to_s if v.include? size
+      break k.to_s if v.include? size.to_s
     end
   end
 
   def parse_bootloader_name(filename)
     make = Makefile.new(filename)
-    name = make.value 'BOOTLOADER'
+    name = make.get :bootloader
     return name if name
 
-    size = make.value 'BOOTLOADER_SIZE'
+    size = make.get :bootloader_size
     return bootloader_from_size(size) if size
 
-    opt_defs = make.value 'OPT_DEFS'
+    opt_defs = make.get :opt_defs
     match = opt_defs.match /BOOTLOADER_SIZE=(\w+)/
     return bootloader_from_size(match[1]) if match
   end

data/qmk_cli.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = "qmk-cli"
-  s.version     = "0.2.0"
+  s.version     = "0.3.0"
   s.date        = "2018-02-27"
   s.summary     = "A cli wrapper for QMK Firmware"
   s.authors     = ["Nic Haynes"]
   s.email       = "nic@nicinabox.com"
   s.files       = `git ls-files -z`.split("\x0")
   s.homepage    = "https://github.com/nicinabox/qmk-cli"
-  s.license     = "MIT"
+  s.license     = "ISC"
 
   s.executables << "qmk"
 end

data/test/rules.mk

@@ -0,0 +1,78 @@
+
+
+ifdef TEENSY2
+    OPT_DEFS += -DATREUS_TEENSY2
+    ATREUS_UPLOAD_COMMAND = teensy_loader_cli -w -mmcu=$(MCU) $(TARGET).hex
+else
+    OPT_DEFS += -DATREUS_ASTAR
+    ATREUS_UPLOAD_COMMAND = while [ ! -r $(USB) ]; do sleep 1; done; \
+                            avrdude -p $(MCU) -c avr109 -U flash:w:$(TARGET).hex -P $(USB)
+endif
+
+# MCU name
+#MCU = at90usb1287
+MCU = atmega32u4
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the
+#     processor frequency in Hz. You can then use this symbol in your source code to
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#
+#     This will be an integer division of F_USB below, as it is sourced by
+#     F_USB after it has run through any CPU prescalers. Note that this value
+#     does not *change* the processor frequency - it should merely be updated to
+#     reflect the processor speed set externally so that the code can use accurate
+#     software delays.
+F_CPU = 16000000
+
+#
+# LUFA specific
+#
+# Target architecture (see library "Board Types" documentation).
+ARCH = AVR8
+
+# Input clock frequency.
+#     This will define a symbol, F_USB, in all source code files equal to the
+#     input clock frequency (before any prescaling is performed) in Hz. This value may
+#     differ from F_CPU if prescaling is used on the latter, and is required as the
+#     raw input clock is fed directly to the PLL sections of the AVR for high speed
+#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
+#     at the end, this will be done automatically to create a 32-bit value in your
+#     source code.
+#
+#     If no clock division is performed on the input clock inside the AVR (via the
+#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
+F_USB = $(F_CPU)
+
+# Bootloader
+#     This definition is optional, and if your keyboard supports multiple bootloaders of
+#     different sizes, comment this out, and the correct address will be loaded 
+#     automatically (+60). See bootloader.mk for all options.
+ifdef TEENSY2
+    BOOTLOADER = halfkay
+else
+    BOOTLOADER = caterina
+endif
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+
+# Build Options
+#   comment out to disable the options.
+#
+#BOOTMAGIC_ENABLE = yes	# Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = yes	# Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes	# Audio control and System control(+450)
+CONSOLE_ENABLE = yes	# Console for debug(+400)
+COMMAND_ENABLE = yes    # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+# SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
+NKRO_ENABLE = yes		# USB Nkey Rollover - not yet supported in LUFA
+# BACKLIGHT_ENABLE = yes  # Enable keyboard backlight functionality
+# MIDI_ENABLE = YES 		# MIDI controls
+UNICODE_ENABLE = YES 		# Unicode
+# BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
+
+USB = /dev/cu.usbmodem1411

data/test/test_makefile.rb

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require 'makefile'
+
+class MakefileTest < Minitest::Test
+  def setup
+    @make = Makefile.new 'test/rules.mk'
+  end
+
+  def test_basic_value
+    value = @make.get :mcu
+    assert_equal value, 'atmega32u4'
+  end
+
+  def test_complex_value
+    value = @make.get :opt_defs
+    assert_equal value, '-DATREUS_ASTAR -DINTERRUPT_CONTROL_ENDPOINT'
+  end
+
+  def test_logical_value
+    value = @make.get :bootloader
+    assert_equal value, 'caterina'
+  end
+end

data/test/test_programmer.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+require 'programmer'
+
+class ProgrammerTest < Minitest::Test
+  def setup
+    @protected_methods = Programmer.private_instance_methods
+    Programmer.send(:public, *@protected_methods)
+
+    @prog = Programmer.new 'test'
+  end
+
+  def test_bootloader
+    assert_equal @prog.bootloader, 'caterina'
+  end
+
+  def test_bootloader_not_found
+    prog = Programmer.new ''
+    assert_nil prog.bootloader
+  end
+
+  def test_flasher
+    assert_equal @prog.flasher, 'avrdude'
+  end
+
+  def test_flasher_not_found
+    prog = Programmer.new ''
+    assert_nil prog.flasher
+  end
+
+  def test_bootloader_mapping
+    assert_equal @prog.bootloader_from_size(512), 'halfkay'
+    assert_equal @prog.bootloader_from_size(1024), 'halfkay'
+    assert_equal @prog.bootloader_from_size(2048), 'usbasploader'
+    assert_equal @prog.bootloader_from_size(4096), 'atmel-dfu'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qmk-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nic Haynes
@@ -28,9 +28,12 @@ files:
 - lib/makefile.rb
 - lib/programmer.rb
 - qmk_cli.gemspec
+- test/rules.mk
+- test/test_makefile.rb
+- test/test_programmer.rb
 homepage: https://github.com/nicinabox/qmk-cli
 licenses:
-- MIT
+- ISC
 metadata: {}
 post_install_message: 
 rdoc_options: []