Controllo Runtime da riga di comando¶

Sono disponibili alcuni parametri con cui eseguire UbiquityRuntimeCli per controllare le operazioni di teleassistenza. Ad esempio, è possibile assegnare tali comandi ad azioni provenienti da un applicativo HMI, in modo da rendere la presenza del Runtime completamente trasparente.

Il file eseguibile UbiquityRuntimeCli è disponibile per UBIQUITY Runtime dalla versione 11.10 o maggiore, tuttavia, per mantenere la compatibilità con i sistemi esistenti, è ancora possibile utilizzare il file eseguibile Runtime.exe. Per maggiori informazioni, vedere Controllo Runtime da riga di comando (versione precedente).

Nota

I parametri da riga di comando sono supportati solo sui sistemi HMI Linux, Linux Debian 10/Ubuntu 20 e Windows, ad eccezione di Windows CE e Windows XP SP2.

Parametri	Descrizione
`--connect`	Connette Runtime al servizio di teleassistenza, rendendolo visibile al Control Center. Si usa questa opzione quando Runtime è già in esecuzione ma è scollegato, poiché di default Runtime si collega automaticamente, a meno che non venga specificata l’opzione disconnect.
`--disconnect`	Se Runtime è già in esecuzione, lo disconnette dal servizio di teleassistenza, rendendolo inaccessibile al Control Center e lo lascia in esecuzione. Se Runtime non è in esecuzione, lo avvia ma non lo connette al servizio di teleassistenza.
`--showChat`	Mostra la chat di teleassistenza.
`--hideChat`	Nasconde la chat di teleassistenza.
`--showKeyboard`	Mostra la tastiera di sistema.
`--hideKeyboard`	Nasconde la tastiera di sistema.
`--remoteAccessServiceConnected`	Indica lo stato di connessione del Runtime. Possibili valori: `0`: Runtime non connesso al server `1`: Runtime connesso al server Codici di uscita: `0`: Successo `1`: Impossibile connettersi al Runtime
`--remoteAccessSessionCount`	Indica il numero di supervisori Control Center connessi al Runtime. Codici di uscita: `0`: Successo `1`: Impossibile connettersi al Runtime
`--getAnonymousID`	Indica il valori dell’ID e della password necessari per la registrazione a Dominio di un dispositivo anonimo. Codici di uscita: `0`: Successo `1`: Impossibile connettersi al Runtime `2`: il Runtime non è connesso al servizio di teleassistenza `3`: il dispositivo è gia associato ad un Dominio
`--requestAssistance`	Attiva una richiesta di assistenza. Se è attiva l’opzione di dominio `The user must provide contact details when assistance is requested`, allora vanno passati i parametri `--name`, `--contact` e `--description` che corrispondono rispettivamente ai campi Name, Contact information e Description. Per maggiori informazioni, vedere Richiesta di assistenza. Codici di uscita: `0`: Successo `1`: Impossibile connettersi al Runtime `2`: Il Runtime non è connesso al servizio di teleassistenza `3`: Non è possibile aprire la richiesta di assistenza
`--closeAssistance`	Chiude una richiesta di assistenza. Per maggiori informazioni, vedere Richiesta di assistenza. Codici di uscita: `0`: Successo `1`: Impossibile connettersi al Runtime `2`: Il Runtime non è connesso al servizio di teleassistenza `3`: Non è possibile chiudere la richiesta di assistenza
`--getRequestAssistanceStatus`	Verifica lo stato di una richiesta di assistenza. Possibili valori: `0`: Una richiesta di assistenza è già attiva `1`: Nessun richiesta di assistenza presente Codici di uscita: `0`: Successo `1`: Impossibile connettersi al Runtime `2`: Il Runtime non è connesso al servizio di teleassistenza
`--canRequestAssistance`	Verifica se una richiesta di assistenza può essere aperta. Per maggiori informazioni, vedere Richiesta di assistenza. Possibili valori: `0`: Il Runtime non può aprire una richiesta di assistenza `1`: Il Runtime può aprire una richiesta di assistenza Codici di uscita: `0`: Successo `1`: Impossibile connettersi al Runtime `2`: Il Runtime non è connesso al servizio di teleassistenza
`--exportConnectionLog`	Esporta i log di connessione. Vanno passati i parametri `--fromDate`, `--toDate` e `outputDirectory` per indicare rispettivamente la data di inizio, la data di fine e la directory in cui verranno esportati i log. Codici di uscita: `0`: Successo `1`: Impossibile connettersi al Runtime `2`: Export non riuscito
`--quit`	Utilizzato solo con Runtime già in esecuzione. Disconnette e chiude Runtime.
`--version`	Visualizza la versione del Runtime.
`-h`, `--help`	Visualizza la lista dei comandi disponibili.

