กริ่งประตู (เดิม)

Nest Hello

Nest Doorbell รุ่นเดิมทั้งหมดรองรับใน Smart Device Management (SDM) API อุปกรณ์นี้แสดงผลประเภทอุปกรณ์เป็นกริ่งประตู

sdm.devices.types.DOORBELL

Google Nest Doorbell (รุ่นเดิม) มีกล้องที่ทำงานเหมือนกับอุปกรณ์ประเภทกล้อง

ลักษณะ

ข้อมูลอ้างอิง

ลักษณะ คำสั่ง หรือเหตุการณ์ต่อไปนี้เกี่ยวข้องกับอุปกรณ์นี้

ลักษณะคำอธิบายคำสั่งกิจกรรม
CameraEventImageลักษณะนี้เป็นของอุปกรณ์ที่รองรับการสร้างรูปภาพจากเหตุการณ์GenerateImage
CameraImageลักษณะนี้เป็นของอุปกรณ์ที่รองรับการถ่ายภาพ
CameraLiveStreamลักษณะนี้ใช้ได้กับอุปกรณ์ที่รองรับสตรีมมิงแบบสดGenerateRtspStream
ExtendRtspStream
StopRtspStream
CameraMotionลักษณะนี้เป็นของอุปกรณ์ที่รองรับเหตุการณ์การตรวจจับการเคลื่อนไหวการเคลื่อนไหว
CameraPersonลักษณะนี้เป็นของอุปกรณ์ที่รองรับเหตุการณ์การตรวจจับคนบุคคล
CameraSoundลักษณะนี้เป็นของอุปกรณ์ที่รองรับเหตุการณ์การตรวจจับเสียงเสียง
DoorbellChimeลักษณะนี้เป็นของอุปกรณ์ที่รองรับกริ่งประตูและเหตุการณ์การกดที่เกี่ยวข้องChime
ข้อมูลลักษณะนี้เป็นของอุปกรณ์ใดก็ได้สำหรับข้อมูลที่เกี่ยวข้องกับอุปกรณ์

JSON

การขาดลักษณะในการตอบกลับ GET บ่งชี้ว่าลักษณะหรือฟีเจอร์ไม่พร้อมใช้งานสำหรับอุปกรณ์ในขณะนี้ ดูข้อมูลเพิ่มเติมได้ที่ประเภทอุปกรณ์

{
  "type" : "sdm.devices.types.DOORBELL",
  "traits" : {
    "sdm.devices.traits.CameraEventImage" : {},
    "sdm.devices.traits.CameraImage" : {
      "maxImageResolution" : {
        "width" : 1280,
        "height" : 960
      }
    },
    "sdm.devices.traits.CameraLiveStream" : {
      "maxVideoResolution" : {
        "width" : 640,
        "height" : 480
      },
      "videoCodecs" : ["H264"],
      "audioCodecs" : ["AAC"],
      "supportedProtocols" : ["WEB_RTC"]
    },
    "sdm.devices.traits.CameraMotion" : {},
    "sdm.devices.traits.CameraPerson" : {},
    "sdm.devices.traits.CameraSound" : {},
    "sdm.devices.traits.DoorbellChime" : {},
    "sdm.devices.traits.Info" : {
      "customName" : "My device"
    }
  }
}

จัดการเหตุการณ์กริ่งประตูและกล้อง

เหตุการณ์ต่อไปนี้อาจทริกเกอร์จากอุปกรณ์ประเภทกริ่งประตู

ประเภท องค์ประกอบ คำอธิบาย
กิจกรรม เหตุการณ์การเคลื่อนไหวของลักษณะ CameraMotion กล้องตรวจพบการเคลื่อนไหว
กิจกรรม เหตุการณ์บุคคลของลักษณะ CameraPerson กล้องตรวจพบบุคคล
กิจกรรม เหตุการณ์เสียงของลักษณะ CameraSound กล้องตรวจพบเสียง
กิจกรรม เหตุการณ์กริ่งของลักษณะ DoorbellChime มีคนกดกริ่งประตู
ตัวอย่างเช่น มีการกดปุ่มกริ่งประตู

เพย์โหลด

{
  "eventId" : "76f85e13-cc15-4705-83c3-0b3838118524",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "cV7T3NiEMXH5ZmQz21AwMaW0mF..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }
เพย์โหลดของเหตุการณ์นี้มี eventId ที่ใช้กับคำสั่ง GenerateImage ได้ คำสั่งนี้จะแสดงผล URL การดาวน์โหลดสำหรับรูปภาพจากกล้องที่เกี่ยวข้องกับเหตุการณ์

ส่งคำขอ

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraEventImage.GenerateImage",
  "params" : {
    "eventId" : "mFNqXZk08luMZuuBBPCPbS7mZ4..."
  }
}

คำตอบ

{
  "results" : {
    "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "token" : "g.0.eventToken"
  }
}

ดาวน์โหลดรูปภาพจากกล้อง

เรียก GET ไปยัง url จากการตอบสนองด้วยคำสั่ง GenerateImage โดยใช้ token ในส่วนหัวการให้สิทธิ์ HTTP ที่มีการให้สิทธิ์พื้นฐานเพื่อดาวน์โหลดอิมเมจกล้องถ่ายรูป:

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...

ใช้พารามิเตอร์การค้นหา width หรือ height เพื่อปรับแต่งความละเอียดของรูปภาพที่ดาวน์โหลด คุณต้องระบุพารามิเตอร์เหล่านี้เพียงรายการเดียว พารามิเตอร์อื่นจะปรับสัดส่วนโดยอัตโนมัติตามสัดส่วนภาพของกล้อง

