trmnl-api 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4ad04625f2891041bc884419cfdf98484be6a3a6a45cec71a45353615b3280f
-  data.tar.gz: eca25cf2510f0967c85960102396e4307a3f99054640d3ef07b0f288b22ccde1
+  metadata.gz: f0980ab987d84b0a2b433ba2e51c940debf05ab8300b68fdabb957bd5d193f8c
+  data.tar.gz: e879629070c4aa3790fee398e737c095818e47db0e182fe68dd19b96679ee731
 SHA512:
-  metadata.gz: 8099e1466106d6a33afec9ec777e378bee3805ea7f0abbf2e73044373705b9eae36c2c6290c6748c2e592dfadb9e16d734f67a2aba3a50a936fde136c35ff11e
-  data.tar.gz: f6b487d1e3ee7b3f1bb55cf992d88c106427093fe6bcb84937a19a47ef0031bc4a35c6d2413ceb8c2be9f37404280ed78227b2488cc1aee54e4bcf95437e4e66
+  metadata.gz: f68e6cbf30b644f3c931d184f709cdca9d412880bbd369fc21aabd407879c4e959f2d6067be5a6bba647bd6ef8970ec2dfab29bff49e07069a7e909dbd253cfc
+  data.tar.gz: 92f25649191286a0a4bc9b17a75cc69330f366daa4b67033335a50d0a95ed504823e6460f3a8dbc83781b5beead560b1343d1967332524cc832fa771aa0dfcfc

data/README.adoc

@@ -137,20 +137,21 @@ client = TRMNL::API.new
 client.display token: "secret"
 
 # Success(
-#   #<struct TRMNL::API::Models::Display
-#     filename="plugin-4c2660-1780411821",
-#     firmware_url="https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_og/FW1.8.5.bin",
-#     firmware_version="1.8.5",
-#     image_url="https://trmnl.s3.us-east-2.amazonaws.com/...",
-#     image_url_timeout=0,
-#     maximum_compatibility=false,
-#     refresh_rate=1765,
-#     reset_firmware=false,
-#     special_function="none",
-#     temperature_profile="default",
-#     touchbar_mode="tap",
-#     update_firmware=true
-#   >
+#  #<data TRMNL::API::Models::Display
+#    filename="plugin-0ac339-1794250527",
+#    image_url="https://trmnl.s3.us-east-2.amazonaws.com/...",
+#    image_url_timeout=0,
+#    refresh_rate=1769,
+#    firmware_version="1.8.18",
+#    firmware_url="https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_og/FW1.8.18.bin",
+#    update_firmware=true,
+#    reset_firmware=false,
+#    maximum_compatibility=false,
+#    temperature_profile="default",
+#    touchbar_mode="tap",
+#    action=nil,
+#    playlist_image_names=["plugin-0ac339", "plugin-f60d70", "plugin-499f35"]
+#  >
 # )
 ----
 
@@ -232,6 +233,38 @@ client.firmware_latest
 # )
 ----
 
+You can also tweak the result to answer current (or past) versions, specific model names, and/or both. Examples:
+
+**By Version**
+
+[source,ruby]
+----
+client = TRMNL::API.new
+client.firmware_latest "1.8.0"
+
+# Success(
+#   #<data TRMNL::API::Models::Firmware::Latest
+#          url="https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_og/FW1.8.0.bin",
+#          version="1.8.0">
+# )
+----
+
+**By Model Name**
+
+[source,ruby]
+----
+client = TRMNL::API.new
+client.firmware_latest model_name: "trmnl_x"
+
+# Success(
+#   #<data TRMNL::API::Models::Firmware::Latest
+#          url="https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/FW1.8.17.bin",
+#          version="1.8.17">
+# )
+----
+
+⚠️ This isn't officially supported by the TRMNL API since the endpoint only knows how to provide the latest firmware for OG models so the above allows you to obtain what you need by dynamically formatting the URI based on version and model name. This also means if you make a typo, you might get a URI that doesn't exist since no verification happens.
+
 ==== IP Addresses
 
 Allows you obtain a list of public IP addresses for all TRMNL core servers because plugin poll requests will only originate from these IPs. Example:
@@ -354,6 +387,7 @@ client.models
 #        "gray-4",
 #        "bw"
 #      ],
+#      default_palette_name = "gray-16"
 #      rotation = 0,
 #      scale_factor = 1.8,
 #      width = 1872

data/lib/trmnl/api/client.rb

@@ -6,9 +6,6 @@ module TRMNL
   module API
     # Provides the primary client for making API requests.
     class Client
-      include Dependencies[:settings]
-      include Inspectable[:endpoints]
-
       ENDPOINTS = {
         categories: Endpoints::Category,
         current_screen: Endpoints::CurrentScreen,
@@ -23,6 +20,9 @@ module TRMNL
         setup: Endpoints::Setup
       }.freeze
 
