trmnl_preview 0.12.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e476239f7e0c53801c4a3100d40640de825bda5ad90174893caf919d26c7a8c4
-  data.tar.gz: 66552a72bd4a6e761090064712f8bc01cb84c5cbff4a8a166b14020f6fcf8f79
+  metadata.gz: ecba4b3a3029f83fccf8ec4efd0215f8a83a8d0d12f2bdaaeef01ee4647b7f8a
+  data.tar.gz: bdbca95517982906657d3b568446c8c525976d9cd0a128e2a96d7c923ff8b59b
 SHA512:
-  metadata.gz: 54e5c7f1044484fb55f26881a8c853455fdf0a3149ad9567633dec55fc2004c36645ab84c00589984cb82192298fd0a8ab40040ed5c57442058595d532102508
-  data.tar.gz: dea4cfcecfeb3fabf9f0df522cc23bffbf90dc1638f03406d17d1022ae777f2846fe9fd7acd1ced2b7c379c2bd6e3d79d665e7b94e80864a64698c3c617ea4ef
+  metadata.gz: 7e599a894d8ef1fc3c3f89f22293284e188d26a563cc063bba5dbdee35865da6eac91ef64c27d1684f91e160e946433b52cf438ecd8f6c02f6cff5ccccbaba0e
+  data.tar.gz: aeb473789628ed40f5a68b14978dddb6ac1fbc49d32828a69c1a4de68abca941ba3288f6d5fac2be66f0c9f0ed4869389b5be8cf6c9d3ecb59db4a3dd0257ef0

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 
 # Changelog
 
