The latest CLI release version:
-
Extraction of file from a compressed file format
-
There are multiple ways to extract a file from a compressed file. Here are the step-by-step instructions:
-
First method:
- Point the cursor on the compressed file.
- Right-click on it to trigger the context-menu (right-click menu).
- On the context menu select the
Extract Here
option to extract the file in the same directory or Select theExtract to
option in order to extract the file into the current directory or directory of your choice.
-
Second method:
- Point the cursor on the compressed file.
- Left-Double-click on it to trigger a window that shows the extraction option.
- Select the
Extract
button to extract the file into the desired directory.
-
Third method:
- Open the terminal in the directory where the compressed file is stored.
- Type in the terminal command
unzip een.zip
to extract the file in the current directory.
unzip een.zip
- Here are the step-by-step instructions:
- Point the cursor on the compressed file.
- Right-click on it to trigger context-menu(right-click menu).
- On the context menu select
Extract All
. - A window is triggered that shows an input box which is used to insert the directory path to a chosen directory.
- After choosing a directory click on the
Extract
button, to extract the file to the chosen directory.
-
-
For all commands with
--no-prompt
option it will skip all user confirmation prompts. This means it will also overwrite any existing files without any confirmation. -
Open all the CSV file outputs in Google Sheets or Libre Office as Excel has formatting issues.
-
verbose mode
: Use--verbose
along with the commands to access the verbose mode. -
Supported
EEN TIME FORMATS
:- 20230125062511.000
- 2023-01-31
- 2023-01-31T08:24:32
- 2023-10-02T23:50:06.337+00:00
-
Execute this extracted file by mapping up the directory path of the een on the terminal
-
Each command should start
./
.Examples:
./een --version
-
To check if the executable works fine
- Run the command:
./een
- Output:
v<version number> usage: een [-v | --version] [-h | --help] <object> <command> [<args>] These are common een commands used in various situations: auth login login to the account auth logout logout of the account camera list list all cameras camera status list status of all cameras bridge list list all bridges bridge availability get bridge availability 'een help' lists all the commands and options 'een <command> help' lists the usage with options and descriptions
een
- A command-line tool for managing and retrieving information related to cameras, bridges, users, and more in a cloud-based environment.
een [OPTIONS] <object> <command> [ARGS]
The een CLI provides various commands to interact with cameras, bridges, users, sites, and other resources. It offers multiple options for fetching information in different formats (CSV, tree structure, etc.) and supports both standard and v1 APIs.
-
--help, -h
Displays the help information for the een command or a specific object. -
--version
Displays the current version of the een CLI.
een --version
Displays the version of the een tool.
een help
Shows detailed help instructions. For shorter help on a specific object, use:
een <object> --help
een help
een --help
een -h
een auth --help
een camera list --help
auth
– EEN authentication commands
een auth [COMMAND] [options]
The een auth command provides utilities for logging in and out of Eagle Eye Networks.
Log in to EEN using the provided credentials.
-
-p, --password <password>
Password for login. Use quotes around the password if it contains special characters (e.g.,--password "MyP@ssw0rd!"
). -
-u, --username <username>
Username for login (e.g.,--username [email protected]
).
-d, --debug
Enable detailed debug output for troubleshooting.
- If the shell misinterprets special characters, ensure the password is wrapped in quotes.
Log out from EEN.
-d, --debug
Enable detailed debug output for troubleshooting.
- To login
een auth login --username johndoe --password secret --debug
- To logout
een auth logout --debug
user
- manage and interact with users.
een user [COMMAND] [OPTIONS]
The user
command allows you to manage users, list user permissions, and export user data in various formats.
List users.
--csv
Export all users in CSV format.-d, --debug
Enable detailed debug output for troubleshooting.-e, --email
Display user email addresses.-f, --file-name [file name]
Specify the file name to save the output under. Use with the--csv
option to generate a report.-F, --first-name
Display user first names.-g, --google-sheet
Export users in CSV format and upload to Google Sheets.--html
Generate an HTML report for user permissions.-l, --long
Display user details, including name, email, last login, status, and permissions.-L, --last-name
Display user last names.-n, --no-prompt
Skip all user confirmation prompts.-p, --permission
Display user permissions.-s, --status
Display user statuses.--v1
Use v1 APIs for listing users.
- If
--html
is specified, generate a user permissions report. - If
--csv
and--v1
are both specified, export users in CSV format using v1 APIs. - If
--csv
is specified, export users in CSV format. - If
--google-sheet
is specified, export and upload user data to Google Sheets. - If
--v1
is specified, list users using v1 APIs.
- To list all users:
een user list
- To list users in CSV format:
een user list --csv -f users.csv
- To generate an HTML report of user permissions:
een user list --html
account
- manage and interact with user accounts.
een account [COMMAND] [OPTIONS]
The account
command allows you to manage reseller accounts, list all accounts, and switch between sub-accounts.
List all accounts of the reseller account.
-d, --debug
Enable detailed debug output for troubleshooting.-l, --long
Display account details, including account ID, account name, and account type.--account-id [account ID]
Specify an account ID to list its details.-s, --sub-account-id
List sub-accounts (only applicable for reseller accounts).
Switch to an account.
-a, --account-id [account ID]
Specify the Account ID to switch between logged-in accounts.-d, --debug
Enable detailed debug output for troubleshooting.-s, --sub-account-id [sub-account ID]
Specify the Sub Account ID to switch to from the reseller account.
- To list all accounts of the reseller:
een account list --debug
- To switch to a specific sub-account:
een account switch --sub-account-id <sub-account ID> --debug
- To switch to a specific account:
een account switch --account-id <account ID> --debug
archive
- manage and interact with archives.
een archive [COMMAND] [OPTIONS]
The archive
command allows you to manage archives, including listing archives and downloading specific archives.
Get the list of available archives.
--csv
Export the archive list in CSV format.-d, --debug
Enable detailed debug output for troubleshooting.-D, --detailed
Retrieve a detailed list of archives with additional metadata.-l, --long
Display archive details, including filename, size, creation date, shared status, and shared path.-t, --target-directory [target directory]
Specify the directory from which the archive will be retrieved.
Download a specific archive.
<archive>
The name of the archive to download (required).
-t, --target-directory [target-directory]
Specify the name of the directory where the output will be saved.
-d, --debug
Enable debug output for troubleshooting.-o, --overwrite
Overwrite the already downloaded archive if it exists.
- To list available archives:
een archive list --detailed --csv --target-directory /path/to/output
- To download a specific archive:
een archive download <archive> --target-directory /path/to/save --overwrite --debug
camera
- Manage camera settings and operations
een camera [COMMAND] [OPTIONS]
List cameras.
-a, --all
List all cameras without filtering.-A, --available
List available cameras that are currently operational.-b, --bridge-esn
List cameras by their bridge ESNs.-c, --cloud-retention-days
List cameras filtered by their cloud retention days.--csv
List cameras in CSV format.-d, --debug
Enable debug output for troubleshooting and detailed logs.-e, --end-time [end time]
Filter cameras based on video end time. Format:YYYYMMDDHHMMSS.sss
(Compact ISO 8601 date-time with milliseconds).--esn
List cameras by their ESNs.-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
.-g, --google-sheet
List cameras in CSV format in a Google Sheet.--html
Generate a chart of the camera list in an HTML file format.-l, --long
List camera details, including camera ESN, bridge ESN, status, resolution, cloud retention days, and local retention days.-L, --local-retention-days
List cameras filtered by their local retention days.-n, --no-prompt
Skip all user confirmation prompts during the command execution.-p, --purge
The--purge
option only works with--csv
or--google-sheet
options. It removes expired data from the output.--v1
Use version 1 APIs for backward compatibility.-r, --resolution
List cameras filtered by resolution.-s, --sites [site1, site2]
List cameras located in the specified sites. Provide a comma-separated list of site names.-S, --start-time [start time]
Filter cameras based on video start time. Format:YYYYMMDDHHMMSS.sss
(Compact ISO 8601 date-time with milliseconds).--shared
List cameras that are shared with other users.--short
List only the camera names and ESNs in CSV format to the specified file.--status [status]
List cameras with a specific status. Accepts values like 'online', 'offline', or 'inactive'.-t, --tags [tag1, tag2]
List cameras based on the given tag. Specify the tag as a comma-separated list of tag names.-T, --tree
List cameras and associated bridges in a tree format.
- Start-time and end-time must follow the format:
YYYYMMDDHHMMSS.sss
(Compact ISO 8601 date-time with milliseconds).
List status of all cameras.
--csv
List camera status in CSV format.-d, --debug
Enable detailed debug output for troubleshooting.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-g, --google-sheet
List camera status in CSV format in Google Sheet.--html
Generate chart in HTML file.-n, --no-prompt
Skip all user confirmation prompts.--v1
Use v1 APIs.
Get all camera settings.
--csv
List camera settings in CSV format.
-d, --debug
Enable detailed debug output for troubleshooting.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-n, --no-prompt
Skip all user confirmation prompts.
Edit camera's settings.
-b, --bridge-esns [bridge-esns]
Edit camera settings by bridge ESNs.--esns [esn1, esn2]
Edit camera settings by camera ESNs.-f, --file-name [file name]
Edit camera settings by reading the CSV file.-T, --tags [tag1, tag2]
Edit camera settings by tag.-s, --site-id [id1, id2]
Edit camera settings by site id.-S, --site-name [name1, name2]
Edit camera settings by site name.--layout-name [name1, name2]
Edit camera settings by layout name.--layout-id [id1, id2]
Edit camera settings by layout id.
-a, --aspect-ratio [aspect ratio]
Preview aspect ratio.--audio-enable
Enable audio.--audio-disable
Disable audio.-B, --bridge-target-days [bridge target days]
Bridge target days.-c, --cloud-retention-days [cloud retention days]
Cloud retention days.-d, --debug
Enable detailed debug output for troubleshooting.-l, --local-retention-days [local retention days]
Local retention days.-n, --no-prompt
Skip all user confirmation prompts.-p, --password [password]
Password.--preview-resolution [preview resolution]
Preview resolution.--preview-transmit-mode [preview transmit mode]
Preview transmit mode.--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.-t, --add-tag [add tag]
Tags.-u, --username [username]
Username.--video-capture-mode [video capture mode]
When to record video.--video-transmit-mode [video transmit mode]
Video transmit mode.--video-quality [video quality]
Video quality.--video-resolution [video resolution]
Video resolution.
- For
--esns "*"
, it changes settings for all cameras.
Delete a camera from the bridge.
<esn>
ESN of the camera (required)
-d, --debug
Enable detailed debug output for troubleshooting.-n, --no-prompt
Skip all user confirmation prompts.
Add camera to bridge.
<esn>
ESN of the bridge to which the camera is added.
-C, --camera-name [camera name]
Name of the camera.--guid [guid]
GUID of the camera.
-c, --cloud-retention-days [cloud retention days]
Cloud retention days.-d, --debug
Enable detailed debug output for troubleshooting.-n, --no-prompt
Skip all user confirmation prompts.-p, --password [password]
Camera password.-s, --site [site]
Site ID.-S, --scene [scene]
Scene.-t, --tags [tags]
Tags.-u, --username [username]
Camera username.
Get camera stream status.
-e, --end-time [end time]
Camera stream end time.-s, --start-time [start time]
Camera stream start time.
--esns [esn1, esn2]
ESNs of the cameras.-d, --debug
Enable detailed debug output for troubleshooting.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-n, --no-prompt
Skip all user confirmation prompts.-S, --stream-type [stream type]
Stream type of the camera.
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
andend-time
time format should beYYYYMMDDHHMMSS.sss
(Compact ISO 8601 date time with millisecond precision).
Get camera purging and duty cycle.
-d, --debug
Enable detailed debug output for troubleshooting.-e, --end-time [end time]
Purge end time.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-n, --no-prompt
Skip all user confirmation prompts.-s, --start-time [start time]
Purge start time.
- If you haven't specified any start-time and end-time, it will take the last 24 hours as default timestamps.
start-time
andend-time
time format should beYYYYMMDDHHMMSS.sss
(Compact ISO 8601 date time with millisecond precision).
Get camera availability.
--esns [esn1, esn2]
ESNs of the camera.--start-time [start time]
Video start time.
-d, --debug
Enable detailed debug output for troubleshooting.-e, --end-time [end time]
Video end time.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-g, --google-sheet
List camera availability in CSV format in Google Sheets.-n, --no-prompt
Skip all user confirmation prompts.-N, --no-check
Show all available data, including unchecked items.-p, --preview-availability
Get preview recording status along with camera availability.-s, --start-time [start time]
Video start time.
- This command only supports a maximum of 200 devices and a seven-day time range.
start-time
andend-time
time format should beYYYY-MM-DDTHH:MM:SS.sss±HH:MM
(ISO 8601 extended date-time).
bridge
- manage and interact with bridges and associated cameras.
een bridge [COMMAND] [OPTIONS]
The bridge
command allows you to manage bridges, list their status, check availability, pull logs, and update camera settings.
List all bridges.
-a, --available
List discovered cameras that are not yet attached.--csv
List all bridges in CSV format.-d, --debug
Enable detailed debug output for troubleshooting.--esn
List bridge ESNs.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-g, --google-sheet
List bridges in CSV format in Google Sheets.--html
Generate a chart in HTML file.-l, --long
Display bridge details, including bridge ID, name, and location. For v3, also includes cameras in the account and online cameras; for v1, includes GUID.-n, --no-prompt
Skip all user confirmation prompts.-s, --site
List the site of the bridge.--sites [site1, site2]
List bridges in a specific site.-S, --status [status]
List bridges with a specific status.-t, --tags [tag1, tag2]
Filter bridges by tags.-T, --tree
View bridges and associated cameras in tree format.--v1
Use v1 APIs.
- 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.
List bridge status.
-d, --debug
Enable detailed debug output for troubleshooting-g, --google-sheet
List bridges in csv format in a Google Sheet--html
Generate a chart in an HTML file
Get bridge availability.
-e, --end-time [end time]
Specify video end time--esns [esn1, esn2]
ESNs of the bridge
-d, --debug
Enable detailed debug output for troubleshooting-f, --file-name [file name]
Specify the file name to save the output-g, --google-sheet
List bridge availability in csv format in a Google Sheet-n, --no-prompt
Skip all user confirmation prompts-N,. --no-check
Show all available data-s, --start-time [start time]
Specify video start time
Pull logs from the archiver/bridge.
--esns [esn1, esn2]
Esns of the bridge (required).
-c, --count [count]
Specify the number of annotations to return-d, --debug
Enable detailed debug output for troubleshooting-e, --end-time [end time]
Specify the end time-E, --events
View events of the bridge-l, --local-rtsp-metrics [enable/disable]
Enable or disable the RTSP metrics set-n, --no-prompt
Skip all user confirmation prompts-p, --performance
View performance metrics of the bridge-s, --start-time [start time]
Specify the start time-S, --summary
Get summarized data
- start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision)
- 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 and interact with switches.
een switch [COMMAND] [OPTIONS]
The switch
command allows you to manage switches and list switch status.
List switches.
-b, --bridge
List the bridge ESNs associated with the switches-d, --debug
Enable detailed debug output for troubleshooting--id
List the IDs of the switches-l, --long
List switch details, including switch ID, bridge ESN, and status-s, --status
List the status of the switches
- 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
site
- manage and interact with sites.
een site [COMMAND] [OPTIONS]
The site
command allows you to manage sites, including listing all available sites.
List all sites.
-a, --address
List the site addresses.--csv
List all sites in CSV format.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-n, --no-prompt
Skip all user confirmation prompts.-d, --debug
Enable detailed debug output for troubleshooting.-l, --long
List site details, including site name and site ID.-s, --site-id
List the IDs of the sites.-S, --site-name
List the site names.
- List sites with options for CSV format, file output, skipping prompts, and debug output as specified.
- To list all sites in CSV format:
een site list --csv --file-name sites.csv
- To list sites without prompting for confirmation:
een site list --no-prompt --debug
video
- manage and interact with recorded videos.
een video [COMMAND] [OPTIONS]
The video
command allows you to download recorded videos, list available videos, and check the status of preview recordings.
Download video from the camera.
--esn [esn]
ESN of the camera.-e, --end-time [end time]
Video end time.-f, --format [format]
Video format.-s, --start-time [start time]
Video start time.-t, --target-directory [target-directory]
Specify the directory where the video will be saved.
-d, --debug
Enable detailed debug output for troubleshooting.-o, --overwrite
Overwrite the existing video file.-T, --timezone [timezone]
Timezone to use for the video download.
- Video downloads support both mp4 and FLV formats.
- The timezone option is only supported for mp4 format.
- Video downloading is done in batches of 5 videos at a time.
- start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision)
- Downloads the video from the specified camera if all required options are provided.
Get a list of videos from the selected camera.
--esn [esn]
ESN of the camera.-s, --start-time [start time]
Video start time.-e, --end-time [end time]
Video end time.
-d, --debug
Enable detailed debug output for troubleshooting.
- start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision)
- Lists videos available from the specified camera within the given time frame.
Get the status of preview recording.
--esns [esns]
ESNs of the camera.-s, --start-time [start time]
Video start time.
-d, --debug
Enable detailed debug output for troubleshooting.-e, --end-time [end time]
Video end time.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-g, --google-sheet
List camera recording status in CSV format in Google Sheets.-n, --no-prompt
Skip all user confirmation prompts.
- start-time and end-time time format should be YYYY-MM-DDTHH:MM:SS.sss±HH:MM (ISO 8601 extended date-time)
- If ESNs and start time are provided, it checks the preview recording status. If the
--google-sheet
option is provided, the statuses will be listed in Google Sheets.
- To download a video from a camera:
een video download --esn 123456 --start-time "20241001000000.000" --end-time "20241001010000.000" --format mp4 --target-directory /path/to/save
- To list videos from a camera:
een video list --esn 123456 --start-time "20241001000000.000" --end-time "20241001010000.000" --debug
- To check the status of a preview recording:
een video previewrecordingstatus --esns 1005f355 --start-time 2024-11-17T09:20:54.619+00:00 --end-time 2024-11-18T09:20:54.619+00:00 --debug
lpr
- manage and retrieve License Plate Recognition events.
een lpr events [OPTIONS]
The lpr events
command allows you to retrieve LPR events within a specified time frame. It supports filtering by license plate number and camera ESN.
Get LPR events.
-e, --end-time [end time]
Events end time.-s, --start-time [start time]
Events start time.
-d, --debug
Enable detailed debug output for troubleshooting.--esns [esn1, esn2]
The ESN for camera of interest.--lp [license plate]
License plate number.--v1
Use v1 APIs.
- start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision)
- If
--v1
is specified along with both--start-time
and--end-time
, it retrieves LPR events using v1 APIs. - If only the start and end times are specified, it retrieves LPR events using the default API.
- To get LPR events for a specific time frame:
een lpr events --start-time "20241001000000.000" --end-time "20241001010000.000"
- To get LPR events for a specific license plate:
een lpr events --start-time "20241001000000.000" --end-time "20241001010000.000" --lp "ABC123"
vsp
- manage and retrieve Vehicle Surveillance Processing events and alerts.
een vsp [COMMAND] [OPTIONS]
The vsp
command allows you to manage and retrieve VSP events and alerts based on parameters such as time, vehicle characteristics, and alert types.
Get VSP events.
-a, --access-type [access type]
Access type.-b, --body-types [types]
Vehicle body types.-c, --colors [colors]
Vehicle colors.-d, --debug
Enable detailed debug output for troubleshooting.-D, --directions [directions]
Direction of the vehicle.-e, --end-time [end time]
LPR end time.--esns [esns]
Camera ESNs.-f, --file-name [file name]
Specify the name of the file where the output will be saved.--html
Generate chart in HTML file.--lp [lp]
License plate number.-m, --makes [makes]
Vehicle makes.-n, --no-prompt
Skip all user confirmation prompts.-s, --sites [sites]
Site names.-S, --start-time [start time]
LPR start time.
- If you haven't specified any start-time and end-time it will take 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).
- If
--html
is specified, it generates a report of VSP events. - If not, it retrieves VSP events and saves them according to the specified options.
Get VSP alerts.
-a, --allowed-vehicle
Alert type - allowed vehicle.-c, --count-of-license-plate
Alert type - count of license plate.-d, --debug
Enable detailed debug output for troubleshooting.-D, --denied-vehicle
Alert type - denied vehicle.-e, --end-time [end time]
LPR end time.--esns [esns]
Camera ESN.-f, --file-name [file name]
Specify the name of the file where the output will be saved.--html
Generate chart in HTML file.-H, --hotlist
Alert type - hotlist.-n, --no-prompt
Skip all user confirmation prompts.-s, --sites [sites]
Name of the site.-S, --start-time [start time]
LPR start time.-u, --unregistered-vehicle
Alert type - unregistered vehicle.-w, --watch-vehicle
Alert type - watch vehicle.
- If you haven't specified any start-time and end-time it will take last 24 hours as default timestamps.
- start-time and end-time time format should be YYYY-MM-DDTHH:MM:SS.sss±HH:MM (ISO 8601 extended date-time).
- If
--html
is specified, it generates a report of VSP alerts. - If not, it retrieves VSP alerts and saves them according to the specified options.
- To get VSP events for a specific time frame:
een vsp listevents --start-time "20241001000000.000" --end-time "20241001235959.000"
- To get VSP alerts for allowed vehicles:
een vsp listalerts --start-time 2024-11-17T09:20:54.619+00:00 --end-time 2024-11-18T09:20:54.619+00:00 --allowed-vehicle
pos
- manage and retrieve Point of Sale events.
een pos listevents [OPTIONS]
The pos
command allows you to manage and retrieve POS events based on parameters such as time, transaction details, and site.
Get POS events.
-b, --bill-number [bill number]
Specify the bill number.-d, --debug
Enable detailed debug output for troubleshooting.--discount-min [discount min]
Specify the minimum discount in percentage.--discount-max [discount max]
Specify the maximum discount in percentage.-e, --end-time [end time]
Defines the end point for retrieving events. The timestamp must be in ISO 8601 format with millisecond precision (e.g., YYYY-MM-DDTHH:MM:SS.sss±HH:MM).-E, --employee-id [employee ID]
Specify the ID of the employee.-f, --file-name [file name]
Specify the name of the file where the output will be saved.-F, --flagged
Retrieve flagged transactions.--html
Generate chart in HTML file.-n, --no-prompt
Skip all user confirmation prompts.--net-amount-min [net amount min]
Specify the minimum net amount.--net-amount-max [net amount max]
Specify the maximum net amount.-s, --sites [sites]
Specify the name of the site.-S, --start-time [start time]
Defines the starting point for retrieving events. The timestamp must be in ISO 8601 format with millisecond precision (e.g., YYYY-MM-DDTHH:MM:SS.sss±HH:MM).-t, --transaction-type [transaction type]
Specify the type of the transaction.
- If no start time or end time is specified, the retrieval period defaults to the last 24 hours.
- Start-time and end-time time format should be YYYY-MM-DDTHH:MM:SS.sss±HH:MM (ISO 8601 extended date-time).
- If
--html
is specified, it generates a report of POS events. - If not, it retrieves POS events and saves them according to the specified options.
- To get POS events for a specific time frame:
een pos listevents --start-time 2024-11-17T09:20:54.619+00:00 --end-time 2024-11-18T09:20:54.619+00:00
- To get flagged POS transactions:
een pos listevents --flagged
googleconfig
- update configuration options for Google settings.
een googleconfig update <option name> <value>
The googleconfig
command allows you to update specific configuration options related to Google settings.
Update Google config option values.
-
<option name>
The name of the configuration option that needs to be updated. -
<value>
The new value for the specified option. This value is parsed as a JSON string.
The action processes the provided option name and value, parsing the value as JSON and updating the Google configuration file accordingly.
To update a Google configuration option:
een googleconfig update "api_key" "your_api_key_value"
The credentials required depends on the type of data, platform, and access methodology of your app.
- Open the Google Cloud console.
- At the top-left, click Menu menu > IAM & Admin > Service Accounts.
- Click Create service account.
- Fill in the service account details, then click Create and continue.
- Optional: Assign roles to your service account to grant access to your Google Cloud project's resources.
- Click Continue.
- Optional: Enter users or groups that can manage and perform actions with this service account.
- Click Done.
Use this credential to authenticate as a robot service account or to access resources on behalf of Google Workspace or Cloud Identity users through domain-wide delegation.
You need to obtain credentials in the form of a public/private key pair. These credentials are used by your code to authorize service account actions within your app.
- Open the Google Cloud console.
- At the top-left, click Menu menu > IAM & Admin > Service Accounts.
- Select your service account.
- Click Keys > Add keys > Create new key.
- Select JSON, then click Create. Your new public/private key pair is generated and downloaded to your machine as a new file. This file is the only copy of this key.
- Click Close.
A folder ID can be extracted from its URL. For example, the folder ID in the URL https://drive.google.com/drive/folders/ABCDE12345 is ABCDE12345
.
Grant permission to your client email in your Google Drive folder. Client email is the email that you get while initializing the project in the Google Cloud console.
- Open APIS and Services page
- Navigate to API Library
- Search for Google Drive API
-
Enable Google Drive API by clicking on the
ENABLE
button -
Search for Google Sheets API
- Enable Google Sheets API by clicking on the
ENABLE
button
While executing Google Sheets commands, if you encounter any error messages like:
errors: [
{
message: 'Google Sheets API has not been used in project 886039128663 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/sheets.googleapis.com/overview?project=886039128663 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.',
domain: 'usageLimits',
reason: 'accessNotConfigured',
extendedHelp: 'https://console.developers.google.com'
}
]
This error indicates that you are not enabled
Google Sheets API for your service account.
errors: [
{
message: 'Google Drive API has not been used in project 886039128663 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/drive.googleapis.com/overview?project=886039128663 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.',
domain: 'usageLimits',
reason: 'accessNotConfigured',
extendedHelp: 'https://console.developers.google.com'
}
]
This error indicates that you are not enabled
Google Drive API for your service account.
To fix the same, please follow the steps above for enabling GoogleSheet API and Google Drive API
The .een/static_config.json file that gets created while logging in using the CLI has the following values:
- "serviceAccountPrivateKey": "your private key"
- "serviceAccountClientEmail": "your client email"
- "driveFolderID": "google drive folder id"
The serviceAccountPrivateKey and serviceAccountClientEmail can be found in your downloaded file, you get while doing the step 5 in obtaining the credentials for your service account.
Replace these values with your credentials, you will be able to get the Google Sheets commands working.
een googleconfig update <name> -- <value>
Example:
een googleconfig update "driveFolderID" -- "1giou_ghlihbZyUpwCx"
- cloud-retention-days - [Cloud retention]
- video-resolution - [Video resolution]
- bridge-target-days - [Local retention - Min]
- local-retention-days - [Local retention - Max]
- preview-resolution - [Preview resolution]
- preview-transmit-mode - [Preview transmit mode]
- video-transmit-mode - [Video transmit mode]
- video-quality - [Full Video quality]
- tags - [Tags]
- username - [Camera username]
- password - [Camera password]
- aspect-ratio- [Preview aspect ratio]
- video-capture-mode - [Preview Record when]
- preview-interval-ms - [Preview update rate]
- preview-quality - [Preview quality]
- preview-only-cloud-retention - [Cloud Preview Only (PR1)]
- audio-enable - [Enable audio if available]
- audio-disable - [Disable audio if available]
Note:
- Except for
cameraID
andcameraName
all other fields in the camera settings file are editable.
- local-rtsp-metrics - [Bridge rtsp metrics]
- "Camera online"
- "Stream attached"
- "Camera on"
- "Camera recording"
- "Camera sending previews"
- "Camera located"
- "Camera not supported"
- "Camera configuration in process"
- "Camera needs ONVIF password"
- "Camera available but not yet attached"
- "Internal status"
- "Camera error"
- "Reserved"
- "Invalid state"
- "Camera streaming"
- "Camera registered"
- "Africa/Abidjan"
- "Africa/Accra"
- "Africa/Addis_Ababa"
- "Africa/Algiers"
- "Africa/Asmara"
- "Africa/Asmera"
- "Africa/Bamako"
- "Africa/Bangui"
- "Africa/Banjul"
- "Africa/Bissau"
- "Africa/Blantyre"
- "Africa/Brazzaville"
- "Africa/Bujumbura"
- "Africa/Cairo"
- "Africa/Casablanca"
- "Africa/Ceuta"
- "Africa/Conakry"
- "Africa/Dakar"
- "Africa/Dar_es_Salaam"
- "Africa/Djibouti"
- "Africa/Douala"
- "Africa/El_Aaiun"
- "Africa/Freetown"
- "Africa/Gaborone"
- "Africa/Harare"
- "Africa/Johannesburg"
- "Africa/Juba"
- "Africa/Kampala"
- "Africa/Khartoum"
- "Africa/Kigali"
- "Africa/Kinshasa"
- "Africa/Lagos"
- "Africa/Libreville"
- "Africa/Lome"
- "Africa/Luanda"
- "Africa/Lubumbashi"
- "Africa/Lusaka"
- "Africa/Malabo"
- "Africa/Maputo"
- "Africa/Maseru"
- "Africa/Mbabane"
- "Africa/Mogadishu"
- "Africa/Monrovia"
- "Africa/Nairobi"
- "Africa/Ndjamena"
- "Africa/Niamey"
- "Africa/Nouakchott"
- "Africa/Ouagadougou"
- "Africa/Porto-Novo"
- "Africa/Sao_Tome"
- "Africa/Timbuktu"
- "Africa/Tripoli"
- "Africa/Tunis"
- "Africa/Windhoek"
- "America/Adak"
- "America/Anchorage"
- "America/Anguilla"
- "America/Antigua"
- "America/Araguaina"
- "America/Argentina/Buenos_Aires"
- "America/Argentina/Catamarca"
- "America/Argentina/ComodRivadavia"
- "America/Argentina/Cordoba"
- "America/Argentina/Jujuy"
- "America/Argentina/La_Rioja"
- "America/Argentina/Mendoza"
- "America/Argentina/Rio_Gallegos"
- "America/Argentina/Salta"
- "America/Argentina/San_Juan"
- "America/Argentina/San_Luis"
- "America/Argentina/Tucuman"
- "America/Argentina/Ushuaia"
- "America/Aruba"
- "America/Asuncion"
- "America/Atikokan"
- "America/Atka"
- "America/Bahia"
- "America/Bahia_Banderas"
- "America/Barbados"
- "America/Belem"
- "America/Belize"
- "America/Blanc-Sablon"
- "America/Boa_Vista"
- "America/Bogota"
- "America/Boise"
- "America/Buenos_Aires"
- "America/Cambridge_Bay"
- "America/Campo_Grande"
- "America/Cancun"
- "America/Caracas"
- "America/Catamarca"
- "America/Cayenne"
- "America/Cayman"
- "America/Chicago"
- "America/Chihuahua"
- "America/Coral_Harbour"
- "America/Cordoba"
- "America/Costa_Rica"
- "America/Creston"
- "America/Cuiaba"
- "America/Curacao"
- "America/Danmarkshavn"
- "America/Dawson"
- "America/Dawson_Creek"
- "America/Denver"
- "America/Detroit"
- "America/Dominica"
- "America/Edmonton"
- "America/Eirunepe"
- "America/El_Salvador"
- "America/Ensenada"
- "America/Fort_Nelson"
- "America/Fort_Wayne"
- "America/Fortaleza"
- "America/Glace_Bay"
- "America/Godthab"
- "America/Goose_Bay"
- "America/Grand_Turk"
- "America/Grenada"
- "America/Guadeloupe"
- "America/Guatemala"
- "America/Guayaquil"
- "America/Guyana"
- "America/Halifax"
- "America/Havana"
- "America/Hermosillo"
- "America/Indiana/Indianapolis"
- "America/Indiana/Knox"
- "America/Indiana/Marengo"
- "America/Indiana/Petersburg"
- "America/Indiana/Tell_City"
- "America/Indiana/Vevay"
- "America/Indiana/Vincennes"
- "America/Indiana/Winamac"
- "America/Indianapolis"
- "America/Inuvik"
- "America/Iqaluit"
- "America/Jamaica"
- "America/Jujuy"
- "America/Juneau"
- "America/Kentucky/Louisville"
- "America/Kentucky/Monticello"
- "America/Knox_IN"
- "America/Kralendijk"
- "America/La_Paz"
- "America/Lima"
- "America/Los_Angeles"
- "America/Louisville"
- "America/Lower_Princes"
- "America/Maceio"
- "America/Managua"
- "America/Manaus"
- "America/Marigot"
- "America/Martinique"
- "America/Matamoros"
- "America/Mazatlan"
- "America/Mendoza"
- "America/Menominee"
- "America/Merida"
- "America/Metlakatla"
- "America/Mexico_City"
- "America/Miquelon"
- "America/Moncton"
- "America/Monterrey"
- "America/Montevideo"
- "America/Montreal"
- "America/Montserrat"
- "America/Nassau"
- "America/New_York"
- "America/Nipigon"
- "America/Nome"
- "America/Noronha"
- "America/North_Dakota/Beulah"
- "America/North_Dakota/Center"
- "America/North_Dakota/New_Salem"
- "America/Ojinaga"
- "America/Panama"
- "America/Pangnirtung"
- "America/Paramaribo"
- "America/Phoenix"
- "America/Port-au-Prince"
- "America/Port_of_Spain"
- "America/Porto_Acre"
- "America/Porto_Velho"
- "America/Puerto_Rico"
- "America/Punta_Arenas"
- "America/Rainy_River"
- "America/Rankin_Inlet"
- "America/Recife"
- "America/Regina"
- "America/Resolute"
- "America/Rio_Branco"
- "America/Rosario"
- "America/Santa_Isabel"
- "America/Santarem"
- "America/Santiago"
- "America/Santo_Domingo"
- "America/Sao_Paulo"
- "America/Scoresbysund"
- "America/Shiprock"
- "America/Sitka"
- "America/St_Barthelemy"
- "America/St_Johns"
- "America/St_Kitts"
- "America/St_Lucia"
- "America/St_Thomas"
- "America/St_Vincent"
- "America/Swift_Current"
- "America/Tegucigalpa"
- "America/Thule"
- "America/Thunder_Bay"
- "America/Tijuana"
- "America/Toronto"
- "America/Tortola"
- "America/Vancouver"
- "America/Virgin"
- "America/Whitehorse"
- "America/Winnipeg"
- "America/Yakutat"
- "America/Yellowknife"
- "Antarctica/Casey"
- "Antarctica/Davis"
- "Antarctica/DumontDUrville"
- "Antarctica/Macquarie"
- "Antarctica/Mawson"
- "Antarctica/McMurdo"
- "Antarctica/Palmer"
- "Antarctica/Rothera"
- "Antarctica/South_Pole"
- "Antarctica/Syowa"
- "Antarctica/Troll"
- "Antarctica/Vostok"
- "Arctic/Longyearbyen"
- "Asia/Aden"
- "Asia/Almaty"
- "Asia/Amman"
- "Asia/Anadyr"
- "Asia/Aqtau"
- "Asia/Aqtobe"
- "Asia/Ashgabat"
- "Asia/Ashkhabad"
- "Asia/Atyrau"
- "Asia/Baghdad"
- "Asia/Bahrain"
- "Asia/Baku"
- "Asia/Bangkok"
- "Asia/Barnaul"
- "Asia/Beirut"
- "Asia/Bishkek"
- "Asia/Brunei"
- "Asia/Calcutta"
- "Asia/Chita"
- "Asia/Choibalsan"
- "Asia/Chongqing"
- "Asia/Chungking"
- "Asia/Colombo"
- "Asia/Dacca"
- "Asia/Damascus"
- "Asia/Dhaka"
- "Asia/Dili"
- "Asia/Dubai"
- "Asia/Dushanbe"
- "Asia/Famagusta"
- "Asia/Gaza"
- "Asia/Harbin"
- "Asia/Hebron"
- "Asia/Ho_Chi_Minh"
- "Asia/Hong_Kong"
- "Asia/Hovd"
- "Asia/Irkutsk"
- "Asia/Istanbul"
- "Asia/Jakarta"
- "Asia/Jayapura"
- "Asia/Jerusalem"
- "Asia/Kabul"
- "Asia/Kamchatka"
- "Asia/Karachi"
- "Asia/Kashgar"
- "Asia/Kathmandu"
- "Asia/Katmandu"
- "Asia/Khandyga"
- "Asia/Kolkata"
- "Asia/Krasnoyarsk"
- "Asia/Kuala_Lumpur"
- "Asia/Kuching"
- "Asia/Kuwait"
- "Asia/Macao"
- "Asia/Macau"
- "Asia/Magadan"
- "Asia/Makassar"
- "Asia/Manila"
- "Asia/Muscat"
- "Asia/Nicosia"
- "Asia/Novokuznetsk"
- "Asia/Novosibirsk"
- "Asia/Omsk"
- "Asia/Oral"
- "Asia/Phnom_Penh"
- "Asia/Pontianak"
- "Asia/Pyongyang"
- "Asia/Qatar"
- "Asia/Qostanay"
- "Asia/Qyzylorda"
- "Asia/Rangoon"
- "Asia/Riyadh"
- "Asia/Saigon"
- "Asia/Sakhalin"
- "Asia/Samarkand"
- "Asia/Seoul"
- "Asia/Shanghai"
- "Asia/Singapore"
- "Asia/Srednekolymsk"
- "Asia/Taipei"
- "Asia/Tashkent"
- "Asia/Tbilisi"
- "Asia/Tehran"
- "Asia/Tel_Aviv"
- "Asia/Thimbu"
- "Asia/Thimphu"
- "Asia/Tokyo"
- "Asia/Tomsk"
- "Asia/Ujung_Pandang"
- "Asia/Ulaanbaatar"
- "Asia/Ulan_Bator"
- "Asia/Urumqi"
- "Asia/Ust-Nera"
- "Asia/Vientiane"
- "Asia/Vladivostok"
- "Asia/Yakutsk"
- "Asia/Yangon"
- "Asia/Yekaterinburg"
- "Asia/Yerevan"
- "Atlantic/Azores"
- "Atlantic/Bermuda"
- "Atlantic/Canary"
- "Atlantic/Cape_Verde"
- "Atlantic/Faeroe"
- "Atlantic/Faroe"
- "Atlantic/Jan_Mayen"
- "Atlantic/Madeira"
- "Atlantic/Reykjavik"
- "Atlantic/South_Georgia"
- "Atlantic/St_Helena"
- "Atlantic/Stanley"
- "Australia/ACT"
- "Australia/Adelaide"
- "Australia/Brisbane"
- "Australia/Broken_Hill"
- "Australia/Canberra"
- "Australia/Currie"
- "Australia/Darwin"
- "Australia/Eucla"
- "Australia/Hobart"
- "Australia/LHI"
- "Australia/Lindeman"
- "Australia/Lord_Howe"
- "Australia/Melbourne"
- "Australia/NSW"
- "Australia/North"
- "Australia/Perth"
- "Australia/Queensland"
- "Australia/South"
- "Australia/Sydney"
- "Australia/Tasmania"
- "Australia/Victoria"
- "Australia/West"
- "Australia/Yancowinna"
- "Brazil/Acre"
- "Brazil/DeNoronha"
- "Brazil/East"
- "Brazil/West"
- "CET"
- "CST6CDT"
- "Canada/Atlantic"
- "Canada/Central"
- "Canada/Eastern"
- "Canada/Mountain"
- "Canada/Newfoundland"
- "Canada/Pacific"
- "Canada/Saskatchewan"
- "Canada/Yukon"
- "Chile/Continental"
- "Chile/EasterIsland"
- "Cuba"
- "EET"
- "EST"
- "EST5EDT"
- "Egypt"
- "Eire"
- "Etc/GMT"
- "Etc/GMT+0"
- "Etc/GMT+1"
- "Etc/GMT+10"
- "Etc/GMT+11"
- "Etc/GMT+12"
- "Etc/GMT+2"
- "Etc/GMT+3"
- "Etc/GMT+4"
- "Etc/GMT+5"
- "Etc/GMT+6"
- "Etc/GMT+7"
- "Etc/GMT+8"
- "Etc/GMT+9"
- "Etc/GMT-0"
- "Etc/GMT-1"
- "Etc/GMT-10"
- "Etc/GMT-11"
- "Etc/GMT-12"
- "Etc/GMT-13"
- "Etc/GMT-14"
- "Etc/GMT-2"
- "Etc/GMT-3"
- "Etc/GMT-4"
- "Etc/GMT-5"
- "Etc/GMT-6"
- "Etc/GMT-7"
- "Etc/GMT-8"
- "Etc/GMT-9"
- "Etc/GMT0"
- "Etc/Greenwich"
- "Etc/UCT"
- "Etc/UTC"
- "Etc/Universal"
- "Etc/Zulu"
- "Europe/Amsterdam"
- "Europe/Andorra"
- "Europe/Astrakhan"
- "Europe/Athens"
- "Europe/Belfast"
- "Europe/Belgrade"
- "Europe/Berlin"
- "Europe/Bratislava"
- "Europe/Brussels"
- "Europe/Bucharest"
- "Europe/Budapest"
- "Europe/Busingen"
- "Europe/Chisinau"
- "Europe/Copenhagen"
- "Europe/Dublin"
- "Europe/Gibraltar"
- "Europe/Guernsey"
- "Europe/Helsinki"
- "Europe/Isle_of_Man"
- "Europe/Istanbul"
- "Europe/Jersey"
- "Europe/Kaliningrad"
- "Europe/Kiev"
- "Europe/Kirov"
- "Europe/Lisbon"
- "Europe/Ljubljana"
- "Europe/London"
- "Europe/Luxembourg"
- "Europe/Madrid"
- "Europe/Malta"
- "Europe/Mariehamn"
- "Europe/Minsk"
- "Europe/Monaco"
- "Europe/Moscow"
- "Europe/Nicosia"
- "Europe/Oslo"
- "Europe/Paris"
- "Europe/Podgorica"
- "Europe/Prague"
- "Europe/Riga"
- "Europe/Rome"
- "Europe/Samara"
- "Europe/San_Marino"
- "Europe/Sarajevo"
- "Europe/Saratov"
- "Europe/Simferopol"
- "Europe/Skopje"
- "Europe/Sofia"
- "Europe/Stockholm"
- "Europe/Tallinn"
- "Europe/Tirane"
- "Europe/Tiraspol"
- "Europe/Ulyanovsk"
- "Europe/Uzhgorod"
- "Europe/Vaduz"
- "Europe/Vatican"
- "Europe/Vienna"
- "Europe/Vilnius"
- "Europe/Volgograd"
- "Europe/Warsaw"
- "Europe/Zagreb"
- "Europe/Zaporozhye"
- "Europe/Zurich"
- "Factory"
- "GB"
- "GB-Eire"
- "GMT"
- "GMT+0"
- "GMT-0"
- "GMT0"
- "Greenwich"
- "HST"
- "Hongkong"
- "Iceland"
- "Indian/Antananarivo"
- "Indian/Chagos"
- "Indian/Christmas"
- "Indian/Cocos"
- "Indian/Comoro"
- "Indian/Kerguelen"
- "Indian/Mahe"
- "Indian/Maldives"
- "Indian/Mauritius"
- "Indian/Mayotte"
- "Indian/Reunion"
- "Iran"
- "Israel"
- "Jamaica"
- "Japan"
- "Kwajalein"
- "Libya"
- "MET"
- "MST"
- "MST7MDT"
- "Mexico/BajaNorte"
- "Mexico/BajaSur"
- "Mexico/General"
- "NZ"
- "NZ-CHAT"
- "Navajo"
- "PRC"
- "PST8PDT"
- "Pacific/Apia"
- "Pacific/Auckland"
- "Pacific/Bougainville"
- "Pacific/Chatham"
- "Pacific/Chuuk"
- "Pacific/Easter"
- "Pacific/Efate"
- "Pacific/Enderbury"
- "Pacific/Fakaofo"
- "Pacific/Fiji"
- "Pacific/Funafuti"
- "Pacific/Galapagos"
- "Pacific/Gambier"
- "Pacific/Guadalcanal"
- "Pacific/Guam"
- "Pacific/Honolulu"
- "Pacific/Johnston"
- "Pacific/Kiritimati"
- "Pacific/Kosrae"
- "Pacific/Kwajalein"
- "Pacific/Majuro"
- "Pacific/Marquesas"
- "Pacific/Midway"
- "Pacific/Nauru"
- "Pacific/Niue"
- "Pacific/Norfolk"
- "Pacific/Noumea"
- "Pacific/Pago_Pago"
- "Pacific/Palau"
- "Pacific/Pitcairn"
- "Pacific/Pohnpei"
- "Pacific/Ponape"
- "Pacific/Port_Moresby"
- "Pacific/Rarotonga"
- "Pacific/Saipan"
- "Pacific/Samoa"
- "Pacific/Tahiti"
- "Pacific/Tarawa"
- "Pacific/Tongatapu"
- "Pacific/Truk"
- "Pacific/Wake"
- "Pacific/Wallis"
- "Pacific/Yap"
- "Poland"
- "Portugal"
- "ROC"
- "ROK"
- "Singapore"
- "Turkey"
- "UCT"
- "US/Alaska"
- "US/Aleutian"
- "US/Arizona"
- "US/Central"
- "US/East-Indiana"
- "US/Eastern"
- "US/Hawaii"
- "US/Indiana-Starke"
- "US/Michigan"
- "US/Mountain"
- "US/Pacific"
- "US/Pacific-New"
- "US/Samoa"
- "UTC"
- "Universal"
- "W-SU"
- "WET"
- "Zulu"
-
API_KEY
- *Deprecated-
Creation: To get an
API_KEY
you will need an account. You can either use your existing account or create a Developer Account.- Existing account: You can create the key under your Account Settings.
- Developer account: You will have to verify your email address first to create your Developer Account. Expect to get an email with a shortcut to create the
API_KEY
. Click on the shortcut link to create yourAPI_KEY
and get started writing some code.
-