SHARX SECURITY HTNC Series Bedienungsanleitung

Sharx Security

HTNC Series PoE IP Camera

API Reference Manual

2018 Version

-2-

Introduction

This reference guide is for programmers wishing to send commands directly to a Sharx Security

HTNC series PoE IP camera.

Some commands also return detailed status information from the camera.

To use this reference guide you’d need to have administrator login access to an HTNC series camera

that is already set up for your network (or accessible to you remotely). It is also assumed that you

know the basics of writing a program or a script to send commands via HTTP.

Many commands can be tested easily by copying and pasting the example into a brower, while of

course substituting your own camera’s IP address for the parameter shown as ”camera ipaddress”

For example, let’s assume your camera is set up on 192.168.0.54, and you wish to obtain the current

settings for the camera’s time, then change the time zone, and then verify that the change took effect.

Then, according to the section on setting time parameters on page 158 of this user’s guide, you

would construct the query string as follows, and you could test it by pasting into your browser:

http://192.168.0.54/system/time.php?app=get

Then once you provide the proper login credentials to the camera, you’d get a long result string

starting with the following:

res=200&tsyncmode=2&dt=2018-07-29&tm=10:03:40&tzone=13&dst_enable=1

The res=200 means you got a valid result, and the rest of the response is explained on page 158

Should you wish to change a setting, such as setting time zone to Pacific Time, you’ll find in the

table that Pacific Time has the time zone code 4, and you’d set that with a command such as the

following:

http://192.168.0.54/system/time.php?app=set&tzone=4

Again you’d be looking for a valid response as designated with the result code 200, and you can

then double check that it took effect by issuing the query again:

http://192.168.0.54/system/time.php?app=get

And now the result is:

res=200&tsyncmode=2&dt=2018-07-29&tm=07:11:05&tzone=4&dst_enable=1

At times this manual refers to the Sony chipset name that is used in our cameras.

Xarina, also known as X2, is the chipset used in our HTNC4400 series of full HD 60 fps cameras

while Xarina Pro, also known as X4, is used in our HTNC4500 series of 5 MP cameras.

-3-

Stream path summary

Quite often the most important piece of information that a programmer is looking for is the spelling

of the camera’s stream paths, so we summarized it up front.

Primary H264 RTSP stream: /1/stream1

MJPEG RTSP stream: /1/stream2

Third stream (H264 RTSP): /1/stream3

JPEG snapshot: /snapshot/1/snapshot.jpg

MJPEG HTTP stream: /jpeg/1/jpeg.php

You can test the RTSP paths by entering rtsp:// followed by the IP address of the camera and the path

above into the VLC media player from www.videolan.org, as in the example below:

You can test the snapshot by adding http:// and the IP address and the JPEG path above into any

browser. For testing the HTTP MJPEG path you need a browser that supports MJPEG, such as

Chrome. Or you can also use VLC for this. Internet Explorer does not support MJPEG.

-4-

Table of Contents

Stream path summary...................................................................................................................... 3

Table of Contents.............................................................................................................................. 4

Audio................................................................................................................................................ 27

Revision History......................................................................................................................... 27

Introduction ................................................................................................................................ 27

Audio URI .................................................................................................................................. 27

Back Channel Audio URI........................................................................................................... 27

Audio Parameter......................................................................................................................... 27

Back Channel Audio Parameter.................................................................................................. 28

Examples .................................................................................................................................... 28

1) get the current setting......................................................................................................... 28

2) Audio Enable setup............................................................................................................. 28

3) Audio Codec setup ............................................................................................................. 28

4) Audio Bitrate setup............................................................................................................. 28

5) Audio Sampling Rate setup................................................................................................ 28

6) Audio Input setup............................................................................................................... 28

7) Audio Input Volume setup ................................................................................................. 28

8) Audio Input Mute setup...................................................................................................... 29

9) Back Channel Audio Enable setup..................................................................................... 29

10) Back Channel Audio Volume setup ................................................................................. 29

11) Back Channel Audio Mute setup...................................................................................... 29

12) Audio Input Auto Enable setup........................................................................................ 29

Caution........................................................................................................................................ 29

Config.txt......................................................................................................................................... 31

Revision History......................................................................................................................... 31

Introduction ................................................................................................................................ 31

Config.txt URI............................................................................................................................ 31

Config.txt Parameters................................................................................................................. 31

1) Parameters.......................................................................................................................... 31

2) Motorized options............................................................................................................... 33

3) RS-485 options................................................................................................................... 33

4) PTZ options........................................................................................................................ 33

