PJ20 – Gateway Ver. 1...Nota La password di default di accesso per amministrazione di PJ20 Tracer...
Transcript of PJ20 – Gateway Ver. 1...Nota La password di default di accesso per amministrazione di PJ20 Tracer...
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 1 di 19
Manuale utente Gateway
PJ20 – Gateway Ver. 1.1
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 2 di 19
INDICE
1. GATEWAY SPECIFICATIONS .................................................................................................... 3
2. FIRST-TIME STARTUP ............................................................................................................... 4
3. Gateway pagina di amministrazione ........................................................................................ 5
3.1 System info ............................................................................................................................ 7
3.2 Network settings .................................................................................................................... 7
3.3 SafeX tracer ........................................................................................................................... 9
3.4 http Callback ........................................................................................................................ 10
3.5 Settings ................................................................................................................................ 12
3.6 API Documentation ............................................................................................................. 13
4. Gateway Settings Setup........................................................................................................... 15
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 3 di 19
1. GATEWAY SPECIFICATIONS
Hardware Specifications
Processor: 1.2GHz 64-bit quad-core Broadcom ARMv8
Memory: 1GB RAM, 8GB SD-CARD
Connectivity: Ethernet, WiFi (802.11b/g/n/ac)
User interfaces: Power-on LED, Factory Reset Button
Optional: RTC (with internal coin battery)
Bluetooth Specifications
Hardware: BLE module with Nordic nRF52832 SoC
Version: 4.2 Bluetooth Low Energy (BLE module is Bluetooth 5.0 ready)
Frequency: 2.402 to 2.480 GHz
Transmission power: up to +4dBm
Sensitivity: -96dBm
Read range: up to 200mt (LOS free-space, version W/ANT)
Antenna: version W/ANT: internal directive patch-antenna
Antenna: version W/SMA: SMA connector for external antenna
Electrical Specifications
Power voltage: 5.1VDC. MicroUSB connector. Power supply unit included.
Current: 1.5A (max)
Mechanical and environmental specification
Enclosure material: ABS (flame-resistant UL94V-0)
Size: 120 x 120 x 45 mm (excluding flanges)
Protection: IP40
Operating temperature: 0°C to +50°C
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 4 di 19
2. FIRST-TIME STARTUP
Connettere il Gateway
PJ20 Tracer Gateway dispone di due LED di stato:
• Il LED ROSSO indica se la spina di alimentazione è collegata
• Il LED VERDE lampeggiante indica che il gateway ha terminato l'avvio ed è pronto per
operare (l'interfaccia di amministrazione web è ora accessibile dal browser).
Dopo aver collegato il cavo di alimentazione e il cavo Ethernet, assicurati che il LED ROSSO sia
acceso e attendere che il LED VERDE del Gateway inizi a lampeggiare (modalità heartbeat).
Quando il LED VERDE inizia a lampeggiare, l'avvio del gateway è terminato e il gateway è
ora pronto per lavorare.
PJ20 Tracer Gateway è configurato di default con DHCP, quindi se è la prima volta che si
avvia, assicurarsi di avere un server DHCP attivo sulla rete LAN in cui ci si trova e di aver collegato
il Gateway.
È necessario individuare l'indirizzo IP assegnato al gateway (utilizzando l'interfaccia web del router)
e connettersi a quell'indirizzo IP utilizzando un browser.
Se l'indirizzo IP è corretto, nel browser verrà visualizzata la schermata di accesso a PJ20 Tracer
Gateway.
Passa al capitolo successivo per apprendere come utilizzare l'interfaccia di amministrazione di
PJ20 Tracer Gateway.
Nota
La password di default di accesso per amministrazione di PJ20 Tracer Gateway è: blueup
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 5 di 19
3. GATEWAY PAGINA DI AMMINISTRAZIONE
Per accedere all'interfaccia di amministrazione di PJ20 Tracer Gateway, aprire un browser e scrivere
l'indirizzo IP assegnato in DHCP al Gateway, la schermata di accesso apparirà nel tuo browser.
Per impostazione predefinita, PJ20 Tracer Gateway è configurato con una password di default che
è: blueup
Utilizzando la barra laterale sinistra è possibile accedere alle varie informazioni di configurazione del Gateway.
La barra laterale ha le seguenti sezioni:
• System Info, dove è possibile recuperare indicazioni sull'hardware e sul software in esecuzione sul gateway.
• Network settings, dove è possibile personalizzare l'interfaccia di rete (Ethernet / WiFi) di configurazione del Gateway.
• SafeX Tracer, in cui è possibile visualizzare un elenco dei Tracer attualmente rilevati
• HTTP Callback, in cui è possibile impostare una richiamata HTTP per consentire al gateway di inviare il file di dati di tracciamento ad una URL personalizzata.
Figura 1- Home page di amministrazione del Gateway
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 6 di 19
• Settings, in cui è necessario configurare tutte le impostazioni principali necessarie al gateway per lavorare con i tag PJ20 Tracer.
• Documentazione API, contiene la documentazione delle API esposte dal software.
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 7 di 19
3.1 SYSTEM INFO
a sezione System Info mostra informazioni sull'hardware e sul software in esecuzione nel Tracer
Gateway.
Da questa sezione è possibile:
• Leggere le informazioni hardware / software (numeri di serie, identificatori, versioni, ecc.)
• Leggere i registri di sistema
• Modificare il fuso orario
• Modificare la password di accesso
• Eseguire un aggiornamento del firmware del gateway
3.2 NETWORK SETTINGS
Figura 2- System info
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 8 di 19
La sezione Network settings consente di configurare le interfacce di rete del Gateway. PJ20
Tracer Gateway dispone di un'interfaccia Ethernet cablata e di una WiFi. Interfaccia wireless
802.11b / g / n / ac.
ATTENZIONE
Poiché il gateway è raggiungibile solo dalla sua interfaccia di amministrazione web,
assicurati di impostare una configurazione di rete corretta, altrimenti il tuo gateway potrebbe
diventare irraggiungibile.
Figura 3 – Network settings
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 9 di 19
3.3 SAFEX TRACER
La sezione SafeX Tracer mostra un elenco dei dispositivi PJ20 Tracer rilevati dal gateway.
Per ricevere i dati dai PJ20 Tracer, è necessaria una corretta configurazione della sezione Impostazioni, altrimenti nessun dispositivo verrà segnalato dal Gateway.
Per ogni PJ20 Tracer, vengono mostrati i dati sotto in elenco:
• TagId, il Tag Identifier del tracer
• Last Seen, il tempo intercorso dal ricevimento dell’ultimo pachetto
• RSSI, forza del segnale ricevuto
• Battery, battery voltage in mV del tracer
• Flash, Tracer flash usage (valore percentuale) memoria flash utilizzata
• State, lo stato del Tracer (può essere uno di: IDLE, DEFAULT, PREALARM, ALARM)
• Moving, un flag che mostra se il Tracer è in movimento
• Initialized, un flag che mostra se il Tracer è stato inizializato
• AlwaysConnectable, un flag che mostra se il Tracer è stato configurato per rimanere “alwaysconnectable”
Figura 4 – Safex tracer
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 10 di 19
3.4 HTTP CALLBACK
Questa sezione consente di configurare una o più callback HTTP per PJ20 Tracer Gateway.
Una richiamata HTTP è una richiesta HTTP POST inviata da PJ20 Tracer Gateway a una
URL di destinazione specifica, per notificare i dati degli annunci ricevuti dai dispositivi PJ20 Tracer.
Per creare un callback HTTP è necessario specificare i seguenti parametri:
• Interval, l'intervallo di tempo tra i callback successivi
• URL, l'URL di destinazione a cui verranno inviati i dati
• RSSI Threshold, (opzionale) solo i dispositivi con un RSSI maggiore di questo valore saranno
inviati dal Gateway.
Il corpo della callback HTTP è un documento JSON, il formato del JSON è descritto nel codice di
seguito.
{
"gateway" : "string", // gateway identifier
"timestamp" : integer, // unix timestamp
"data" : {
Figura 5 – Callback settings
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 11 di 19
"status" : "string", // can be "OK" or "error"
"type" : "advertisements", // fixed string
"tracers" : [
{
"state":"string", // tracer state
"buttonPressed":boolean, // button press indicator
"lastSeen":integer, // ms from last received packet
"isMoving":boolean, // movement indicator
"alertsDisabledByBeacon":boolean, // alerts disabled indicator
"address":"string", // mac address
"idleByButton":boolean, // device disabled by button
"rssi":integer, // rssi
"timeSync":boolean, // time synch indicator
"id":"string", // device unique identifier
"batteryVoltage":integer, // battery voltage (mV)
"firmwareVersion":"string", // firmware version
"alwaysConnectable":boolean, // always connectable indicator
"flashUsage":integer, // flash usage (percentual)
"haveDownloadedData":boolean // data download indicator
},
...
]
}
}
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 12 di 19
3.5 SETTINGS
Questa sezione include la parte più importante della configurazione del gateway.
In questa sezione verranno configurati i parametri necessari al gateway per connettere i dispositivi
tracer e scaricare i dati dei contatti da essi.
La sezione delle impostazioni è composta da 4 sottosezioni:
• Account, qui vengono specificati gli identificativi e le chiavi dell'account (assegnati al
momento della registrazione)
• Auto download, qui è possibile abilitare / disabilitare la funzione di download automatico del
Gateway
• Endpoint, qui è possibile configurare la URL dell'endpoint su cui caricare il dati dal gateway
dopo che sono stati scaricati dai tracer:
NOTA: inserire la URL https://hello.pj20tracer.it/api/blueup/GatewayContactEvents
questa sopra è la URL per caricare i dati dal gateway in piattaforma.
• Tracers, qui è necessario caricare un elenco di coppie utilizzate dal Gateway per connettere i dispositivi tracer
https://hello.pj20tracer.it/api/blueup/GatewayContactEvents
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 13 di 19
Per facilitare questa configurazione è possibile utilizzare il pulsante Importa e lasciare che il gateway
importi il file di dati dell'account dalla piattaforma Cloud e configurare le altre impostazioni con i valori
standard..
3.6 API DOCUMENTATION
In questa sezione sarà possibile consultare la documentazione delle REST API disponibili nel
gateway.
Figura 6 – Settings
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 14 di 19
Figura 7 – API Document
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 15 di 19
4. GATEWAY SETTINGS SETUP
La configurazione delle impostazioni dell'account richiede la configurazione di due valori:
• ID cliente / ID azienda
• Master Key (Chiave principale)
Questi valori vengono assegnati al momento della registrazione e possono essere richiesti alla mail
di supporto: [email protected] .
È possibile effettuare una configurazione manuale oppure importare (metodo consigliato) i valori di
Master Key e UserID/CompanyID direttamente dal Cloud tramite il tasto Import.
NOTA
Se non si configurano questi valori, nessun tracer verrà visualizzato nell'elenco dei Tracer
nell’interfaccia di amministrazione del gateway.
mailto:[email protected]
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 16 di 19
Auto Download
Nella configurazione delle impostazioni di download automatico, è possibile scegliere di abilitare o
disabilitare il download automatico caratteristica del PJ20 Tracer Gateway.
Quando il download automatico è abilitato, il Gateway proverà a scaricare i dati dei contatti dal tag
Tracer, per quei device che soddisfano i requisiti specificati nella configurazione.
La configurazione si compone di questi parametri:
● Default Unlock Key, (OPZIONALE) una chiave di sblocco predefinita da utilizzare per sbloccare
i tag tracer
● Flash Usage Threshold, solo per i tracer con un utilizzo Flash maggiore o uguale a questo valore
verranno scaricati i dati
● RSSI Threshold, solo per i tracer con un valore RSSI maggiore o uguale a questo valore saranno
scaricati i dati
● Only Always-Connectable, solo per i tracer configurati in modalità Sempre collegabili saranno
scaricati
● Seconds between Data Downloads, intervallo di tempo minimo che il gateway attende tra due
download consecutivi dallo stesso dispositivo tracer
● Seconds between Connect Attempts, intervallo di tempo minimo che il gateway attende tra due
tentativi di connessione consecutivi allo stesso dispositivo tracer
Figura 8 – Settings – Auto download
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 17 di 19
Endpoint
Le impostazioni dell'endpoint devono essere configurate se si desidera che il gateway invii i dati
scaricati ad una URL di endpoint.
Se vuoi abilitare questa funzione, dovrai anche impostare questi parametri:
● URL, l'URL di destinazione a cui devono essere inviati i dati
● Interval, questo è l'intervallo minimo tra i caricamenti dei dati riusciti, in secondi
● Retry Interval, questo è l'intervallo tra i tentativi per caricamenti di dati non riusciti, in secondi
Il corpo della callback HTTP è un documento JSON, il formato del JSON è descritto in codice di
seguito.
{
"gateway" : "string", // gateway identifier
"timestamp" : integer, // unix timestamp
"data" : {
"status" : "string", // can be "OK" or
"error"
"type" : "downloads", // fixed string
"tracers" : [
{
"version" : integer, // logs format version
"id" : "string", // id of the downloaded
tracer
Figura 9 – Settings – Import
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 18 di 19
"battery_voltage" : integer, // battery voltage (millivolts)
"logs": [
{
"records":[
{
"id" : "string", // see documentation on
cloud
"prealarm" : integer, // see documentation on
cloud
"alarm" : integer // see documentation on cloud
},
...
]
},
...
]
}
]
}
}
Tracers
Quando la funzione di download automatico è abilitata, solo i dispositivi elencati qui saranno
considerati dal Gateway (tutti gli altri tracer verranno ignorati).
-
PJ20 – Gateway Ver. 1.1 Classificazione
PUBBLICA
Manuale utente Gateway
Mod 7.3.11 MU Manuale d’uso Rev 0 del 08.08.18 Pagina 19 di 19
Se si utilizza il pulsante Importa, l'elenco dei tracer verrà compilato automaticamente con i tracer
presenti nell’account cloud, altrimenti è possibile caricare manualmente il file CSV contenente
l'elenco Tracer.
Se viene eseguito il caricamento manuale, il file può essere richiesto a Vetrya ([email protected])
che invierà un file CSV con l’elenco dei tracer associati all’account.
Figura 10 – Settings – Tracers
mailto:[email protected]