prusalink 0.1.0

data/lib/prusalink/job.rb

@@ -0,0 +1,191 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  # The printer's current job.
+  #
+  # @example Inspect and control the current job
+  #   job = Prusalink::Job.get # => nil when the printer is idle
+  #   job.state           # => "PRINTING"
+  #   job.progress        # => 42.0
+  #   job.file.full_path  # => "/usb/SPICE~1.gco"
+  #   job.pause
+  #
+  # @example Control a job by id
+  #   Prusalink::Job.stop(420)
+  class Job < BaseResource
+    extend T::Sig
+    include AutoInitializable
+    include Deserializable
+
+    resource_path("/api/v1/job")
+
+    # @!attribute [r] id
+    #   @return [Integer] The job's id
+    auto_attr :id, type: Integer
+
+    # @!attribute [r] state
+    #   @return [String] One of "PRINTING", "PAUSED", "FINISHED", "STOPPED" or "ERROR"
+    auto_attr :state, type: String
+
+    # @!attribute [r] progress
+    #   @return [Float] Completion, in percent
+    auto_attr :progress, type: Float
+
+    # @!attribute [r] time_remaining
+    #   @return [Integer, nil] Estimated time left, in seconds
+    auto_attr :time_remaining, type: Integer
+
+    # @!attribute [r] time_printing
+    #   @return [Integer] Time spent printing, in seconds
+    auto_attr :time_printing, type: Integer
+
+    # @!attribute [r] inaccurate_estimates
+    #   @return [Boolean, nil] Whether the time estimates are inaccurate
+    auto_attr :inaccurate_estimates, type: T::Boolean
+
+    # @!attribute [r] serial_print
+    #   @return [Boolean, nil] Whether the printer is printing from the serial line (no file is then available)
+    auto_attr :serial_print, type: T::Boolean
+
+    # @!attribute [r] file
+    #   @return [Job::File, nil] The file being printed, absent for serial prints
+    auto_attr :file, type: File
+
+    # @!attribute [r] extra
+    #   @return [Hash] Any additional fields returned by the API
+    auto_attr :extra, type: Hash
+
+    auto_initialize!
+
+    deserialize_config do
+      nested :file, File
+    end
+
+    class << self
+      extend T::Sig
+
+      # Retrieve the current job.
+      #
+      # @return [Job, nil] nil when there is no job (the printer answers 204 No Content)
+      # @raise [Prusalink::Exceptions::Error] if the request fails
+      sig { returns(T.nilable(Job)) }
+      def get
+        fetch_resource
+      end
+
+      # Stop the job with the given id.
+      #
+      # @param id [Integer] The job's id
+      # @return [Boolean] true on success
+      # @raise [Prusalink::Exceptions::NotFoundError] if no job has this id
+      # @raise [Prusalink::Exceptions::ConflictError] if the job can't be stopped in its current state
+      sig { params(id: Integer).returns(T::Boolean) }
+      def stop(id)
+        delete(path: job_path(id))
+      end
+
+      # Pause the job with the given id.
+      #
+      # @param id [Integer] The job's id
+      # @return [Boolean] true on success
+      # @raise [Prusalink::Exceptions::NotFoundError] if no job has this id
+      # @raise [Prusalink::Exceptions::ConflictError] if the job can't be paused in its current state
+      sig { params(id: Integer).returns(T::Boolean) }
+      def pause(id)
+        put(path: job_path(id, "pause"))
+      end
+
+      # Resume the paused job with the given id.
+      #
+      # @param id [Integer] The job's id
+      # @return [Boolean] true on success
+      # @raise [Prusalink::Exceptions::NotFoundError] if no job has this id
+      # @raise [Prusalink::Exceptions::ConflictError] if the job isn't paused
+      sig { params(id: Integer).returns(T::Boolean) }
+      def resume(id)
+        put(path: job_path(id, "resume"))
+      end
+
+      # Continue the job with the given id after a timelapse capture.
+      #
+      # @param id [Integer] The job's id
+      # @return [Boolean] true on success
+      # @raise [Prusalink::Exceptions::NotFoundError] if no job has this id
+      # @raise [Prusalink::Exceptions::ConflictError] if the job isn't waiting to continue
+      sig { params(id: Integer).returns(T::Boolean) }
+      def continue(id)
+        put(path: job_path(id, "continue"))
+      end
+
+      private
+
+      sig { params(id: Integer, action: T.nilable(String)).returns(String) }
+      def job_path(id, action = nil)
+        ["/api/v1/job", id, action].compact.join("/")
+      end
+    end
+
+    # Stop this job. See {Job.stop}.
+    #
+    # @return [Boolean] true on success
+    sig { returns(T::Boolean) }
+    def stop
+      self.class.stop(T.must(id))
+    end
+
+    # Pause this job. See {Job.pause}.
+    #
+    # @return [Boolean] true on success
+    sig { returns(T::Boolean) }
+    def pause
+      self.class.pause(T.must(id))
+    end
+
+    # Resume this job. See {Job.resume}.
+    #
+    # @return [Boolean] true on success
+    sig { returns(T::Boolean) }
+    def resume
+      self.class.resume(T.must(id))
+    end
+
+    # Continue this job after a timelapse capture. See {Job.continue}.
+    #
+    # @return [Boolean] true on success
+    sig { returns(T::Boolean) }
+    def continue
+      self.class.continue(T.must(id))
+    end
+
+    # @return [Boolean] whether the job is printing
+    sig { returns(T::Boolean) }
+    def printing?
+      state == "PRINTING"
+    end
+
+    # @return [Boolean] whether the job is paused
+    sig { returns(T::Boolean) }
+    def paused?
+      state == "PAUSED"
+    end
+
+    # @return [Boolean] whether the job has finished
+    sig { returns(T::Boolean) }
+    def finished?
+      state == "FINISHED"
+    end
+
+    # @return [Boolean] whether the job was stopped
+    sig { returns(T::Boolean) }
+    def stopped?
+      state == "STOPPED"
+    end
+
+    # @return [Boolean] whether the job ended in error
+    sig { returns(T::Boolean) }
+    def error?
+      state == "ERROR"
+    end
+  end
+end

