@mega-yfue/eufy-sdk / VacuumSchedule

Interface: VacuumSchedule

One schedule the robot holds.

Properties

action

readonly action: "autoClean" | "roomsClean" | "cruise" | "sceneClean";

What the timer runs.

---

daylightSaving

readonly daylightSaving: boolean;

Whether the phone that created the timer said its region observes daylight saving.

---

enabled

readonly enabled: boolean;

Whether the timer is switched on. A valid timer that is off stays stored and does not fire.

---

hour

readonly hour: number;

Hour of the day it fires, 0–23, in the user's own timezone — see utcOffsetSeconds.

---

id

readonly id: number;

The device's own id for this timer — what a future edit or delete would name it by.

---

mapId?

readonly optional mapId?: number;

The map the run targets, for a rooms-clean or a cruise.

---

minute

readonly minute: number;

Minute of the hour it fires, 0–59.

---

repeats

readonly repeats: boolean;

true for a weekly timer, false for one that fires once.

---

roomIds?

readonly optional roomIds?: readonly number[];

The rooms a rooms-clean visits, in the order the timer lists them.

---

sceneId?

readonly optional sceneId?: number;

The scene a scene-clean runs.

---

sceneName?

readonly optional sceneName?: string;

The scene's name as the device last saw it — kept so a deleted scene can still be named.

---

utcOffsetSeconds

readonly utcOffsetSeconds: number;

The offset from UTC the timer's clock was set against, in seconds east.

Carried per timer rather than per device: the robot stores whatever the phone that created the schedule told it, so an absolute instant follows from this offset and not from any local zone.

---

valid

readonly valid: boolean;

Whether the device still considers the timer usable. A timer pointing at a deleted scene or a map that no longer exists is reported valid: false rather than removed, so the app can show why.

---

weekdays

readonly weekdays: readonly (
  | "sunday"
  | "monday"
  | "tuesday"
  | "wednesday"
  | "thursday"
  | "friday"
  | "saturday")[];

The days a repeating timer fires on. Empty for a one-shot timer, and empty for a repeating one whose week_bits is zero — which the device treats as a timer that never fires.