@mega-yfue/eufy-sdk / ReadDescriptor

Interface: ReadDescriptor

One read installed on a bound capability object — a value the device reports, and what it means.

Properties

accessor

accessor: string;

The getter's name on the capability object (dev.battery()?.level → level).

---

description?

optional description?: string;

---

kind?

optional kind?: ValueKind;

What the value MEANS, as opposed to how it is stored. See ValueKind.

---

labels?

optional labels?: Readonly<Record<string, string>>;

Labels for values, keyed by the raw value as a string.

---

property

property: string;

The name the same value carries in the device's flat property namespace (getProperty).

---

type

type: PropertyValueType;

How the value is stored.

---

unit?

optional unit?: string;

The unit the device reports the value in, when it has one ("%", "°C", "dBm").

---

values?

optional values?: readonly (string | number)[];

The option set, for a value out of a fixed domain.

---

writable

writable: boolean;

Whether a setter for this value is installed BESIDE the getter on the same object.

Read off the bound object rather than the schema, so it means "a caller can write this on THIS device" — a write the device gave no evidence for, or one whose wire is not confirmed, is not installed and reads false here. A value driven by a differently-named method (a pair of frames, a validating setter) is false too and appears under the capability's CapabilityDescriptor.actions instead, which is where its signature is described.