Framework sc
  • Accueil
  • Class
  • Todo
  • Download
v0.993e

Accueil

  • Démarrage
  • Documentation

Classes

  • sc
  • sc_cmd
  • sc_files
  • sc_install
  • sc_jpi

Class sc_jpi

LIBRAIRIE jpi - fonctions dédiées à JPI

01/2021

Pour utiliser cette librairie référez vous à la fonction $sc->load()

Fonction autoStart - valeur paramètre (String) : Url de JPI SET_URL()

Note importante: Nécessite la version 0.993 (au minimum) de JPI pour fonctionner correctement

sc
Extended by sc_jpi
Package: Documentation
Author: dJuL
Version: 0.993
See: $sc->load() pour charger cette librairie
Located at sc_jpi.class.php

Methods summary

public [boolean]
# SET_URL( string $url, string|boolean $_log = true, string $_logStyle = null )

Définie l'url (et le port) de JPI

Parameters :

$url
L'url de JPI
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[boolean]
retourne true en cas de succès, false si l'url fournie n'est pas correcte

Alias :

Cette fonction n'a pas d'alias

Example#1 :

CODE::SELECT ALL
//Charge la librairie jpi
$sc->load('jpi');

//Définie l'url et le port de JPI en spécifiant l'utilisateur et le mot de passe
$sc->jpi->SET_URL('http://login:password@192.168.0.10:8080');

Example#2 :

CODE::SELECT ALL
//Charge la librairie jpi avec le parmamètre autostart
$sc->load('jpi', 'http://192.168.0.10:8080');

Example#3 :

CODE::SELECT ALL
//Charge la librairie jpi et stocke la librairie dans une variable
$jpi = $sc->load('jpi');

//Définie l'url et le port de JPI
$jpi->SET_URL('http://192.168.0.10:8080');
public [boolean]
# SET_TIMEOUT( integer $timeout = 30, string|boolean $_log = true, string $_logStyle = null )

Définie le temps de réponse maximum de JPI

Parameters :

$timeout
Paramètre optionel Durée du timeout en seconde
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[boolean]
retourne true en cas de succès, false si le temps spécifié n'est pas correcte

Alias :

Cette fonction n'a pas d'alias

Example#1 :

CODE::SELECT ALL
//Définie le temps de réponse maximum de JPI à 60s
$sc->jpi->SET_TIMEOUT(60);

Example#2 :

CODE::SELECT ALL
//Définie le temps de réponse maximum de JPI à 30s
$sc->jpi->SET_TIMEOUT();
public [boolean]
# CHECK( string|boolean $_log = true, string $_logStyle = null )

Vérifie la connexion à JPI

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[boolean]
retourne true en cas de succès, false en cas d'echec

Example :

CODE::SELECT ALL
if ($sc->jpi->CHECK()) { 
  //Connexion OK à JPI 
}

Alias :

Cette fonction n'a pas d'alias
public [integer]
# STATUS( string $result, string|boolean $_log = true, string $_logStyle = null )

Retourne le statut en chiffre du résultat de l'action

Parameters :

$result
Résultat de l'action
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[integer]
retourne -2 si pas de réponse, -1 si action désactivée, 0 si ERREUR, 1 si OK et 2 si autre / information

Example :

CODE::SELECT ALL
//Envoie un SMS
$result = $sc->jpi->sendSms('{MY_NUMBER}', 'Message de test');
if ($sc->jpi->STATUS($result) == 1) { 
  //SMS envoyé et reçu par le destinataire avec succès 
}

Alias :

Cette fonction n'a pas d'alias
public [string]
# ACTION( string $action, array $params = array(), string|boolean $_log = true, string $_logStyle = null )

Fonction générique pour exécuter une action JPI (personalisée ou non)

Parameters :

$action
L'action JPI à exécuter
$params

Paramètre optionel

Les paramètres de l'action JPI (tableau associatif)

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur intervient

Alias :

Cette fonction n'a pas d'alias

Example#1 :

CODE::SELECT ALL
//Prononce un texte (action tts)
$sc->jpi->ACTION('tts', array( 
    'message' => 'La lumière est allumée !', 
    'volume' => $sc->getCmd('#[CONFIG][VOLUME TTS][value]#'), 
    'voice' => 'voxygen.tts.sorciere', 
    'queue' => 1 
  ) 
);

Example#2 :

CODE::SELECT ALL
//Récupère le niveau de la batterie
$battLevel = $sc->jpi->ACTION('getBattLevel');

Example#3 :

CODE::SELECT ALL
//Envoie un SMS
$message = 'Message de test';
$sc->jpi->ACTION('sendSms', array( 
    'number' => '{MY_NUMBER}', 
    'message' => $message 
  ) 
);

Example#4 :

CODE::SELECT ALL
//Action personalisée _designFS
$result = $sc->jpi->ACTION('_designFS', array( 
    'id' => 7 
  ) 
);
public [string]
# GET( string $url, string|boolean $_log = true, string $_logStyle = null )

Fonction générique pour exécuter une requête JPI

Parameters :

$url
L'url complète de l'action JPI à exécuter
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur intervient

Alias :

Cette fonction n'a pas d'alias

Example#1 :

CODE::SELECT ALL
//Prononce un texte (action tts)
$sc->jpi->GET('http://192.168.0.10:8080/?action=tts&message=La+lumi%C3%A8re+est+allum%C3%A9e+!&volume=50');

Example#2 :

CODE::SELECT ALL
//Récupère le niveau de la batterie
$battLevel = $sc->jpi->GET('http://192.168.0.10:8080/?action=getBattLevel');
public [string]
# ASK_SMS( string $number, string $message, integer $timeout = 600, string|boolean $_log = true, string $_logStyle = null )

Fonction générique pour exécuter une requête ASK via SMS

Parameters :

$number

Numéro(s) du / des destinataire(s)

Vous devez séparer les numéros par des points-virgules.

$message
Message (question) à envoyer
$timeout

Paramètre optionel

Temps maximum d'attente de la réponse (en secondes)

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[string]
retourne la réponse du destinataire ou false si le timeout est atteint, ou null si le SMS n'est pas distibué ou si une erreur intervient

Example :

CODE::SELECT ALL
//Lance la requête ASK via SMS avec un timeout de 300 secondes (5 minutes)
$response = $sc->jpi->ASK_SMS('{MY_NUMBER}', 'Voulez-vous une bière ? (Oui | Non)', 300);

if (strtolower(trim($response)) == 'oui') {
  //La réponse est OUI
}
elseif (strtolower(trim($response)) == 'non') {
  //La réponse est NON
}
elseif ($response) {
  //La réponse est ni OUI ni NON
}
elseif ($response === false) {
  //Le timeout est atteint, aucune réponse
}
elseif ($response === null) {
  //SMS non envoyé ou non reçu ou erreur JPI
}

Alias :

Cette fonction n'a pas d'alias
public [string]
# ASK_MMS( string $number, string $imagePath, string $message = null, integer $timeout = 600, string|boolean $_log = true, string $_logStyle = null )

Fonction générique pour exécuter une requête ASK via MMS

Parameters :

$number

Numéro(s) du / des destinataire(s)

Vous devez séparer les numéros par des points-virgules.

$imagePath
Image à envoyer (Chemin local ou URL)
$message

Paramètre optionel

Message à envoyer

$timeout

Paramètre optionel

Temps maximum d'attente de la réponse (en secondes)

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[string]
retourne la réponse du destinataire ou false si le timeout est atteint, ou null si le MMS n'est pas distibué ou si une erreur intervient

Example :

CODE::SELECT ALL
//Chemin local de l'image sur l'appareil JPI ou URL
$image = 'https://ladysmithgazette.co.za/wp-content/uploads/sites/64/2016/12/bar-1.jpg';

//Lance la requête ASK via MMS avec un timeout de 300 secondes (5 minutes)
$response = $sc->jpi->ASK_MMS('{MY_NUMBER}', $image, 'Voulez-vous une bière ? (Oui | Non)', 300);

if (strtolower(trim($response)) == 'oui') {
  //La réponse est OUI
}
elseif (strtolower(trim($response)) == 'non') {
  //La réponse est NON
}
elseif ($response) {
  //La réponse est ni OUI ni NON
}
elseif ($response === false) {
  //Le timeout est atteint, aucune réponse
}
elseif ($response === null) {
  //MMS non envoyé ou non reçu ou erreur JPI
}

Alias :

Cette fonction n'a pas d'alias
public [string]
# ASK_FREESMS( string $ident, string $number, string $message, integer $timeout = 600, string|boolean $_log = true, string $_logStyle = null )

Fonction générique pour exécuter une requête ASK via l'Api Free SMS

Parameters :

$ident

Information d’identification

Le format doit être ’Votre identifiant Free Mobile;Votre clé d'identification’

Ex: 28XXXX47;PWj20HXxXxXxsG

$number
Numéro Free Mobile du destinataire
$message
Message (question) à envoyer
$timeout

Paramètre optionel

Temps maximum d'attente de la réponse (en secondes)

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[string]
retourne la réponse du destinataire ou false si le timeout est atteint ou null si le SMS n'est pas distibué ou si une erreur intervient

Example :

CODE::SELECT ALL
//Lance la requête ASK via l'API Free SMS avec un timeout de 300 secondes (5 minutes)
$response = $sc->jpi->ASK_FREESMS('{FREESMS_IDENT}', '{MY_NUMBER}', 'Voulez-vous une bière ? (Oui | Non)', 300);