+## 0.13.1
+
+- `lat_lon` is a known form field type, so `trmnlp lint`, `build` and `serve` no longer warn "unknown field_type: lat_lon" for a location field. The vendored list in `db/data/form_fields.yml` predated the hosted service adding it. (#129)
+
+## 0.13.0
+
+- `trmnlp login` now accepts the scoped API keys trmnl.com issues with a `trmnl_` prefix, as well as `user_` account keys. It used to refuse them with "Invalid API key; did you copy it from the right place?" before checking them with the server. A scoped key needs the profile capability to log in, read to list and pull, and content to push. With delete as well, a failed first push removes the plugin it created. (#132)
+- The local preview now fills the `trmnl` fields the hosted service added: `trmnl.device.model`, `bit_depth`, `firmware_version`, `refresh_interval_seconds`, `sleep_mode_enabled`, `sleep_start_time` and `sleep_end_time`, and `trmnl.plugin_settings.refresh_interval_minutes`. The model and bit depth follow the device picker, with `og_plus` and 2 when nothing is picked. (#131)
+
 ## 0.12.0
 
 - `required_ruby_version` is now `>= 4.0`, matching the Ruby version trmnlp actually needs. It has understated the real floor since 0.4.0: both `xdg` (Ruby 4.0 in the 10.x series pinned since 0.8.0) and `trmnl-liquid` (Ruby 4.0 since 0.5.0) require more than the gemspec claimed. RubyGems resolves against the declared value, so `gem install trmnl_preview` on an older Ruby did not fail. It quietly walked backwards to the newest version whose dependency tree resolved, reporting "Successfully installed" for a build up to twenty months old. On Ruby 3.4 that was 0.7.1, and on Ruby 3.3 and below it was 0.3.2, which predates the Thor CLI and offers only `serve`, `build` and `version`. Asking for the current version explicitly (`gem install trmnl_preview -v 0.11.0`) crashed RubyGems inside its own conflict reporting rather than explaining the problem. Installing on an unsupported Ruby now stops with "requires Ruby version >= 4.0".

data/db/data/form_fields.yml

@@ -18,6 +18,7 @@ field_types:
   - copyable
   - copyable_webhook_url
   - date
+  - lat_lon
   - multi_string
   - number
   - password

data/lib/trmnlp/commands/login.rb

@@ -17,8 +17,8 @@ module TRMNLP
         api_key = prompt('API Key: ')
         raise InvalidApiKey, 'API key cannot be empty' if api_key.empty?
 
-        # Only trmnl.com issues user_-prefixed keys; BYOS servers use their own token formats (e.g. Sanctum).
-        if config.app.trmnl_host? && !api_key.start_with?('user_')
+        # Only trmnl.com issues user_ and trmnl_ prefixed keys; BYOS servers use their own token formats (e.g. Sanctum).
+        if config.app.trmnl_host? && !api_key.start_with?('user_', 'trmnl_')
           raise InvalidApiKey,
                 'Invalid API key; did you copy it from the right place?'
         end

data/lib/trmnlp/config/plugin.rb

@@ -26,6 +26,7 @@ module TRMNLP
       end
 
       def strategy = @config['strategy']
+      def refresh_interval = @config['refresh_interval']
       def polling? = strategy == 'polling'
       def webhook? = strategy == 'webhook'
       def static? = strategy == 'static'

data/lib/trmnlp/user_data_assembler.rb

@@ -29,7 +29,8 @@ module TRMNLP
     end
 
     def device_from_params(params)
-      { 'width' => params[:width]&.to_i, 'height' => params[:height]&.to_i }.compact
+      { 'width' => params[:width]&.to_i, 'height' => params[:height]&.to_i,
+        'model' => params[:model], 'bit_depth' => params[:bit_depth]&.to_i }.compact
     end
 
     private
@@ -86,13 +87,17 @@ module TRMNLP
       {
         'friendly_id' => 'ABC123', 'percent_charged' => 85.0, 'wifi_strength' => 90,
         'height' => device['height'] || DEFAULT_DEVICE_HEIGHT,
-        'width' => device['width'] || DEFAULT_DEVICE_WIDTH
+        'width' => device['width'] || DEFAULT_DEVICE_WIDTH,
+        'model' => device['model'] || 'og_plus', 'bit_depth' => device['bit_depth'] || 2,
+        'firmware_version' => '1.6.3', 'refresh_interval_seconds' => 900,
+        'sleep_mode_enabled' => false, 'sleep_start_time' => 1320, 'sleep_end_time' => 480
       }
     end
 
     def plugin_settings_namespace
       {
         'instance_name' => 'instance_name',
+        'refresh_interval_minutes' => config.plugin.refresh_interval,
         'strategy' => config.plugin.strategy,
         'dark_mode' => config.plugin.dark_mode,
         'polling_headers' => config.plugin.polling_headers_encoded,

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = '0.12.0'
+  VERSION = '0.13.1'
 end

data/web/public/index.js

@@ -20,18 +20,22 @@ trmnlp.connectLiveRender = function () {
 };
 
 
+// trmnl.device values the picked model and palette decide.
+trmnlp.deviceParams = function (state) {
+  const bitDepth = Math.ceil(Math.log2(state.palette?.grays || 2));
+  return new URLSearchParams({ width: state.width, height: state.height, model: state.model.name, bit_depth: bitDepth });
+};
+
 trmnlp.fetchPreview = function (pickerState) {
   const state = pickerState || trmnlp.picker?.state;
   const screenClasses = (state?.screenClasses || []).join(" ");
   const encodedScreenClasses = encodeURIComponent(screenClasses);
   let src = `/render/${trmnlp.view}.${trmnlp.formatSelect.value}?screen_classes=${encodedScreenClasses}`;
 
-  // Pass dimensions for both HTML and PNG renders so trmnl.device.{width,height}
+  // Pass the device for both HTML and PNG renders so trmnl.device.{width,height,model,bit_depth}
   // in the Liquid context tracks the picker model selection.
   if (state) {
-    const width = encodeURIComponent(state.width);
-    const height = encodeURIComponent(state.height);
-    src += `&width=${width}&height=${height}`;
+    src += `&${trmnlp.deviceParams(state)}`;
   }
 
   // PNG-only: dark mode + color depth from palette
@@ -48,7 +52,7 @@ trmnlp.fetchPreview = function (pickerState) {
 
 trmnlp.refreshUserData = async function (state) {
   if (!state) return;
-  const params = new URLSearchParams({ width: state.width, height: state.height });
+  const params = trmnlp.deviceParams(state);
   try {
     const response = await fetch(`/data?${params}`);
     if (!response.ok) return;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Rockwell Schrock