data/lib/prusalink/server_version.rb

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  # Version information about the PrusaLink server and the printer's firmware.
+  #
+  # @example
+  #   version = Prusalink::ServerVersion.get
+  #   version.text     # => "PrusaLink 0.7.0"
+  #   version.firmware # => "6.1.3+8098"
+  #   version.upload_by_put? # => true
+  class ServerVersion < BaseResource
+    extend T::Sig
+    include AutoInitializable
+    include Deserializable
+
+    resource_path("/api/version")
+
+    # @!attribute [r] api
+    #   @return [String] The API version
+    auto_attr :api, type: String
+
+    # @!attribute [r] version
+    #   @return [String] The PrusaLink version
+    auto_attr :version, type: String
+
+    # @!attribute [r] printer
+    #   @return [String] The printer's version
+    auto_attr :printer, type: String
+
+    # @!attribute [r] text
+    #   @return [String] Server version including the "PrusaLink" prefix
+    auto_attr :text, type: String
+
+    # @!attribute [r] firmware
+    #   @return [String] The printer's firmware version
+    auto_attr :firmware, type: String
+
+    # @!attribute [r] sdk
+    #   @return [String] The PrusaLink SDK version
+    auto_attr :sdk, type: String
+
+    # @!attribute [r] capabilities
+    #   @return [Hash] Optional capabilities, e.g. { upload_by_put: true }
+    auto_attr :capabilities, type: Hash
+
+    # @!attribute [r] extra
+    #   @return [Hash] Any additional fields returned by the API
+    auto_attr :extra, type: Hash
+
+    auto_initialize!
+
+    # Retrieve information regarding server and API version.
+    #
+    # @return [ServerVersion]
+    # @raise [Prusalink::Exceptions::Error] if the request fails
+    sig { returns(ServerVersion) }
+    def self.get
+      fetch_resource
+    end
+
+    # Whether the printer accepts uploads with PUT /api/v1/files (see {Files.upload})
+    #
+    # @return [Boolean]
+    sig { returns(T::Boolean) }
+    def upload_by_put?
+      capabilities&.fetch(:upload_by_put, false) == true
+    end
+  end
+end

data/lib/prusalink/status/camera.rb

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  class Status
+    # The default working camera, if available.
+    #
+    # @example
+    #   Prusalink::Status.get.camera&.id # => "Ba1kmCbifTa8X"
+    class Camera
+      extend T::Sig
+      include AutoInitializable
+      include Deserializable
+
+      # @!attribute [r] id
+      #   @return [String] The camera's id
+      auto_attr :id, type: String
+
+      # @!attribute [r] extra
+      #   @return [Hash] Any additional fields returned by the API
+      auto_attr :extra, type: Hash
+
+      auto_initialize!
+    end
+  end
+end

