PyAarlo

https://pyaarlo.readthedocs.io/en/latest/
Admin
PyAarlo is a Python library that provides an interface to control Arlo security devices including...
Tokens:6,982
Snippets:51
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### PyArlo Class Initialization

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

The PyArlo class is the entry point for all Arlo operations, requiring authentication credentials and supporting various configuration parameters.

```APIDOC
## PyArlo Class Initialization

### Description
Initializes the PyArlo client, logs into Arlo, and sets up the event stream and device management.

### Parameters
#### Request Body (kwargs)
- **username** (string) - Required - Your Arlo username.
- **password** (string) - Required - Your Arlo password.
- **wait_for_initial_setup** (boolean) - Optional - Wait for initial devices states to load. Default: True.
- **last_format** (string) - Optional - Date string format for video files. Default: %m-%d %H:%M.
- **library_days** (integer) - Optional - Number of days of recordings to load. Default: 30.
- **save_state** (boolean) - Optional - Store device state across restarts. Default: True.
- **state_file** (string) - Optional - Path to store state file.
- **refresh_devices_every** (integer) - Optional - Hours to refresh device list.
- **stream_timeout** (integer) - Optional - Seconds for event stream to close after no packets. Default: 0.
- **synchronous_mode** (boolean) - Optional - Wait for operations to complete before returning.
- **save_media_to** (string) - Optional - Local directory to save media.
- **tfa_source** (string) - Optional - 2FA token source (console, imap, rest-api). Default: console.
- **tfa_type** (string) - Optional - 2FA delivery method (email, sms). Default: email.
- **host** (string) - Optional - Arlo host URL. Default: https://my.arlo.com.
- **user_agent** (string) - Optional - User-agent string for request headers. Default: arlo.
```

--------------------------------

### Hardware Settings

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods for adjusting hardware configurations such as brightness, color temperature, and recording states.

```APIDOC
## POST /set_nightlight_brightness

### Description
Sets the nightlight brightness.

### Parameters
#### Request Body
- **brightness** (int) - Required - Brightness value (0-255)

## POST /start_recording

### Description
Request the camera start recording.

### Parameters
#### Request Body
- **duration** (int) - Optional - Seconds for recording to run
```

--------------------------------

### Update and Sync Methods

Source: https://pyaarlo.readthedocs.io/en/latest/genindex.html

Methods for updating device states, sensors, and media information.

```APIDOC
## Device Update Methods

### Description
Methods to refresh device data from the Arlo cloud.

### Methods
- **update_ambient_sensors()**: Updates ambient sensor data for ArloCamera.
- **update_last_image()**: Refreshes the last captured image for ArloCamera.
- **update_media()**: Updates media information for ArloCamera.
- **update_mode() / update_modes()**: Updates operational modes for ArloBase.
- **update_silent_mode()**: Updates silent mode settings for ArloDoorBell.
- **update_states()**: Updates general device states for ArloBase.
```

--------------------------------

### ArloLight Attribute Management

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods for retrieving device state and registering callbacks for attribute changes.

```APIDOC
## attribute

### Description
Returns the value of a specific device attribute.

### Parameters
- **attr** (str) - Required - The attribute key to look up.
- **default** (any) - Optional - Value to return if the attribute is not found.

## add_attr_callback

### Description
Registers a callback function to be triggered when a specific attribute changes.

### Parameters
- **attr** (str) - Required - The attribute to monitor (e.g., 'motionStarted').
- **cb** (function) - Required - The callback function to execute.
```

--------------------------------

### ArloLight Class

Source: https://pyaarlo.readthedocs.io/en/latest/_sources/index.rst.txt

Documentation for the ArloLight class, used for controlling Arlo smart lights.

```APIDOC
## ArloLight Class

### Description
Provides methods for managing and controlling Arlo smart lights.

### Class
pyaarlo.light.ArloLight

### Inherited Members
This class inherits members from its parent classes, which are also documented.
```

