File: camera.md

package info (click to toggle)
simplisafe-python 2024.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,268 kB
  • sloc: python: 5,252; sh: 50; makefile: 19
file content (62 lines) | stat: -rw-r--r-- 1,566 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# Cameras

{meth}`Camera <simplipy.camera.Camera>` objects correspond to SimpliSafeā„¢ "SimpliCam"
cameras and doorbells (only available for V3 systems) and allow users to retrieve
information on them, including URLs to view short-lived streams of the camera.

## Core Properties

All {meth}`Camera <simplipy.camera.Camera>` objects come with a standard set of properties:

```python
for serial, camera in system.cameras.items():
    # Return the cammera's UUID:
    serial
    # >>> 1234ABCD

    # ...or through the property:
    camera.serial
    # >>> 1234ABCD

    # Return all camera settings data:
    camera.camera_settings
    # >>> {"cameraName": "Camera", "pictureQuality": "720p", ...}

    # Return the type of camera this object represents:
    camera.camera_type
    # >>> doorbell

    # Return the camera name:
    camera.name
    # >>> My Doorbell

    # Return whether the privacy shutter is open when the
    # alarm is armed in away mode:
    camera.shutter_open_when_off
    # >>> False

    # Return whether the privacy shutter is open when the
    # alarm is armed in home mode:
    camera.shutter_open_when_home
    # >>> False

    # Return whether the privacy shutter is open when the
    # alarm is disarmed:
    camera.shutter_open_when_off
    # >>> False

    # Return the camera status:
    camera.status
    # >>> online

    # Return the camera subscription status:
    camera.subscription_enabled
    # >>> True
```

## Getting the Camera Video URL

```python
url = camera.video_url()
# >>> https://media.simplisafe.com/v1/...
```