83 Commits
Author SHA1 Message Date
Brooke Kuhlmann 0953ece84f Updated devices documentation to reflect recent hardware changes
Milestone: minor
2026-08-11 08:32:55 -06:00
Brooke Kuhlmann 8163b13e9e Removed device firmware automatic update from defaults
Necessary to prevent automatic bricking of devices due to unreliable firmware updates. I have a couple issues, via the Core and Firmware projects, to address this but the root cause stems from unreliable and inconsistent firmware version releases.

Milestone: minor
2026-08-05 09:54:20 -06:00
Brooke Kuhlmann acc3645917 Updated documentation survey links
Allows these links to be accessible via documentation instead of using the dashboard for this.

Milestone: minor
2026-08-05 09:53:30 -06:00
Brooke Kuhlmann 97dea93666 Added command to Devices API
Necessary to support device commands (this also updates the `touch_bar` value for better test coverage).

Issue: 345
Milestone: minor
2026-07-22 12:24:42 -06:00
Brooke Kuhlmann b78cedf56c Added device API key
This is a partial revert of d470a36 (Removed device friendly ID and API implementation) and is also why all of these changes are in a single commit since they are related and represent the revert of the original commit (for the most part). These changes allow us to restore use of the device API key because the Firmware fails to process Setup API requests when the `status` key is missing from the JSON payload body despite using a proper HTTP status code in the API response. By using the API key, we solve the following:

* Can use both the HTTP ID and ACCESS_TOKEN headers to identify, provision, and authenticate a device (more will be supported soon).
* Can transition devices between our Core server and this server more easily.
* Can support TRMNL Viewer and TRMNL Lib projects.
* Can finally stop devices from constantly hitting the Setup API before each Display API request.

As for the database migration, a unique index is used for the API Key but only when the API key is not `nil`.

Issue: 347
Milestone: minor
2026-07-14 15:29:31 -06:00
Brooke Kuhlmann 22ce23d61b Updated to TRMNL API 0.19.0
Minor updates but defaults the device special function to none instead of sleep.

Milestone: minor
2026-07-13 17:15:00 -06:00
Brooke Kuhlmann b363fbbd4a Added API log creation action log level
Necessary to support log levels in future firmware versions. For now, the level, is optional but will be required in the future.

Milestone: minor
2026-06-30 11:07:39 -06:00
Brooke Kuhlmann 982d32d754 Added font synchronizer configuration
Allows folks to disable the synchronizer in case folks don't want or don't need this functionality.

Milestone: minor
2026-06-30 08:18:49 -06:00
Brooke Kuhlmann 550c5238d0 Updated firmware ID and access token documentation
Explains how the HTTP access token serves as an alias/fallbcak for the ID header.

Milestone: minor
2026-06-29 10:54:27 -06:00
Brooke Kuhlmann 44db96eb4d Removed browser environment variable setting
No longer needed now that we are using individual Ferrum environment variables.

Milestone: minor
2026-06-24 12:28:28 -06:00
Brooke Kuhlmann 53f4e3bd6d Updated browser configuration to be split into individual Ferrum options
Necessary to simplify the configuration so you can tweak individual environment variables instead of a single environment variable which required a hash value. This will allow us to remove the more complicated `BROWSER` environment variable in favor of this change.

This is a _breaking change_ and will require some folks to update their environment settings accordingly.

Milestone: minor
2026-06-24 12:28:27 -06:00
Brooke Kuhlmann 79f4280de5 Refactored designer to designs namespace
Necessary to allow the designer to manage multiple designs (i.e. screen templates).

Issue: 321
Milestone: patch
2026-06-22 12:11:56 -06:00
Brooke Kuhlmann 3f77fd1abd Fixed Display API documentation typos
A few small tweaks and corrections.

Milestone: patch
2026-06-19 07:28:41 -06:00
Brooke Kuhlmann 682c72daef Fixed API access token and session environment variable documentation
Necessary to clarify how these variables work and how they interact with each other.

Milestone: patch
2026-06-16 09:06:51 -06:00
Brooke Kuhlmann 78121116ca Removed API setup trailing slash from documentation
This was a typo since all endpoints don't use trailing slashes.

Issue: 333
Milestone: patch
2026-06-14 11:03:24 -06:00
Brooke Kuhlmann 759bbf3a87 Added session expiration environment variable
While disablement is not recommended, this can be useful when running on a local network with no outside access.

This will soon be used to enable or disable within Rodauth when the session expiration feature is loaded and configured.

Issue: 327
Milestone: minor
2026-06-13 17:40:52 -06:00
Brooke Kuhlmann d470a36927 Removed device friendly ID and API implementation
These attributes were originally used for the Core proxy feature (and device provisioning) but are no longer needed. These changes completely remove these attributes (including the migration for removing from the `device` table).

Issue: 326
Milestone: minor
2026-06-10 11:32:51 -06:00
Nate GibsonandBrooke Kuhlmann 96abc28134 Updated Kubernetes documentation with Valkey storage guidance
Aligns Kubernetes documentation with existing documentation for Valkey storage configuration guidance.

Co-authored-by: Brooke Kuhlmann <brooke@alchemists.io>
Milestone: minor
2026-06-09 10:46:22 -06:00
Brooke Kuhlmann ce6a93bacd Updated API documentation to include recent attributes
Necessary to reflect recent changes so that the documentation matches the current implementation.

Milestone: minor
2026-06-09 10:42:56 -06:00
Brooke Kuhlmann 03675b93d9 Fixed configuration documentation typos and links
The header had a typo while the links were missing when transferred from the main documentation.

Milestone: patch
2026-06-08 07:26:26 -06:00
Brooke Kuhlmann 799c8414ad Updated Display API documentation to reflect recent attribute updates
Necessary to document what the updated API response looks like now that all attributes are included.

Milestone: minor
2026-06-03 11:08:47 -06:00
Brooke Kuhlmann d4601a0082 Updated API documentation for devices with latest attributes
Necessary to documenat the new headers and API responses. Not all of the battery headers are fully supported, though, that will be added later.

Milestone: minor
2026-06-02 17:19:37 -06:00
Brooke Kuhlmann 46d7be8bb6 Added configuration documentation for Puma environment variables
This has existed from the start but hasn't been documented so is now listed as such.

Milestone: patch
2026-06-01 10:35:22 -06:00
Brooke Kuhlmann 1217558d14 Updated extension documentation reflect import/export capabilities
Necessary to reflect the current capabilities of the application especially now that you can import and export extensions.

Milestone: minor
2026-05-24 13:24:55 -06:00
Brooke Kuhlmann 90669db206 Fixed inconsistency with RFC 3339 formatted data/times
Necessary to adhere to link:https://datatracker.ietf.org/doc/html/rfc3339[RFC 3339] which corrects the RSpec matcher, time transformer, and associated specs.

Issue: 312
Milestone: patch
2026-05-18 19:27:05 -06:00