prremote 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38c2f68eda963d1330c36a056cd57d7f40aa20916aab7b254b190aea3f9cde11
-  data.tar.gz: 6ef03b383f689c40a43a5449300e648cc693a1c7ebc974661398e2f290272396
+  metadata.gz: 9069bbf984dd62c31390570c934396581e816ad884511d248ebdf3a40657ae9d
+  data.tar.gz: 853acaa0a69a126503b90ce6726958d194cd56fd5abaf559ff759284d26bf1a6
 SHA512:
-  metadata.gz: 67e8c6d8ce84d1721f23671269460fa366ab3ceaf4316f535e185a8d4395b919d6cb746197934074a8942752ed389476a0e979d41705f22cb5053a0fbade6531
-  data.tar.gz: 88100fc592979327716cf747bebbd06c90087c8193c2bb7fc692fab36fb7a3f9d38d68b97c5b5533c3a682ca0ac4e55b39c311ff28c2ac0643aaea3fe1fd3a2f
+  metadata.gz: dff7ed500809d4d457b68ae7483e4d47632c5ced344d0c01237bcec981b589b57794a086508ac99ae7ac28f1b2f351e25dc3c3498b99fb87dac172c43720ebc9
+  data.tar.gz: 58fe0f9d4911c33c8ed9456810cef1405784ab9d778d8bb14502fb9832611877e897880ebfbbd84c29b6c69a82bf42add2f020037534fe809908816cff3409ef

data/README.md

@@ -12,7 +12,12 @@ Inspired by [mpremote](https://docs.micropython.org/en/latest/reference/mpremote
 
 - Ruby 3.x or later
 - Raspberry Pi Pico W
-- `mrbc` in your PATH (for `run`, `deploy`, and `eval`) — install via `brew install mruby` on macOS
+- `mrbc` (mruby 4.x) for `run`, `deploy`, and `eval`
+  - macOS: `brew install mruby`
+  - Linux: build from source — [github.com/mruby/mruby/releases](https://github.com/mruby/mruby/releases)
+    (`sudo apt install mruby` installs mruby 3.x which is **not compatible**)
+  - If `mrbc` is not on your PATH, set the `MRBC` environment variable:
+    `MRBC=/path/to/mrbc prremote run app.rb`
 
 ---
 
@@ -43,16 +48,18 @@ prremote run app.rb
 
 ### `install`
 
-Flash the prremote runtime firmware to a Pico W.
+Flash the prremote runtime firmware to a Pico W or Pico.
 
 ```bash
-prremote install
-prremote install --version 0.1.1   # specify a runtime version
+prremote install                          # Pico W (default)
+prremote install --board pico             # Pico (no wireless)
+prremote install --version 0.1.1          # specify a runtime version
+prremote install --board pico --version 0.1.1
 ```
 
 The firmware is downloaded from GitHub Releases on first use and cached in `~/.prremote/runtime/`. Subsequent installs use the cache.
 
-Put the Pico W into BOOTSEL mode (hold BOOTSEL, connect USB, release) when prompted.
+Put the device into BOOTSEL mode (hold BOOTSEL, connect USB, release) when prompted.
 
 ---
 
@@ -140,9 +147,9 @@ Show the gem version, mrbc version, and the connected device's runtime version.
 
 ```bash
 prremote version
-# prremote: 0.1.0
+# prremote: 0.1.1
 # mrbc:     3.3.0 (/usr/local/bin/mrbc)
-# runtime:  0.1.2
+# runtime:  0.1.3
 ```
 
 ---
@@ -199,4 +206,5 @@ Scripts saved via `deploy` are stored in flash and run automatically on every bo
 ## Related Projects
 
 - [mruby/c](https://github.com/mrubyc/mrubyc) — Lightweight mruby implementation used in the runtime
+- [picotool](https://github.com/raspberrypi/picotool) — Official Raspberry Pi tool for inspecting and managing Pico devices; useful for checking what's on flash or force-rebooting outside of prremote
 - [mpremote](https://docs.micropython.org/en/latest/reference/mpremote.html) — MicroPython equivalent (inspiration)

data/lib/prremote/cli.rb

@@ -20,12 +20,20 @@ module Prremote
       true
     end
 
-    desc 'install', 'Flash prremote runtime firmware to Pico W'
+    remove_command :tree
+
+    desc 'install', 'Flash prremote runtime firmware to Pico W or Pico'
     option :version, type: :string, desc: "Firmware version to install (default: #{RUNTIME_VERSION})"
+    option :board, type: :string, desc: 'Board type: pico or picow (default: picow)'
     def install
       version = options[:version] || RUNTIME_VERSION
-      Commands::Install.new(version: version).call
-    rescue RuntimeError => e
+      board = options[:board] || 'picow'
+      unless RuntimeManager::BOARDS.include?(board)
+        raise Thor::Error, "Unknown board '#{board}'. Valid values: #{RuntimeManager::BOARDS.join(', ')}"
+      end
+
+      Commands::Install.new(version: version, board: board).call
+    rescue StandardError => e
       raise Thor::Error, e.message
     end
 
@@ -33,7 +41,7 @@ module Prremote
     def run_script(file)
       port = resolve_port
       Commands::Run.new(port: port, baud: options[:baud]).call(file)
-    rescue RuntimeError => e
+    rescue StandardError => e
       raise Thor::Error, e.message
     end
     map 'run' => :run_script
@@ -42,7 +50,7 @@ module Prremote
     def deploy(file)
       port = resolve_port
       Commands::Deploy.new(port: port, baud: options[:baud]).call(file)
-    rescue RuntimeError => e
+    rescue StandardError => e
       raise Thor::Error, e.message
     end
 
@@ -50,7 +58,7 @@ module Prremote
     def undeploy
       port = resolve_port
       Commands::Undeploy.new(port: port, baud: options[:baud]).call
-    rescue RuntimeError => e
+    rescue StandardError => e
       raise Thor::Error, e.message
     end
 
@@ -58,7 +66,7 @@ module Prremote
     def eval(expr)
       port = resolve_port
       Commands::EvalCmd.new(port: port, baud: options[:baud]).call(expr)
-    rescue RuntimeError => e
+    rescue StandardError => e
       raise Thor::Error, e.message
     end
 
@@ -66,7 +74,7 @@ module Prremote
     def watch(file)
       port = resolve_port
       Commands::Watch.new(port: port, baud: options[:baud]).call(file)
-    rescue RuntimeError => e
+    rescue StandardError => e
       raise Thor::Error, e.message
     end
 
@@ -87,7 +95,7 @@ module Prremote
       serial.write("\x03")
       sleep 0.1
       puts 'Reset signal sent.'
-    rescue RuntimeError => e
+    rescue StandardError => e
       raise Thor::Error, e.message
     ensure
       serial&.close
@@ -98,8 +106,13 @@ module Prremote
       puts "prremote: #{VERSION}"
 
       begin
+        major = Mrbc.major_version
         puts "mrbc:     #{Mrbc.version} (#{Mrbc.bin})"
-      rescue RuntimeError => e
+        unless major && major >= Mrbc::REQUIRED_MAJOR
+          puts "  ** mrbc is too old (need #{Mrbc::REQUIRED_MAJOR}.x) **"
+          puts "  Hint: the path can be set via MRBC environment variable."
+        end
+      rescue StandardError => e
         puts "mrbc:     (#{e.message})"
       end
 
@@ -108,7 +121,7 @@ module Prremote
 
     private
 
-    def fetch_runtime_version
+    def fetch_runtime_version # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       port = options[:port] || Detector.find_device
       return '(no device connected)' unless port
 
@@ -116,14 +129,44 @@ module Prremote
       serial.write("\x03")
       buf      = +''
       deadline = Time.now + 5
+
       loop do
-        buf << (serial.read(256) || '').gsub("\r\n", "\n").gsub("\r", '')
+        begin
+          buf << (serial.read(256) || '').gsub("\r\n", "\n").gsub("\r", '')
+        rescue StandardError
+          # Watchdog reboot dropped USB; wait for re-enumeration then reopen.
+          begin
+            serial.close
+          rescue StandardError
+            nil
+          end
+          serial = nil
+          reopen_deadline = [deadline, Time.now + 8].min
+          loop do
+            return '(not responding)' if Time.now > reopen_deadline
+
+            p = options[:port] || Detector.find_device
+            if p && File.exist?(p)
+              serial = begin
+                Serial.new(p, options[:baud])
+              rescue StandardError
+                nil
+              end
+              break if serial
+            end
+            sleep 0.3
+          end
+          buf = +''
+          next
+        end
+
         return ::Regexp.last_match(1) if buf =~ %r{READY prremote-runtime/([\d.]+)}
-        break if Time.now > deadline
+        return '(not responding)' if Time.now > deadline
 
         sleep 0.05
       end
-      '(not responding)'
+    rescue StandardError => e
+      "(#{e.message})"
     ensure
       serial&.close
     end

data/lib/prremote/commands/deploy.rb

@@ -26,6 +26,7 @@ module Prremote
       private
 
       def compile(rb_path)
+        Mrbc.check_version!
         tmp = Tempfile.new(['prremote', '.mrb'])
         out, status = Open3.capture2e(Mrbc.bin, '-o', tmp.path, rb_path)
         raise "mrbc failed:\n#{out.chomp}" unless status.success?

data/lib/prremote/commands/install.rb

@@ -3,14 +3,16 @@ require 'fileutils'
 module Prremote
   module Commands
     class Install
-      def initialize(version: RUNTIME_VERSION)
+      def initialize(version: RUNTIME_VERSION, board: 'picow')
         @version = version
+        @board = board
       end
 
       def call
-        uf2_path = RuntimeManager.fetch(@version)
+        uf2_path = RuntimeManager.fetch(@version, @board)
 
-        puts 'Put the Pico W into BOOTSEL mode:'
+        device_label = @board == 'picow' ? 'Pico W' : 'Pico'
+        puts "Put the #{device_label} into BOOTSEL mode:"
         puts '  1. Hold the BOOTSEL button'
         puts '  2. Connect USB (or press RUN while holding BOOTSEL)'
         puts '  3. Release BOOTSEL — RPI-RP2 should appear as a USB drive'

data/lib/prremote/commands/run.rb

@@ -23,6 +23,7 @@ module Prremote
       private
 
       def compile(rb_path)
+        Mrbc.check_version!
         tmp = Tempfile.new(['prremote', '.mrb'])
         out, status = Open3.capture2e(Mrbc.bin, '-o', tmp.path, rb_path)
         raise "mrbc failed:\n#{out.chomp}" unless status.success?

data/lib/prremote/commands/undeploy.rb

@@ -10,18 +10,67 @@ module Prremote
 
       def call
         serial = Serial.new(@port, @baud)
-        sleep 0.5
-        serial.read(4096)
+        serial.write("\x03")
+
+        # \x03 may trigger a watchdog reboot (if a script was running).
+        # wait_for_ready returns the active serial (original or reopened).
+        serial = wait_for_ready(serial)
 
         serial.write(ERASE_MAGIC)
         wait_for_erased(serial)
         warn 'Flash erased. Device will no longer auto-run a script on boot.'
       ensure
-        serial&.close
+        begin
+          serial&.close
+        rescue StandardError
+          nil
+        end
       end
 
       private
 
+      # Returns the serial object in READY state (may be a new object after reboot).
+      def wait_for_ready(serial) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+        buf      = +''
+        deadline = Time.now + 10
+        loop do
+          begin
+            buf << (serial.read(256) || '').gsub("\r\n", "\n").gsub("\r", '')
+          rescue StandardError
+            # Watchdog reboot dropped USB; wait for device to re-enumerate.
+            begin
+              serial.close
+            rescue StandardError
+              nil
+            end
+            serial = nil
+            reopen_deadline = [deadline, Time.now + 8].min
+            loop do
+              raise 'Timeout waiting for device to reconnect' if Time.now > reopen_deadline
+
+              candidate = Detector.find_device || @port
+              if candidate && File.exist?(candidate)
+                begin
+                  serial = Serial.new(candidate, @baud)
+                  @port  = candidate
+                  break
+                rescue StandardError
+                  nil
+                end
+              end
+              sleep 0.3
+            end
+            buf = +''
+            next
+          end
+
+          return serial if buf.include?('READY prremote-runtime/')
+          raise 'Timeout waiting for READY' if Time.now > deadline
+
+          sleep 0.05
+        end
+      end
+
       def wait_for_erased(serial)
         buf = +''
         deadline = Time.now + 30

data/lib/prremote/commands/watch.rb

@@ -34,7 +34,7 @@ module Prremote
 
       def run(rb_path)
         Run.new(port: @port, baud: @baud).call(rb_path)
-      rescue RuntimeError => e
+      rescue StandardError => e
         warn "Error: #{e.message}"
       end
     end

data/lib/prremote/mrbc.rb

@@ -1,18 +1,21 @@
 require 'open3'
 
 module Prremote
+  # mrbc lookup order:
+  #   1. MRBC env var if set (use this to point at a non-PATH binary)
+  #   2. PATH entries, excluding rbenv shims — shims delegate to the project's
+  #      .ruby-version (typically CRuby) and do not work as a standalone mrbc
+  #   3. rbenv direct installs (~/.rbenv/versions/mruby-*/bin/mrbc)
+  # The first candidate wins; version compatibility is checked in check_version!.
   module Mrbc
     SHIMS_RE = %r{\.rbenv/shims}
+    REQUIRED_MAJOR = 4
 
     def self.bin
       return ENV['MRBC'] if ENV['MRBC'] && File.executable?(ENV['MRBC'])
 
-      found = ENV['PATH'].split(File::PATH_SEPARATOR)
-                         .grep_v(SHIMS_RE)
-                         .map    { |d| File.join(d, 'mrbc') }
-                         .find   { |f| File.executable?(f) }
-
-      found || raise('mrbc not found. Install mruby: brew install mruby')
+      (path_candidates + rbenv_candidates).first ||
+        raise('mrbc not found. Install mruby 4.x: brew install mruby')
     end
 
     def self.version
@@ -21,5 +24,35 @@ module Prremote
     rescue RuntimeError
       '(mrbc not found)'
     end
+
+    def self.major_version
+      version[/\bmruby (\d+)\./, 1]&.to_i
+    end
+
+    def self.check_version!
+      return if @version_ok
+
+      major = major_version
+      unless major && major >= REQUIRED_MAJOR
+        raise "mrbc is mruby #{major || '?'}.x but mruby #{REQUIRED_MAJOR}.x or newer is required.\n" \
+              "Installed: #{version}\n" \
+              "Install mruby 4.x: brew install mruby\n" \
+              "On Linux: build from source (https://github.com/mruby/mruby/releases)"
+      end
+
+      @version_ok = true
+    end
+
+    private_class_method def self.path_candidates
+      ENV['PATH'].split(File::PATH_SEPARATOR)
+                 .grep_v(SHIMS_RE)
+                 .map { |d| File.join(d, 'mrbc') }
+                 .select { |f| File.executable?(f) }
+    end
+
+    private_class_method def self.rbenv_candidates
+      Dir.glob(File.expand_path('~/.rbenv/versions/mruby-*/bin/mrbc'))
+         .select { |f| File.executable?(f) }
+    end
   end
 end

data/lib/prremote/runtime_manager.rb

@@ -4,33 +4,32 @@ require 'fileutils'
 
 module Prremote
   module RuntimeManager
-    REPO  = 'lumbermill/prremote'.freeze
-    BOARD = 'picow'.freeze
+    BOARDS = %w[pico picow].freeze
 
-    def self.uf2_filename(version)
-      "prremote-#{BOARD}-runtime-#{version}.uf2"
+    def self.uf2_filename(version, board)
+      "prremote-#{board}-runtime-#{version}.uf2"
     end
 
-    def self.release_url(version)
-      "https://github.com/#{REPO}/releases/download/runtime-#{version}/#{uf2_filename(version)}"
+    def self.release_url(version, board)
+      "https://github.com/lumbermill/prremote/releases/download/runtime-#{version}/#{uf2_filename(version, board)}"
     end
 
     def self.cache_dir
       File.join(Dir.home, '.prremote', 'runtime')
     end
 
-    def self.cached_path(version)
-      File.join(cache_dir, uf2_filename(version))
+    def self.cached_path(version, board)
+      File.join(cache_dir, uf2_filename(version, board))
     end
 
-    def self.fetch(version)
-      path = cached_path(version)
+    def self.fetch(version, board)
+      path = cached_path(version, board)
       return path if File.exist?(path)
 
       FileUtils.mkdir_p(cache_dir)
-      $stderr.print "Downloading #{uf2_filename(version)}..."
+      $stderr.print "Downloading #{uf2_filename(version, board)}..."
       $stderr.flush
-      download(release_url(version), path)
+      download(release_url(version, board), path)
       warn ' done.'
       path
     end

data/lib/prremote/version.rb

@@ -1,4 +1,4 @@
 module Prremote
-  VERSION         = '0.1.0'.freeze
-  RUNTIME_VERSION = '0.1.2'.freeze
+  VERSION         = '0.1.2'
+  RUNTIME_VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prremote
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - ITO Yosei