camera - Manage Cameras

NAME

camera - Manage camera settings and operations

SYNOPSIS

een camera [COMMAND] [OPTIONS]

COMMANDS

list

List cameras.

Options:

• --csv
  List cameras in CSV format.
• --tree
  List cameras and associated bridges in a tree format.
• --tags [tags]
  List cameras based on the given tag. Specify the tag as a comma-separated list of tag names.
• --available
  List available cameras that are currently operational.
• --sites [sites]
  List cameras located in the specified sites. Provide a comma-separated list of site names.
• --status [status]
  List cameras with a specific status. Accepts values like 'online', 'offline', or 'inactive'.
• --short
  List only the camera names and ESNs in CSV format to the specified file.
• --html
  Generate a chart of the camera list in an HTML file format.
• --google-sheet
  List cameras in CSV format in a Google Sheet.
• --purge
  The --purge option only works with --csv or --google-sheet options. It removes expired data from the output.
• --start-time [start time]
  Filter cameras based on video start time. Format: YYYYMMDDHHMMSS.sss (Compact ISO 8601 date-time with milliseconds).
• --end-time [end time]
  Filter cameras based on video end time. Format: YYYYMMDDHHMMSS.sss (Compact ISO 8601 date-time with milliseconds).
• -f, --file-name [file name]
  Specify the name of the file where the output will be saved. This can be used with --csv or --google-sheet.
• --no-prompt
  Skip all user confirmation prompts during the command execution.
• --debug
  Enable debug output for troubleshooting and detailed logs.
• --v1
  Use version 1 APIs for backward compatibility.
• -l
  List camera details, including camera ESN, bridge ESN, status, resolution, cloud retention days, and local retention days.
• --esn
  List cameras by their ESNs.
• --bridge-esn
  List cameras by their bridge ESNs.
• --resolution
  List cameras filtered by resolution.
• --cloud-retention-days
  List cameras filtered by their cloud retention days.
• --local-retention-days
  List cameras filtered by their local retention days.
• -s, --shared
  List cameras that are shared with other users.
• -a, --all
  List all cameras without filtering.

Notes:

• Start-time and end-time must follow the format: YYYYMMDDHHMMSS.sss (Compact ISO 8601 date-time with milliseconds).

status

List status of all cameras.

Options:

• --csv
  List camera status in CSV format.
• --html
  Generate chart in HTML file.
• --google-sheet
  List camera status in CSV format in Google Sheet.
• -f, --file-name [file name]
  Specify the name of the file where the output will be saved.
• --v1
  Use v1 APIs.
• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.

settings

Get all camera settings.

Required options:

• --csv
  List camera settings in CSV format.

Optional options:

• -f, --file-name [file name]
  Specify the name of the file where the output will be saved.
• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.

set

Edit camera's settings.

Arguments:

• --esns [esns]
  Edit camera settings by camera ESNs.
• --bridge-esns [bridge-esns]
  Edit camera settings by bridge ESNs.
• -f, --file-name [file name]
  Edit camera settings by reading the CSV file.
• --tag [tag]
  Edit camera settings by tag.

Options:

• --cloud-retention-days [cloud retention days]
  Cloud retention days.
• --video-resolution [video resolution]
  Video resolution.
• --bridge-target-days [bridge target days]
  Bridge target days.
• --local-retention-days [local retention days]
  Local retention days.
• --preview-resolution [preview resolution]
  Preview resolution.
• --preview-transmit-mode [preview transmit mode]
  Preview transmit mode.
• --video-transmit-mode [video transmit mode]
  Video transmit mode.
• --video-quality [video quality]
  Video quality.
• --tags [tags]
  Tags.
• --username [username]
  Username.
• --password [password]
  Password.
• --aspect-ratio [aspect ratio]
  Preview aspect ratio.
• --video-capture-mode [video capture mode]
  When to record video.
• --preview-interval-ms [preview interval ms]
  Preview interval rate in milliseconds.
• --preview-quality [preview quality]
  Preview quality.
• --preview-only-cloud-retention [preview only cloud retention]
  Preview only cloud retention.
• --audio-enable
  Enable audio.
• --audio-disable
  Disable audio.
• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.

Notes:

• For --esns "*", it changes settings for all cameras.

delete

Delete a camera from the bridge.

Argument:

• <esn>
  ESN of the camera (required)

Options:

• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.

add

Add camera to bridge.

Argument:

• <esn>
  ESN of the bridge to which the camera is added.

Required options:

• --camera-name [camera name]
  Name of the camera.
• --guid [guid]
  GUID of the camera.

Optional options:

• --cloud-retention-days [cloud retention days]
  Cloud retention days.
• --scene [scene]
  Scene.
• --tags [tags]
  Tags.
• --username [username]
  Username.
• --password [password]
  Password.
• --site [site]
  Site ID.
• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.

streamstatus

Get camera stream status.

Arguments:

• <esns>
  ESNs of the cameras.

Required options:

• --start-time [start time]
  Camera stream start time.
