Skip to main content

A remote control client for Ubiquiti's UVC NVR

Project description

https://travis-ci.org/kk7ds/uvcclient.svg?branch=master

This is extremely raw at the moment. Use at your own risk.

Hopefully this is enough to get you going:

Usage: uvc [options]

Options:
  -h, --help            show this help message and exit
  -H HOST, --host=HOST  UVC Hostname
  -P PORT, --port=PORT  UVC Port
  -K APIKEY, --apikey=APIKEY
                        UVC API Key
  -v, --verbose
  -d, --dump
  -u UUID, --uuid=UUID  Camera UUID
  --name=NAME           Camera name
  -l, --list
  --recordmode=RECORDMODE
                        Recording mode (none,full,motion)
  --recordchannel=RECORDCHANNEL
                        Recording channel (high,medium,low)
  -p, --get-picture-settings
                        Return picture settings as a string
  --set-picture-settings=SET_PICTURE_SETTINGS
                        Set picture settings with a string like that returned
                        from --get-picture-settings
  --set-led=ENABLED     Enable/Disable front LED (on,off)
  --get-snapshot        Get a snapshot image and write to stdout
  --prune-zones         Prune all but the first motion zone
  --list-zones          List motion zones
  --set-password        Store camera password

For example:

$ export UVC="http://192.168.1.1:7080/?apiKey=XXXXXXXX"
$ uvc --name Porch --recordmode motion --recordchannel high

or:

$ export UVC="http://192.168.1.1:7080/?apiKey=XXXXXXXX"
$ uvc -l
fb9e6d48-6f5a-42b2-8cb4-e3705a99a0e2: Inside                   [    online]
f0579c60-e400-477e-8f89-f8861ef58f80: Parking                  [    online]
998b134e-13ea-4465-ad39-6ad27b067ac4: Spare                    [   offline]
5474242a-51d5-428e-97de-826675068e70: Front Porch              [    online]
715f0725-e7e1-4214-a551-41071c82bacd: Garage                   [    online]

In order to take actions on cameras directly (such as change the LED state on a UVC Micro or get a snapshot from the camera) you need to set the admin password for it. The NVR tells us the username, but we must store the password. To do this:

$ uvc --name Porch --set-password
This will store the administrator password for a camera
for later use. It will be stored on disk obscured, but
NOT ENCRYPTED! If this is not okay, cancel now.

Password:
Confirm:
Password set

Then you can do things like get a snapshot from the camera directly:

$ uvc --name Porch --get-snapshot > foo.jpg

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uvcclient-0.12.2.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

uvcclient-0.12.2-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

Details for the file uvcclient-0.12.2.tar.gz.

File metadata

  • Download URL: uvcclient-0.12.2.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for uvcclient-0.12.2.tar.gz
Algorithm Hash digest
SHA256 a399eb672e7cc03306ac7c720acdb6e1ac111a399341c0c762737c230d305c51
MD5 9a8dc38e187bcc934ca28e6b0a356b88
BLAKE2b-256 2b5fb56c0fbe1540f8c599bf6877e1bb3667c92dd7902205ba1e3218ed0a51ab

See more details on using hashes here.

File details

Details for the file uvcclient-0.12.2-py3-none-any.whl.

File metadata

  • Download URL: uvcclient-0.12.2-py3-none-any.whl
  • Upload date:
  • Size: 23.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for uvcclient-0.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 82a84f8d99349a466286ba15edf6c0769269004ea6142e9a366f678a79f6be5a
MD5 a1df70e9d2205313cbb29dfb051b84cc
BLAKE2b-256 eca37a9143761dc417f8004c229dd620e3b1353c38ebd7836cd7bde6b6cb8f5b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page