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.1.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

uvcclient-0.12.1-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uvcclient-0.12.1.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for uvcclient-0.12.1.tar.gz
Algorithm Hash digest
SHA256 c2dc82fd610b353c81d9f9d0ce55ea864c794fdce5b00d323763123671ed4077
MD5 63b5f93a909935670c2ab2a650395507
BLAKE2b-256 97669108fe3adb42e5575322cbe8c4083d269d843142781fc3e6a547f2997aae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uvcclient-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 23.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for uvcclient-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2cf99f38acee05227a33b94064279866d12a5d4e8763c58c87076f89198c185f
MD5 2777de99d5ece5a4ffaa9722dfb5bb0e
BLAKE2b-256 e1bf07df37559e7824b40a8d8649c6c74692dbc8b5df05b8807149e553729512

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