5) VCA options....................................................................................................................... 34

6) Options ............................................................................................................................... 34

Example...................................................................................................................................... 36

1) get the current setting......................................................................................................... 36

Dome Configuration....................................................................................................................... 37

Dome – Home Function:.............................................................................................................. 37

Revision History......................................................................................................................... 37

Introduction ................................................................................................................................ 37

Home Function URI ................................................................................................................... 37

Home Function Parameter.......................................................................................................... 37

Examples .................................................................................................................................... 38

1) get the current setting......................................................................................................... 38

2) Home Function setup.......................................................................................................... 38

3) Home Function Waiting Time setup .................................................................................. 38

-5-

4) Home Function Type setup............................................................................................................. 38

5) Home Function number setup......................................................................................................... 38

6) Home Function number set setup....................................................................................... 38

Caution........................................................................................................................................ 38

Dome – Motor Setup:................................................................................................................... 40

Revision History......................................................................................................................... 40

Introduction ................................................................................................................................ 40

Motor Setup URI........................................................................................................................ 40

Motor Setup Parameter............................................................................................................... 40

Examples .................................................................................................................................... 40

1) get the current setting......................................................................................................... 40

2) Motor Setup Propotional setup........................................................................................... 40

3) Motor Setup Max Pan Speed setup..................................................................................... 40

4) Motor Setup Max Tilt Speed setup..................................................................................... 41

Caution........................................................................................................................................ 41

Dome – Preset:............................................................................................................................. 42

Revision History......................................................................................................................... 42

Introduction ................................................................................................................................ 42

Preset URI................................................................................................................................... 42

Preset Parameter......................................................................................................................... 42

Examples .................................................................................................................................... 43

1) get configurable Preset value.............................................................................................. 43

2) get the current setting......................................................................................................... 43

3) Preset creation .................................................................................................................... 43

4) Preset deletion .................................................................................................................... 43

5) Preset modification............................................................................................................. 43

6) Preset movement ................................................................................................................ 44

Caution........................................................................................................................................ 44

Dome – Privacy Zone:.................................................................................................................. 45

Revision History......................................................................................................................... 45

Introduction ................................................................................................................................ 45

Privacy Zone URI....................................................................................................................... 45

Privacy Zone Parameter.............................................................................................................. 45

Examples .................................................................................................................................... 45

1) get configurable privacy Zone List..................................................................................... 45

2) Privacy Zone creation......................................................................................................... 46

3) Privacy Zone modification................................................................................................. 46

4) Privacy Zone deletion......................................................................................................... 46

5) PTZ movement................................................................................................................... 46

Caution........................................................................................................................................ 46

Dome – RS485:............................................................................................................................ 47

Revision History......................................................................................................................... 47

Introduction ................................................................................................................................ 47

RS485 URI ................................................................................................................................. 47

RS485 Parameter........................................................................................................................ 47

Examples .................................................................................................................................... 47

1) get the current setting......................................................................................................... 47

2) DOME ID setup.................................................................................................................. 47

3) Protocol setup..................................................................................................................... 47

4) Baudrate setup.................................................................................................................... 47

5) Parity setup......................................................................................................................... 48

-6-

6) Dome Answer setup........................................................................................................................48

Caution................................................................................................................................................48

Dome – System Menu:................................................................................................................. 49

Revision History......................................................................................................................... 49

Introduction ................................................................................................................................ 49

System Menu URI...................................................................................................................... 49

System Menu Parameter............................................................................................................. 49

Examples .................................................................................................................................... 50

1) Get the current PTZ Camera information and settings....................................................... 50

2) Check current Origin Check function status....................................................................... 50

3) Calibration setup................................................................................................................. 50

4) Origin Check start............................................................................................................... 50

5) Enable Schedule Origin Check setup................................................................................. 50

6) Schedule Origin Check setup ............................................................................................. 50

7) FA Module F/W Upgrade................................................................................................... 51

F/W Upload ................................................................................................................................ 51

Caution........................................................................................................................................ 52

Dome – Tour:............................................................................................................................... 53

Revision History......................................................................................................................... 53

Introduction ................................................................................................................................ 53

Tour URI..................................................................................................................................... 53

Tour Parameter........................................................................................................................... 53

Examples .................................................................................................................................... 54

1) get configurable Tour value................................................................................................ 54

2) get configured Preset List................................................................................................... 54

3) get configured Tour List..................................................................................................... 54

4) get specific configured Tour List ....................................................................................... 54

5) Tour creation ...................................................................................................................... 54

