trmnl-api 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8efedaa295b0c387a87ff3ae179bc8179e21485505de33474d1b5e00bb694e15
-  data.tar.gz: ca6875d143b129e2b42114289a3be856e41b5581b4e7ba5286292e6829b3c940
+  metadata.gz: f0980ab987d84b0a2b433ba2e51c940debf05ab8300b68fdabb957bd5d193f8c
+  data.tar.gz: e879629070c4aa3790fee398e737c095818e47db0e182fe68dd19b96679ee731
 SHA512:
-  metadata.gz: d2ba42f64f6e549c6852b5326d7ef0e1a1a8356baff3010fa88e2fe7469fcc82986b3b15ade6fe9734cc1d7df36474139b8c6345733eb8bf932e900ddd04f791
-  data.tar.gz: 0d7e7e1ade6a86c1f689ac783ba5160dd87544306e295b9befe9150c86cb26d410f15e0efa64ee867be9e2a06ef06bd82c6ff19a6502a53709da4a2f863db570
+  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"]
+#  >
 # )
 ----
 
@@ -386,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(**)
 

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,8 +20,6 @@ module TRMNL
           include Inspectable[schema: :type]
           include Pipeable
 
-          ASSET_URI = "https://trmnl-fw.s3.us-east-2.amazonaws.com/%<model_name>s/FW%<version>s.bin"
-
           def initialize(asset_uri: ASSET_URI, **)
             @asset_uri = asset_uri
             super(**)

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.22.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.22.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.22
+rubygems_version: 4.0.24
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []