@mega-yfue/eufy-sdk / PushPayload

Interface: PushPayload

Normalised device push payload. Superset of the common fields across device types plus the v6 enrichment; concrete pushes populate a subset. The short single-letter keys are eufy's wire names (kept for fidelity).

Extends

• PushEnrichment

Indexable

[k: string]: unknown

Properties

a?

optional a?: number;

---

ai_detect_type?

optional ai_detect_type?: string;

Comma list of detection types, e.g. "0,1,2,3" (person/vehicle/pet/package).

Inherited from

PushEnrichment.ai_detect_type

---

ai_faces?

optional ai_faces?: object[];

confidence?

optional confidence?: number;

face_id?

optional face_id?: number;

height?

optional height?: number;

width?

optional width?: number;

x?

optional x?: number;

y?

optional y?: number;

Inherited from

PushEnrichment.ai_faces

---

alarm_type?

optional alarm_type?: number;

---

arming?

optional arming?: number;

---

c?

optional c?: number;

---

channel?

optional channel?: number;

---

cipher?

optional cipher?: number;

---

cover_path?

optional cover_path?: string;

Inherited from

PushEnrichment.cover_path

---

create_time?

optional create_time?: number;

---

crop_local_path?

optional crop_local_path?: string;

Inherited from

PushEnrichment.crop_local_path

---

crop_url?

optional crop_url?: string;

Inherited from

PushEnrichment.crop_url

---

crying?

optional crying?: number | boolean;

Sound/cry detection (indoor).

Inherited from

PushEnrichment.crying

---

device_name?

optional device_name?: string;

---

device_sn?

optional device_sn?: string;

---

duration?

optional duration?: number;

Inherited from

PushEnrichment.duration

---

e?

optional e?: string;

---

event_end_time?

optional event_end_time?: number;

Inherited from

PushEnrichment.event_end_time

---

event_time?

optional event_time?: number;

---

event_type?

optional event_type?: number;

---

face_id?

optional face_id?: number;

Inherited from

PushEnrichment.face_id

---

face_ids?

optional face_ids?: number[];

Inherited from

PushEnrichment.face_ids

---

familiar_faces?

optional familiar_faces?: unknown[];

Inherited from

PushEnrichment.familiar_faces

---

file_path?

optional file_path?: string;

---

k?

optional k?: number;

---

m?

optional m?: number;

Unverified vendor field; polarity and entity scope are not established.

---

mode?

optional mode?: number;

---

msg_type?

optional msg_type?: number;

---

n?

optional n?: string;

---

name?

optional name?: string;

---

nick_name?

optional nick_name?: string;

---

notification_style?

optional notification_style?: number;

---

objects?

optional objects?: 
  | string[]
  | {
  names?: string[];
};

Detected object class names.

Inherited from

PushEnrichment.objects

---

p?

optional p?: string;

---

person?

optional person?: string | number;

Inherited from

PushEnrichment.person

---

person_count?

optional person_count?: number;

Inherited from

PushEnrichment.person_count

---

person_id?

optional person_id?: number;

Inherited from

PushEnrichment.person_id

---

pet_type?

optional pet_type?: string | number;

Inherited from

PushEnrichment.pet_type

---

pic_url?

optional pic_url?: string;

---

push_count?

optional push_count?: number;

---

s?

optional s?: string;

---

session_id?

optional session_id?: string;

---

short_user_id?

optional short_user_id?: string;

---

short_video_url?

optional short_video_url?: string;

Inherited from

PushEnrichment.short_video_url

---

sound_detection?

optional sound_detection?: number | boolean;

Inherited from

PushEnrichment.sound_detection

---

sound_type?

optional sound_type?: string | number;

Inherited from

PushEnrichment.sound_type

---

station_sn?

optional station_sn?: string;

---

storage_type?

optional storage_type?: number;

---

thumbnail?

optional thumbnail?: string;

Media enrichment.

Inherited from

PushEnrichment.thumbnail

---

trigger_time?

optional trigger_time?: number;

Timing.

Overrides

PushEnrichment.trigger_time

---

type?

optional type?: number;

---

unique_id?

optional unique_id?: string;

---

user_id?

optional user_id?: string;

---

user_name?

optional user_name?: string;

---

vehicle_types?

optional vehicle_types?: string[];

Inherited from

PushEnrichment.vehicle_types

---

video_url?

optional video_url?: string;

Inherited from

PushEnrichment.video_url