Table of Contents   MOBOTIX Online Help

Opzioni API HTTP

L'interfaccia API (Application Programming Interface) HTTP è un software di interfaccia che consente di integrare comodamente la videocamera in un sistema di gestione centralizzato. L'interfaccia è formata da due script CGI richiamabili con parametri e valori tramite i comandi HTTP. Grazie a questi script è possibile modificare le impostazioni dei sottomenu di Impostazione ed eseguire determinate funzioni della videocamera.

Modifica delle impostazioni del menu Setup

Il comando HTTP http://128.243.66.90/control/control consente di modificare le impostazioni del menu Setup.

Esecuzione delle funzioni della videocamera

Il comando HTTP http://128.243.66.90/control/rcontrol permette di eseguire alcune funzioni della videocamera.

Importante: alcune funzioni di salvataggio e ripristino della configurazione possono essere eseguite solo da utenti con livello di accesso amministratore. In tal caso occorre un altro comando HTTP per richiamare lo script rcontrol, e precisamente:
http://128.243.66.90/admin/rcontrol

Convenzioni relative ai comandi

Comandi con un'istruzione

Per utilizzare l'istruzione list con il comando control, è necessario separare l'istruzione dal comando con un punto interrogativo ?:
   http://128.243.66.90/control/control?list

Comando con un'istruzione e una coppia parametro/valore

Per eseguire un'istruzione con un parametro, separare l'istruzione dal parametro con una "e commerciale" &. Il valore del parametro è separato da un segno di uguale =.
   http://128.243.66.90/control/control?list&section=actions

Comando con un'istruzione e diverse coppie parametro/valore

Per utilizzare più parametri, separarli con una "e commerciale" &:
    http://128.243.66.90/control/rcontrol?action=ledson&time=5

Diversi valori per un parametro

Per alcuni parametri è necessario immettere due valori per indirizzarsi a entrambi gli obiettivi. Tali parametri sono riportati con due valori di default (ad esempio: 0 0). Nel comando http questi valori vanno separati con un segno di addizione +:
   http://128.243.66.90/control/control?set&section=general&sharpen=0+0

Caratteri di 'a capo' nei comandi

Per utilizzare uno o più caratteri di 'a capo' in un comando, ad esempio per impostare diverse definizioni di finestre di movimento video, sostituire i caratteri di 'a capo' con la stringa CGI %0A.    http://128.243.66.90/control/control?set&section=general&
    coverimage_area=0,540,380,200,200,2%0A1,320,100,100,150,2

Caratteri speciali nei comandi

Per visualizzare le stringhe di formattazione CGI (a capo, spazi, accenti e così via), immettere i caratteri in base alla codifica URL. A tale scopo immettere un segno di percentuale % seguito dal valore esadecimale del carattere da visualizzare. La tabella seguente contiene un elenco dei caratteri più comuni:

Carattere Codifica URL Carattere Codifica URL Carattere Codifica URL
(a capo) %0A (spazio) %20 o + % %25
& %26 + %2B = %3D
? %3F © %A9 ® %AE
ß %DF ä %e4 Ä %c4
ö %F6 Ö %D6 ü %FC
Ü %DC Ç %c7 à %e0
á %e1 â %E2 æ %E6
ç %E7 è %E8 é %E9
ê %EA ë %EB î %ee
ï %EF ô %F4 ù %F9
ú %FA ù %FB û %fc

Tabella dei codici dei colori

È possibile specificare i valori dei colori di alcuni parametri. Tali valori corrispondono ai valori esadecimali del rosso, verde e blu (RGB) di un colore specifico. Due caratteri rappresentano un colore: 00 rappresenta il valore più basso (nessun colore), FF rappresenta il valore più alto (colore pieno). Per il tipo di miscelazione dei colori, 0x000000 è nero e 0XFFFFFF è bianco.

Esempio:

0xFF0000 Rosso
0x00FF00 Verde
0x0000FF Blu

Nome del colore Notazione esadecimale Colore Nome del colore Notazione esadecimale Colore
Nero 0x000000   Marrone 0x800000  
Verde scuro 0x008000   Verde oliva 0x808000  
Blu oltremare 0x000080   Viola 0x800080  
Verde bluastro 0x008080   Grigio scuro 0x808080  
Grigio chiaro 0xC0C0C0   Rosso 0xFF0000  
Verde 0x00FF00   Giallo 0xFFFF00  
Blu 0x0000FF   Magenta 0xFF00FF  
Ciano 0x00FFFF   Bianco 0xFFFFFF  

Il comando control

È innanzitutto necessario comunicare alla videocamera le istruzioni da eseguire.

Istruzioni per il comando control

Istruzioni Descrizione
set Accesso in scrittura alle impostazioni dell'immagine. Utilizzare questa istruzione per modificare le impostazioni dell'immagine.
http://128.243.66.90/control/control?set
read Accesso in lettura alle impostazioni dell'immagine. Utilizzare questa istruzione per eseguire query informative sulle impostazioni dell'immagine.
http://128.243.66.90/control/control?read
list

L'istruzione list restituisce un elenco delle sezioni modificabili dei file di configurazione.
Per richiamare i parametri di una determinata sezione aggiungere section=<nomesezione> alla fine della chiamata.

Esempio:
http://128.243.66.90/control/control?list&section=actions elenca tutte le opzioni della sezione actions.

Questo comando consente ad altre applicazioni di leggere i valori correnti e di ottenere le opzioni e i testi dell'interfaccia utente.

factory L'istruzione factory permette di ripristinare i parametri di una sezione alle impostazioni di default. Questa chiamata richiede il nome sezione section=<nomesezione> come parametro addizionale.
http://128.243.66.90/control/control?factory&section=<nomesezione>
restore L'istruzione restore permette di ripristinare i parametri di una sezione ai valori contenuti nella memoria flash. Questa chiamata richiede il nome sezione section=<nomesezione> come parametro addizionale.
http://128.243.66.90/control/control?restore&section=<nomesezione>



Il comando rcontrol

Il primo valore atteso dallo script è sempre il nome dell'azione da eseguire. A seconda dell'azione può essere necessario fornire parametri addizionali. I parametri addizionali possono essere obbligatori od opzionali.

Nota:

per visualizzare tutte le opzioni del comando rcontrol immettere l'istruzione list nella barra degli indirizzi del browser:
http://128.243.66.90/control/rcontrol?list.

Parametri di rcontrol

Azione Descrizione Parametro obbligatorio Parametro opzionale
sigouthigh L'uscita del segnale è chiusa. Il parametro time opzionale riapre l'uscita del segnale dopo il periodo di tempo definito. nessuno/a
time
Periodo di tempo in secondi
sigoutlow L'uscita del segnale è aperta. Il parametro time opzionale chiude nuovamente l'uscita del segnale dopo il periodo di tempo definito. nessuno/a
time
Periodo di tempo in secondi
sound Esegue il file audio boing. Il parametro soundfile opzionale permette di specificare un file di suono. È inoltre possibile utilizzare uno dei file di suono forniti con il software, oppure qualsiasi file registrato nella finestra di dialogo Gestione messaggi vocali. nessuno/a
soundfile
Nome del file di suono
ledson Attiva tutti i led. Il parametro time opzionale resetta i led alle impostazioni di default dopo il periodo di tempo specificato. nessuno/a
time
Periodo di tempo in secondi
ledsoff Disattiva tutti i led. Il parametro time opzionale resetta i led alle impostazioni di default dopo il periodo di tempo specificato. nessuno/a
time
Periodo di tempo in secondi
ledsdefault Resetta tutti i led alle impostazioni di default. Il parametro time opzionale resetta i led alle impostazioni precedenti l'intervallo di tempo specificato. nessuno/a time
ledsstring È possibile cambiare esplicitamente lo stato di ogni singolo led. È sufficiente utilizzare il parametro leds. Questo parametro attende una stringa di sei caratteri, ognuno dei quali definisce lo stato di un led. I caratteri sono allocati in senso orario, con il primo riferito al led che si trova nella posizione "ore 12".
Esempio: http://128.243.66.90/
    control/rcontrol?
    action=ledsstring
    &leds=01BD11

leds

0=led spento
1=led acceso
B=led lampeggiante
D=stato di default dei led
time
Periodo di tempo in secondi
irledson Attiva tutti i led IR. Il parametro time opzionale disattiva nuovamente tutti i led dopo il periodo di tempo definito. nessuno/a
time
Periodo di tempo in secondi
irledsoff Disattiva tutti i led IR. nessuno/a nessuno/a
irledsstring

È possibile cambiare in modo esplicito lo stato dei led IR per ciascun lato. È sufficiente utilizzare il parametro leds. Questo parametro attende una stringa di due caratteri, ognuno dei quali definisce lo stato di un led IR. Il primo carattere della stringa controlla lo stato della serie di led a destra, il secondo la serie di led a sinistra.

Esempio:
http://128.243.66.90/
    control/rcontrol?
    action=ledsstring
    &leds=01

leds

0=led spento
1=led acceso
time
Periodo di tempo in secondi
defreeze Sblocca la videocamera dopo un evento Arresta azione (SP) e riprende la registrazione delle immagini. nessuno/a nessuno/a
putrs232 Invia il testo tramite interfaccia seriale. Quando non si imposta il parametro rs232outtext, vengono trasferite solo le parole "hello world". nessuno/a
rs232outtext
stringa
getrs232 Legge il testo dall'interfaccia seriale. Quando non si utilizzano altri parametri, dal buffer vengono letti solo gli ultimi 2048 byte. nessuno/a
nrofbytes
0 .. 102400 byte
rs232delafterread
Svuota il buffer dopo la lettura
getrs232hex È simile alla funzione getrs232, con l'unica differenza che i caratteri sono restituiti come codice esadecimale. nessuno/a come getrs232
userclick Esegue la funzione Clic utente. nessuno/a nessuno/a
pancenter Imposta la posizione della sezione dell'immagine ingrandita al centro dell'immagine visibile. nessuno/a nessuno/a
gettemp Restituisce la temperatura interna della videocamera.
Nota:
Questo comando non è disponibile per il modello Web e di base.
nessuno/a nessuno/a
rs232sigin Restituisce lo stato del pin 9 dell'interfaccia seriale. nessuno/a nessuno/a
setrs232sig Imposta i pin dell'interfaccia seriale. Verificare che l'interfaccia seriale sia stata correttamente configurata nella finestra di dialogo Impostazione dell'interfaccia seriale e del modem.
24V 0, 1
RTS 0, 1
TXD 0, 1
DTR 0, 1
nessuno/a
ftplastevent Trasferisce via FTP l'ultima immagine dell'allarme memorizzata. Attende il nome di un profilo FTP come informazione addizionale. Il profilo deve essere definito nella finestra di dialogo Profili FTP.
profile
Profilo
nessuno/a
ftpcurrent Trasferisce l'immagine corrente via FTP. Attende il nome di un profilo FTP come informazione addizionale. Il profilo deve essere definito nella finestra di dialogo Profili FTP.
profile
Profilo
nessuno/a
emaillastevent Trasferisce via email l'ultima immagine dell'allarme memorizzata. Attende il nome di un profilo email come informazione addizionale. Il profilo deve essere definito nella finestra di dialogo Profili email.
profile
Profilo
nessuno/a
emailcurrent Trasferisce via email l'immagine corrente. Attende il nome di un profilo email come informazione addizionale. Il profilo deve essere definito nella finestra di dialogo Profili email.
profile
Profilo
nessuno/a
notifylastevent Invia un messaggio di rete con lo stato dell'immagine più recente dell'evento.
profile
Profilo
nessuno/a
notifycurrent Invia un messaggio di rete con lo stato dell'immagine corrente.
profile
Profilo
nessuno/a
sendmessage Invia una notifica IP all'indirizzo definito
Nota:
Questo comando non è disponibile per il modello Web e di base.
message Stringa
addr ip-address:port
nessuno/a
actionactivityon Attiva tutte le azioni nessuno/a nessuno/a
actionactivityoff Disattiva tutte le azioni nessuno/a nessuno/a
actionactivitytime Attiva tutte le azioni per il periodo di tempo definito nella finestra di dialogo Impostazioni generali eventi. nessuno/a nessuno/a
eventack Riconosce un allarme. nessuno/a nessuno/a
isdnphone Attiva un messaggio vocale dalla videocamera via telefono. Come informazione addizionale attende il nome di un profilo definito in Profili telefonia.
profile
Profilo
nessuno/a
speakip Ripete l'indirizzo IP corrente tramite l'altoparlante.

Nota:
Questo comando non è disponibile per il modello Web e di base.

nessuno/a nessuno/a

Salvataggio e ripristino della configurazione

Le funzioni di salvataggio e ripristino della configurazione possono essere eseguite solo da utenti del livello di accesso admin.

Esempio: http://128.243.66.90/admin/rcontrol?action=storeconfig
Nota: Questo comando non è disponibile per il modello Web e di base.

Funzioni per gli utenti del livello admin

Funzione Descrizione Parametro obbligatorio Parametro opzionale
storeconfig Archivia la configurazione corrente nella memoria permanente della videocamera. nessuno/a nessuno/a
restoreconfig Ripristina l'ultima configurazione salvata nella memoria permanente della videocamera. nessuno/a nessuno/a
resetconfig Legge le impostazioni di default della videocamera. nessuno/a nessuno/a
reboot Riavvia la videocamera. nessuno/a nessuno/a

cn, de, en, es, fr, it, jp, ru

© 2001-2017 MOBOTIX AG, Germany · http://www.mobotix.com/