Skip to content

@mega-yfue/eufy-sdk / VacuumMapSnapshot

Interface: VacuumMapSnapshot

Everything the store currently holds about one map. Any piece may be absent until it arrives.

Properties

description

ts
readonly description: VacuumMapDescription | undefined;

mapId

ts
readonly mapId: number | undefined;

Which map these pieces describe, or undefined when nothing carrying an id has arrived yet.

A robot with several floors saved sends whichever is loaded. When this changes, every piece below is from the new map — the store does not merge across maps.


outline

ts
readonly outline: VacuumRoomOutline | undefined;

plane

ts
readonly plane: VacuumMapPlane | undefined;

pose

ts
readonly pose: MapPose | undefined;

Where the robot was when it last said so.

Kept across a map switch, unlike everything else: a pose is a position in the world and does not belong to a map. It may fall outside the new map's bounds, in which case a lookup answers nothing.


rooms

ts
readonly rooms: VacuumRoomParams | undefined;

zones

ts
readonly zones: VacuumRestrictedZones | undefined;

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.