6) Tour deletion ...................................................................................................................... 56

7) Tour modification............................................................................................................... 56

8) Tour movement .................................................................................................................. 56

Caution........................................................................................................................................ 56

Dome – View Angle: ................................................................................................................... 57

Revision History......................................................................................................................... 57

Introduction ................................................................................................................................ 57

View Angle URI......................................................................................................................... 57

View Angle Parameter................................................................................................................ 57

Examples .................................................................................................................................... 58

1) get the current setting......................................................................................................... 58

2) Tilt Angle Limit setup........................................................................................................ 58

3) Flip setup............................................................................................................................ 58

Caution........................................................................................................................................ 58

Event................................................................................................................................................ 59

Event – AIHM:............................................................................................................................. 59

Revision History......................................................................................................................... 59

Introduction ................................................................................................................................ 59

AIHM URI.................................................................................................................................. 59

AIHM Parameter ........................................................................................................................ 59

Examples .................................................................................................................................... 59

1) get the current setting......................................................................................................... 59

-7-

2) AIHM setup.................................................................................................................................... 59

3) AIHM record status check setup.....................................................................................................59

4) AIHM format event setup................................................................................................... 59

5) AIHM server setup............................................................................................................. 59

6) AIHM dwell time setup...................................................................................................... 60

Caution........................................................................................................................................ 60

Event – Alarm In:......................................................................................................................... 61

Revision History......................................................................................................................... 61

Introduction ................................................................................................................................ 61

Alarm In URI.............................................................................................................................. 61

Alarm In Parameter .................................................................................................................... 61

Examples .................................................................................................................................... 61

1) get the current setting......................................................................................................... 61

2) Alarm In setup.................................................................................................................... 61

3) Alarm In type setup............................................................................................................ 61

4) Alarm In dwell time setup.................................................................................................. 61

Caution........................................................................................................................................ 61

Event – Alarm Out:...................................................................................................................... 62

Revision History......................................................................................................................... 62

Introduction ................................................................................................................................ 62

Alarm Out URI........................................................................................................................... 62

Alarm Out Parameter.................................................................................................................. 62

Examples .................................................................................................................................... 62

1) get the current setting......................................................................................................... 62

2) Alarm Out setup ................................................................................................................. 62

3) Alarm Out type setup.......................................................................................................... 62

Caution........................................................................................................................................ 62

Event – Audio Alert:.................................................................................................................... 63

Revision History......................................................................................................................... 63

Introduction ................................................................................................................................ 63

Audio Alert URI......................................................................................................................... 63

Audio Alert Parameter................................................................................................................ 63

Examples .................................................................................................................................... 63

1) get the current setting......................................................................................................... 63

2) Audio Alert setup ............................................................................................................... 63

3) Audio file remove............................................................................................................... 63

4) Audio Alert Test method.................................................................................................... 63

Caution........................................................................................................................................ 63

1) Reminder for the Audio Alert file upload .......................................................................... 64

Event – Audio detection:.............................................................................................................. 65

Revision History......................................................................................................................... 65

Introduction ................................................................................................................................ 65

Audio detection URI................................................................................................................... 65

Audio detection Parameter ......................................................................................................... 65

Examples .................................................................................................................................... 65

1) get the current setting......................................................................................................... 65

2) Audio detection setup......................................................................................................... 65

3) Audio detection level setup................................................................................................ 65

4) Audio detection Dwell time setup...................................................................................... 65

Caution........................................................................................................................................ 65

Event – Boost:.............................................................................................................................. 67

-8-

Revision History................................................................................................................................. 67

Introduction.........................................................................................................................................67

Boost URI................................................................................................................................... 67

Boost Parameter.......................................................................................................................... 67

Examples .................................................................................................................................... 67

1) get the current setting......................................................................................................... 67

2) Boost setup......................................................................................................................... 67

3) Boost stream setup.............................................................................................................. 67

4) Boost stream1 Normal Condition setup.............................................................................. 67

5) Boost stream2 Normal Condition setup.............................................................................. 68

6) Boost stream3 Normal Condition setup.............................................................................. 68

7) Boost Condition setup ........................................................................................................ 69

Caution........................................................................................................................................ 69

1) You must check the following values in the response to http://”camera

ipaddress”/config.txt.......................................................................................................... 69

2) Explanation on “ch#¹_strm#²_○○○” ................................................................................ 70

3) When you setup Boost stream Normal Condition, boost_enable value must be equal to 1.

........................................................................................................................................... 70

Event – Map:................................................................................................................................ 71

Revision History......................................................................................................................... 71

Introduction ................................................................................................................................ 71

Event – Map................................................................................................................................ 71

Video & Image – Image Parameter............................................................................................ 71

Event In ID ................................................................................................................................. 72

Examples .................................................................................................................................... 73

1) get the current setting......................................................................................................... 73

2) Method setup...................................................................................................................... 73

3) Event name setup................................................................................................................ 73

4) Event out SMTP setup........................................................................................................ 73

5) Event out alarm setup......................................................................................................... 73

6) Event out FTP setup ........................................................................................................... 74

7) Event out FTP Server setup................................................................................................ 74

8) Event out HTTP notification setup..................................................................................... 74

9) Event out audio alert setup................................................................................................. 74

10) Event out preset setup....................................................................................................... 75

11) Event out record setup...................................................................................................... 75

12) Event out event push setup............................................................................................... 75

13) Event out light setup......................................................................................................... 75

14) Event out event notification setup.................................................................................... 75

15) Event out boost setup........................................................................................................ 75

16) setup all Maps at once (in case of Error on individual Map setup).................................. 75

Caution........................................................................................................................................ 76

Event – Event Push: ..................................................................................................................... 77

Revision History......................................................................................................................... 77

Introduction ................................................................................................................................ 77

Event Push URI.......................................................................................................................... 77

Event Push Parameter................................................................................................................. 77

Examples .................................................................................................................................... 77

1) Get the current setting ........................................................................................................ 77

2) Event Push setup ................................................................................................................ 77

3) Event Push Stream Type setup........................................................................................... 77

-9-

4) Event Push Pre-event setup ............................................................................................................78

5) Event Push Post-event setup...........................................................................................................78

6) Event Push URL setup........................................................................................................ 78

7) Event Push Port setup......................................................................................................... 78

8) Event Push User name setup .............................................................................................. 78

9) Event Push Password setup................................................................................................ 78

Caution........................................................................................................................................ 78

Event – Face Detector:................................................................................................................. 79

Revision History......................................................................................................................... 79

Introduction ................................................................................................................................ 79

Face Detector URI...................................................................................................................... 79

Face Detector Parameter............................................................................................................. 79

Examples .................................................................................................................................... 79

1) get the current setting......................................................................................................... 79

2) face detector enable setup................................................................................................... 79

3) threshold setup.................................................................................................................... 79

4) setup face detector at once.................................................................................................. 79

Event – FTP & JPEG: .................................................................................................................. 80

Revision History......................................................................................................................... 80

Introduction ................................................................................................................................ 80

FTP & JPEG URI....................................................................................................................... 80

FTP & JPEG Parameter.............................................................................................................. 80

Examples .................................................................................................................................... 81

1) Get the current setting ........................................................................................................ 81

2) FTP & JPEG setup ............................................................................................................. 81

3) FTP Server usage setup...................................................................................................... 81

4) FTP & JPEG Server address setup..................................................................................... 81

5) FTP & JPEG Port setup...................................................................................................... 82

6) FTP & JPEG Passive mode setup....................................................................................... 82

7) FTP & JPEG User name setup ........................................................................................... 82

8) FTP & JPEG Password setup............................................................................................. 82

9) FTP & JPEG Anonymous login setup................................................................................ 82

10) FTP & JPEG Remote directory setup............................................................................... 82

11) FTP & JPEG Time folder setup........................................................................................ 83

12) FTP & JPEG JPEG Time folder type setup...................................................................... 83

13) FTP & JPEG JPEG Pre-event time setup......................................................................... 83

14) FTP & JPEG JPEG Pre-event FPS setup.......................................................................... 83

15) FTP & JPEG JPEG Event FPS setup ............................................................................... 83

16) FTP & JPEG JPEG Post-event time setup........................................................................ 84

17) FTP & JPEG JPEG Post-event FPS setup........................................................................ 84

18) FTP & JPEG JPEG Prefix file name setup....................................................................... 84

19) FTP & JPEG JPEG Additional suffix setup..................................................................... 84

Caution........................................................................................................................................ 84

Event – Light:............................................................................................................................... 85

Revision History......................................................................................................................... 85

Introduction ................................................................................................................................ 85

Light URI.................................................................................................................................... 85

Light Parameter .......................................................................................................................... 85

Examples .................................................................................................................................... 85

1) get the current setting......................................................................................................... 85

2) Light setup.......................................................................................................................... 85

-10-

3) Light brightness setup..................................................................................................................... 85

4) Light mode & Light time setup ...................................................................................................... 85

5) Operates only at night mode setup ..................................................................................... 86

6) Inactivate setup................................................................................................................... 86

Caution........................................................................................................................................ 86

Event – Manual Trigger:.............................................................................................................. 87

Revision History......................................................................................................................... 87

Introduction ................................................................................................................................ 87

Manual Trigger Setup & Operation URI.................................................................................... 87

Manual Trigger Setup Parameter................................................................................................ 87

Manual Trigger Operation Parameter......................................................................................... 87

Example...................................................................................................................................... 87

1) Manual Trigger setup ......................................................................................................... 87

Caution........................................................................................................................................ 87

Event – Motion:............................................................................................................................ 89

Revision History......................................................................................................................... 89

Introduction ................................................................................................................................ 89

Event – Motion URI ................................................................................................................... 89

Event – Motion Parameter.......................................................................................................... 89

Examples (latest F/W)................................................................................................................ 90

1) get the current setting......................................................................................................... 90

2) Motion setup....................................................................................................................... 90

3) Motion Day & Night setup................................................................................................. 90

4) Motion Region create......................................................................................................... 90

5) Motion Region Parameter modify...................................................................................... 91

6) Motion Region remove....................................................................................................... 93

Examples (old F/W).................................................................................................................... 94

1) get the current setting......................................................................................................... 94

2) Motion setup....................................................................................................................... 94

3) Motion Day & Night setup................................................................................................. 94

4) Motion Region create......................................................................................................... 94

5) Motion Region modify....................................................................................................... 94

6) Motion Region remove....................................................................................................... 94

7) Motion modify all............................................................................................................... 94

Event – Network Loss:................................................................................................................. 96

Revision History......................................................................................................................... 96

Introduction ................................................................................................................................ 96

Network Loss URI...................................................................................................................... 96

Network Loss Parameter............................................................................................................. 96

Examples .................................................................................................................................... 96

1) Get the current setting ........................................................................................................ 96

2) Network Loss setup............................................................................................................ 96

3) Network Loss dwell time setup.......................................................................................... 96

Caution........................................................................................................................................ 96

Event –Notification Server:.......................................................................................................... 97

Revision History......................................................................................................................... 97

Introduction ................................................................................................................................ 97

Notification Server Parameter .................................................................................................... 97

Examples .................................................................................................................................... 97

1) get the current setting......................................................................................................... 97

2) Notification Server setup.................................................................................................... 97

Inhaltsverzeichnis

Andere SHARX SECURITY Sicherheitskamera Handbücher

SHARX SECURITY

SHARX SECURITY HTNC4503M Bedienungsanleitung

SHARX SECURITY

SHARX SECURITY HTNC5803M Bedienungsanleitung

SHARX SECURITY

SHARX SECURITY HTNC4420PTZ Bedienungsanleitung

SHARX SECURITY

SHARX SECURITY Onvif HTNC5204DMX Bedienungsanleitung

SHARX SECURITY

SHARX SECURITY HTNC4410M Bedienungsanleitung

SHARX SECURITY

SHARX SECURITY HTNC5404M Bedienungsanleitung

SHARX SECURITY

SHARX SECURITY HTNC4300DM Bedienungsanleitung

Beliebte Sicherheitskamera Handbücher anderer Marken

Okina USA

Okina USA SIR36-870VF650LP Bedienungsanleitung

Divio

Divio NDR155PA Bedienungsanleitung

Canon

Canon VB-C500D Bedienungsanleitung

Easy Access

Easy Access EasyGuard Bedienungsanleitung

Vivotek

Vivotek FD9389-EHV-v2 Bedienungsanleitung

TUYA

TUYA COSMO W2 Bedienungsanleitung

Eusso

Eusso UNC7500-IR Einrichtungshandbuch

urmet domus

urmet domus 1096/204 Bedienungsanleitung

VC VC20 series Bedienungsanleitung

Axis

Axis Q1614 Bedienungsanleitung

ieGeek

ieGeek DD201 Bedienungsanleitung

VADDIO

VADDIO ClearVIEW HD-USB PTZ 999-6990-000 Bedienungsanleitung

Vicon

Vicon V662-D-1 Betriebsanleitung

Grundig

Grundig GCH-K0274P Bedienungsanleitung

Lorex

Lorex VANTAGE LBC7032 Bedienungsanleitung

4xem

4xem WPT Bedienungsanleitung

Samsung

Samsung SCV-3082 Bedienungsanleitung

Vitek

Vitek VTC-C544 Bedienungsanleitung