--------------------------------

### Device Control and Playback

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods for controlling device hardware, sirens, and music playback features.

```APIDOC
## POST /siren_on

### Description
Turn camera siren on.

### Parameters
#### Request Body
- **duration** (int) - Optional - How long, in seconds, to sound for (default 300)
- **volume** (int) - Optional - Volume level from 1 to 8 (default 8)

## POST /play_track

### Description
Play the track on the device.

### Parameters
#### Request Body
- **track_id** (string) - Optional - Track ID to play
- **position** (int) - Optional - Position in the track (default 0)
```

--------------------------------

### Connection Management

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods to manage the connection state to Arlo servers.

```APIDOC
## POST stop(logout=False)

### Description
Stop connection to Arlo and, optionally, logout.

### Parameters
#### Request Body
- **logout** (bool) - Optional - Whether to logout from the server.
```

--------------------------------

### Attribute and State Management

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods for retrieving device attributes and state information.

```APIDOC
## GET attribute(attr)

### Description
Return the value of a specific attribute. PyAarlo stores state in key/value pairs.

### Parameters
#### Path Parameters
- **attr** (str) - Required - Attribute to look up.

### Response
- **value** (any) - The value associated with the attribute or None if not found.
```

--------------------------------

### ArloLight Control Methods

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods for controlling the power state and brightness of an Arlo light device.

```APIDOC
## turn_on

### Description
Turns the light on with optional brightness and color settings.

### Parameters
- **brightness** (int) - Optional - Brightness level.
- **rgb** (str) - Optional - Color setting.

## turn_off

### Description
Turns the light off.

## set_brightness

### Description
Sets the light brightness.

### Parameters
- **brightness** (int) - Required - Brightness level (0-255).
```

--------------------------------

### Device Discovery

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods to list and lookup various Arlo devices.

```APIDOC
## GET lookup_camera_by_id(device_id)

### Description
Return the camera referenced by device_id.

### Parameters
#### Path Parameters
- **device_id** (str) - Required - The camera device to look for.

### Response
- **camera** (ArloCamera) - A camera object or None on failure.
```

--------------------------------

### Device Control Methods

Source: https://pyaarlo.readthedocs.io/en/latest/genindex.html

Methods for controlling the power state of Arlo devices.

```APIDOC
## Device Power Control

### Description
Methods to turn Arlo devices on or off.

### Methods
- **turn_on()**: Powers on the device (ArloCamera, ArloDoorBell, ArloLight).
- **turn_off()**: Powers off the device (ArloCamera, ArloDoorBell, ArloLight).
```

--------------------------------

### ArloCamera Class Methods

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

This section details the various methods available for the ArloCamera class, allowing you to interact with and control Arlo cameras.

```APIDOC
## ArloCamera Class Methods

### `add_attr_callback(attr, cb)`

**Description**: Adds a callback to be triggered when a specified attribute changes. This is useful for tracking device activity, such as motion detection.

**Parameters**:
- **attr** (str) - Required - The attribute to monitor (e.g., 'motionStarted').
- **cb** - Required - The callback function to execute when the attribute changes.

### `attribute(attr, default=None)`

**Description**: Retrieves the value of a specified attribute. PyArlo stores device state in key-value pairs.

**Parameters**:
- **attr** (str) - Required - The attribute key to look up.
- **default** - Optional - The value to return if the attribute is not found.

**Returns**:
The value of the attribute or the default value if not found.

### `floodlight_off()`

**Description**: Turns the camera's floodlight off.

### `floodlight_on()`

**Description**: Turns the camera's floodlight on.

### `get_audio_playback_status()`

**Description**: Gets the current audio playback status and the list of available tracks.

### `get_snapshot(timeout=60)`

**Description**: Captures a snapshot from the camera.

**Parameters**:
- **timeout** (int) - Optional - The maximum time in seconds to wait for the snapshot.

**Returns**:
A bytearray representing the image, or the last image if the snapshot times out.

### `get_stream(user_agent=None)`

**Description**: Starts a video stream and returns the URL for it. The stream will stop if no client connects within 30 seconds.

**Parameters**:
- **user_agent** (str) - Optional - The user agent string for the stream.

### `get_video()`

**Description**: Downloads and returns the last recorded video. It is recommended to get the URL and download the video manually.

### `has_activity(activity)`

**Description**: Checks if the camera is currently performing a specific activity.

**Parameters**:
- **activity** (str) - Required - The activity to check (e.g., 'motionStarted').

**Returns**:
True if the camera is performing the activity, False otherwise.

### `has_capability(cap)`

**Description**: Determines if the device is capable of performing a specific capability.

**Parameters**:
- **cap** (str) - Required - The capability to check (e.g., 'motionStarted').

**Returns**:
True if the device has the capability, False otherwise.

### `last_image_from_cache()`

**Description**: Returns the last captured image or snapshot in binary format from the cache.

**Returns**:
A bytearray representing the last image.

```

--------------------------------

### ArloVideo Class

Source: https://pyaarlo.readthedocs.io/en/latest/_sources/index.rst.txt

Information about the ArloVideo class for handling Arlo video recordings.

```APIDOC
## ArloVideo Class

### Description
Handles Arlo video recordings, including retrieval and playback functionalities.

### Class
pyaarlo.media.ArloVideo

### Inherited Members
This class inherits members from its parent classes, which are also documented.
```

--------------------------------

### PyArlo Device Lookup Methods

Source: https://pyaarlo.readthedocs.io/en/latest/genindex.html

Methods available in the PyArlo class to retrieve specific devices by their ID or name.

```APIDOC
## PyArlo Lookup Methods

### Description
These methods allow for the retrieval of specific Arlo devices (base stations, cameras, doorbells, lights) from the PyArlo instance.

### Methods
- lookup_base_station_by_id(id)
- lookup_base_station_by_name(name)
- lookup_camera_by_id(id)
- lookup_camera_by_name(name)
- lookup_doorbell_by_id(id)
- lookup_doorbell_by_name(name)
- lookup_light_by_id(id)
- lookup_light_by_name(name)
```

--------------------------------

### ArloBase Methods

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods to interact with and update the Arlo base station's settings and capabilities.

```APIDOC
## ArloBase Methods

### Description
Methods to check device capabilities, control the siren, and update mode and state information.

### Capability Check
#### `has_capability(cap: str)`
- **Description**: Checks if the device is capable of performing a specific activity.
- **Parameters**:
  - **cap** (str) - The capability attribute to check (e.g., 'motionStarted').
- **Returns**: True if the device has the capability, False otherwise.
- **Type**: bool

### Siren Control
#### `siren_off()`
- **Description**: Turns the base station's siren off. Does nothing if the base does not support sirens.

#### `siren_on(duration: int = 300, volume: int = 8)`
- **Description**: Turns the base station's siren on.
- **Parameters**:
  - **duration** (int, optional) - The duration in seconds for the siren to sound. Defaults to 300.
  - **volume** (int, optional) - The volume level from 1 to 8. Defaults to 8.
- **Note**: Does nothing if the base does not support sirens.

### Mode and State Updates
#### `update_mode()`
- **Description**: Checks and updates the base station's current operating mode.

#### `update_modes(initial: bool = False)`
- **Description**: Retrieves and updates the list of available modes for the base station.
- **Parameters**:
  - **initial** (bool, optional) - If True, performs an initial fetch. Defaults to False.

#### `update_states()`
- **Description**: Retrieves device state from older 'old' style base stations. Most new devices return their state from the devices URL, but this method is needed for older base stations to query child states.
```

--------------------------------

### ArloVideo Object Attributes

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

This section details the attributes available for the ArloVideo object, providing access to various video properties.

```APIDOC
## ArloVideo Object Attributes

This object represents a video file from an Arlo camera and provides access to its metadata.

### Attributes

- **`content_type`** (string) - Returns the video content type. Usually `video/mp4`.
- **`created_at`** (string) - Returns the date the video was created, adjusted to milliseconds.
- **`created_at_pretty`** (function) - Returns the date the video was taken, formatted with `last_date_format`. Accepts an optional `date_format` argument.
- **`created_today`** (boolean) - Returns `True` if the video was taken today, `False` otherwise.
- **`datetime`** (datetime) - Returns a Python `datetime` object representing when the video was created.
- **`id`** (string) - Returns the unique ID representing the video.
- **`media_duration_seconds`** (float) - Returns the duration of the recording in seconds.
- **`object_region`** (dict) - Returns the region of the thumbnail showing the detected object.
- **`object_type`** (string) - Returns the type of object that caused the video to start. Currently can be `vehicle`, `person`, `animal`, or `other`.
- **`thumbnail_url`** (string) - Returns the URL of the video's thumbnail image.
- **`url`** (string) - Returns the URL of the video.
- **`video_url`** (string) - Returns the URL of the video.
```

--------------------------------

### ArloDoorBell Control Methods

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods for controlling device operations such as sirens and power states.

```APIDOC
## siren_on(duration=300, volume=8)

### Description
Activates the device siren for a specified duration and volume level.

### Parameters
- **duration** (int) - Optional - Duration in seconds (default 300).
- **volume** (int) - Optional - Volume level from 1 to 8 (default 8).

## siren_off()

### Description
Deactivates the device siren.

## turn_on()

### Description
Powers the device on.

## turn_off()

### Description
Powers the device off.
```

--------------------------------

### Media and Status Retrieval

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Endpoints and properties for retrieving the latest media, device status, and identification information.

```APIDOC
## GET /last_n_videos

### Description
Returns the last count video objects describing the last captured videos.

### Parameters
#### Query Parameters
- **count** (int) - Required - Number of videos to retrieve

### Response
#### Success Response (200)
- **videos** (list) - List of ArloVideo objects

## GET /last_video

### Description
Returns a video object describing the last captured video.

### Response
#### Success Response (200)
- **video** (ArloVideo) - The last captured video object
```

--------------------------------

### PyAarlo Base Module

Source: https://pyaarlo.readthedocs.io/en/latest/_sources/index.rst.txt

Documentation for the base module of PyAarlo, which likely contains core functionalities and base classes.

```APIDOC
## PyAarlo Base Module

### Description
Provides the foundational elements and base classes for the PyAarlo library.

### Module
pyaarlo

### Members
This module exposes various members, including classes and functions, that are essential for the library's operation.
```

--------------------------------

### Camera Control Methods

Source: https://pyaarlo.readthedocs.io/en/latest/genindex.html

Methods available for controlling Arlo camera devices, including streaming, snapshots, and floodlight control.

```APIDOC
## GET /camera/get_snapshot

### Description
Retrieves a snapshot from the specified Arlo camera.

### Method
GET

## POST /camera/floodlight_on

### Description
Turns on the floodlight for the specified Arlo camera.

### Method
POST

## POST /camera/floodlight_off

### Description
Turns off the floodlight for the specified Arlo camera.

### Method
POST

## GET /camera/get_stream

### Description
Initiates or retrieves the video stream from the camera.

### Method
GET
```

--------------------------------

### Media and Data Updates

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Update media information and retrieve the latest recordings or thumbnails.

```APIDOC
## POST /device/update/last_image

### Description
Requests the latest thumbnail from the backend server and updates the last image.

### Method
POST

### Endpoint
/device/update/last_image

### Query Parameters
- **wait** (boolean) - Optional. If True, waits for completion. If False, does not wait. If None, uses the synchronous_mode setting.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the update operation (e.g., 'completed', 'pending').

#### Response Example
{
  "status": "completed"
}

## POST /device/update/media

### Description
Requests the latest list of recordings from the backend server and reloads the videos library from Arlo.

### Method
POST

### Endpoint
/device/update/media

### Query Parameters
- **wait** (boolean) - Optional. If True, waits for completion. If False, does not wait. If None, uses the synchronous_mode setting.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the media update operation (e.g., 'completed', 'pending').

#### Response Example
{
  "status": "completed"
}
```

--------------------------------

### ArloCamera Class Properties

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

This section lists the properties available for the ArloCamera class, providing access to various camera states and information.

```APIDOC
## ArloCamera Class Properties

### `base_station`

**Description**: Returns the base station controlling this device. If no base station is found, it returns the first available one.

### `battery_level`

**Description**: Returns the current battery level of the camera.

### `battery_tech`

**Description**: Returns the technology used for the camera's battery (e.g., rechargeable, wired).

### `brightness`

**Description**: Returns the current brightness setting of the camera.

### `captured_today`

**Description**: Returns the number of videos captured by the camera today.

### `charger_type`

**Description**: Returns the type of charger the device is using for recharging.

### `device_id`

**Description**: Returns the unique identifier for the device.

### `device_type`

**Description**: Returns the type of the device.

### `flip_state`

**Description**: Returns True if the camera's image is flipped, False otherwise.

### `has_batteries`

**Description**: Returns True if the device has batteries installed, False otherwise.

### `has_charger`

**Description**: Returns True if a charger is plugged into the device, False otherwise.

### `hw_version`

**Description**: Returns the hardware version of the camera.

### `is_charging`

**Description**: Returns True if the device is currently charging, False otherwise.

### `is_corded`

**Description**: Returns True if the device is directly connected to a power outlet and cannot use battery options.

### `is_on`

**Description**: Returns True if the camera is turned on, False otherwise.

### `is_own_parent`

**Description**: Returns True if the device is its own parent (not controlled by a separate base station).

### `is_recording`

**Description**: Returns True if the camera is currently recording a video, False otherwise.

### `is_streaming`

**Description**: Returns True if the camera is currently streaming video, False otherwise.

### `is_taking_idle_snapshot`

**Description**: Returns True if the camera is taking a non-streaming snapshot, False otherwise.

### `is_taking_snapshot`

**Description**: Returns True if the camera is taking a snapshot, False otherwise.

### `is_unavailable`

**Description**: Returns True if the device is unavailable, False otherwise.

### `last_capture`

**Description**: Returns a date string indicating when the last video was captured.

### `last_capture_date_format`

**Description**: Returns the date format string used by the `last_capture` function.

### `last_image`

**Description**: Returns the URL of the last snapshot or image taken by the camera.

### `is_charger_only`

**Description**: Returns True if the charger is plugged in and no batteries are present, False otherwise.

```

--------------------------------

### ArloCamera Control Methods

Source: https://pyaarlo.readthedocs.io/en/latest/genindex.html

Methods for controlling Arlo camera features such as recording, streaming, and spotlight/nightlight settings.

```APIDOC
## ArloCamera Control Methods

### Description
Methods to manage camera operations including recording, streaming, and adjusting hardware settings like spotlights and nightlights.

### Methods
- last_n_videos()
- next_track()
- nightlight_off()
- nightlight_on()
- pause_track()
- play_track()
- previous_track()
- request_snapshot()
- set_floodlight_brightness()
- set_music_loop_mode_continuous()
- set_music_loop_mode_single()
- set_nightlight_brightness()
- set_nightlight_color_temperature()
- set_nightlight_mode()
- set_nightlight_rgb()
- set_shuffle()
- set_spotlight_brightness()
- set_spotlight_off()
- set_spotlight_on()
- set_volume()
- siren_on()
- siren_off()
- start_recording()
- start_stream()
- stop_activity()
- stop_recording()
```

