Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What does every entity mean? #15

Open
boehser-enkel opened this issue Jun 12, 2024 · 1 comment
Open

What does every entity mean? #15

boehser-enkel opened this issue Jun 12, 2024 · 1 comment

Comments

@boehser-enkel
Copy link

What does every entity mean?

greetings

@travisterrell
Copy link

travisterrell commented Feb 28, 2025

Here's some information I found on those, from the Obico API documentation. Note that there are some extra ones in this list as well that aren't used in HA (or not exposed as entities, at least). It looks like P is the most important one, but the additional parameters can be used for improving the data and enhancing confidence.

  • p: A number between 0 and 1.0. 0 means no failure is detected. 1 means the maximum confidence on predicting a print failure.
  • temporal_stats: The temporal stats that may be useful in determining if a failure has actually occurred. These stats are important for smoothening the noises in failure detection. See the tip below for details.
    • ewm_mean: Exponentially weighted mean for p. EWM window span = 12.
    • rolling_mean_short: Short-term rolling mean for p. Rolling window span = 310. This rolling mean is reset to 0 when a new print starts.
    • rolling_mean_long: Long-term rolling mean for p. Rolling window span = 7200. This rolling mean is accumulated over the lifetime of the printer.
    • prediction_num: The number of predictions for the current print so far.
    • prediction_num_lifetime: The number of predictions for the life-time of the printer.
    • detections: A list of tuples. Each tuple is [confidence, [xc, yc, w, h]].
      • confidence: Range: [0, 1], where 0 means not failure and 1.0 means the maximum confidence on predicting a print failure.
      • [xc, yc, w, h]: Rectangle of the detected area. xc and yc are the X and Y coordinates of the center of the rectangle. w and h are the width and height of the rectangle.

The documentation does have a little more information if you are curious about any of this stuff.
https://www.obico.io/docs/developer-guides/super-detection-api/

Also, if anybody has free time on their hands, it'd be nice to create a PR to update the documentation here with the ones that are relevant! (I might get around to it eventually, but too busy today.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants