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.

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

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

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

Uploaded Source

Built Distribution

amcrest-1.5.2-py3-none-any.whl (82.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: amcrest-1.5.2.tar.gz
  • Upload date:
  • Size: 61.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for amcrest-1.5.2.tar.gz
Algorithm Hash digest
SHA256 ab64f35e330becb475fe0475b1b79c7f5e25990b22767463356294924a425459
MD5 8da79085d9d7095d728d014222cd4e7e
BLAKE2b-256 e038342fea7372b3e0cfea1a789dc8cf2675a4c8e8a6e215f14917f135c778e1

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: amcrest-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 82.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for amcrest-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1b19dc2ec376f5b32e044e665bcefeb8bca48bbd8676f50256bfdd0d400d561c
MD5 a8fa6c6bdc7fddbab2faa2d7cb980674
BLAKE2b-256 9b57a78f44868cc814d4de3ef6f4b57dceb9797958c456b40c70fffe0c4a5c46

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