Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AndMu committed Jan 15, 2018
1 parent 7fd6200 commit 3147a27
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 13 deletions.
41 changes: 34 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,47 @@
# Yi Camera FTP Scanner and Video Clips Downloader
# Yi Camera FTP Scanner and Video Clips/Images Downloader

Application supports two modes - arguments explictly specified in command promt and configuration based.
It can also run as Windows service
The application supports two modes - arguments explicitly specified in command prompt and configuration based.
It can also run as Windows service.

## Configuration via service.json
In this mode application will monitor designated cameras
In this mode, application will monitor designated cameras

```
"Scan": 30,
"Cameras": "1080i,720p",
"Hosts": "192.168.0.103,192.168.0.129",
"Compress": false,
"Archive": 2,
"Out": "D:/Cloud/Camera/Monitor"
"Images": false,
"All": false,
"Out": "D:/Cloud/Camera/Monitor",
"Action": null,
```

## Settings:
- **Cameras** - list of cameras
- **Hosts** - list of camera ips.
- **Compress** - do you want to compress retrieved video/images
- **Out** - location of downloaded files
- **Scan** - frequency of FTP scan (in seconds)
- **Archive** - delete previously downloaded old files. Number specifies how many days you want to keep history
- **Images** - Do you want to retrieve video as images
- **Action** - Execute action on each retrieved image

## Actions on image

If you want some action to be executed on each retrieved image:
```
"Action":{
"Type": "Execute",
"Cmd": "%1",
"Payload": null
}
```

%1 will be replaced by file name.


## Install as Windows service
```
Wikiled.YiScanner.exe install
Expand All @@ -35,12 +62,12 @@ Wikiled.YiScanner.exe Download -Cameras=1080i -Hosts=192.168.0.202 [-Compress] -
```

Options:
- **Camera** - list of cameras
- **Cameras** - list of cameras
- **Hosts** - list of hosts.
- **Compress** - do you want to compress files
- **Out** - location of downloaded files
- **Scan** - frequency of FTP scan (in seconds)
- **Archive** - delete previously downloaded old files. Number specifies how many days you want to keep history
- **Archive** - delete previously downloaded old files. Number specifies how many days you want to keep history.


# FTP configuration
Expand Down
7 changes: 1 addition & 6 deletions src/YiScanner/service.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,5 @@
"Archive": 2,
"Images": true,
"Out": "D:/Cloud/GoogleUni/Camera/Monitor",
"Action":
{
"Type": "Execute",
"Cmd": "%1",
"Payload": null
}
"Action": null
}

0 comments on commit 3147a27

Please sign in to comment.