No description
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-03 13:49:51 +01:00
.gitignore Ignore local Buddy firmware checkout 2026-11-03 13:48:17 +01:00
agents.md Document metrics research and maintenance process 2026-11-03 13:49:09 +01:00
BUDDY_METRICS_REFERENCE.md Move detailed probe analysis reference into separate document 2026-11-03 13:49:29 +01:00
probing.md Move detailed probe analysis reference into separate document 2026-11-03 13:49:29 +01:00
readme.md Add repository file guide and source scope 2026-11-03 13:49:51 +01:00

Prusa Buddy metrics documentation

A source-derived reference for the metrics that Prusa Buddy firmware can send to a remote host. Start with the metric catalogue for configuration and payloads; use the probing reference to interpret individual probing attempts.

What is where

File or directory Contents
BUDDY_METRICS_REFERENCE.md Catalogue of all 179 distinct metric names found in the examined source: meanings, units, fields, default settings, minimum intervals, hardware restrictions and pinned source links. Also explains G-code setup, transport, numeric states and implementation caveats.
probing.md Detailed probe_analysis reference: all 30 emitted desc values, arg meanings, feature-range checks, and the calculation and conditional bypasses of angle_after.
agents.md How the source investigation was performed, how to reproduce/update it, validation steps and the local commit workflow.
.gitignore Excludes the downloaded upstream firmware checkout from this repository.
Prusa-Firmware-Buddy/ Optional local clone of the upstream firmware used for research. Ignored by Git; not included in this repository and not a submodule.

Source and scope

The reference examines prusa3d/Prusa-Firmware-Buddy at commit 1ce23f33ed3b94e26aa33a44557d6c4a4be11eb6, dated 2026-08-27 and cloned from master on 2026-11-02.

The 179 names come from 184 non-comment metric declarations across mainboard, remote-board and optional firmware builds. They form a union across builds; one printer will expose a subset. Use M333 on the printer to list the metrics actually compiled into its installed firmware. Descriptions and thresholds can change between releases.

The documents were checked against source definitions, recording calls and enums. No firmware build or live-printer testing was performed. This repository contains documentation, not a metrics receiver or a firmware modification.

Read or reproduce

The Markdown documents can be read directly without downloading the firmware. Their upstream source links are pinned to the examined commit.

To obtain the ignored research checkout:

git clone --depth 1 https://github.com/prusa3d/Prusa-Firmware-Buddy.git Prusa-Firmware-Buddy

A fresh clone may point to a newer commit. Follow agents.md to select the documented revision or research another release. The main reference's completeness and updating section contains a Python inventory snippet to run from the upstream checkout.

Keep the downloaded firmware excluded from commits. Commit each logical documentation change separately to this local Git repository; nothing needs to be published or pushed to read or maintain these files.