data/lib/prusalink/status/job.rb

@@ -0,0 +1,41 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  class Status
+    # Telemetry about the current job. All values are optional.
+    # See {Prusalink::Job} for the full job details.
+    #
+    # @example
+    #   job = Prusalink::Status.get.job
+    #   job.progress       # => 42.0
+    #   job.time_remaining # => 520
+    class Job
+      extend T::Sig
+      include AutoInitializable
+      include Deserializable
+
+      # @!attribute [r] id
+      #   @return [Integer] The job's id
+      auto_attr :id, type: Integer
+
+      # @!attribute [r] progress
+      #   @return [Float] Job progress, in percent
+      auto_attr :progress, type: Float
+
+      # @!attribute [r] time_remaining
+      #   @return [Integer] Estimated time remaining, in seconds
+      auto_attr :time_remaining, type: Integer
+
+      # @!attribute [r] time_printing
+      #   @return [Integer] Time spent printing, in seconds
+      auto_attr :time_printing, type: Integer
+
+      # @!attribute [r] extra
+      #   @return [Hash] Any additional fields returned by the API
+      auto_attr :extra, type: Hash
+
+      auto_initialize!
+    end
+  end
+end

data/lib/prusalink/status/printer.rb

@@ -0,0 +1,136 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  class Status
+    # Telemetry about the printer. All values except {#state} are optional.
+    #
+    # @example
+    #   printer = Prusalink::Status.get.printer
+    #   printer.state      # => "PRINTING"
+    #   printer.printing?  # => true
+    #   printer.temp_bed   # => 59.5
+    class Printer
+      extend T::Sig
+      include AutoInitializable
+      include Deserializable
+
+      # @!attribute [r] state
+      #   @return [String] The printer's state: "IDLE", "BUSY", "PRINTING", "PAUSED", "FINISHED", "STOPPED",
+      #     "ERROR", "ATTENTION" or "READY"
+      auto_attr :state, type: String
+
+      # @!attribute [r] temp_nozzle
+      #   @return [Float] Current nozzle temperature, in °C
+      auto_attr :temp_nozzle, type: Float
+
+      # @!attribute [r] target_nozzle
+      #   @return [Float] Target nozzle temperature, in °C
+      auto_attr :target_nozzle, type: Float
+
+      # @!attribute [r] temp_bed
+      #   @return [Float] Current bed temperature, in °C
+      auto_attr :temp_bed, type: Float
+
+      # @!attribute [r] target_bed
+      #   @return [Float] Target bed temperature, in °C
+      auto_attr :target_bed, type: Float
+
+      # @!attribute [r] axis_x
+      #   @return [Float, nil] X axis position, in mm. Only available when the printer is not moving
+      auto_attr :axis_x, type: Float
+
+      # @!attribute [r] axis_y
+      #   @return [Float, nil] Y axis position, in mm. Only available when the printer is not moving
+      auto_attr :axis_y, type: Float
+
+      # @!attribute [r] axis_z
+      #   @return [Float] Z axis position, in mm
+      auto_attr :axis_z, type: Float
+
+      # @!attribute [r] flow
+      #   @return [Integer] Flow rate factor, in percent
+      auto_attr :flow, type: Integer
+
+      # @!attribute [r] speed
+      #   @return [Integer] Print speed factor, in percent
+      auto_attr :speed, type: Integer
+
+      # @!attribute [r] fan_hotend
+      #   @return [Integer] Hotend fan speed, in RPM
+      auto_attr :fan_hotend, type: Integer
+
+      # @!attribute [r] fan_print
+      #   @return [Integer] Print fan speed, in RPM
+      auto_attr :fan_print, type: Integer
+
+      # @!attribute [r] status_printer
+      #   @return [Hash] Printer health, e.g. { ok: true, message: "OK" }
+      auto_attr :status_printer, type: Hash
+
+      # @!attribute [r] status_connect
+      #   @return [Hash] Prusa Connect health, e.g. { ok: true, message: "OK" }
+      auto_attr :status_connect, type: Hash
+
+      # @!attribute [r] extra
+      #   @return [Hash] Any additional fields returned by the API
+      auto_attr :extra, type: Hash
+
+      auto_initialize!
+
+      # @return [Boolean] true when the state is "IDLE"
+      sig { returns(T::Boolean) }
+      def idle?
+        state == "IDLE"
+      end
+
+      # @return [Boolean] true when the state is "BUSY"
+      sig { returns(T::Boolean) }
+      def busy?
+        state == "BUSY"
+      end
+
+      # @return [Boolean] true when the state is "PRINTING"
+      sig { returns(T::Boolean) }
+      def printing?
+        state == "PRINTING"
+      end
+
+      # @return [Boolean] true when the state is "PAUSED"
+      sig { returns(T::Boolean) }
+      def paused?
+        state == "PAUSED"
+      end
+
+      # @return [Boolean] true when the state is "FINISHED"
+      sig { returns(T::Boolean) }
+      def finished?
+        state == "FINISHED"
+      end
+
+      # @return [Boolean] true when the state is "STOPPED"
+      sig { returns(T::Boolean) }
+      def stopped?
+        state == "STOPPED"
+      end
+
+      # @return [Boolean] true when the state is "ERROR"
+      sig { returns(T::Boolean) }
+      def error?
+        state == "ERROR"
+      end
+
+      # @return [Boolean] true when the state is "ATTENTION" (the printer waits for user input)
+      sig { returns(T::Boolean) }
+      def attention?
+        state == "ATTENTION"
+      end
+
+      # @return [Boolean] true when the state is "READY"
+      sig { returns(T::Boolean) }
+      def ready?
+        state == "READY"
+      end
+    end
+  end
+end

