writeDashboard
Generates or updates a Garmin training dashboard HTML page with recent weekly data and returns a data digest for coach notes; preview mode shows results without writing.
Instructions
Writes the training dashboard page (default /garmin-dashboard.html) with the data of the
last weeks weeks, and returns its path and a short digest of the data (totals, weekly sums, load,
best efforts, races, long runs, race predictions, strength top sets, readiness, fitness and form,
HRV, recovery, fitness age, sync) for the coach notes. Without HRV and sleep data the digest has
no readiness: give the verdict as n/a.
An existing page keeps all its code, layout and widgets: its data is replaced. A page with
different page code gets the page code of the server and keeps its layout and widgets; the result then has page: "upgraded",
previousServer (the server version that wrote the page, n/a when unknown) and server. Every page from the template
also gets the custom widgets of the widget library (/widgets.json), not placed on a board.
On a page from the template, an edited board also gets the widgets that a release adds to its preset, one time;
the result lists the ones that the page shows in addedWidgets (board -> widget ids).
layout writes a new page
from the template: preset (the default widgets) or blank (empty boards). It keeps the languages
added with editDashboard languages. page writes your own
page code instead; it must contain /* garmin-data:start /null/ garmin-data:end */. A replaced
page is kept as .bak. The .bak keeps the page from before the build: a write that follows
within 15 minutes (the notes, a new title) does not replace it.
notes: at most 5 plain-text coach notes; the server escapes them.
settings replace the page's settings (title, headline, sports, data to leave out, languages,
themes); without them the page keeps its own. The page holds only the data, languages and themes
they keep. pageLanguages in the result lists the languages of the page's Language menu, and
settings the settings that the page keeps. missingProfileLanguage is the language of the Garmin
profile when the page has no texts in it (it shows English); editDashboard languages adds it.
missingWidgetTexts lists the custom widgets that miss texts in a language of the page, with
those languages; editDashboard widgetTexts adds them.
preview: true writes nothing: it returns the digest, the activities of each board and the
settings of the page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Your own page code, with an empty garmin-data block, instead of the template | |
| path | No | The .html file; relative paths are inside the data dir | |
| notes | No | Coach notes, plain text; without notes the page has none | |
| weeks | No | Weeks to cover, default 12, max 52 | |
| layout | No | Write a new page from the template with this layout | |
| preview | No | Write nothing: return the digest, the activities of each board and the page settings | |
| settings | No | The page settings; replaces the page's own |