+      include Dependencies[:settings]
+      include Inspectable[:endpoints]
+
       def initialize(requester: Requester, endpoints: ENDPOINTS, **)
         super(**)
 
@@ -43,7 +43,7 @@ module TRMNL
 
       def firmware_flashes = endpoints.fetch(__method__).call
 
-      def firmware_latest = endpoints.fetch(__method__).call
+      def firmware_latest(...) = endpoints.fetch(__method__).call(...)
 
       def ip_addresses = endpoints.fetch(__method__).call
 

data/lib/trmnl/api/endpoints/firmware/latest.rb

@@ -9,6 +9,8 @@ module TRMNL
       module Firmware
         # Handles API request/response.
         class Latest
+          ASSET_URI = "https://trmnl-fw.s3.us-east-2.amazonaws.com/%<model_name>s/FW%<version>s.bin"
+
           include TRMNL::API::Dependencies[
             :requester,
             schema: "schemas.firmware.latest",
@@ -18,12 +20,26 @@ module TRMNL
           include Inspectable[schema: :type]
           include Pipeable
 
-          def call
+          def initialize(asset_uri: ASSET_URI, **)
+            @asset_uri = asset_uri
+            super(**)
+          end
+
+          def call version = nil, model_name: "trmnl_og"
             pipe requester.get("firmware/latest"),
                  try(:parse, catch: JSON::ParserError),
                  validate(schema, as: :to_h),
+                 fmap { transform_uri it, (version || it[:version]), model_name },
                  to(model, :for)
           end
+
+          private
+
+          attr_reader :asset_uri
+
+          def transform_uri data, version, model_name
+            data.merge! url: format(asset_uri, model_name:, version:), version:
+          end
         end
       end
     end

data/lib/trmnl/api/models/display.rb

@@ -6,32 +6,34 @@ module TRMNL
       # Models the data of the API response.
       Display = Data.define(
         :filename,
-        :firmware_url,
-        :firmware_version,
         :image_url,
         :image_url_timeout,
-        :maximum_compatibility,
         :refresh_rate,
+        :firmware_version,
+        :firmware_url,
+        :update_firmware,
         :reset_firmware,
-        :special_function,
+        :maximum_compatibility,
         :temperature_profile,
         :touchbar_mode,
-        :update_firmware
+        :action,
+        :playlist_image_names
       ) do
         def self.for(attributes) = new(**attributes)
 
         def initialize filename: nil,
-                       firmware_url: nil,
-                       firmware_version: nil,
                        image_url: nil,
                        image_url_timeout: 0,
-                       maximum_compatibility: false,
                        refresh_rate: 300,
+                       firmware_version: nil,
+                       firmware_url: nil,
+                       update_firmware: false,
                        reset_firmware: false,
-                       special_function: "none",
+                       maximum_compatibility: false,
                        temperature_profile: "default",
                        touchbar_mode: "tap",
-                       update_firmware: false
+                       action: nil,
+                       playlist_image_names: nil
           super
         end
 

data/lib/trmnl/api/models/model.rb

@@ -21,9 +21,17 @@ module TRMNL
         :offset_x,
         :offset_y,
         :palette_names,
+        :default_palette_name,
         :css
       ) do
-        def self.for(attributes) = new(**attributes.transform_keys!(palette_ids: :palette_names))
+        def self.for attributes
+          new(
+            **attributes.transform_keys!(
+              palette_ids: :palette_names,
+              default_palette_id: :default_palette_name
+            )
+          )
+        end
 
         def initialize(**)
           super

data/lib/trmnl/api/schemas/display.rb

@@ -8,13 +8,18 @@ module TRMNL
       # Validates API response.
       Display = Dry::Schema.JSON do
         required(:filename).filled :string
-        required(:firmware_url).filled :string
-        optional(:firmware_version).maybe :string
         required(:image_url).filled :string
+        optional(:image_url_timeout).filled :integer
         required(:refresh_rate).filled :integer
+        optional(:firmware_version).filled :string
+        required(:firmware_url).filled :string
         required(:reset_firmware).filled :bool
-        required(:special_function).filled :string
         required(:update_firmware).filled :bool
+        optional(:maximum_compatibility).filled :bool
+        optional(:temperature_profile).filled :string
+        optional(:touchbar_mode).filled :string
+        optional(:action).filled :string
+        optional(:playlist_image_names).filled(:array).each(:string)
       end
     end
   end

data/lib/trmnl/api/schemas/model.rb

@@ -22,6 +22,7 @@ module TRMNL
           required(:offset_x).filled :integer
           required(:offset_y).filled :integer
           required(:palette_ids).array(:string)
+          required(:default_palette_id).filled :string
           optional(:css).hash do
             optional(:classes).hash do
               required(:density).filled :string

data/trmnl-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "trmnl-api"
-  spec.version = "0.21.0"
+  spec.version = "0.23.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/trmnl-api"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl-api
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -272,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.21
+rubygems_version: 4.0.24
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []