Cameras

Cameras API client and functional wrappers for pykada.

The CamerasClient provides access to video feeds, license-plate and person-of-interest lists, cloud-backup settings, occupancy analytics, and camera metadata through Verkada’s Cameras API.

Module-level functional wrappers (e.g. get_camera_data()) share a single lazily-initialized CamerasClient instance so token caching and connection pooling are preserved across calls.

Client

class pykada.cameras.CamerasClient(api_key=None, token_manager=None)

Bases: BaseClient

Client for interacting with Verkada Cameras API.

Initialize the client with either an API key or a token manager. If not key is provided, a default token manager will be used based on the environment configuration (VERKADA_API_KEY in a .env file).

Parameters:

• api_key (Optional[str]) – Optional API key for authentication.

• token_manager (Optional[VerkadaTokenManager]) – Optional token manager for handling tokens.

get_camera_alerts(start_time=None, end_time=None, include_image_url=None, notification_type=None, page_token=None, page_size=None)

Parameters:

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• include_image_url (Optional[bool])

• notification_type (Optional[List[str]])

• page_token (Optional[str])

• page_size (Optional[int])

Returns:

Return type:

dict

get_all_camera_alerts(start_time=None, end_time=None, include_image_url=None, notification_type=None)

Returns all camera alerts for the organization, walking all pages automatically.

Parameters:

• start_time (Optional[int]) – Start of the time window (Unix timestamp, seconds).

• end_time (Optional[int]) – End of the time window (Unix timestamp, seconds).

• include_image_url (Optional[bool]) – When True, each alert includes a pre-signed image URL.

• notification_type (Optional[List[str]]) – Optional list of alert types to filter by.

Returns:

A generator that yields individual alert dictionaries.

Return type:

Generator

create_lpoi(license_plate, description)

Parameters:

• license_plate (str) – License plate to be added

• description (str) – Short text description of the plate

Return type:

dict

Returns:

object response from Verkada API

get_all_lpois()

Returns all License Plates of Interest for the organization, walking all pages automatically.

Returns:

A generator that yields individual LPOI dictionaries.

Return type:

Generator

get_lpois(page_size=None, page_token=None)

Parameters:

• page_size (Optional[int]) – int

• page_token (Optional[str])

Returns:

Return type:

dict

update_lpoi(license_plate, description)

Parameters:

• license_plate (str)

• description (str)

Returns:

Return type:

dict

delete_lpoi(license_plate)

Parameters:

license_plate (str)

Returns:

Return type:

dict

create_bulk_lpois(filename)

Creates a License Plates of Interest in bulk for an organization. Include The csv file containing license plates to be added to the License Plate of Interest list. The column headers for the csv file should be “License Plate”, “Name” for creating LPOIs.

Parameters:

filename (str) – The .csv file for creating the bulk LPOIs

Return type:

dict

Returns:

The created LPOI objects.

delete_bulk_lpois(filename)

Deletes License Plates of Interest in bulk for an organization. Include The csv file containing license plates to be added to the License Plate of Interest list. The column header for the csv file should be “License Plate”.

Parameters:

filename (str) – The .csv file for deleting the bulk LPOIs

Return type:

dict

Returns:

The deleted LPOI objects.

get_all_seen_license_plates(camera_id, license_plate=None, start_time=None, end_time=None)

Returns all license-plate detection events for a camera, walking all pages automatically.

Parameters:

• camera_id (str) – The unique identifier of the camera.

• license_plate (Optional[str]) – Optional plate string to filter results to a specific plate.

• start_time (Optional[int]) – Start of the time window (Unix timestamp, seconds).

• end_time (Optional[int]) – End of the time window (Unix timestamp, seconds).

Returns:

A generator that yields individual detection dictionaries.

Return type:

Generator

get_seen_license_plates(camera_id, license_plate=None, start_time=None, end_time=None, page_size=None, page_token=None)

Parameters:

• camera_id (str)

• license_plate (Optional[str])

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• page_size (Optional[int])

• page_token (Optional[str])

Returns:

Return type:

dict

get_lpr_timestamps(camera_id, license_plate, start_time=None, end_time=None, page_size=None, page_token=None)

Returns the timestamps for a certain license plate (only for LPR-enabled cameras_tests).

Parameters:

• camera_id (str) – The unique identifier of the camera.

• license_plate (str) – The license plate number.

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• page_size (Optional[int]) – Number of items per response.

• page_token (Optional[str]) – Pagination token for the next page.

Return type:

dict

Returns:

A dictionary with timestamps for the given camera and license plate.

get_all_lpr_timestamps(camera_id, license_plate, start_time=None, end_time=None)

Parameters:

• camera_id (str)

• license_plate (str)

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• end_time

Returns:

Return type:

Generator[Any, None, None]

get_all_object_counts(camera_id, start_time=None, end_time=None)

Parameters:

• camera_id (str)

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• end_time

Returns:

Return type:

get_object_counts(camera_id, start_time=None, end_time=None, page_size=None, page_token=None)

Parameters:

• camera_id (str)

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• page_size (Optional[int])

• page_token (Optional[str])

Returns:

Return type:

dict

set_object_position_mqtt(broker_cert, broker_host_port, camera_id, client_username=None, client_password=None)

Sets the MQTT configuration for a particular camera.

Object Position Events will be published to the specified MQTT broker.

Parameters:

• broker_cert (str) – CA-signed certificate for TLS connection.

• broker_host_port (str) – The host and port for the MQTT server.

• camera_id (str) – The unique identifier of the camera.

• client_username (str) – Optional username for the MQTT server.

• client_password (str) – Optional password for the MQTT server.

Return type:

dict

Returns:

The new MQTT configuration.

get_occupancy_trends(camera_id, start_time=None, end_time=None, interval=None, trend_type=None, preset_id=None)

Returns all occupancy trends data for a specified camera over a time range.

Parameters:

• camera_id (str) – The unique identifier of the camera.

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• interval (Optional[str]) – Time interval (e.g., 15_minutes, 1_hour, etc.).

• trend_type (Optional[str]) – Data type; for example, “person”.

• preset_id (Optional[str]) – Optional preset identifier.

Return type:

dict

Returns:

A JSON object with occupancy trends data.

get_cloud_backup_settings(camera_id)

Retrieves cloud backup settings for a specified camera.

Parameters:

camera_id (str) – The unique identifier of the camera.

Return type:

dict

Returns:

A dictionary of the current cloud backup settings.

update_cloud_backup_settings(camera_id, days_to_preserve, enabled, time_to_preserve, upload_timeslot, video_quality, video_to_upload)

Updates the cloud backup settings for a specified camera.

Parameters:

• camera_id (str) – The unique identifier of the camera.

• days_to_preserve (str) – Delimited list of booleans for each day (e.g., “0,1,1,1,1,1,0”).

• enabled (int) – 1 if cloud backup is enabled; otherwise, 0.

• time_to_preserve (str) – Delimited list of start_time, end_time for footage backup (e.g., “3600,7200”).

• upload_timeslot (str) – Delimited list of start_time, end_time for upload schedule (e.g., “3600,7200”).

• video_quality (str) – Video quality (“STANDARD_QUALITY” or “HIGH_QUALITY”).

• video_to_upload (str) – Video type (“MOTION” or “ALL”).

Return type:

dict

Returns:

The updated cloud backup configuration.

get_all_camera_data()

Returns:

Return type:

get_camera_data(page_size=None, page_token=None)

Returns details of all cameras_tests within the organization.

Parameters:

• page_size (Optional[int]) – The number of items per response.

• page_token (Optional[str]) – Pagination token for the next page.

Return type:

dict

Returns:

A dictionary with camera device information.

get_footage_link(camera_id, timestamp=None)

Returns a link to video footage for a specified camera at a given timestamp.

Return type:

dict

Parameters:

• camera_id (str)

• timestamp (int | None)

get_historical_thumbnail(camera_id, timestamp=None, resolution=None)

Returns a thumbnail (low or high resolution) from a specified camera at a given time.

Return type:

bytes

Parameters:

• camera_id (str)

• timestamp (int | None)

• resolution (str | None)

get_latest_thumbnail(camera_id, resolution=None)

Returns the latest thumbnail from a specified camera in low or high resolution.

Return type:

bytes

Parameters:

• camera_id (str)

• resolution (str | None)

get_thumbnail_link(camera_id, timestamp=None, expiry=3600)

Returns a link to a thumbnail image from a specified camera at a given timestamp.

Return type:

dict

Parameters:

• camera_id (str)

• timestamp (int | None)

• expiry (int | None)

get_all_pois()

Iterates through paginated results for Persons of Interest.

get_pois(page_size=None, page_token=None)

Returns details for all Persons of Interest in the organization.

Return type:

dict

Parameters:

• page_size (int | None)

• page_token (str | None)

create_poi(image_url, label)

Creates a Person of Interest using a base64-encoded image and label.

Return type:

dict

Parameters:

• image_url (str)

• label (str)

update_poi(person_id, label)

Updates the label of a Person of Interest.

Return type:

dict

Parameters:

• person_id (str)

• label (str)

delete_poi(person_id)

Deletes a Person of Interest from the organization.

Return type:

dict

Parameters:

person_id (str)

get_dashboard_occupancy_trend_data(dashboard_id, start_time=None, end_time=None, interval=None)

Returns occupancy trend data for a specified dashboard.

Return type:

dict

Parameters:

• dashboard_id (str)

• start_time (int | None)

• end_time (int | None)

• interval (str | None)

get_occupancy_trend_enabled_cameras()

Returns the list of cameras in the organization that have occupancy trends enabled.

Returns:

A dictionary containing camera identifiers and their occupancy-trend status.

Return type:

dict

get_max_people_vehicle_counts(camera_id, start_time=None, end_time=None, search_zones=None)

Returns the maximum people and vehicle counts for a specified camera.

Return type:

dict

Parameters:

• camera_id (str)

• start_time (int | None)

• end_time (int | None)

• search_zones (List[List[int]] | None)

get_camera_audio_status(camera_id)

Returns the audio status of a specified camera.

Return type:

dict

Parameters:

camera_id (str)

set_camera_audio_status(camera_id, enabled)

Sets the audio status of a specified camera.

Return type:

dict

Parameters:

• camera_id (str)

• enabled (bool)

get_viewing_stations()

Returns a list of viewing stations in an organization.

Returns:

A list of viewing stations within the organization

Return type:

dict

property request_manager: VerkadaRequestManager

Returns the request manager used by this client.

Functional wrappers

The functions below share a single lazily-initialized CamerasClient so token caching is preserved across calls.

Cameras API client and functional wrappers for pykada.

The CamerasClient provides access to video feeds, license-plate and person-of-interest lists, cloud-backup settings, occupancy analytics, and camera metadata through Verkada’s Cameras API.

Module-level functional wrappers (e.g. get_camera_data()) share a single lazily-initialized CamerasClient instance so token caching and connection pooling are preserved across calls.

pykada.cameras.create_bulk_lpois(filename)

Creates a License Plates of Interest in bulk for an organization. Include The csv file containing license plates to be added to the License Plate of Interest list. The column headers for the csv file should be “License Plate”, “Name” for creating LPOIs.

Parameters:

filename (str) – The .csv file for creating the bulk LPOIs

Returns:

The created LPOI objects.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.create_lpoi(license_plate, description)

Parameters:

• license_plate (str) – License plate to be added

• description (str) – Short text description of the plate

Returns:

object response from Verkada API

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.create_poi(image_url, label)

Creates a Person of Interest using a base64-encoded image and label.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• image_url (str)

• label (str)

pykada.cameras.delete_bulk_lpois(filename)

Deletes License Plates of Interest in bulk for an organization. Include The csv file containing license plates to be added to the License Plate of Interest list. The column header for the csv file should be “License Plate”.

Parameters:

filename (str) – The .csv file for deleting the bulk LPOIs

Returns:

The deleted LPOI objects.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.delete_lpoi(license_plate)

Parameters:

license_plate (str)

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.delete_poi(person_id)

Deletes a Person of Interest from the organization.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

person_id (str)

pykada.cameras.get_all_camera_alerts(start_time=None, end_time=None, include_image_url=None, notification_type=None)

Returns all camera alerts for the organization, walking all pages automatically.

Parameters:

• start_time (Optional[int]) – Start of the time window (Unix timestamp, seconds).

• end_time (Optional[int]) – End of the time window (Unix timestamp, seconds).

• include_image_url (Optional[bool]) – When True, each alert includes a pre-signed image URL.

• notification_type (Optional[List[str]]) – Optional list of alert types to filter by.

Returns:

A generator that yields individual alert dictionaries.

Return type:

Generator

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_all_camera_data()

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_all_lpois()

Returns all License Plates of Interest for the organization, walking all pages automatically.

Returns:

A generator that yields individual LPOI dictionaries.

Return type:

Generator

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_all_lpr_timestamps(camera_id, license_plate, start_time=None, end_time=None)

Parameters:

• camera_id (str)

• license_plate (str)

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• end_time

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_all_object_counts(camera_id, start_time=None, end_time=None)

Parameters:

• camera_id (str)

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• end_time

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_all_pois()

Iterates through paginated results for Persons of Interest.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_all_seen_license_plates(camera_id, license_plate=None, start_time=None, end_time=None)

Returns all license-plate detection events for a camera, walking all pages automatically.

Parameters:

• camera_id (str) – The unique identifier of the camera.

• license_plate (Optional[str]) – Optional plate string to filter results to a specific plate.

• start_time (Optional[int]) – Start of the time window (Unix timestamp, seconds).

• end_time (Optional[int]) – End of the time window (Unix timestamp, seconds).

Returns:

A generator that yields individual detection dictionaries.

Return type:

Generator

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_camera_alerts(start_time=None, end_time=None, include_image_url=None, notification_type=None, page_token=None, page_size=None)

Parameters:

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• include_image_url (Optional[bool])

• notification_type (Optional[List[str]])

• page_token (Optional[str])

• page_size (Optional[int])

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_camera_audio_status(camera_id)

Returns the audio status of a specified camera.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

camera_id (str)

pykada.cameras.get_camera_data(page_size=None, page_token=None)

Returns details of all cameras_tests within the organization.

Parameters:

• page_size (Optional[int]) – The number of items per response.

• page_token (Optional[str]) – Pagination token for the next page.

Returns:

A dictionary with camera device information.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_cloud_backup_settings(camera_id)

Retrieves cloud backup settings for a specified camera.

Parameters:

camera_id (str) – The unique identifier of the camera.

Returns:

A dictionary of the current cloud backup settings.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_dashboard_occupancy_trend_data(dashboard_id, start_time=None, end_time=None, interval=None)

Returns occupancy trend data for a specified dashboard.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• dashboard_id (str)

• start_time (int | None)

• end_time (int | None)

• interval (str | None)

pykada.cameras.get_footage_link(camera_id, timestamp=None)

Returns a link to video footage for a specified camera at a given timestamp.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• camera_id (str)

• timestamp (int | None)

pykada.cameras.get_historical_thumbnail(camera_id, timestamp=None, resolution=None)

Returns a thumbnail (low or high resolution) from a specified camera at a given time.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• camera_id (str)

• timestamp (int | None)

• resolution (str | None)

pykada.cameras.get_latest_thumbnail(camera_id, resolution=None)

Returns the latest thumbnail from a specified camera in low or high resolution.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• camera_id (str)

• resolution (str | None)

pykada.cameras.get_lpois(page_size=None, page_token=None)

Parameters:

• page_size (Optional[int]) – int

• page_token (Optional[str])

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_lpr_timestamps(camera_id, license_plate, start_time=None, end_time=None, page_size=None, page_token=None)

Returns the timestamps for a certain license plate (only for LPR-enabled cameras_tests).

Parameters:

• camera_id (str) – The unique identifier of the camera.

• license_plate (str) – The license plate number.

• start_time (Optional[int]) – Start of the time range (Unix timestamp in seconds).

• end_time (Optional[int]) – End of the time range (Unix timestamp in seconds).

• page_size (Optional[int]) – Number of items per response.

• page_token (Optional[str]) – Pagination token for the next page.

Returns:

A dictionary with timestamps for the given camera and license plate.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_max_people_vehicle_counts(camera_id, start_time=None, end_time=None, search_zones=None)

