Skip to main content

Python wrapper implementation for Amcrest cameras.

Project description

https://badge.fury.io/py/amcrest.svg https://travis-ci.org/tchellomello/python-amcrest.svg?branch=master https://coveralls.io/repos/github/tchellomello/python-amcrest/badge.svg https://img.shields.io/pypi/pyversions/amcrest.svg

A Python 2.7/3.x module for Amcrest Cameras using the SDK HTTP API. Amcrest and Dahua devices share similar firmwares. Dahua Cameras and NVRs also work with this module.

Documentation: http://python-amcrest.readthedocs.io/

Installation

PyPI

$ pip install amcrest --upgrade
$ eval "$(register-python-argcomplete amcrest-cli)"

# To enable amcrest-cli autocomplete in the system:
$ echo 'eval "$(register-python-argcomplete amcrest-cli)"' >  /etc/profile.d/amcrest-cli-autocomplete.sh

RPM

$ git clone git@github.com:tchellomello/python-amcrest.git
$ ./autogen.sh
$ make rpm
$ dnf/yum install amcrest-cli-NVR.rpm pythonX-amcrest-NVR.rpm

Usage

from amcrest import AmcrestCamera
camera = AmcrestCamera('192.168.0.1', 80, 'admin', 'password').camera

#Check software information
camera.software_information
'version=2.420.AC00.15.R\r\nBuildDate=2016-09-08'

#Capture snapshot
camera.snapshot(0, "/home/user/Desktop/snapshot00.jpeg")
<requests.packages.urllib3.response.HTTPResponse object at 0x7f84945083c8>

#Capture audio
camera.audio_stream_capture(httptype="singlepart", channel=1, path_file="/home/user/Desktop/audio.aac")
CTRL-C to stop the continuous audio flow or use a timer

#Move camera down
camera.ptz_control_command(action="start", code="Down", arg1=0, arg2=0, arg3=0)

#Record realtime stream into a file
camera.realtime_stream(path_file="/home/user/Desktop/myvideo")
CTRL-C to stop the continuous video flow or use a timer

Command Line

$ man amcrest-cli
or
$ amcrest-cli --help

# Saving credentials to file.
$ vim ~/.config/amcrest.conf
[patio]
hostname: 192.168.0.20
username: admin
password: 123456
port: 80

[living_room]
hostname: 192.168.0.21
username: admin
password: secret
port: 80

$ amcrest-cli --camera living_room --version-http-api
version=1.40

Text User Interface (TUI)

Configure amcrest.conf and trigger amcrest-tui, make sure the user triggering amcrest-tui have access to framebuffer device or use sudo.

NOTE: Execute it from console logins, like /dev/ttyX (Non X Window). Pseudo-terminals like xterm, ssh, screen and others WONT WORK.

$ vim ~/.config/amcrest.conf
[patio]
hostname: 192.168.0.20
username: admin
password: 123456
port: 80

[living_room]
hostname: 192.168.0.21
username: admin
password: secret
port: 80

$ amcrest-tui

Supportability Matrix

Cameras

Model

Tested

Status

Results/Issues

IPM-721

Yes

working

IPM-HX1

Yes

working

IP2M-841

Yes

working

IP2M-842

Yes

working

IP3M-941

Yes

working

IP3M-943

Yes

working

IP3M-956

Yes

working

IP3M-956E

Yes

working

IP3M-HX2

Yes

working

IP4M-1026B

Yes

working

IP4M-1051B

Yes

working

IP5M-1176EB

Yes

working

IP8M-2496EB

Yes

working

IP8M-T2499EW-28M

Yes

working

Network Video Recorders (NVR)

Model

Tested

Status

Results/Issues

XVR DAHUA 5104S

Yes

working

If you have different model, feel fee to contribute and report your results.

Help

If you need any help, please join our community on the Gitter channels available at Gitter.

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

amcrest-1.9.5.tar.gz (918.8 kB view details)

Uploaded Source

Built Distribution

amcrest-1.9.5-py3-none-any.whl (156.0 kB view details)

Uploaded Python 3

File details

Details for the file amcrest-1.9.5.tar.gz.

File metadata

  • Download URL: amcrest-1.9.5.tar.gz
  • Upload date:
  • Size: 918.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/29.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.6 tqdm/4.62.2 importlib-metadata/4.8.1 keyring/23.2.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for amcrest-1.9.5.tar.gz
Algorithm Hash digest
SHA256 fb4f6baaefd57daa4e1715b2d533c3d0fd1f5aa3d860c749f0c64aa781c81cee
MD5 5f90bb35a1746b5e7f8c746f1631005e
BLAKE2b-256 5ae0855575284371d6a26252289992a141b7566b32918b36b481c336cff389ee

See more details on using hashes here.

Provenance

File details

Details for the file amcrest-1.9.5-py3-none-any.whl.

File metadata

  • Download URL: amcrest-1.9.5-py3-none-any.whl
  • Upload date:
  • Size: 156.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/29.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.6 tqdm/4.62.2 importlib-metadata/4.8.1 keyring/23.2.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for amcrest-1.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f97b4fe2bf9eb6f6ab9654bea06184bd9082f42ae589ac089b5caec443ce09dd
MD5 0d8b8229b748e4a660370a5b4d22b91b
BLAKE2b-256 3629b78047dc69fd6e11d68cb9fd33cd2e22a92474511388c1ae4c44cd5e96a5

See more details on using hashes here.

Provenance

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