ตัวอย่างเช่น หากสัดส่วนภาพของกล้องคือ 4:3 ให้ระบุความกว้างหรือความสูงเพื่อดาวน์โหลดรูปภาพจากกล้องที่มีความละเอียด 480 x 360

ความกว้าง

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?width=480

ส่วนสูง

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?height=360

ข้อจำกัดอื่นๆ สำหรับ URL การดาวน์โหลดมีดังนี้

  • หากระบุพารามิเตอร์ทั้ง 2 รายการใน URL ระบบจะใช้ width และละเว้น height
  • หากไม่ได้ระบุพารามิเตอร์ใดเลยใน URL ระบบจะเลือกค่าเริ่มต้น 480 สําหรับ width

ดูข้อมูลเกี่ยวกับพร็อพเพอร์ตี้รูปภาพได้ที่แอตทริบิวต์ CameraImage

เข้าถึงสตรีมแบบสด

เข้าถึงสตรีมแบบสดจากกล้องได้ อุปกรณ์นี้รองรับสตรีมรูปแบบต่อไปนี้

  • RTSP

ดูรายการกล้องและรูปแบบสตรีมที่รองรับทั้งหมดได้ที่หัวข้ออุปกรณ์ที่รองรับ

หากต้องการเข้าถึงสตรีมแบบสด ให้ใช้คำสั่ง GenerateFormatStream ที่เหมาะสมของลักษณะCameraLiveStream

RTSP

สำหรับสตรีม RTSP คำสั่ง GenerateRtspStream ของคำสั่งลักษณะ CameraLiveStream จะแสดง URL ของสตรีมและ streamToken ที่เกี่ยวข้องดังนี้

ส่งคำขอ

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
  "params" : {}
}

คำตอบ

{
  "results" : {
    "streamUrls" : {
      "rtspUrl" : "rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken"
    },
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
    "streamToken" : "g.0.streamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

จากนั้นใช้ URL ของสตรีมเพื่อเข้าถึงสตรีมแบบสดของกล้อง โดยทำดังนี้

rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken

คุณจะแชร์ URL สตรีมแบบสด RTSP ระหว่างลูกค้าไม่ได้ ไคลเอ็นต์แต่ละรายจะใช้ URL ของสตรีมได้ครั้งละ 1 รายเท่านั้น หากไคลเอ็นต์หลายรายต้องการสตรีมจากกล้องตัวเดียวกันพร้อมกัน จะต้องส่งคําสั่ง RTSP สําหรับไคลเอ็นต์แต่ละราย และแต่ละไคลเอ็นต์ต้องใช้ URL สตรีมของตนเอง

ขยายเวลาสตรีมแบบสด

เซสชันสตรีมแบบสดของกล้องจะใช้ได้เพียง 5 นาที หากต้องการยืดอายุการใช้งานของสตรีมแบบสด ให้ใช้คำสั่ง "ขยายFormatสตรีม" ที่เหมาะสมของลักษณะ cameraLiveStream สำหรับรูปแบบสตรีมที่สร้างขึ้น

RTSP

หากต้องการขยายสตรีม RTSP ให้ใช้คำสั่ง ExtendRtspStream ของคำสั่งลักษณะ CameraLiveStream เพื่อรับค่า streamExtensionToken และ streamToken ใหม่ ดังนี้

ส่งคำขอ

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.ExtendRtspStream",
  "params" : {
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
  }
}

คำตอบ

{
  "results" : {
    "streamExtensionToken" : "dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "streamToken" : "g.0.newStreamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

อัปเดต URL ของสตรีมด้วยค่าใหม่ต่อไปนี้เพื่อดูสตรีมแบบสดต่อ

rtsps://someurl.com/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?auth=g.0.newStreamingToken

หยุดสตรีมแบบสด

เมื่อไม่ได้ใช้สตรีมแบบสดของกล้องแล้ว คุณควรหยุดสตรีมนั้นและทำให้สตรีมเป็นโมฆะ โดยให้ใช้คำสั่ง StopFormatStream ที่เหมาะสมของลักษณะ CameraLiveStream สำหรับรูปแบบสตรีมที่สร้างขึ้น

RTSP

หากต้องการหยุดสตรีม RTSP ให้ใช้โทเค็นเพื่อทำให้ใช้งานไม่ได้ด้วยคำสั่ง StopRtspStream ของคำสั่งลักษณะ CameraLiveStream

ส่งคำขอ

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.StopRtspStream",
  "params" : {
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
  }
}

คำตอบ

{}

ข้อผิดพลาด

ระบบอาจแสดงรหัสข้อผิดพลาดต่อไปนี้ที่เกี่ยวข้องกับอุปกรณ์นี้

ข้อความแสดงข้อผิดพลาด RPC การแก้ปัญหา
รูปภาพจากกล้องจะดาวน์โหลดไม่ได้อีกต่อไป DEADLINE_EXCEEDED รูปภาพกิจกรรมจะหมดอายุใน 30 วินาทีหลังจากเผยแพร่ โปรดดาวน์โหลดรูปภาพก่อนหมดอายุ
รหัสเหตุการณ์ไม่ได้เป็นของกล้อง FAILED_PRECONDITION ใช้ eventID ที่ถูกต้องซึ่งแสดงผลโดยเหตุการณ์ของกล้อง

ดูรายการรหัสข้อผิดพลาดทั้งหมดของ API ได้ที่ข้อมูลอ้างอิงรหัสข้อผิดพลาดของ API