data/lib/prusalink/status/storage.rb

@@ -0,0 +1,40 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  class Status
+    # Telemetry about the current storage.
+    #
+    # @example
+    #   storage = Prusalink::Status.get.storage
+    #   storage.name       # => "LOCAL"
+    #   storage.free_space # => 4202335
+    class Storage
+      extend T::Sig
+      include AutoInitializable
+      include Deserializable
+
+      # @!attribute [r] name
+      #   @return [String] The storage's name, e.g. "LOCAL"
+      auto_attr :name, type: String
+
+      # @!attribute [r] path
+      #   @return [String] The storage's path, e.g. "/local"
+      auto_attr :path, type: String
+
+      # @!attribute [r] read_only
+      #   @return [Boolean] Whether the storage is read-only
+      auto_attr :read_only, type: T::Boolean
+
+      # @!attribute [r] free_space
+      #   @return [Integer] Free space, in bytes
+      auto_attr :free_space, type: Integer
+
+      # @!attribute [r] extra
+      #   @return [Hash] Any additional fields returned by the API
+      auto_attr :extra, type: Hash
+
+      auto_initialize!
+    end
+  end
+end

data/lib/prusalink/status/transfer.rb

@@ -0,0 +1,40 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  class Status
+    # Telemetry about the current file transfer. All values except {#id} and {#time_transferring} are optional.
+    #
+    # @example
+    #   transfer = Prusalink::Status.get.transfer
+    #   transfer.progress         # => 65.82
+    #   transfer.data_transferred # => 123084800
+    class Transfer
+      extend T::Sig
+      include AutoInitializable
+      include Deserializable
+
+      # @!attribute [r] id
+      #   @return [Integer] The transfer's id
+      auto_attr :id, type: Integer
+
+      # @!attribute [r] time_transferring
+      #   @return [Integer] Time spent transferring, in seconds
+      auto_attr :time_transferring, type: Integer
+
+      # @!attribute [r] progress
+      #   @return [Float] Transfer progress, in percent
+      auto_attr :progress, type: Float
+
+      # @!attribute [r] data_transferred
+      #   @return [Integer] Amount of data transferred, in bytes
+      auto_attr :data_transferred, type: Integer
+
+      # @!attribute [r] extra
+      #   @return [Hash] Any additional fields returned by the API
+      auto_attr :extra, type: Hash
+
+      auto_initialize!
+    end
+  end
+end

data/lib/prusalink/status.rb