• --end-time [end time]
  Camera stream end time.

Optional options:

• --stream-type [stream type]
  Stream type of the camera.
• -f, --file-name [file name]
  Specify the name of the file where the output will be saved.
• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.

Notes:

• stream-type can be "fullvideo" or "preview".
• start-time can be "-1h" (one hour before current time).
• end-time can be "now" (current time).
• start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision).

purgelist

Get camera purging and duty cycle.

Options:

• --start-time [start time]
  Purge start time.
• --end-time [end time]
  Purge end time.
• -f, --file-name [file name]
  Specify the name of the file where the output will be saved.
• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.

Notes:

• If you haven't specified any start-time and end-time, it will take the last 24 hours as default timestamps.
• start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision).

availability

Get camera availability.

Required options:

• --esns [esns]
  ESNs of the camera.

Optional options:

• --start-time [start time]
  Video start time.
• --end-time [end time]
  Video end time.
• -f, --file-name [file name]
  Specify the name of the file where the output will be saved.
• --google-sheet
  List camera availability in CSV format in Google Sheets.
• --preview-availability
  Get preview recording status along with camera availability.
• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.
• --no-check
  Show all available data, including unchecked items.

Notes:

• This command only supports a maximum of 200 devices and a seven-day time range.
• start-time and end-time time format should be YYYY-MM-DDTHH:MM:SS.sss±HH:MM (ISO 8601 extended date-time).

bridge - Manage Bridges

NAME

bridge - manage and interact with bridges and associated cameras.

SYNOPSIS

een bridge [COMMAND] [OPTIONS]

DESCRIPTION

The bridge command allows you to manage bridges, list their status, check availability, pull logs, and update camera settings.

COMMANDS

list

List all bridges.

Options:

• --csv
  List all bridges in CSV format.
• --tree
  View bridges and associated cameras in tree format.
• --available
  List discovered cameras that are not yet attached.
• --sites [sites]
  List bridges in a specific site.
• --tags [tags]
  Filter bridges by tags.
• --status [status]
  List bridges with a specific status.
• --html
  Generate a chart in HTML file.
• --google-sheet
  List bridges in CSV format in Google Sheets.
• -f, --file-name [file name]
  Specify the name of the file where the output will be saved.
• --no-prompt
  Skip all user confirmation prompts.
• --debug
  Enable detailed debug output for troubleshooting.
• --v1
  Use v1 APIs.
• -l
  Display bridge details, including bridge ID, name, and location. For v3, also includes cameras in the account and online cameras; for v1, includes GUID.
• --esn
  List bridge ESNs.
• --site
  List the site of the bridge.

Actions:

• If --html is specified and --v1, generate a bridge list report using v1.
• If --csv is specified and --v1, list bridges in CSV format using v1.
• Handle other combinations of options to perform various listing and reporting tasks.

status

List bridge status.

Options:

• --html
  Generate a chart in an HTML file
• --google-sheet
  List bridges in csv format in a Google Sheet
• --debug
  Enable detailed debug output for troubleshooting

availability

Get bridge availability.

Options:

• --esns [esns]
  ESNs of the bridge
• --start-time [start time]
  Specify video start time
• --end-time [end time]
  Specify video end time
• -f, --file-name [file name]
  Specify the file name to save the output
• --google-sheet
  List bridge availability in csv format in a Google Sheet
• --no-prompt
  Skip all user confirmation prompts
• --debug
  Enable detailed debug output for troubleshooting
• --no-check
  Show all available data

qlstreammetrics

Pull logs from the archiver/bridge.

Required options:

• --esns [esns]
  Esns of the bridge (required).

Optional options:

• --performance
  View performance metrics of the bridge
• --events
  View events of the bridge
• --count [count]
  Specify the number of annotations to return
• --start-time [start time]
  Specify the start time
• --end-time [end time]
  Specify the end time
• --summary
  Get summarized data
• --local-rtsp-metrics [enable/disable]
  Enable or disable the RTSP metrics set
• --no-prompt
  Skip all user confirmation prompts
• --debug
  Enable detailed debug output for troubleshooting

Notes:

• start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision)

EXAMPLES

• To list all bridges:

een bridge list

• To check the status of a specific bridge:

een bridge status --html

• To get availability information for a bridge:

een bridge availability --esns [esns] --start-time [start time] --end-time [end time]

switch - Manage Switches

NAME

switch - manage and interact with switches.

SYNOPSIS

een switch [COMMAND] [OPTIONS]

DESCRIPTION

The switch command allows you to manage switches and list switch status.

COMMANDS

list

List switches.

Options:

• --debug
  Enable detailed debug output for troubleshooting
• -l
  List switch details, including switch ID, bridge ESN, and status
• --bridge
  List the bridge ESNs associated with the switches
• --id
  List the IDs of the switches
• --status
  List the status of the switches

EXAMPLES

• To list all switches:

een switch list

• To list switches ids:

een switch list --id

• To list switches and their statuses:

een switch list --status