eufy-mega / model/capabilities / DoorbellActions

Type Alias: DoorbellActions

type DoorbellActions = object;

Bound doorbell controls — the object returned by dev.doorbell(). The status LED is NOT here: a doorbell is a camera-codec device, so its LED lives on the shared dev.camera().setStatusLed() surface, which swaps to the doorbell's own wire by family (one action, not a duplicate here). playQuickResponse is always present (it orchestrates a live stream); quickResponses (a P2P request/reply query that RETURNS data) is present only when the device is bound to a live client with a MediaProvider — hence optional, call with ?..

Properties

chimeSwitch?

readonly optional chimeSwitch?: boolean;

Whether the (electronic) chime is on (property chimeSwitch).

---

dingdongRingtone?

readonly optional dingdongRingtone?: number;

Indoor-chime ringtone index (property dingdongRingtone).

---

dingdongVolume?

readonly optional dingdongVolume?: number;

Indoor-chime (dingdong) volume 0-100 (property dingdongVolume).

---

doorbellLedEnable?

readonly optional doorbellLedEnable?: boolean;

Whether the doorbell status LED is on (property doorbellLedEnable).

---

mechanicalChimeSwitch?

readonly optional mechanicalChimeSwitch?: boolean;

Whether the mechanical chime is on (property mechanicalChimeSwitch).

---

notificationMode?

readonly optional notificationMode?: string;

Notification mode (property notificationMode).

---

quickResponses?

optional quickResponses?: (opts?) => Promise<QuickResponse[]>;

Fetch the doorbell's quick-response list (present only when bound to a media provider).

Parameters

opts?

timeoutMs?

number

Returns

Promise<QuickResponse[]>

---

ringtoneVolume?

readonly optional ringtoneVolume?: number;

Ring/chime volume 0-100 (property ringtoneVolume).

---

wdrSwitch?

readonly optional wdrSwitch?: boolean;

Whether WDR is on (property wdrSwitch).

Methods

playQuickResponse()

playQuickResponse(voiceId, opts?): Promise<void>;

Play one of the doorbell's quick responses at the visitor. voiceId comes from DoorbellActions.quickResponses. The doorbell only plays while it has an active media session, so by default this briefly engages a live stream, sends, then tears it down; pass { engage: false } if you already have a stream open.

Parameters

voiceId

number

opts?

engage?

boolean

Returns

Promise<void>