--------------------------------

### ArloCamera Class

Source: https://pyaarlo.readthedocs.io/en/latest/_sources/index.rst.txt

Documentation for the ArloCamera class, used for interacting with Arlo cameras.

```APIDOC
## ArloCamera Class

### Description
Provides functionalities to interact with Arlo cameras, including streaming, recording, and status checks.

### Class
pyaarlo.camera.ArloCamera

### Inherited Members
This class inherits members from its parent classes, which are also documented.
```

--------------------------------

### ArloDoorBell Attribute Management

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Methods for monitoring and retrieving specific device attributes and state information.

```APIDOC
## add_attr_callback(attr, cb)

### Description
Registers a callback function to be triggered when a specific device attribute changes.

### Parameters
- **attr** (str) - Required - The attribute name to monitor (e.g., 'motionStarted').
- **cb** (function) - Required - The callback function to execute.

## attribute(attr, default=None)

### Description
Retrieves the current value of a specific device attribute.

### Parameters
- **attr** (str) - Required - The attribute key to look up.
- **default** (any) - Optional - The value to return if the attribute is not found.
```

--------------------------------

### ArloDoorBell Class

Source: https://pyaarlo.readthedocs.io/en/latest/_sources/index.rst.txt

Details on the ArloDoorBell class for managing Arlo doorbell devices.

```APIDOC
## ArloDoorBell Class

### Description
Enables control and monitoring of Arlo doorbell devices.

### Class
pyaarlo.doorbell.ArloDoorBell

### Inherited Members
This class inherits members from its parent classes, which are also documented.
```

--------------------------------

### ArloBase Class

Source: https://pyaarlo.readthedocs.io/en/latest/_sources/index.rst.txt

Details about the ArloBase class, which serves as a base for Arlo devices.

```APIDOC
## ArloBase Class

### Description
Represents the base class for all Arlo devices, providing common attributes and methods.

### Class
pyaarlo.base.ArloBase

### Members
This class has members that include methods and attributes inherited from its parent classes and its own definitions.
```

--------------------------------

### Device Status and Information

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Retrieve various status indicators and unique identifiers for the Arlo device.

```APIDOC
## GET /device/status/timezone

### Description
Returns the timezone of the device. It attempts to intelligently determine the timezone, falling back to the basestation's timezone if not explicitly set.

### Method
GET

### Endpoint
/device/status/timezone

### Response
#### Success Response (200)
- **timezone** (string) - The current timezone of the device.

#### Response Example
{
  "timezone": "America/New_York"
}

## GET /device/status/too_cold

### Description
Returns a boolean indicating if the device is too cold to operate.

### Method
GET

### Endpoint
/device/status/too_cold

### Response
#### Success Response (200)
- **too_cold** (boolean) - True if the device is too cold, False otherwise.

#### Response Example
{
  "too_cold": false
}

## GET /device/info/unique_id

### Description
Returns the unique identifier for the device.

### Method
GET

### Endpoint
/device/info/unique_id

### Response
#### Success Response (200)
- **unique_id** (string) - The unique ID of the device.

#### Response Example
{
  "unique_id": "XYZ789ABC"
}

## GET /device/status/unseen_videos

### Description
Returns the count of unseen videos recorded by the camera.

### Method
GET

### Endpoint
/device/status/unseen_videos

### Response
#### Success Response (200)
- **unseen_videos** (integer) - The number of videos that have not been viewed.

#### Response Example
{
  "unseen_videos": 5
}

## GET /device/info/user_id

### Description
Returns the user ID associated with the device.

### Method
GET

### Endpoint
/device/info/user_id

### Response
#### Success Response (200)
- **user_id** (string) - The ID of the user.

#### Response Example
{
  "user_id": "user123"
}

## GET /device/info/user_role

### Description
Returns the role of the user associated with the device.

### Method
GET

### Endpoint
/device/info/user_role

### Response
#### Success Response (200)
- **user_role** (string) - The role of the user (e.g., 'owner', 'member').

#### Response Example
{
  "user_role": "owner"
}

## GET /device/status/using_wifi

### Description
Returns a boolean indicating if the device is connected to Wi-Fi directly (not through an Arlo basestation).

### Method
GET

### Endpoint
/device/status/using_wifi

### Response
#### Success Response (200)
- **using_wifi** (boolean) - True if connected to Wi-Fi, False otherwise.

#### Response Example
{
  "using_wifi": true
}

## GET /device/status/recently_active

### Description
Returns a boolean indicating if the camera has been active recently.

### Method
GET

### Endpoint
/device/status/recently_active

### Response
#### Success Response (200)
- **was_recently_active** (boolean) - True if the camera was recently active, False otherwise.

#### Response Example
{
  "was_recently_active": true
}

## GET /device/info/web_id

### Description
Returns the web-based identifier for the device.

### Method
GET

### Endpoint
/device/info/web_id

### Response
#### Success Response (200)
- **web_id** (string) - The web ID of the device.

#### Response Example
{
  "web_id": "web456"
}

## GET /device/info/xcloud_id

### Description
Returns the xCloud identifier for the device.

### Method
GET

### Endpoint
/device/info/xcloud_id

### Response
#### Success Response (200)
- **xcloud_id** (string) - The xCloud ID of the device.

#### Response Example
{
  "xcloud_id": "xcloud789"
}
```

