Skip to content

@mega-yfue/eufy-sdk / VacuumRoom

Interface: VacuumRoom ​

One room on the map.

Properties ​

floor ​

ts
readonly floor: "unknown" | "carpet" | "wood" | "tile";

id ​

ts
readonly id: number;

The room's id — what the byte in VacuumRoomOutline.cells resolves to, and what a room-select frame names.


name ​

ts
readonly name: string | undefined;

The name the user gave this room, or undefined.

undefined is common and is not a decode failure: the vendor's own comment says an unnamed room is labelled by the app from VacuumRoom.scene and VacuumRoom.sceneIndex — "Kitchen 1", "Bedroom 2" — in the user's language. A host wanting the same label builds it the same way, which it can only do if the absence is reported rather than papered over.


order ​

ts
readonly order: number;

Where the room sits in the order the app lists them.


scene ​

ts
readonly scene: 
  | "unknown"
  | "study"
  | "bedroom"
  | "bathroom"
  | "kitchen"
  | "livingRoom"
  | "diningRoom"
  | "corridor";

sceneIndex ​

ts
readonly sceneIndex: number;

Which room of its kind this is, counting from 1. Pairs with VacuumRoom.scene to name it.


settings ​

ts
readonly settings: VacuumRoomSettings;

This room's own clean settings. Only in force while VacuumRoomParams.customEnabled.

Independent and unofficial. Not affiliated with, endorsed by, or sponsored by Anker Innovations, Anker eufy, or eufy. "Anker eufy", "eufy" and "Anker" are trademarks of their respective owners. Use responsibly — rapid or failed logins can trigger captcha or temporary cooldowns.