if (strtolower(trim($response)) == 'oui') {
  //La réponse est OUI
}
elseif (strtolower(trim($response)) == 'non') {
  //La réponse est NON
}
elseif ($response) {
  //La réponse est ni OUI ni NON
}
elseif ($response === false) {
  //Le timeout est atteint, aucune réponse
}
elseif ($response === null) {
  //SMS non envoyé: erreur d'identification ou erreur Serveur API Free ou erreur JPI
}

Alias :

Cette fonction n'a pas d'alias
public [string]
# ASK_TTS( string $message, integer $timeout = 15, integer $volume = -1, boolean $queue = false, string $voice = null, string $lang = null, string $reloadEngine = "auto", string|boolean $_log = true, string $_logStyle = null )

Fonction générique pour exécuter une requête ASK via TTS

Parameters :

$message
Message (question) à prononcer
$timeout

Paramètre optionel

Temps maximum d'attente de la réponse (en secondes)

$volume

Paramètre optionel

Volume en % (-1 utilise le volume du système)

Valeur par défaut si null : -1

$queue

Paramètre optionel

Place le message dans la file d’attente

Si ce paramètre est désactivé et que le moteur de voix est en cours de prononciation, la voix en cours de lecture sera stoppée.

Valeur par défaut si null : false

$voice

Paramètre optionel

Moteur de voix (si vide utilise celui du système)

Valeur par défaut si null : [valeur par défaut du système]

$lang

Paramètre optionel

Langue (si vide utilise celle du système)Ex: fr, en_GB...

Soyez certain que la langue est compatible avec la voix choisie.

Valeur par défaut si null : [valeur par défaut du système]

$reloadEngine

Paramètre optionel

Force la réinitialisation du moteur TTS

Utilisez le mode ’forcé’ uniquement si vous avez des problèmes (ex: pas ou plus de son).
L’option ’queue’ ne fonctionne pas quand le moteur TTS est réinitialisé.

Valeur par défaut si null : 'auto'

valeurs possibles: 'never', 'forced', 'auto'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logStyle de la fonction $sc->setLog()

Returns :

[string]
retourne la réponse ou false si le timeout est atteint ou null si une erreur intervient

Example :

CODE::SELECT ALL
//Lance la requête ASK via TTS avec un timeout de 10 secondes et un volume de 80%
$response = $sc->jpi->ASK_TTS('Voulez-vous une bière ?', 10, 80);

if (strtolower(trim($response)) == 'oui') {
  //La réponse est OUI
}
elseif (strtolower(trim($response)) == 'non') {
  //La réponse est NON
}
elseif ($response) {
  //La réponse est ni OUI ni NON
}
elseif ($response === false) {
  //Le timeout est atteint, aucune réponse
}
elseif ($response === null) {
  //Erreur JPI
}

Alias :

Cette fonction n'a pas d'alias
public [string]
# restart( integer $sleepFirst = null, integer $sleepBetween = null, string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Redémarre le serveur PAW, le moteur et l’APK

Parameters :

$sleepFirst

Paramètre optionel

Pause en secondes avant de stopper le service PAW

Valeur par défaut si null : 0

$sleepBetween

Paramètre optionel

Pause en secondes avant de relancer le service PAW

