TRMNL Anki

TRMNL Anki is an add-on/plugin combination that allows a TRMNL to display your Anki flashcards. It supports multiple instances and mashups. It requires a TRMNL with developer edition and a private plugin created from the template located in the GitHub repo here. (If you use the code JUSTTHOMAS you get $15 off your TRMNL order. Thanks for your support!)

Note: Since this is an Anki Add-on / TRMNL Plugin combination, if you find that something broke and the add-on is up to date, it might be the plugin side that's broken (since it doesn't have automatic updates). Check the GitHub for any updates or submit an issue there <3

TRMNL Anki Add-on

This is the add-on that is added to Anki. It scans the Anki notes at a recurring interval, gets the relevant field data for a single note, compresses it, and sends it to the TRMNL server via a webhook. It does not support images or (of course) audio.

Config

Configuration is as follows. You do not need to restart Anki for changes to take effect (unless the config change crashed the add-on, which means the thing that watches the config change also crashed).

refresh_rate

This is the rate in seconds that the add-on will fetch and send data to the TRMNL server. It does not affect how often the TRMNL device refreshes its screen. It has a hard-coded minimum of 300 seconds to avoid rate limiting from TRMNL's server. To help aid initial setup, you can force the add-on to refresh in the Anki menu under Tools > Refresh TRMNL (This can still be affected by the rate limiting).

plugins

An array of configuration for TRMNL Anki plugins.

Plugin Config

enabled

Set to false to stop the plugin from sending data.

visible_fields

An array of case-sensitive strings that are Anki note fields. If a note has one of these fields, it will be sent to the TRMNL server to be displayed. Data is sent in the order that the fields are listed. This means you should order the fields in the priority they should be displayed.

webhook

The webhook link for the TRMNL plugin. Found on the TRMNL website.

search_query

The query that will be executed to find notes. This takes the same syntax as the Anki Browser. Double quotes must be escaped.

Example:

"search_query": "(is:new OR is:learn OR is:review) \"note:Cantonese Basic\""

Full Example

{
    "plugins": [
        {
            "search_query": "(is:new OR is:learn OR is:review) \"note:Japanese Sentence Mine\"",
            "visible_fields": [
                "Word",
                "Meaning",
                "Sentence"
            ],
            "webhook": "https://usetrmnl.com/api/custom_plugins/replace-this-1"
        },
        {
            "search_query": "nid:1741914054864",
            "visible_fields": [
                "Word",
                "Meaning",
                "Sentence"
            ],
            "webhook": "https://usetrmnl.com/api/custom_plugins/replace-this-2"
        },
        {
            "search_query": "\"note:AnkiJazz - Theory\"",
            "visible_fields": [
                "Front",
                "Back"
            ],
            "webhook": "https://usetrmnl.com/api/custom_plugins/replace-this-3"
        }
    ],
    "refresh_rate": "300"
}