diff --git a/README.adoc b/README.adoc index 77bc435..bb010b1 100644 --- a/README.adoc +++ b/README.adoc @@ -82,6 +82,24 @@ Any/all environment changes will be applied unless you override these settings v === Endpoints +==== Categories + +Allows you to obtain the list of approved plugin categories. Example: + +[source,ruby] +---- +client = TRMNL::API::Client.new +client.categories + +# Success( +# [ +# "analytics", +# "art", +# "calendar" +# ] +# ) +---- + ==== Current Screen Allows you to obtain current screen being displayed for your device. You must supply your device's API token as the `token`. Example: @@ -135,6 +153,29 @@ client.firmware # Success(#) ---- +==== 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: + +[source,ruby] +---- +client = TRMNL::API::Client.new +client.ip_addresses + +# Success( +# #, +# # +# ], +# version_6=[ +# #, +# # +# ] +# > +# ) +---- + ==== Log Allows you to create a log entry (which is what the device reports when it captures an error). You must supply your device's API token as the `token`. Example: @@ -188,6 +229,7 @@ client.models # name="test", # label="Test", # description="A test.", +# kind="trmnl", # colors=2, # bit_depth=1, # scale_factor=1, @@ -197,13 +239,66 @@ client.models # height=480, # offset_x=10, # offset_y=15, -# published_at="2025-07-16T18:18:11+00:00" +# palette_ids=["bw"], +# css: { +# classes: { +# device: "screen--og_png", +# size: "screen--md" +# }, +# variables: [ +# [ +# "--screen-w", +# "800px" +# ], +# [ +# "--screen-h", +# "480px" +# ], +# [ +# "--ui-scale", +# "1.0" +# ], +# [ +# "--gap-scale", +# "1.0" +# ] +# ] +# } # > # ) ---- ℹ️ The `scale_factor` can be an integer or float. +==== Palettes + +Allows you to obtain palettes details. The IDs correlate to the `palette_ids` as found in the Models API. Example: + +[source,ruby] +---- +client = TRMNL::API::Client.new +client.palettes + +Success( + [ + #, + # + ] +) +---- + ==== Setup Allows you to obtain the setup response for when a new device is setup. You must supply your device's MAC Address as the `id`. Example: