Skip to content

v0.1.0b1 (beta)

Pre-release
Pre-release

Choose a tag to compare

@yieldhog yieldhog released this 31 Jul 04:20
aebb0d4

First beta of the Sycamore School integration for Home Assistant — a native,
HACS-installable data layer that turns each child's Sycamore data into first-class
HA entities (a device per student). No MQTT bridge, no database.

Entities

Per student

  • Per-class letter grade sensor (percent, up/down/stable trend, and last-updated as attributes)
  • Per-class grade percent sensor (measurement → long-term statistics/graphs)
  • Missing work count
  • Upcoming work count over your focus window (each item tagged with is_test/kind, by class)
  • Upcoming tests count over the focus window (tests/quizzes listed by class)
  • Attendance events count (optional)
  • Has missing work and Test within 24 hours binary sensors
  • Homework calendar (assignments & tests by due date, [TEST]/[QUIZ] prefixed)
  • Missing work to-do list (read-only)

School (with a School ID)

  • Today's lunch sensor (today's meals as state; the full pulled week in the menu attribute)
  • Lunch calendar (one all-day event per day)

Setup

  • UI config flow: access token, optional Family ID (auto-discovers students), optional School ID (enables lunch). Manual student entry if you skip Family ID.
  • Reauthentication flow, and options for poll interval (60 min default/min), focus window (days), and Attendance/Lunch toggles.

Requirements

  • Home Assistant 2024.12 or newer.

Beta notes / known limitations

  • Between terms (summer): the Grades/Homework endpoints return empty, so those sensors stay quiet until the school year starts — that's expected, not a bug.
  • Families scope: if your token can't access the family list, leave Family ID blank and add students by Student ID — the per-student data uses endpoints that don't need that scope.
  • No integration icon in Home Assistant yet — the brand logo submission to home-assistant/brands is still pending.

Unofficial project — not affiliated with or endorsed by Sycamore Education.