@@ -0,0 +1,64 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  # Telemetry about the printer, the current job, the current transfer, the storage and the camera.
+  # Everything except {#printer} is optional and is nil when the printer doesn't report it.
+  #
+  # @example
+  #   status = Prusalink::Status.get
+  #   status.printer.state       # => "PRINTING"
+  #   status.printer.printing?   # => true
+  #   status.job&.progress       # => 42.0
+  #   status.transfer            # => nil when nothing is being transferred
+  class Status < BaseResource
+    extend T::Sig
+    include AutoInitializable
+    include Deserializable
+
+    resource_path("/api/v1/status")
+
+    # @!attribute [r] printer
+    #   @return [Status::Printer] Telemetry about the printer (always present)
+    auto_attr :printer, type: Status::Printer
+
+    # @!attribute [r] job
+    #   @return [Status::Job, nil] Telemetry about the current job
+    auto_attr :job, type: Status::Job
+
+    # @!attribute [r] transfer
+    #   @return [Status::Transfer, nil] Telemetry about the current file transfer
+    auto_attr :transfer, type: Status::Transfer
+
+    # @!attribute [r] storage
+    #   @return [Status::Storage, nil] Telemetry about the current storage
+    auto_attr :storage, type: Status::Storage
+
+    # @!attribute [r] camera
+    #   @return [Status::Camera, nil] The default working camera, if available
+    auto_attr :camera, type: Status::Camera
+
+    # @!attribute [r] extra
+    #   @return [Hash] Any additional fields returned by the API
+    auto_attr :extra, type: Hash
+
+    auto_initialize!
+
+    deserialize_config do
+      nested :printer, Status::Printer
+      nested :job, Status::Job
+      nested :transfer, Status::Transfer
+      nested :storage, Status::Storage
+      nested :camera, Status::Camera
+    end
+
+    # Retrieve the printer, job, transfer, storage and camera telemetry.
+    #
+    # @return [Status, nil] nil when the printer answers 204 No Content
+    # @raise [Prusalink::Exceptions::Error] if the request fails
+    sig { returns(T.nilable(Status)) }
+    def self.get
+      fetch_resource
+    end
+  end
+end

data/lib/prusalink/storage.rb

@@ -0,0 +1,87 @@
+# typed: true
+# frozen_string_literal: true
+
+module Prusalink
+  # A file storage of the printer, such as the local storage, an SD card or a USB drive.
+  #
+  # @example
+  #   storages = Prusalink::Storage.list
+  #   usb = storages.find { |storage| storage.storage_type == "USB" }
+  #   usb.available? # => true
+  #   usb.free_space # => 1921681142
+  class Storage < BaseResource
+    extend T::Sig
+    include AutoInitializable
+    include Deserializable
+
+    resource_path("/api/v1/storage")
+
+    # @!attribute [r] name
+    #   @return [String, nil] Name of the storage, in the printer's language, e.g. "PrusaLink gcodes"
+    auto_attr :name, type: String
+
+    # @!attribute [r] storage_type
+    #   @return [String] The storage's source: "LOCAL", "SDCARD" or "USB". Renamed from the API's `type` field.
+    auto_attr :storage_type, type: String
+
+    # @!attribute [r] path
+    #   @return [String] Path of the storage (not the display path), e.g. "/local"
+    auto_attr :path, type: String
+
+    # @!attribute [r] print_files
+    #   @return [Integer, nil] Size of all print files, in bytes
+    auto_attr :print_files, type: Integer
+
+    # @!attribute [r] system_files
+    #   @return [Integer, nil] Size of all system files, in bytes
+    auto_attr :system_files, type: Integer
+
+    # @!attribute [r] free_space
+    #   @return [Integer, nil] Free space, in bytes
+    auto_attr :free_space, type: Integer
+
+    # @!attribute [r] total_space
+    #   @return [Integer, nil] Total space, in bytes
+    auto_attr :total_space, type: Integer
+
+    # @!attribute [r] available
+    #   @return [Boolean] Whether the storage is available. See {#available?}
+    auto_attr :available, type: T::Boolean
+
+    # @!attribute [r] read_only
+    #   @return [Boolean, nil] Whether the storage is read only. See {#read_only?}
+    auto_attr :read_only, type: T::Boolean
+
+    # @!attribute [r] extra
+    #   @return [Hash] Any additional fields returned by the API
+    auto_attr :extra, type: Hash
+
+    auto_initialize!
+
+    deserialize_config do
+      rename type: :storage_type
+    end
+
+    # Retrieve every file storage of the printer.
+    #
+    # @return [Array<Storage>]
+    # @raise [Prusalink::Exceptions::Error] if the request fails
+    sig { returns(T::Array[Storage]) }
+    def self.list
+      response = fetch_resource(deserialize: false)
+      Array(response&.fetch(:storage_list, nil)).map { |storage| deserialize(storage) }
+    end
+
+    # @return [Boolean] whether the storage is available
+    sig { returns(T::Boolean) }
+    def available?
+      available == true
+    end
+
+    # @return [Boolean] whether the storage is read only
+    sig { returns(T::Boolean) }
+    def read_only?
+      read_only == true
+    end
+  end
+end