Valore di uscita

Il valore di uscita dei comandi viene stampato sullo standard output (stdout).

Codici di uscita

I codici di uscita rappresentano la corretta esecuzione di un comando oppure l’errore generato.

0

Successo
1

Impossibile connettersi al Runtime.
2, 3

Vedi la tabella dei comandi.

Esempi:

<path> identifica il percorso di installazione di UBIQUITY Runtime, per esempio

C:\Program Files (x86)\ASEM\Ubiquity\Runtime\

"<path>\UbiquityRuntimeCli" --connect

Connette il Runtime al servizio di teleassistenza.
"<path>\UbiquityRuntimeCli" --disconnect

Disconnette il Runtime dal servizio di teleassistenza.
"<path>\UbiquityRuntimeCli" –-quit

Chiude definitivamente il Runtime.
"<path>\UbiquityRuntimeCli" –-showChat\hideChat

Apre o chiude la finestra di chat.
"<path>\UbiquityRuntimeCli" –-showKeyboard\hideKeyboard

Apre o chiude tastiera di sistema.
"<path>\UbiquityRuntimeCli" –-remoteAccessServiceConnected

Interroga il Runtime sullo stato della connessione al server.
"<path>\UbiquityRuntimeCli" –-remoteAccessSessionCount

Interroga il Runtime sul numero di Control Center connessi.

"<path>\UbiquityRuntimeCli" --getAnonymousID

Interroga il Runtime sull’ID e la password del dispositivo.

Di seguito un esempio di interrogazione del Runtime con parametro --getAnonymousID utilizzando .NET:

var process = new Process();
process.StartInfo.FileName = @"C:\Program Files (x86)\ASEM\Ubiquity\Runtime\UbiquityRuntimeCli.exe";
process.StartInfo.Arguments = "--getAnonymousID";
process.StartInfo.CreateNoWindow = true;
process.StartInfo.RedirectStandardOutput = true;
process.StartInfo.UseShellExecute = false;
process.StartInfo.WindowStyle = ProcessWindowStyle.Hidden;
process.Start();
process.WaitForExit();
Console.WriteLine("AnonymousID, Password: " + process.StandardOutput.ReadToEnd());
Console.WriteLine("exit code: " + process.ExitCode);
Console.ReadLine();

"<path>\UbiquityRuntimeCli" –-requestAssistance

Attiva una richiesta di assistenza.
"<path>\UbiquityRuntimeCli" –-requestAssistance --name "John Doe" --contact "john.doe@email.com" --description "A brief description of the problem"

Attiva una richiesta di assistenza passando i tre parametri per Name, Contact information e Description.
"<path>\UbiquityRuntimeCli" –-closeAssistance

Cancella una richiesta di assistenza.
"<path>\UbiquityRuntimeCli" –-canRequestAssistance

Interroga il Runtime per vedere se una richiesta di assistenza può essere aperta.
"<path>\UbiquityRuntimeCli" –-getRequestAssistanceStatus

Interroga il Runtime per sapere lo stato di una richiesta di assistenza.
"<path>\UbiquityRuntimeCli" --exportConnectionLog --fromDate "2020-06-06" --toDate "2020-06-07" --outputDirectory "/tmp"

Esporta i log di connessione dal 6 giugno 2020 al 7 giugno 2020 nella cartella tmp.
"<path>\UbiquityRuntimeCli" -–version

Visualizza la versione del Runtime.
"<path>\UbiquityRuntimeCli" –-help

Visualizza i comandi disponibili.