--------------------------------

### Device Control Operations

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Perform actions to control the Arlo device, such as turning it on or off, and updating its status.

```APIDOC
## POST /device/control/turn_off

### Description
Turns the camera off.

### Method
POST

### Endpoint
/device/control/turn_off

### Response
#### Success Response (200)
- **status** (string) - Indicates the operation was successful (e.g., 'success').

#### Response Example
{
  "status": "success"
}

## POST /device/control/turn_on

### Description
Turns the camera on.

### Method
POST

### Endpoint
/device/control/turn_on

### Response
#### Success Response (200)
- **status** (string) - Indicates the operation was successful (e.g., 'success').

#### Response Example
{
  "status": "success"
}

## POST /device/update/ambient_sensors

### Description
Requests the latest temperature, humidity, and air quality settings. This action queues a job to retrieve the information from Arlo.

### Method
POST

### Endpoint
/device/update/ambient_sensors

### Response
#### Success Response (200)
- **status** (string) - Indicates the request was queued successfully (e.g., 'queued').

#### Response Example
{
  "status": "queued"
}
```

--------------------------------

### ArloBase Properties

Source: https://pyaarlo.readthedocs.io/en/latest/index.html

Properties to retrieve information about the Arlo base station's modes, schedules, and state.

```APIDOC
## ArloBase Properties

### Description
Access properties to get information about the Arlo base station, including available modes, current mode, schedule status, and siren state.

### Available Modes
#### `available_modes`
- **Description**: Returns a string list of available modes for the base station (e.g., `['disarmed', 'armed', 'home']`).
- **Type**: list[str]

#### `available_modes_with_ids`
- **Description**: Returns a dictionary mapping available modes to their corresponding Arlo IDs (e.g., `{'armed': 'mode1','disarmed': 'mode0','home': 'mode2'}`).
- **Type**: dict[str, str]

### Current State
#### `mode`
- **Description**: Returns the current operating mode of the base station.
- **Type**: str

#### `on_schedule`
- **Description**: Returns `True` if the base station is currently running a schedule, `False` otherwise.
- **Type**: bool

#### `schedule`
- **Description**: Returns the name of the current active schedule, or `None` if no schedule is active.
- **Type**: str | None

#### `siren_state`
- **Description**: Returns the current state of the base station's siren ('on' or 'off').
- **Type**: str

#### `state`
- **Description**: Returns a string describing the device's current overall state.
- **Type**: str
```
Tokens:
Raw