Skip to content

@mega-yfue/eufy-sdk / SolixSite

Class: SolixSite ​

A discovered Solix site with its member devices resolved to SolixDevice models. Build one directly from a record + members, or discover an account's sites with discoverSolixSites.

Constructors ​

Constructor ​

ts
new SolixSite(record, devices): SolixSite;

Parameters ​

record ​

SolixSiteRecord

devices ​

SolixDevice[]

Returns ​

SolixSite

Properties ​

devices ​

ts
readonly devices: SolixDevice[];

id ​

ts
readonly id: string;

name ​

ts
readonly name: string;

Friendly site name (e.g. "My Home"), or the site id when the record carries none.


powerSiteType? ​

ts
readonly powerSiteType?: number;

Anker's site-type discriminator (e.g. 20 for a Solarbank-anchored home system), when present.


record ​

ts
readonly record: SolixSiteRecord;

Methods ​

device() ​

ts
device(serial): SolixDevice | undefined;

The member device with this serial, if it belongs to the site.

Parameters ​

serial ​

string

Returns ​

SolixDevice | undefined


powerStations() ​

ts
powerStations(): SolixDevice[];

The portable power-station members of the system.

Returns ​

SolixDevice[]


smartMeters() ​

ts
smartMeters(): SolixDevice[];

The smart-meter (grid-CT) members of the system.

Returns ​

SolixDevice[]


solarbanks() ​

ts
solarbanks(): SolixDevice[];

The Solarbank / plug-in home-battery members of the system.

Returns ​

SolixDevice[]


withCapability() ​

ts
withCapability(capability): SolixDevice[];

Member devices that carry a given capability (e.g. every battery in the system).

Parameters ​

capability ​

SolixCapability

Returns ​

SolixDevice[]


withFamily() ​

ts
withFamily(family): SolixDevice[];

Member devices of a given product SolixProductFamily — the grouping accessor.

Parameters ​

family ​

SolixProductFamily

Returns ​

SolixDevice[]

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.