Returns the maximum people and vehicle counts for a specified camera.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• camera_id (str)

• start_time (int | None)

• end_time (int | None)

• search_zones (List[List[int]] | None)

pykada.cameras.get_object_counts(camera_id, start_time=None, end_time=None, page_size=None, page_token=None)

Parameters:

• camera_id (str)

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• page_size (Optional[int])

• page_token (Optional[str])

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_occupancy_trend_enabled_cameras()

Returns cameras_tests enabled for occupancy trends.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_occupancy_trends(camera_id, start_time=None, end_time=None, interval=None, trend_type=None, preset_id=None)

Returns all occupancy trends data for a specified camera over a time range.

Parameters:

• camera_id (str) – The unique identifier of the camera.

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• interval (Optional[str]) – Time interval (e.g., 15_minutes, 1_hour, etc.).

• trend_type (Optional[str]) – Data type; for example, “person”.

• preset_id (Optional[str]) – Optional preset identifier.

Returns:

A JSON object with occupancy trends data.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_pois(page_size=None, page_token=None)

Returns details for all Persons of Interest in the organization.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• page_size (int | None)

• page_token (str | None)

pykada.cameras.get_seen_license_plates(camera_id, license_plate=None, start_time=None, end_time=None, page_size=None, page_token=None)

Parameters:

• camera_id (str)

• license_plate (Optional[str])

• start_time (Optional[int]) – Start time for the data (Unix timestamp in seconds).

• end_time (Optional[int]) – End time for the data (Unix timestamp in seconds).

• page_size (Optional[int])

• page_token (Optional[str])

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.get_thumbnail_link(camera_id, timestamp=None, expiry=3600)

Returns a link to a thumbnail image from a specified camera at a given timestamp.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• camera_id (str)

• timestamp (int | None)

• expiry (int | None)

pykada.cameras.set_camera_audio_status(camera_id, enabled)

Sets the audio status of a specified camera.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• camera_id (str)

• enabled (bool)

pykada.cameras.set_object_position_mqtt(broker_cert, broker_host_port, camera_id, client_username=None, client_password=None)

Sets the MQTT configuration for a particular camera.

Object Position Events will be published to the specified MQTT broker.

Parameters:

• broker_cert (str) – CA-signed certificate for TLS connection.

• broker_host_port (str) – The host and port for the MQTT server.

• camera_id (str) – The unique identifier of the camera.

• client_username (str) – Optional username for the MQTT server.

• client_password (str) – Optional password for the MQTT server.

Returns:

The new MQTT configuration.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.update_cloud_backup_settings(camera_id, days_to_preserve, enabled, time_to_preserve, upload_timeslot, video_quality, video_to_upload)

Updates the cloud backup settings for a specified camera.

Parameters:

• camera_id (str) – The unique identifier of the camera.

• days_to_preserve (str) – Delimited list of booleans for each day (e.g., “0,1,1,1,1,1,0”).

• enabled (int) – 1 if cloud backup is enabled; otherwise, 0.

• time_to_preserve (str) – Delimited list of start_time, end_time for footage backup (e.g., “3600,7200”).

• upload_timeslot (str) – Delimited list of start_time, end_time for upload schedule (e.g., “3600,7200”).

• video_quality (str) – Video quality (“STANDARD_QUALITY” or “HIGH_QUALITY”).

• video_to_upload (str) – Video type (“MOTION” or “ALL”).

Returns:

The updated cloud backup configuration.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.update_lpoi(license_plate, description)

Parameters:

• license_plate (str)

• description (str)

Returns:

Return type:

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

pykada.cameras.update_poi(person_id, label)

Updates the label of a Person of Interest.

—

Note: This is a functional wrapper for its equivalent method in the CamerasClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a CamerasClient object directly for better performance.

Parameters:

• person_id (str)

• label (str)

pykada.cameras.get_viewing_stations()

Returns a list of viewing stations in an organization.

Returns:

A list of viewing stations within the organization

Return type:

dict

—

Note: This is a functional wrapper for its equivalent method in the ViewingStationClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use a ViewingStationClient object directly for better performance.