Valeur par défaut si null : 2

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getConfig( string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Retourne la configuration en cours d’utilisation

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# reloadConfig( string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Recharge la configuration (moteur et APK)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# userLog( string $message, string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Ajoute un message dans le journal utilisateur

Parameters :

$message
Message à journaliser
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# clearLog( string $log, string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Vide les journaux

Parameters :

$log

Spécifie le journal à vider

Valeurs possibles: 'event_log', 'app_log', 'error_log', 'sync_log', 'auth_log', 'user_log'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# clearData( string $data, string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Nettoyage des données

Parameters :

$data

Données à supprimer

Valeurs possibles: 'record', 'tts', 'media', 'picts', 'videos', 'downloads', 'vars', 'events', 'sync', 'log', 'tmp', 'all'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# clearDownHisto( string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Vide l’historique des téléchargements

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# clearNotifs( string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Supprime les notifications dans la barre de statut

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# quit( string|boolean $_log = true, string $_logStyle = null )

MOTEUR - Quitte le serveur PAW et l’APK

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getCaract( integer $id, string $returnValue = null, boolean $localApi = null, string|boolean $_log = true, string $_logStyle = null )

EEDOMUS - Renvoie les caractéristiques de base d’un périphérique

Parameters :

$id
Le code API du périphérique
$returnValue

Paramètre optionel

La valeur à retourner

Valeur par défaut si null : 'last_value'

Valeurs possibles: 'name', 'last_value', 'last_value_text', 'last_value_change', 'JSON'

$localApi

Paramètre optionel

Utiliser l’API locale(box eedomus)

Si ce paramètre est est à ’0’, l’API serveur (cloud) sera utilisée.

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# setValue( integer $id, string $value, boolean $updateOnly = null, boolean $localApi = null, string|boolean $_log = true, string $_logStyle = null )

EEDOMUS - Définie une valeur sur un périphérique

Parameters :

$id
Le code API du périphérique
$value
La valeur a définir
$updateOnly

Paramètre optionel

Mettre à jour la valeur sans demander d’action physique

Valeur par défaut si null : false

$localApi

Paramètre optionel

Utiliser l’API locale(box eedomus)

Si ce paramètre est à ’0’, l’API serveur (cloud) sera utilisée.

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# setMacro( integer $id, integer $dynamicValue = null, boolean $localApi = null, string|boolean $_log = true, string $_logStyle = null )

EEDOMUS - Active une macro sur un périphérique

Parameters :

$id
Identifiant de la macro
$dynamicValue

Paramètre optionel

Valeur du paramètre dynamique de macro

Valeur par défaut si null : null

$localApi

Paramètre optionel

Utiliser l’API locale(box eedomus)

Si ce paramètre est à ’0’, l’API serveur (cloud) sera utilisée.

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_getDevice( integer $deviceID, string $returnValue = null, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Renvoie les informations d’un module

Parameters :

$deviceID
Identifiant du module
$returnValue

Paramètre optionel

La valeur à retourner

Valeur par défaut si null : 'value'

Valeurs possibles: 'name', 'type', 'value', 'JSON'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_turnOn( integer $deviceID, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Allume un module (ON)

Parameters :

$deviceID
Identifiant du module
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_turnOff( integer $deviceID, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Éteint un module (OFF)

Parameters :

$deviceID
Identifiant du module
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_setValue( integer $deviceID, integer $value, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Spécifie la position d’un variateur ou d’un volet roulant

Parameters :

$deviceID
Identifiant du module
$value
Valeur en %
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_setAjar( integer $deviceID, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Fonction setAjar sur un volet roulant

Parameters :

$deviceID
Identifiant du module
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_stop( integer $deviceID, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Arrête un volet roulant (STOP)

Parameters :

$deviceID
Identifiant du module
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_setColor( integer $deviceID, string $color, integer $white, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Spécifie la couleur d’un module RGBW

Parameters :

$deviceID
Identifiant du module
$color
Couleur à afficher(format #RRGGBB)
$white
Valeur du blanc(0 - 255)
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_startProgram( integer $deviceID, integer $programID, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Démarre le programme d’un module RGBW

Parameters :

$deviceID
Identifiant du module
$programID
Identifiant du programme
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_setTargetLevel( integer $deviceID, integer $targetLevel, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Spécifie une température (Têtes thermostatiques)

Parameters :

$deviceID
Identifiant du module
$targetLevel
Température souhaitée en °C
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_setTime( integer $deviceID, integer $duration, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Spécifie la durée de conservation pour le thermostat

Parameters :

$deviceID
Identifiant du module
$duration
Durée en minute(à partir de maintenant)
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_pressButton( integer $deviceID, integer $buttonID, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Appuie sur un bouton d’un module virtuel

Parameters :

$deviceID
Identifiant du module
$buttonID
Identifiant du bouton
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_setSlider( integer $deviceID, integer $sliderID, integer $value, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Spécifie la valeur d’un slider (module virtuel)

Parameters :

$deviceID
Identifiant du module
$sliderID
Identifiant du slider
$value
Valeur en %
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hc_scene( integer $sceneID, string $op, string $arg1 = null, string $arg2 = null, string $arg3 = null, string $arg4 = null, string $arg5 = null, string|boolean $_log = true, string $_logStyle = null )

HOME CENTER - Contrôle une scène de la Home Center

Parameters :

$sceneID
Identifiant de la scène
$op

Opération à effectuer sur la scène

Valeurs possibles: 'start', 'stop'

$arg1

Paramètre optionel

Argument à passer à la scène (nom: "arg1")

Valeur par défaut si null : ''

$arg2

Paramètre optionel

Argument à passer à la scène (nom: "arg2")

Valeur par défaut si null : ''

$arg3

Paramètre optionel

Argument à passer à la scène (nom: "arg3")

Valeur par défaut si null : ''

$arg4

Paramètre optionel

Argument à passer à la scène (nom: "arg4")

Valeur par défaut si null : ''

$arg5

Paramètre optionel

Argument à passer à la scène (nom: "arg5")

Valeur par défaut si null : ''

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# configureLayout( boolean $buttons = null, boolean $webTitleBar = null, boolean $webZoomEnabled = null, integer $webInitialScale = null, integer $webTextSize = null, boolean $webNoBackButton = null, boolean $androidFullScreen = null, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Configure l’affichage de l’APK

Parameters :

$buttons

Paramètre optionel

Affiche ou non les boutons du bas de l’APK

Si les boutons sont cachés vous ne pourrez plus quitter l’application sur l’écran de l’appareil.

Valeur par défaut si null : true

$webTitleBar

Paramètre optionel

Affiche ou non la barre de titre du navigateur de l’APK

Si la barre de titre est cachée vous ne pourrez plus revenir sur l’écran d’accueil de l’application via l’écran de l’appareil.

Valeur par défaut si null : true

$webZoomEnabled

Paramètre optionel

Active ou non le zoom multipoint dans le navigateur de l’APK

Valeur par défaut si null : true

$webInitialScale

Paramètre optionel

Echelle d’affichage (zoom) du navigateur de l’APK (0 - 999)

Permet de changer le zoom d’affichage
- 0 => pour utiliser la valeur par défaut de l’appareil
(il sera necessaire de recharger la page web pour voir le résultat avec la valeur à 0)
- 1 => pour épouser au maximum la taille de la page web (zoom au minimum)
- Autre valeur => Valeur personalisée
(en général au dessus de 200 pour commencer à zoomer la page web)

Valeur par défaut si null : 1

$webTextSize

Paramètre optionel

Taille globale du texte du navigateur en % (10 - 999)

Valeur par défaut si null : 100

$webNoBackButton

Paramètre optionel

Empêche l’action du bouton système précédent

Valeur par défaut si null : false

$androidFullScreen

Paramètre optionel

Affiche ou non la barre de statut et les boutons du système

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# refreshLayout( string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Actualise la page web, le journal, ou l’accueil de l’APK

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# showApp( string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Lance / affiche l’APK au premier plan

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# goToHome( string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Retourne sur l’écran d’accueil de l’APK

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# goToDesign( integer $id, boolean $fullscreen = null, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Affiche un design Jeedom dans l’APK

Parameters :

$id
ID du design
$fullscreen

Paramètre optionel

Cache les menus de l’interface Jeedom

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias

Overrides :

sc::goToDesign
public [string]
# goToDesign3d( integer $id, boolean $fullscreen = null, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Affiche un design 3D Jeedom dans l’APK

Parameters :

$id
ID du design 3D
$fullscreen

Paramètre optionel

Cache les menus de l’interface Jeedom

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# goToView( integer $id, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Affiche une vue Jeedom dans l’APK

Parameters :

$id
ID de la vue
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# goToCamViewer( integer $lines = null, integer $cols = null, string $assign = null, boolean $names = null, boolean $enlarge = null, boolean $animate = null, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Affiche la visionneuse de caméras dans l’APK

Parameters :

$lines

Paramètre optionel

Nombre de ligne(s) de la grille

Valeur par défaut si null : [config CAM_VIEWER|CAMVIEWER_defaultParams / 0]

$cols

Paramètre optionel

Nombre de colonne(s) de la grille

Valeur par défaut si null : [config CAM_VIEWER|CAMVIEWER_defaultParams / 1]

$assign

Paramètre optionel

Affectation des caméras dans la grille

Valeur par défaut si null : [config CAM_VIEWER|CAMVIEWER_defaultParams / 2]

$names

Paramètre optionel

Afficher le nom des caméras

Affiche le nom des caméras au dessus de l’image

Valeur par défaut si null : [config CAM_VIEWER|CAMVIEWER_defaultParams / 3]

$enlarge

Paramètre optionel

Toujours afficher l’image en plein écran

Peut ne pas fonctionner sur les vieux navigateurs

Valeur par défaut si null : [config CAM_VIEWER|CAMVIEWER_defaultParams / 4]

$animate

Paramètre optionel

Afficher les animations

Affiche les animations lors des transitions de l’affichage

Valeur par défaut si null : [config CAM_VIEWER|CAMVIEWER_defaultParams / 5]

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# goToQuickActions( string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Affiche les actions rapides dans l’APK

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# goToUrl( string $url, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Affiche une page web dans l’APK

Parameters :

$url
Adresse de la page à afficher
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# voiceCmd( string $mode = null, boolean $setModeOnly = null, string $message = null, boolean $wait = null, boolean $exit = null, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Contrôle la reconnaissance vocale

Parameters :

$mode

Paramètre optionel

Sélection du mode(scénario)

Valeur par défaut si null : ''

$setModeOnly

Paramètre optionel

Va dans un mode sans le lancer(pas d’intéraction)

Valeur par défaut si null : false

$message

Paramètre optionel

Message manuel à envoyer au mode(lance le mode sans intéraction)

Valeur par défaut si null : ''

$wait

Paramètre optionel

Attendre la fin de l’éxécution du mode(si paramètre message non vide)

Valeur par défaut si null : true

$exit

Paramètre optionel

Termine le scénario vocale en cours(équivalent à l’action exit)

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# VRstatus( boolean $status, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Change le statut de la reconnaissance vocale

Parameters :

$status
0 = Pause (manuel) ou 1 = Play (permanante)
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# startScreenBurnFix( boolean $red = null, boolean $green = null, boolean $blue = null, boolean $white = null, boolean $black = null, float $frameDuration = null, integer $totalDuration = null, string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Permet de réduire les "brulures" d’écran

Parameters :

$red

Paramètre optionel

Affiche une image rouge

Valeur par défaut si null : true

$green

Paramètre optionel

Affiche une image verte

Valeur par défaut si null : true

$blue

Paramètre optionel

Affiche une image bleue

Valeur par défaut si null : true

$white

Paramètre optionel

Affiche une image blanche

Valeur par défaut si null : true

$black

Paramètre optionel

Affiche une image noire

Valeur par défaut si null : false

$frameDuration

Paramètre optionel

Durée d’une image (en secondes)

Valeur par défaut si null : 0.1

$totalDuration

Paramètre optionel

Durée du nettoyage (en minutes)

Valeur par défaut si null : 240

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stopScreenBurnFix( string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Stop le nettoyage en cours de l’écran

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# checkMaj( string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Vérifie les mises à jour (via l’APK)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# forceMaj( string|boolean $_log = true, string $_logStyle = null )

APPLICATION (APK) - Installe la dernière version du moteur (via l’APK)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# reboot( string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Redémarre le système (nécessite le ROOT)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# shutdown( string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Arrête le système (nécessite le ROOT)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# resetWifi( integer $sleepFirst = null, integer $sleepBetween = null, string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Désactive et réactive le wifi

Parameters :

$sleepFirst

Paramètre optionel

Pause en secondes avant de désactiver le wifi

Valeur par défaut si null : 0

$sleepBetween

Paramètre optionel

Pause en secondes avant de réactiver le wifi

Valeur par défaut si null : 2

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# launchApp( string $packageName, string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Démarre une application

Parameters :

$packageName
Le nom du package
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# killApp( string $packageName, string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Termine une application (nécessite le ROOT)

Parameters :

$packageName
Le nom du package
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# brightness( integer $level, string $mode = null, string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Définit la luminosité de l’écran

Parameters :

$level
Niveau de la luminosité en % (0 - 100)
$mode

Paramètre optionel

Adaptation de la luminosité

Valeur par défaut si null : 'manual'

Valeurs possibles: 'manual', 'auto'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# screenOn( string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Allume l’écran de l’appareil

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# screenOff( string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Éteint l’écran de l’appareil (peut prendre plusieurs secondes)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# sleepScreen( integer $duration, string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Définie la durée avant la mise en veille de l’écran

Parameters :

$duration
Durée en secondes de temporisation (-1 pour jamais)
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# enableBT( string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Active le bluetooth de l’appareil

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# disableBT( string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Désactive le bluetooth de l’appareil

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# manageBTDevice( string $deviceName, string $BTaction, string $profil = null, string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Connecte ou déconecte un appareil bluetooth apparié

Parameters :

$deviceName
Nom de l’appareil bluetooth apparié
$BTaction

Action à effectuer sur l’appareil

Valeurs possibles: 'connect', 'disconnect'

$profil

Paramètre optionel

Définit sur quel profil bluetooth agir

Lorsque "ALL" est sélectionné, cela revient à connecter / déconnecter totalement le périphérique

Valeur par défaut si null : 'ALL'

Valeurs possibles: 'ALL', 'A2DP', 'HSP', 'HDP'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# disableWifi( string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Désactive le wifi de l’appareil

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# shell( string $script, integer $timeout = null, boolean $statusOnly = null, boolean $root = null, string|boolean $_log = true, string $_logStyle = null )

SYSTÈME - Permet d’exécuter un script shell

Parameters :

$script

Script à exécuter (shell bash)

Attention à ce que vous faites, surtout en tant que ROOT !

$timeout

Paramètre optionel

Timeout d’exécution (en seconde)

Valeur par défaut si null : 5

$statusOnly

Paramètre optionel

Retourne le code de sortie du script (OK ou ERREUR)

Valeur par défaut si null : false

$root

Paramètre optionel

Exécuter en tant que ROOT (nécessite le ROOT)

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# makeCall( string $number, string $mode = null, boolean $speaker = null, string|boolean $_log = true, string $_logStyle = null )

TÉLÉPHONIE - Lance un appel

Parameters :

$number
Numéro à apeller
$mode

Paramètre optionel

Type d’appel

Pour utiliser la composition automatique avec CSipSimple vous devez créer un filtre dans CSipSimple :
Ex: Appeler directement: Tous (avec le compte SIP désiré)

Valeur par défaut si null : 'gsm'

Valeurs possibles: 'gsm', 'sip', 'csip'

$speaker

Paramètre optionel

Utiliser le haut-parleur

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# hangUp( string|boolean $_log = true, string $_logStyle = null )

TÉLÉPHONIE - Termine un appel (raccroche)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# answerCall( string $method = null, integer $serviceIndex = null, boolean $speaker = null, string|boolean $_log = true, string $_logStyle = null )

TÉLÉPHONIE - Accepte un appel entrant (décroche)

Parameters :

$method

Paramètre optionel

Méthode pour décrocher (prendre l’appel)

La méthode "Service" nécessite un système rooté

Valeur par défaut si null : [config PHONE / AutoAnswer_ServiceOrKey]

Valeurs possibles: 'service', 'key'

$serviceIndex

Paramètre optionel

Index pour la méthode "Service"

Les valeurs classiques sont 5 ou 6 selon le modèle d’appareil

Valeur par défaut si null : [config PHONE / AutoAnswer_ServiceIndex]

$speaker

Paramètre optionel

Utiliser le haut-parleur

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# sendSms( string $number, string $message, string $askData = null, integer $askTimeout = null, string|boolean $_log = true, string $_logStyle = null )

TÉLÉPHONIE - Permet d’envoyer un message texte (SMS)

Parameters :

$number

Numéro(s) du / des destinataire(s)

Vous devez séparer les numéros par un point-virgule.

$message
Message à envoyer
$askData

Paramètre optionel

Données de l’action ASK

Si ce paramètre n’est pas vide, la clef de scénario ’Réponses aux ASK’ sera exécutée
en cas de réponse du destinataire avant le timeout spécifié dans le paramètre askTimeout.

Valeur par défaut si null : ''

$askTimeout

Paramètre optionel

Timeout du ASK (en secondes)

Valeur par défaut si null : 600

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# resetSmsCounter( string|boolean $_log = true, string $_logStyle = null )

TÉLÉPHONIE - Permet de remettre à zéro le compteur de SMS

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# sendMms( string $number, string $imagePath, string $message = null, string $askData = null, integer $askTimeout = null, string|boolean $_log = true, string $_logStyle = null )

TÉLÉPHONIE - Permet d’envoyer une image par MMS

Parameters :

$number

Numéro(s) du / des destinataire(s)

Vous devez séparer les numéros par un point-virgule.

$imagePath
Image à envoyer (Chemin local ou URL)
$message

Paramètre optionel

Message à envoyer

Valeur par défaut si null : ''

$askData

Paramètre optionel

Données de l’action ASK

Si ce paramètre n’est pas vide, la clef de scénario ’Réponses aux ASK’ sera exécutée
en cas de réponse du destinataire avant le timeout spécifié dans le paramètre askTimeout.

Valeur par défaut si null : ''

$askTimeout

Paramètre optionel

Timeout du ASK (en secondes)

Valeur par défaut si null : 600

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# resetMmsCounter( string|boolean $_log = true, string $_logStyle = null )

TÉLÉPHONIE - Permet de remettre à zéro le compteur de MMS

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# delConv( string $number, string|boolean $_log = true, string $_logStyle = null )

TÉLÉPHONIE - Permet de supprimer une conversation SMS / MMS

Parameters :

$number
Numéro de l’expéditeur
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# play( string $media = null, string $order = null, integer $volume = null, boolean $queue = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Lit des médias / Ajoute à la liste de lecture

Parameters :

$media

Paramètre optionel

Url(s) ou fichier(s) à lire

Pour les fichiers, si le chemin racine n’est pas spécifié il s’agit par défaut du dossier ’paw/JPI/media’.
Vous devez séparer les médias par un retour à la ligne ou une barre verticale (’ | ’).
Vous pouvez utiliser le caractère ’ * ’ pour lire tous les médias d’un dossier.

Ce paramètre est facultatif si vous souhaitez reprendre la lecture après une pause ou un stop.

Valeur par défaut si null : ''

$order

Paramètre optionel

Ordre de lecture des medias spécifiés

Valeur par défaut si null : 'default'

Valeurs possibles: 'default', 'asc', 'desc', 'random'

$volume

Paramètre optionel

Volume en % (-1 utilise le volume du système)

Valeur par défaut si null : -1

$queue

Paramètre optionel

Ajoute à la liste de lecture

Si ce paramètre est désactivé et que le paramètre ’média’ n’est pas vide, la liste de lecture en cours sera éffacée.
Elle sera remplacée par le(s) média(s) spécifiés dans le paramètre ’média’.

Valeur par défaut si null : false

$wait

Paramètre optionel

Attend que la lecture soit finie avant de continuer

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stop( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Stop la lecture (la liste de lecture est conservée)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias

Overrides :

sc::stop
public [string]
# pause( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Met en pause la lecture (Utilisez play pour relancer)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias

Overrides :

sc::pause
public [string]
# next( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Passe au média suivant

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# tts( string $message, integer $volume = null, string $voice = null, string $lang = null, string $stream = null, boolean $queue = null, boolean $wait = null, string $askData = null, integer $askTimeout = null, string $reloadEngine = null, string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Prononce un texte (synthèse vocale)

Parameters :

$message
Message à prononcer
$volume

Paramètre optionel

Volume en % (-1 utilise le volume du système)

Valeur par défaut si null : -1

$voice

Paramètre optionel

Moteur de voix (si vide utilise celui du système)

Valeur par défaut si null : [valeur par défaut du système]

$lang

Paramètre optionel

Langue (si vide utilise celle du système)Ex: fr, en_GB...

Soyez certain que la langue est compatible avec la voix choisie.

Valeur par défaut si null : [valeur par défaut du système]

$stream

Paramètre optionel

Choix du flux pour la diffusion

Valeur par défaut si null : 'media'

Valeurs possibles: 'ring', 'notif', 'alarm', 'call', 'system', 'media', 'dtmf'

$queue

Paramètre optionel

Place le message dans la file d’attente

Si ce paramètre est désactivé et que le moteur de voix est en cours de prononciation, la voix en cours de lecture sera stoppée.

Valeur par défaut si null : false

$wait

Paramètre optionel

Attend que le message soit pronnoncé avant de continuer

Valeur par défaut si null : false

$askData

Paramètre optionel

Données de l’action ASK

Si ce paramètre n’est pas vide, la clef de scénario ’Réponses aux ASK’ de l’événement Commande VOCALE sera exécutée
en cas de réponse avant le timeout spécifié dans le paramètre askTimeout.

Valeur par défaut si null : ''

$askTimeout

Paramètre optionel

Timeout du ASK (en secondes)

Valeur par défaut si null : 15

$reloadEngine

Paramètre optionel

Force la réinitialisation du moteur TTS

Utilisez le mode ’forcé’ uniquement si vous avez des problèmes (ex: pas ou plus de son).
L’option ’queue’ ne fonctionne pas quand le moteur TTS est réinitialisé.

Valeur par défaut si null : 'auto'

Valeurs possibles: 'never', 'forced', 'auto'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# ttsToFile( string $message, string $voice = null, string $lang = null, string $linkType = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Enregistre un texte en WAV et retourne le fichier

Parameters :

$message
Message à enregistrer
$voice

Paramètre optionel

Moteur de voix (si vide utilise celui du système)

Valeur par défaut si null : 'voxygen.tts.fabienne'

$lang

Paramètre optionel

Langue (si vide utilise celle du système)Ex: fr, en_GB...

Soyez certain que la langue est compatible avec la voix choisie.

Valeur par défaut si null : 'fr_FR'

$linkType

Paramètre optionel

Format du lien retourné

Pour pouvoir utiliser l’adresse externe, il faut l’avoir préalablement configurée :
CONFIGURATION / Réglages avancés / Connexion au réseau / Url externe de JPI

Valeur par défaut si null : 'filePath'

Valeurs possibles: 'filePath', 'localIP', 'externalIP'

$wait

Paramètre optionel

Attend que le message soit enregistré avant de continuer

Si ce paramètre est désactivé et que vous voulez lire le fichier enregistré, il se peut que ce dernier soit encore en cours d’enregistrement.

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# playRingtone( string $ringtone = null, integer $volume = null, boolean $playLoop = null, integer $maxDuration = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Lit une notification, sonnerie ou alarme

Parameters :

$ringtone

Paramètre optionel

Son interne ou chemin du media

Pour les fichiers média, si le chemin racine n’est pas spécifié il s’agit par défaut du dossier ’paw/JPI/media’.

Valeur par défaut si null : 'SYSTEM_DEFAULT'

$volume

Paramètre optionel

Volume en % (-1 utilise le volume du système)

Valeur par défaut si null : -1

$playLoop

Paramètre optionel

Lire le son ou le media en boucle

Valeur par défaut si null : true

$maxDuration

Paramètre optionel

Durée maxi (en secondes) de lecture (0 pour désactiver)

Valeur par défaut si null : 30

$wait

Paramètre optionel

Attend que la lecture soit finie avant de continuer

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stopRingtone( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Arrête la lecture

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# startAudioStream( string $sampleRate = null, boolean $BTmic = null, string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Démarre le streaming du microphone

Parameters :

$sampleRate

Paramètre optionel

Fréquence d’échantillonnage

Valeur par défaut si null : [config STREAMING / SAMPLERATE_AudioStream]

Valeurs possibles: '16000', '22050', '32000', '44100'

$BTmic

Paramètre optionel

Utiliser le micro bluetooth (si disponible)

Valeur par défaut si null : [config STREAMING / BTMIC_AudioStream]

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stopAudioStream( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Stop le streaming du microphone

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# startAudioRecorder( string $sampleRate = null, boolean $BTmic = null, integer $duration = null, string $linkType = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Démarre l’enregistrement du microphone

Parameters :

$sampleRate

Paramètre optionel

Fréquence d’échantillonnage

Valeur par défaut si null : [config AUDIO_RECORDER / SAMPLERATE_AudioRecorder]

Valeurs possibles: '16000', '22050', '32000', '44100'

$BTmic

Paramètre optionel

Utiliser le micro bluetooth (si disponible)

Valeur par défaut si null : [config AUDIO_RECORDER / BTMIC_AudioRecorder]

$duration

Paramètre optionel

Durée (en seconde) de l’enregistrement (1 - 3600)

Un long enregistrement avec un samplerate élevé peut générer un fichier avec un poids conséquent.

Valeur par défaut si null : [config AUDIO_RECORDER / DURATION_AudioRecorder]

$linkType

Paramètre optionel

Format du lien retourné

Pour pouvoir utiliser l’adresse externe, il faut l’avoir préalablement configurée :
CONFIGURATION / Réglages avancés / Connexion au réseau / Url externe de JPI

Valeur par défaut si null : 'filePath'

Valeurs possibles: 'filePath', 'localIP', 'externalIP'

$wait

Paramètre optionel

Attend la fin de l’enregistrement avant de continuer

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stopAudioRecorder( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Stop l’enregistrement du microphone

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stopAudioStrRec( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Stop l’enregistrement du microphone

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# setVolume( integer $volume, string $stream = null, string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Définir les volumes du système

Parameters :

$volume
Niveau du volume en % (0 - 100)
$stream

Paramètre optionel

Flux à contrôler

Valeur par défaut si null : 'media'

Valeurs possibles: 'ring', 'notif', 'alarm', 'call', 'system', 'media', 'dtmf'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# muteAll( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Définit tous les volumes à 0%

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# unmuteAll( string|boolean $_log = true, string $_logStyle = null )

MÉDIAS - Restaure les volumes muets à leur valeur d’origine

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# sendMail( string $to, string $subject = null, string $message = null, string $attach = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Envoie un email

Parameters :

$to

Email(s) du / des destinataire(s)

Vous devez séparer les adresses email par une virgule.

$subject

Paramètre optionel

Sujet du message

Valeur par défaut si null : ''

$message

Paramètre optionel

Corps du message

Valeur par défaut si null : ''

$attach

Paramètre optionel

Pièce jointe (Chemin local ou URL)

Valeur par défaut si null : ''

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# sendFreeSms( string $ident, string $message, string $askNumber = null, string $askData = null, integer $askTimeout = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Envoie un sms via l’API SMS Free Mobile

Parameters :

$ident

Information d’identification

Le format doit être ’Votre identifiant Free Mobile;Votre clé d’identification’
Ex: 28XXXX47;PWj20HXxXxXxsG

$message
Message à envoyer
$askNumber

Paramètre optionel

Numéro Free Mobile du destinataire

Obligatoire pour associer le SMS de retour à la requête ASK

Valeur par défaut si null : ''

$askData

Paramètre optionel

Données de l’action ASK

Si ce paramètre n’est pas vide, la clef de scénario ’Réponses aux ASK’ sera exécutée
en cas de réponse du destinataire avant le timeout spécifié dans le paramètre askTimeout.

Valeur par défaut si null : ''

$askTimeout

Paramètre optionel

Timeout du ASK (en secondes)

Valeur par défaut si null : 600

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# httpGet( string $url, string $user = null, string $password = null, boolean $getHTTPcode = null, integer $timeout = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Retourne la réponse d’une requête http de type GET

Parameters :

$url
Adresse web de la requête (http://xxx ou https://xxx)
$user

Paramètre optionel

Utilisateur(authentification basique)

Valeur par défaut si null : ''

$password

Paramètre optionel

Mot de passe(authentification basique)

Valeur par défaut si null : ''

$getHTTPcode

Paramètre optionel

Retourne le code HTTP(à la place de la réponse)

Valeur par défaut si null : false

$timeout

Paramètre optionel

Temps d’attente maximum (en seconde)

Valeur par défaut si null : 2

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# httpPost( string $url, string $parameters, string $user = null, string $password = null, boolean $getHTTPcode = null, integer $timeout = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Retourne la réponse d’une requête http de type POST

Parameters :

$url
Adresse web de la requête (http://xxx ou https://xxx)
$parameters
Les paramètres encodés (param1=value&param2=value)
$user

Paramètre optionel

Utilisateur(authentification basique)

Valeur par défaut si null : ''

$password

Paramètre optionel

Mot de passe(authentification basique)

Valeur par défaut si null : ''

$getHTTPcode

Paramètre optionel

Retourne le code HTTP(à la place de la réponse)

Valeur par défaut si null : false

$timeout

Paramètre optionel

Temps d’attente maximum (en seconde)

Valeur par défaut si null : 2

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# httpPut( string $url, string $data, string $contentType = null, string $user = null, string $password = null, boolean $getHTTPcode = null, integer $timeout = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Retourne la réponse d’une requête http de type PUT

Parameters :

$url
Adresse web de la requête (http://xxx ou https://xxx)
$data
Les données à envoyer
$contentType

Paramètre optionel

Le type de données à envoyer

Valeur par défaut si null : 'text/plain'

$user

Paramètre optionel

Utilisateur(authentification basique)

Valeur par défaut si null : ''

$password

Paramètre optionel

Mot de passe(authentification basique)

Valeur par défaut si null : ''

$getHTTPcode

Paramètre optionel

Retourne le code HTTP(à la place de la réponse)

Valeur par défaut si null : false

$timeout

Paramètre optionel

Temps d’attente maximum (en seconde)

Valeur par défaut si null : 2

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# httpPatch( string $url, string $data, string $contentType = null, string $user = null, string $password = null, boolean $getHTTPcode = null, integer $timeout = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Retourne la réponse d’une requête http de type PATCH

Parameters :

$url
Adresse web de la requête (http://xxx ou https://xxx)
$data
Les données à envoyer
$contentType

Paramètre optionel

Le type de données à envoyer

Valeur par défaut si null : 'application/x-www-form-urlencoded'

$user

Paramètre optionel

Utilisateur(authentification basique)

Valeur par défaut si null : ''

$password

Paramètre optionel

Mot de passe(authentification basique)

Valeur par défaut si null : ''

$getHTTPcode

Paramètre optionel

Retourne le code HTTP(à la place de la réponse)

Valeur par défaut si null : false

$timeout

Paramètre optionel

Temps d’attente maximum (en seconde)

Valeur par défaut si null : 2

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# httpDelete( string $url, string $data, string $contentType = null, string $user = null, string $password = null, boolean $getHTTPcode = null, integer $timeout = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Retourne la réponse d’une requête http de type DELETE

Parameters :

$url
Adresse web de la requête (http://xxx ou https://xxx)
$data
Les données à envoyer
$contentType

Paramètre optionel

Le type de données à envoyer

Valeur par défaut si null : 'application/x-www-form-urlencoded'

$user

Paramètre optionel

Utilisateur(authentification basique)

Valeur par défaut si null : ''

$password

Paramètre optionel

Mot de passe(authentification basique)

Valeur par défaut si null : ''

$getHTTPcode

Paramètre optionel

Retourne le code HTTP(à la place de la réponse)

Valeur par défaut si null : false

$timeout

Paramètre optionel

Temps d’attente maximum (en seconde)

Valeur par défaut si null : 2

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# ping( string $address, integer $attempts = null, float $timeout = null, float $interval = null, boolean $root = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Effectue un ping

Parameters :

$address
Domaine ou adresse IP
$attempts

Paramètre optionel

Nombre de tentatives

Valeur par défaut si null : [config ADVANCED / Ping_NumberOfAttempts]

$timeout

Paramètre optionel

Délai d’attente (en seconde)

Valeur par défaut si null : [config ADVANCED / Ping_Timeout]

$interval

Paramètre optionel

Intervalle entre les pings (en seconde)

Valeur par défaut si null : [config ADVANCED / Ping_IntervalTimeout]

$root

Paramètre optionel

Exécuter en tant que ROOT (nécessite le ROOT)

Valeur par défaut si null : [config ADVANCED / Ping_Root]

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# skype( string $participants, string $type = null, string|boolean $_log = true, string $_logStyle = null )

COMMUNICATION - Effectue un appel audio ou vidéo avec skype

Parameters :

$participants

Pseudo(s) skype ou numéro(s) de téléphone

Vous devez séparer les pseudos skype ou les numéros de téléphone par un point-virgule.

$type

Paramètre optionel

Type d’appel (audio ou vidéo)

Valeur par défaut si null : 'audio'

Valeurs possibles: 'audio', 'video'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# toast( string $message, boolean $fast = null, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Affiche un toast sur l’écran

Parameters :

$message
Message à afficher
$fast

Paramètre optionel

Afficher le message moins longtemps

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# notification( string $header, string $message, string $icon = null, boolean $sound = null, boolean $vibrate = null, boolean $light = null, string $color = null, integer $time = null, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Affiche une notification dans la barre d’état

Parameters :

$header
Titre de la notification
$message
Message de la notification
$icon

Paramètre optionel

Icône de la notification

Valeur par défaut si null : 'default'

Valeurs possibles: 'default', 'android', 'sms', 'call', 'call_incoming', 'call_outgoing', 'call_missed', 'email', 'check', 'uncheck', 'star', 'star_gray', 'online', 'invisible', 'away', 'busy', 'offline', 'error', 'warning'

$sound

Paramètre optionel

Émettre un son

Valeur par défaut si null : true

$vibrate

Paramètre optionel

Émettre une vibration

Valeur par défaut si null : true

$light

Paramètre optionel

Utiliser la led de notification

Valeur par défaut si null : true

$color

Paramètre optionel

Couleur de la led de notification

Valeur par défaut si null : '#72f100'

$time

Paramètre optionel

Durée de vie (0 pour désactiver)

Valeur par défaut si null : 0

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# vibration( float $timeOn = null, float $timeOff = null, integer $loop = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Anime le vibreur

Parameters :

$timeOn

Paramètre optionel

Temps en seconde de vibration

Valeur par défaut si null : 0.5

$timeOff

Paramètre optionel

Temps de pause en seconde

Valeur par défaut si null : 0.6

$loop

Paramètre optionel

Nombre de répétitions

Valeur par défaut si null : 3

$wait

Paramètre optionel

Attend la fin de l’animation

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# sleepStatus( string $name, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Retourne l’état d’une pause (SLEEP)

Parameters :

$name

Nom du timer

L’action retourne 1 si la pause est en cours, sinon elle retourne 0.

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# setVar( string $name, string $value = null, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Définit une variable

Parameters :

$name

Nom de la variable

- Les variables dont le nom commence par ’%’ existent uniquement au sein du scénario courant.
- Les variables dont le nom commence par ’$’ sont stockées sur la carte SD
- Les autres variables sont stockées en RAM et restent accessibles tant que PAW n’est pas relancé

$value

Paramètre optionel

Valeur de la variable

Valeur par défaut si null : ''

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias

Overrides :

sc::setVar
public [string]
# getVar( string $name, string $defaultValue = null, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Retourne la valeur d’une variable ou" NULL"

Parameters :

$name

Nom de la variable

- Les variables dont le nom commence par ’%’ existent uniquement au sein du scénario courant.
- Les variables dont le nom commence par ’$’ sont stockées sur la carte SD
- Les autres variables sont stockées en RAM et restent accessibles tant que PAW n’est pas relancé

$defaultValue

Paramètre optionel

Valeur par défaut si la variable n’éxiste pas

Valeur par défaut si null : '_NULL_'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias

Overrides :

sc::getVar
public [string]
# unsetVar( string $name, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Supprime une variable

Parameters :

$name

Nom de la variable

- Les variables dont le nom commence par ’%’ existent uniquement au sein du scénario courant.
- Les variables dont le nom commence par ’$’ sont stockées sur la carte SD
- Les autres variables sont stockées en RAM et restent accessibles tant que PAW n’est pas relancé

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias

Overrides :

sc::unsetVar
public [string]
# phoneNumber( string $number, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Formate un numéro de téléphone

Parameters :

$number
Numéro à formater
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# cronNext( string $cron, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Retourne les prochaines dates d’exécution d’une expression cron

Parameters :

$cron
Expression cron (au format Quartz)
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# sendIntent( string $intentAction = null, string $category = null, string $mimeType = null, string $data = null, string $extra1Name = null, string $extra1Data = null, string $extra1DataType = null, string $extra2Name = null, string $extra2Data = null, string $extra2DataType = null, string $extra3Name = null, string $extra3Data = null, string $extra3DataType = null, string $package = null, string $className = null, string $target = null, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Envoie un Intent

Parameters :

$intentAction

Paramètre optionel

Ce que l’expéditeur souhaite que le récepteur fasse avec les données

Valeur par défaut si null : ''

$category

Paramètre optionel

Fournit des informations supplémentaires sur l’action

Valeur par défaut si null : 'none'

Valeurs possibles: 'none', 'Default', 'Browsable', 'Tab', 'Alternative', 'Selected Alternative', 'Launcher', 'Info', 'Home', 'Preference', 'Test', 'Car Dock', 'Desk Dock', 'Le Desk Dock', 'He Desk Dock', 'Car Mode', 'App Market', 'Vr Home'

$mimeType

Paramètre optionel

Type MIME (Ne peut pas être utilisé avec le paramètre 'data')

Valeur par défaut si null : ''

$data

Paramètre optionel

Principales spécifications de données au format URI.

Valeur par défaut si null : ''

$extra1Name

Paramètre optionel

Nom des données additionnelles à envoyer

Valeur par défaut si null : ''

$extra1Data

Paramètre optionel

Valeur des données additionnelles à envoyer

Valeur par défaut si null : ''

$extra1DataType

Paramètre optionel

Type de valeur des données additionnelles à envoyer

Valeur par défaut si null : 'String'

Valeurs possibles: 'String', 'int', 'double', 'float', 'long', 'boolean', 'char'

$extra2Name

Paramètre optionel

Nom des données additionnelles à envoyer

Valeur par défaut si null : ''

$extra2Data

Paramètre optionel

Valeur des données additionnelles à envoyer

Valeur par défaut si null : ''

$extra2DataType

Paramètre optionel

Type de valeur des données additionnelles à envoyer

Valeur par défaut si null : 'String'

Valeurs possibles: 'String', 'int', 'double', 'float', 'long', 'boolean', 'char'

$extra3Name

Paramètre optionel

Nom des données additionnelles à envoyer

Valeur par défaut si null : ''

$extra3Data

Paramètre optionel

Valeur des données additionnelles à envoyer

Valeur par défaut si null : ''

$extra3DataType

Paramètre optionel

Type de valeur des données additionnelles à envoyer

Valeur par défaut si null : 'String'

Valeurs possibles: 'String', 'int', 'double', 'float', 'long', 'boolean', 'char'

$package

Paramètre optionel

Spécifie la diffusion à un package

Valeur par défaut si null : ''

$className

Paramètre optionel

Spécifie la diffusion à une classe

Valeur par défaut si null : ''

$target

Paramètre optionel

Type de composant Android qui doit recevoir l’intent

Valeur par défaut si null : 'broadcast'

Valeurs possibles: 'broadcast', 'activity', 'Service'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# tasker( string $task, string|boolean $_log = true, string $_logStyle = null )

FONCTIONS - Exécute une tâche utilisateur Tasker

Parameters :

$task
Nom de la tâche utilisateur
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getLink( string $filePath, string $ip = null, boolean $checkFile = null, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Retourne le lien direct d’un fichier local

Parameters :

$filePath
Chemin du fichier
$ip

Paramètre optionel

Adresse locale ou externe

Pour pouvoir utiliser l’adresse externe, il faut l’avoir préalablement configurée :
CONFIGURATION / Réglages avancés / Connexion au réseau / Url externe de JPI

Valeur par défaut si null : 'local'

Valeurs possibles: 'local', 'external'

$checkFile

Paramètre optionel

Vérifier si le fichier existe

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getLastFile( string $dirPath, string $linkType = null, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Retourne le fichier le plus récent d’un dossier

Parameters :

$dirPath
Chemin complet du dossier où se placer
$linkType

Paramètre optionel

Format du lien retourné

Pour pouvoir utiliser l’adresse externe, il faut l’avoir préalablement configurée :
CONFIGURATION / Réglages avancés / Connexion au réseau / Url externe de JPI

Valeur par défaut si null : 'filePath'

Valeurs possibles: 'filePath', 'localIP', 'externalIP'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# download( string $url, string $user = null, string $password = null, string $POSTparams = null, integer $timeout = null, boolean $replace = null, string $linkType = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Télécharge un fichier (dans le dossier download)

Parameters :

$url
Adresse web (http://xxx ou https://xxx)
$user

Paramètre optionel

Utilisateur(authentification basique)

Valeur par défaut si null : ''

$password

Paramètre optionel

Mot de passe(authentification basique)

Valeur par défaut si null : ''

$POSTparams

Paramètre optionel

Paramètres à envoyer dans une requête POST

Les paramètres encodés (param1=value&param2=value)

Valeur par défaut si null : ''

$timeout

Paramètre optionel

Temps d’attente maximum (en seconde)

Valeur par défaut si null : 10

$replace

Paramètre optionel

Remplace le fichier si il existe

Valeur par défaut si null : false

$linkType

Paramètre optionel

Format du lien retourné

Pour pouvoir utiliser l’adresse externe, il faut l’avoir préalablement configurée :
CONFIGURATION / Réglages avancés / Connexion au réseau / Url externe de JPI

Valeur par défaut si null : 'filePath'

Valeurs possibles: 'filePath', 'localIP', 'externalIP'

$wait

Paramètre optionel

Attend la fin de l’action avant de continuer

Le fichier n’existera pas encore lors du retour de l’action si ce paramètre est désactivé

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# read( string $filePath, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Retourne le contenu d’un fichier

Parameters :

$filePath
Chemin complet du fichier
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# rename( string $filePath, string $newFileName, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Renomme un fichier ou un dossier

Parameters :

$filePath
Chemin complet du fichier ou du dossier
$newFileName
Nouveau nom (sans le chemin)
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# move( string $filePath, string $toDirPath, boolean $replace = null, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Déplace un fichier ou un dossier

Parameters :

$filePath
Chemin complet du fichier ou du dossier
$toDirPath
Chemin complet du dossier de destination
$replace

Paramètre optionel

Remplace le(s) fichier(s) existant(s)

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# copy( string $filePath, string $toDirPath, boolean $replace = null, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Copie un fichier ou un dossier

Parameters :

$filePath
Chemin complet du fichier ou du dossier
$toDirPath
Chemin complet du dossier de destination
$replace

Paramètre optionel

Remplace le(s) fichier(s) existant(s)

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# delete( string $filePath, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Supprime un fichier

Parameters :

$filePath
Chemin complet du fichier
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# deleteFiles( string $dirPath, string $searchMask = null, integer $olderThan = null, boolean $recursive = null, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Supprime des fichiers spécifiques

Parameters :

$dirPath
Chemin complet du dossier où se placer
$searchMask

Paramètre optionel

Masque de recherche (format MS-DOS)

Si la valeur du paramètre est vide ou égale a ’ * ’, tous les fichiers seront supprimés.
Ce paramètre n’est pas sensible à la casse.

Ex: .mov => Tous les fichiers de type MOV
.mov|.jpg> => Tous les fichiers de type MOV et de type JPG
f??a
=> Tous les fichiers commençant par un ’ f ’ suivi de 2 caractères et suivi d’un ’ a ’

Valeur par défaut si null : '*'

$olderThan

Paramètre optionel

Supprime les fichier modifiés il y a plus de x minutes

Utilisez la valeur ’ 0 ’ pour désactiver la fonction (tous les fichiers seront supprimés)

Valeur par défaut si null : 0

$recursive

Paramètre optionel

Traite également les fichiers des sous-dossiers

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# makeDir( string $dirPath, string $dirName, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Crée un nouveau dossier

Parameters :

$dirPath
Chemin complet du dossier où se placer
$dirName
Nom du dossier à créer (sans le chemin)
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# removeDir( string $dirPath, boolean $recursive = null, string|boolean $_log = true, string $_logStyle = null )

FICHIERS - Supprime un dossier

Parameters :

$dirPath
Chemin complet du dossier
$recursive

Paramètre optionel

Supprime tout le contenu du dossier

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getProximity( string|boolean $_log = true, string $_logStyle = null )

CAPTEURS - Valeur du capteur de proximité (cm)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getLight( string|boolean $_log = true, string $_logStyle = null )

CAPTEURS - Valeur du capteur de luminosité (lux)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getPressure( string|boolean $_log = true, string $_logStyle = null )

CAPTEURS - Valeur du capteur de pression (hPa)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getHumidity( string|boolean $_log = true, string $_logStyle = null )

CAPTEURS - Valeur du capteur d’humidité (%)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getTemperature( string|boolean $_log = true, string $_logStyle = null )

CAPTEURS - Valeur du capteur de témpérature (°C)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getOrientBearing( string|boolean $_log = true, string $_logStyle = null )

CAPTEURS - Valeur du capteur d’orientation (°)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getGyroscope( string $axis = null, string|boolean $_log = true, string $_logStyle = null )

CAPTEURS - Valeurs du Gyroscope (radians/seconde)

Parameters :

$axis

Paramètre optionel

valeur de l’axe à retourner

Valeur par défaut si null : 'X'

Valeurs possibles: 'x', 'y', 'z', 'all'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# animFlash( float $timeOn = null, float $timeOff = null, integer $loop = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Anime le flash de l’appareil photo

Parameters :

$timeOn

Paramètre optionel

Temps en seconde d’allumage

Valeur par défaut si null : 0.1

$timeOff

Paramètre optionel

Temps en seconde d’extinction

Valeur par défaut si null : 0.15

$loop

Paramètre optionel

Nombre de répétitions

Valeur par défaut si null : 10

$wait

Paramètre optionel

Attend la fin de l’animation

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# takePicture( string $camera = null, string $resolution = null, string $flash = null, integer $rotation = null, string $scene = null, string $focus = null, integer $zoom = null, string $white = null, integer $quality = null, integer $dateSize = null, string $dateColor = null, string $linkType = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Prend une photo et retourne le fichier

Parameters :

$camera

Paramètre optionel

Caméra à utiliser (Frontale ou arrière)

Valeur par défaut si null : 'rear'

Valeurs possibles: 'front', 'rear'

$resolution

Paramètre optionel

Résolution de la photo (format x*y)

Valeur par défaut si null : '640*480'

$flash

Paramètre optionel

Mode du flash (off, auto, on...)

Valeur par défaut si null : ''

Valeurs possibles: '', 'off', 'auto', 'on', 'red-eye', 'torch'

$rotation

Paramètre optionel

Effectue une rotation horaire (en degré)

Valeur par défaut si null : 0

$scene

Paramètre optionel

Spécifie une scène (auto, portrait, sports...)

Valeur par défaut si null : ''

Valeurs possibles: '', 'action', 'auto', 'barcode', 'beach', 'candlelight', 'fireworks', 'hdr', 'landscape', 'night', 'night-portrait', 'party', 'portrait', 'snow', 'sports', 'steadyphoto', 'sunset', 'theatre'

$focus

Paramètre optionel

Mode de mise au point (auto, macro, normal...)

Valeur par défaut si null : ''

Valeurs possibles: '', 'auto', 'continuous-picture', 'edof', 'fixed', 'infinity', 'macro'

$zoom

Paramètre optionel

Spécifie un niveau de zoom

Valeur par défaut si null : 0

$white

Paramètre optionel

Mode de balance des blancs (auto, fluorescent ...)

Valeur par défaut si null : ''

Valeurs possibles: '', 'auto', 'cloudy-daylight', 'daylight', 'fluorescent', 'incandescent', 'shade', 'twilight', 'warm-fluorescent'

$quality

Paramètre optionel

Qualité du Jpeg (1 - 100)

Valeur par défaut si null : 75

$dateSize

Paramètre optionel

Taille de la date (0 pour désactiver l’incrustation)

Valeur par défaut si null : 12

$dateColor

Paramètre optionel

Couleur de la date (format hexadécimal)

Valeur par défaut si null : '#0080dd'

$linkType

Paramètre optionel

Format du lien retourné

Pour pouvoir utiliser l’adresse externe, il faut l’avoir préalablement configurée :
CONFIGURATION / Réglages avancés / Connexion au réseau / Url externe de JPI

Valeur par défaut si null : 'filePath'

Valeurs possibles: 'filePath', 'localIP', 'externalIP'

$wait

Paramètre optionel

Attend la fin de l’action avant de continuer

Le retour d’erreur, si jamais la photo échoue, n’est pas effectif si ce paramètre est désactivé.

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# startStreaming( string $camera = null, string $rotation = null, integer $quality = null, integer $framerate = null, string $buffer = null, string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Démarre le streaming de la caméra

Parameters :

$camera

Paramètre optionel

Caméra à utiliser (Frontale ou arrière)

Si la détection de mouvement ou l’enregistrement vidéo est actif, ce paramètre sera temporairement ignoré.

Valeur par défaut si null : [config STREAMING / CAMERA_Streaming]

Valeurs possibles: 'front', 'rear'

$rotation

Paramètre optionel

Effectue une rotation horaire (en degré)

Valeur par défaut si null : [config STREAMING / ROTATION_Streaming]

Valeurs possibles: '0', '90', '180', '270'

$quality

Paramètre optionel

Qualité du Streaming (1 - 100)

Valeur par défaut si null : [config STREAMING / QUALITY_Streaming]

$framerate

Paramètre optionel

Image(s) par seconde (1 - 25)

Valeur par défaut si null : [config STREAMING / FRAMERATE_Streaming]

$buffer

Paramètre optionel

Méthode de mise en tampon

La méthode en RAM peut poser des problèmes de mémoire avec certains appareils.

Valeur par défaut si null : [config STREAMING / BUFFER_Streaming]

Valeurs possibles: 'sd', 'ram'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stopStreaming( string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Stop le streaming de la caméra

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# startVideoRecorder( string $camera = null, string $rotation = null, integer $quality = null, integer $framerate = null, integer $duration = null, string $linkType = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Démarre l’enregistrement vidéo

Parameters :

$camera

Paramètre optionel

Caméra à utiliser (Frontale ou arrière)

Si la détection de mouvement est active, ce paramètre sera temporairement ignoré.

Valeur par défaut si null : [config VIDEO_RECORDER / CAMERA_VideoRecorder]

$rotation

Paramètre optionel

Effectue une rotation horaire (en degré)

Valeur par défaut si null : [config VIDEO_RECORDER / ROTATION_VideoRecorder]

Valeurs possibles: '0', '90', '180', '270'

$quality

Paramètre optionel

Qualité de compression (1 - 100)

Valeur par défaut si null : [config VIDEO_RECORDER / QUALITY_VideoRecorder]

$framerate

Paramètre optionel

Image(s) par seconde (1 - 25)

Valeur par défaut si null : [config VIDEO_RECORDER / FRAMERATE_VideoRecorder]

$duration

Paramètre optionel

Durée (en seconde) de l’enregistrement (1 - 3600)

Un long enregistrement avec un framerate élevé et/ou une qualité de compression élevée peut générer un fichier avec un poids conséquent.

Valeur par défaut si null : [config VIDEO_RECORDER / DURATION_VideoRecorder]

$linkType

Paramètre optionel

Format du lien retourné

Pour pouvoir utiliser l’adresse externe, il faut l’avoir préalablement configurée :
CONFIGURATION / Réglages avancés / Connexion au réseau / Url externe de JPI

Valeur par défaut si null : 'filePath'

Valeurs possibles: 'filePath', 'localIP', 'externalIP'

$wait

Paramètre optionel

Attend la fin de l’enregistrement avant de continuer

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stopVideoRecorder( string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Stop l’enregistrement vidéo

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# startMotionDetector( string $camera = null, float $interval = null, integer $tolerence = null, integer $minLuma = null, integer $sleepFirst = null, string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Démarre la détection de mouvement

Parameters :

$camera

Paramètre optionel

Caméra à utiliser (Frontale ou arrière)

Valeur par défaut si null : [config MOTION_DETECTOR / CAMERA_MotionDetector]

$interval

Paramètre optionel

Intervalle de temps (en seconde) de calcul

Valeur par défaut si null : [config MOTION_DETECTOR / INTERVAL_MotionDetector]

$tolerence

Paramètre optionel

Tolérance de détection

Valeur par défaut si null : [config MOTION_DETECTOR / TOLERENCE_MotionDetector]

$minLuma

Paramètre optionel

Luminosité minimum requise

Valeur par défaut si null : [config MOTION_DETECTOR / MINLUMA_MotionDetector]

$sleepFirst

Paramètre optionel

Temps d’initialisation (en seconde)

Valeur par défaut si null : [config MOTION_DETECTOR / TIMETOINIT_MotionDetector]

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# pauseMotionDetector( string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Met en pause la détection de mouvement

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# resumeMotionDetector( string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Démarre la détection de mouvement avec les derniers paramètres

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# saveLastDetection( integer $rotation = null, integer $quality = null, integer $dateSize = null, string $dateColor = null, string $linkType = null, boolean $wait = null, string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Sauvegarde et retourne la photo du dernier mouvement détecté

Parameters :

$rotation

Paramètre optionel

Effectue une rotation horaire (en degré)

Valeur par défaut si null : 0

$quality

Paramètre optionel

Qualité du Jpeg (1 - 100)

Valeur par défaut si null : 75

$dateSize

Paramètre optionel

Taille de la date (0 pour désactiver l’incrustation)

Valeur par défaut si null : 12

$dateColor

Paramètre optionel

Couleur de la date (format hexadécimal)

Valeur par défaut si null : '#0080dd'

$linkType

Paramètre optionel

Format du lien retourné

Pour pouvoir utiliser l’adresse externe, il faut l’avoir préalablement configurée :
CONFIGURATION / Réglages avancés / Connexion au réseau / Url externe de JPI

Valeur par défaut si null : 'filePath'

Valeurs possibles: 'filePath', 'localIP', 'externalIP'

$wait

Paramètre optionel

Attend la fin de l’action avant de continuer

Le retour d’erreur, si jamais la photo échoue, n’est pas effectif si ce paramètre est désactivé.

Valeur par défaut si null : true

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# stopCamera( string|boolean $_log = true, string $_logStyle = null )

CAMÉRA - Stop le streaming vidéo, l’enregistrement, et la détection de mouvement

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getVersion( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la version du soft installée

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getApkVersion( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la version de l’APK installée

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getAndroidVersion( string $type = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la version Android installée

Parameters :

$type

Paramètre optionel

Version ou niveau d’API du système

Valeur par défaut si null : 'version'

Valeurs possibles: 'version', 'API'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# checkUpdate( string $type = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Vérifie les mises à jour disponibles

Parameters :

$type

Paramètre optionel

Type de mise à jour à rechercher

Valeur par défaut si null : 'auto'

Valeurs possibles: 'apk', 'code', 'auto'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getDeviceName( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la marque et le modèle de l’appareil

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getState( string $keyword, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la valeur d’un mot clef d’état

Parameters :

$keyword

Mot clef d’état

Valeurs possibles: 'GSM', 'WIFI', 'GATEWAY', 'INTERNET', 'JEEDOM', 'JEEDOM_SLAVE', 'EEDOMUS', 'HOMECENTER', 'CUSTOM_1', 'CUSTOM_2', 'CUSTOM_3', 'CUSTOM_4', 'CUSTOM_5', 'PROXIMITY', 'LIGHT', 'PRESSURE', 'HUMIDITY', 'TEMPERATURE', 'POWER', 'BATTERY', 'VR_STATUS', 'IS_CAMERA', 'IS_CAM_STREAMING', 'IS_CAM_RECORDING', 'IS_MICROPHONE', 'IS_AUDIO_STREAMING', 'IS_AUDIO_RECORDING', 'IS_PLAYING', 'IS_SPEAKING', 'IS_RINGING', 'IS_SCREEN_ON'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getLog( string $log, integer $maxLines = null, boolean $reverse = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne le contenu des journaux

Parameters :

$log

Spécifie le journal à retourner

Valeurs possibles: 'event_log', 'app_log', 'error_log', 'sync_log', 'auth_log', 'user_log'

$maxLines

Paramètre optionel

Nombre max de lignes (à partir de la fin)

Valeur par défaut si null : 50

$reverse

Paramètre optionel

Inverser l’ordre des lignes

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getScreenTime( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Returne la durée en secondes de temporisation (-1 pour jamais)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getSmsCounter( boolean $detail = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne le nombre de SMS envoyé(s)

Parameters :

$detail

Paramètre optionel

Retour plus détaillé

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getMmsCounter( boolean $detail = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne le nombre de MMS envoyé(s)

Parameters :

$detail

Paramètre optionel

Retour plus détaillé

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getNetworkName( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne le nom du réseau mobile (GSM)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getLastEvent( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne le dernier événement exécuté

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# lastEventDate( string $event, string $format = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la date de la dernière exécution d’un événement

Parameters :

$event
Événement concerné
$format

Paramètre optionel

Format de la date

Valeur par défaut si null : 'normal'

Valeurs possibles: 'normal', 'full', 'timestamp '

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getLastDetection( string $format = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la date de la dernière détection de mouvement

Parameters :

$format

Paramètre optionel

Format de la date

Valeur par défaut si null : 'normal'

Valeurs possibles: 'normal', 'full', 'timestamp'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getWifiStrength( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la puissance de réception en %

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# wifiInfo( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne les informations du wifi

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getFreeMem( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la taille de RAM libre en Mo

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# cpuInfo( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne l’utilisation du CPU

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getPackagesNames( boolean $json = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne les applications installées

Parameters :

$json

Paramètre optionel

Retour au format JSON

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getVoices( boolean $json = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne les voix (tts) installées

Parameters :

$json

Paramètre optionel

Retour au format JSON

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getVoiceLangs( string $voice, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne les languages disponibles

Parameters :

$voice
Moteur de voix
$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getRingtones( string $type = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la liste des sons systèmes (format JSON)

Parameters :

$type

Paramètre optionel

Type des sons à récupérer

Valeur par défaut si null : 'all'

Valeurs possibles: 'notif', 'ringtone', 'alarm', 'all', 'bycategory'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getVolume( string $stream = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne les volumes du système en %

Parameters :

$stream

Paramètre optionel

Volume du flux à retourner

Valeur par défaut si null : 'media'

Valeurs possibles: 'ring', 'notif', 'alarm', 'call', 'system', 'media', 'dtmf', 'all'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getBattLevel( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne le niveau de la batterie en %

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# battInfo( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne les informations de la batterie

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# cameraInfo( string $camera = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne les informations des caméras

Parameters :

$camera

Paramètre optionel

Spécifie la caméra

Valeur par défaut si null : 'rear'

Valeurs possibles: 'front', 'rear'

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getBTpaired( boolean $json = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne le nombre d’appareils appariés (-1 si BT désactivé)

Parameters :

$json

Paramètre optionel

Retourne la liste des appareils appariés (format JSON)

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getBTconnected( boolean $json = null, string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne le nombre d’appareils connectés (-1 si BT désactivé)

Parameters :

$json

Paramètre optionel

Retourne la liste des appareils connectés (format JSON)

Valeur par défaut si null : false

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getSyncDevices( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne les appareils synchronisés (format JSON)

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias
public [string]
# getLastUrl( string|boolean $_log = true, string $_logStyle = null )

INFORMATIONS - Retourne la dernière url chargée dans l’APK

Parameters :

$_log

Paramètre optionel

Un texte pour personaliser l'intitulé, ou false pour désactiver le log pour cette fonction

$_logStyle

Paramètre optionel

Voir le paramètre $_logstyle de la fonction $sc->setLog()

Returns :

[string]
retourne le résultat de l'action JPI ou null si une erreur de connexion intervient

Alias :

Cette fonction n'a pas d'alias

Methods inherited from sc

alert(), equipment(), getCmd(), getCond(), getEquipment(), getExp(), getInfoCmd(), getTag(), htmlLog(), icon(), isEqActive(), isVisible(), jeedom_poweroff(), jeedom_reboot(), load(), message(), persistLog(), popup(), scenario(), scenario_return(), setCmd(), setInfo(), setLog(), setTag(), startLog(), stopLog(), toHuman(), toId(), trigger(), version(), wait()

Framework sc API documentation generated by ApiGen - dJuL