EE-downloader-v3/README.md

52 lines
1.7 KiB
Markdown

# EE-downloader-v3 #
## Summary ##
This is a python webapp for downloading recorder videos from your cameras.
## Settings File ##
There is file `settings.py` that is needed to run. It should look similar to this:
```
config = {
# Set up your application and get client id/secrete first
# https://developerv3.eagleeyenetworks.com/page/my-application
"client_id": "",
"client_secret": "",
# you will need to add approved redirect_uris in your application
# this examples assumes you've added http://127.0.0.1:3333/login_callback
# change the following variables if you did something different
# Note: do not use localhost for server_host, use 127.0.0.1 instead
"server_protocol": "http",
"server_host": "127.0.0.1",
"server_port": "3333",
"server_path": "login_callback",
# how many days of history should be requested be default, more == slower API call
"days_of_history": 1,
"log_level": "INFO",
# determines directory where videos should be stored, see formating option below, don't include trailing slash
"video_dir": "videos",
# Folder structure that will be created, default is to save as:
# {video_dir}/{camera_device_id}/{start.year}/{start.month}/{start.day}/
# Setting this to False to save it as:
# {video_dir}/{start.year}/{start.month}/{start.day}/{camera_device_id}/
"path_esn_first": True,
# default is set at 4, but we feel the need for speed
"num_of_threads_in_pool": 4
}
```
You can create your application and setup credentials at: [https://developerv3.eagleeyenetworks.com/page/my-application-html](my applications). You can also reach out to api_support@een.com for help.
## Ideas on how to use ##
I encluded an example Flask server in `app.py`. You can run it locally with `python flask run -p 3333 --debug`