• Light
  • Dark
  • Français
  • English
  • Spanish
  • Deutsch
  • Core 3.3
  • Core 4.0 (legacy)
  • Core 4.1
  • Core 4.2
  • Core 4.3
  • Core 4.4
  • Core 4.5

#

: l’arborescence

: :

:

:

:

info.json

install.php

:

:

). :

:

<?php
.
 *
 * : 
 * 
 * 
 * (.
 *
 * ,
 * 
 * . 
 * .
 *
 * 
 * . If not, see <http:www.gnu.orglicenses>.
 *


() {
    $cron = cron::byClassAndFunction('zwave', 'pull')
     (!)) {
        $cron = new cron()
        $cron->setClass('zwave')
        $cron->setFunction('pull')
        $cron->setEnable(1)
        $cron->setDeamon(1)
        $cron->setSchedule('* * * * *')
        $cron->save()
    }
}

() {
    $cron = cron::byClassAndFunction('zwave', 'pull')
     (!)) {
        $cron = new cron()
        $cron->setClass('zwave')
        $cron->setFunction('pull')
        $cron->setEnable(1)
        $cron->setDeamon(1)
        $cron->setSchedule('* * * * *')
        $cron->save()
    }
    $cron->stop()
}

() {
    $cron = cron::byClassAndFunction('zwave', 'pull')
    )) {
        $cron->remove()
    }
}
?>

configuration.php

Fichier permettant de demander des informations de configuration à l’utilisateur :

Le fichier est constitué de :

Ensuite vient le paramètre demandé (il peut en avoir plusieurs), c’est une syntaxe standard Bootstrap pour les formulaires, les seules particularités à respecter sont la classe (configKey) à mettre sur l’élément de paramètre ainsi que le “data-l1key” qui indique le nom du paramètre. Pour récupérer la valeur de celui-ci ailleurs dans le plugin il suffit de faire : config::byKey(NOM_PARAMETRE, PLUGIN_ID)

:

<?php
.
 *
  * : 
 * 
 * 
 * (.
 *
 * ,
 * 
 * . 
 * .
 *
  * 
 * . If not, see <http:www.gnu.orglicenses>.
  *

 

 (!isConnect()) {
    include_file('desktop', '404', 'php')
    die()
 }
 ?>
 <form class="form-horizontal">
     <fieldset>
         <div class="form-group">
             <label class="col-lg-2 control-label">Zway IP<label>
             <div class="col-lg-2">
                 <input class="configKey form-control" data-l1key="zwaveAddr" >
             <div>
         <div>
         <div class="form-group">
             <label class="col-lg-4 control-label">Supprimer automatiquement les périphériques exclus<label>
             <div class="col-lg-4">
                 <input type="checkbox" class="configKey" data-l1key="autoRemoveExcludeDevice" >
             <div>
         <div>
         <div class="form-group">
             <label class="col-lg-4 control-label">J'utilise un serveur openzwave<label>
             <div class="col-lg-4">
                 <input type="checkbox" class="configKey" data-l1key="isOpenZwave" >
             <div>
         <div>
     <fieldset>
 <form>

:

PHP

. ). . ).

.php :

<?php
 (!')) {
    
 }
 
 ?>

Une fois sur cette page vous aurez accès en à toutes les fonctions du core de jeedom (voir ) ainsi qu’à celles de tous les modules installés donc le vôtre aussi.

Toutes ces pages étant des vues elles utilisent principalement la syntaxe HTML. Pour tout ce qui est présentation, Jeedom se base principalement sur bootstrap donc toute la documentation est applicable.

Pour simplifier la création de plugin vous pouvez inclure dans votre page le script javascript de template pour les plugins :

<? include_file('core', 'plugin.template', 'js') ?>

. ).

. .

:

<input type="text" class="eqLogicAttr form-control" data-l1key="name" placeholder="">

Là, par exemple, lors du chargement des données jeedom mettra la valeur du nom de l’équipement dans l’input et lors de la sauvegarde récupérera celle-ci pour la remettre en base de données. Petite astuce certaines propriétés sont en fait des chaînes JSON en BDD (cela permet d’avoir vraiment pas mal de liberté pour le plugin), dans ce cas il suffit de faire :

<input class="eqLogicAttr form-control" data-l1key='configuration' data-l2key='fromName' >
)

. :

.

JS

!!!). ). . :

) {
     (!)) {
        : {}}
     }
    
      : 
    
      : 
      : 
     .id)) {
        
     }
     
    
     $('#table_cmd tbody').append(tr)
    $('#table_cmd tbody tr:last').setValues(_cmd, '.cmdAttr')
}

Vous remarquerez qu’il y a une ligne par commande et que celle-ci a bien la classe css cmd. Vous pouvez aussi voir les éléments qui ont la classe cmdAttr.

Plusieurs points importants :

Dernier point: un exemple plus complet avec type et sous-type de commande :

) {
     (!)) {
        var _cmd = {}
    }
      (!.configuration)) {
        _cmd.configuration = {}
    }
     var selRequestType = '<select style="width : 90px" class="cmdAttr form-control input-sm" data-l1key="configuration" data-l2key="requestType">'
     selRequestType += '<option value="script"><option>'
     selRequestType += '<option value="http"><option>'
     selRequestType += '<select>'
    var tr = ''     tr += '<input class="cmdAttr form-control input-sm" data-l1key="name" style="width : 140px">'
    tr += '<input class="cmdAttr form-control input-sm" data-l1key="id"  style="display : 
    tr += '' + selRequestType
    tr += '<div class="requestTypeConfig" data-type="http">'
    tr += '<input type="checkbox" class="cmdAttr" data-l1key="configuration" data-l2key="noSslCheck" >Ne pas vérifier SSL'
    tr += '<div>'
         
    tr += '<span class="type" type="' + init(_cmd.type) + '">' + jeedom.cmd.availableType() + '<span>'
    tr += '<span class="subType" subType="' + init(_cmd.subType) + '"><span>'
         tr += '<textarea style="height : 95px" class="cmdAttr form-control input-sm" data-l1key="configuration" data-l2key="request"><textarea>'
    tr += '<a class="btn btn-default browseScriptFile cursor input-sm" style="margin-top : 5px"><i class="fa fa-folder-open"><i> <a> '
    tr += '<a class="btn btn-default editScriptFile cursor input-sm" style="margin-top : 5px"><i class="fa fa-edit"><i> <a> '
    tr += '<a class="btn btn-success newScriptFile cursor input-sm" style="margin-top : 5px"><i class="fa fa-file-o"><i> <a> '
    tr += '<a class="btn btn-danger removeScriptFile cursor input-sm" style="margin-top : 5px"><i class="fa fa-trash-o"><i> <a> '
    tr += '<a class="btn btn-warning bt_shareOnMarket cursor input-sm" style="margin-top : 5px"><i class="fa fa-cloud-upload"><i> <a> '
    tr += '<div>'
         
    tr += '<input class="cmdAttr form-control tooltips input-sm" data-l1key="unite"  style="width : 100px" placeholder="" title="">'
    tr += '<input class="tooltips cmdAttr form-control input-sm" data-l1key="configuration" data-l2key="minValue" placeholder="" title=""> '
    tr += '<input class="tooltips cmdAttr form-control input-sm" data-l1key="configuration" data-l2key="maxValue" placeholder="" title="">'
         
    tr += '<span><input type="checkbox" class="cmdAttr" data-l1key="isHistorized" > <br><span>'
         
    .id)) {
    
    }
    
    
    $('#table_cmd tbody').append(tr)
    $('#table_cmd tbody tr:last').setValues(_cmd, '.cmdAttr')

     (.configuration.requestType)) {
        $('#table_cmd tbody tr:last .cmdAttr[data-l1key=configuration][data-l2key=requestType]').value(init(_cmd.configuration.requestType))
        $('#table_cmd tbody tr:last .cmdAttr[data-l1key=configuration][data-l2key=requestType]').trigger('change')
    }

      (.type)) {
        $('#table_cmd tbody tr:last .cmdAttr[data-l1key=type]').value(init(_cmd.type))
    }
     jeedom.cmd.changeType($('#table_cmd tbody tr:last'), init(_cmd.subType))
    initTooltips()
}

:

:

<? include_file('desktop', 'weather', 'js', 'weather') ?>

Le premier argument donne le dossier dans lequel le trouver (attention c’est le dossier père du dossier JS), le deuxième le nom de votre javascript, le troisième indique à Jeedom que c’est un fichier et le dernier dans quel plugin il se trouve.

CSS

Ce dossier contient vos fichiers CSS (il ne devrait pas être trop utilisé) , vo comment les inclure sur votre page :

<? include_file('desktop', 'weather', 'css', 'weather') ?>

.

. ) :

:

$('#md_modal').dialog({title: ""}).load('index.php?v=d&plugin=zwave&modal=show.class&id=' + $('.eqLogicAttr[data-l1key=id]').value()).dialog('open')

La première ligne permet de mettre un titre à votre modal

La deuxième ligne charge votre modal et l’affichage. : plugin, l’ de votre plugin, modal, le nom de votre modal sans le et ensuite les paramètres que vous voulez lui passer

API JS

Ce n’est pas un dossier mais dans les dernières versions de Jeedom celui-ci offre au développeur toute une api javascript (cela évite d’écrire des appels dans tous les sens). J’essayerai de faire un article pour expliquer les différentes fonctionnalités mais vous pouvez déjà trouver le code .

Voilà pour les détails du . Je me doute qu’il n’est pas des plus complets (j’essayerai de le compléter en fonction des différentes demandes reçues) mais j’espère que grâce à lui vous pourrez commencer à faire des plugins pour Jeedom.

Trucs et astuces

Assitant cron

$('body').delegate('.helpSelectCron','click',function() {
  var el = $(this).closest('.schedule').find('.scenarioAttr[data-l1key=schedule]')
  jeedom.getCronSelectModal({},function (result) {
    el.value(result.value)
  })
})

.

:

.

:

PHP

Template

##

)

ajax

:

<?php

.
 *
 * : 
 * 
 * 
 * (.
 *
 * ,
 * 
 * . 
 * .
 *
 * 
 * . If not, see <http:www.gnu.orglicenses>.
 *

 {
    
    

     (!')) {
        
    }

    ') {
        ajax::
    }

     : ', 
    *     * ************************ *
} ) {
    ajax::
}
?>

class

Dossier très important, c’est le moteur de votre plugin. C’est là que viennent les 2 classes obligatoires de votre plugin :

La première devant hériter de la classe eqLogic et la deuxième de cmd. Vo un template :

<?php

.
 *
 * : 
 * 
 * 
 * (.
 *
 * ,
 * 
 * . 
 * .
 *
 * 
 * . If not, see <http:www.gnu.orglicenses>.
 *

* * ***************************Includes********************************* *


class plugin_ extends eqLogic {

    *     * *************************Attributs****************************** *


    *     * ***********************Methode static*************************** *


    *     * *********************Methode d'instance************************* *


    *     * **********************Getteur Setteur*************************** *

}

class plugin_idCmd extends cmd {

    *     * *************************Attributs****************************** *


    *     * ***********************Methode static*************************** *


    *     * *********************Methode d'instance************************* *


    *     * **********************Getteur Setteur*************************** *

}

?>

:

()) {
       (! !'])) {
          
      }
      $eqLogic = $this->getEqLogic()
      $message = ''
      '])) {
          $message = $_options['title'] . '. '
      }
      $message .= $_options['message']
      $http = new com_http($eqLogic->getConfiguration('addrSrvTts') . '?tts=' . urlencode($message))
      
  }

assez simple mais complet, le principe est le suivant, si la commande est une action ou une info (mais pas en événement seulement et que son est dépassé) alors jeedom appelle cette méthode.

Dans notre exemple c’est une commande pour faire parler S.A.R.A.H, où le plugin récupère les paramètres dans $_options (attention c’est un tableau et ses attributs changent en fonction du sous-type de la commande : color pour un sous-type color, slider pour un sous-type slider, title et message pour un sous-type message et vide pour un sous-type other).

Voila pour la partie obligatoire, voila maintenant ce qui peut être utilisé à coté (avec exemple) :

toHtml($_version = ‘dashboard’)

Fonction utilisable dans la commande ou dans l’équipement, en fonction des besoins, vo un exemple pour l’équipement

public function toHtml($_version = 'dashboard') {
    $replace = $this->preToHtml($_version)
     (!is_array($replace)) {
        return $replace
    }
    $version = jeedom::versionAlias($_version)
    $replace['#forecast#'] = ''
     ($version != 'mobile' || $this->getConfiguration('fullMobileDisplay', 0) == 1) {
        $forcast_template = getTemplate('core', $version, 'forecast', 'weather')
        for ($i = 0 $i < 5 $i++) {
            $replaceDay = array()
            $replaceDay['#day#'] = date_fr(date('l', strtotime('+' . $i . ' days')))

             ($i == 0) {
                $temperature_min = $this->getCmd(null, 'temperature_min')
            } else {
                $temperature_min = $this->getCmd(null, 'temperature_' . $i . '_min')
            }
            $replaceDay['#low_temperature#'] = is_object($temperature_min) ? $temperature_min->execCmd() : ''

             ($i == 0) {
                $temperature_max = $this->getCmd(null, 'temperature_max')
            } else {
                $temperature_max = $this->getCmd(null, 'temperature_' . $i . '_max')
            }
            $replaceDay['#hight_temperature#'] = is_object($temperature_max) ? $temperature_max->execCmd() : ''
            $replaceDay['#tempid#'] = is_object($temperature_max) ? $temperature_max->getId() : ''

             ($i == 0) {
                $condition = $this->getCmd(null, 'condition')
            } else {
                $condition = $this->getCmd(null, 'condition_' . $i)
            }
            $replaceDay['#icone#'] = is_object($condition) ? self::getIconFromCondition($condition->execCmd()) : ''
            $replaceDay['#conditionid#'] = is_object($condition) ? $condition->getId() : ''
            $replace['#forecast#'] .= template_replace($replaceDay, $forcast_template)
        }
    }
    $temperature = $this->getCmd(null, 'temperature')
    $replace['#temperature#'] = is_object($temperature) ? $temperature->execCmd() : ''
    $replace['#tempid#'] = is_object($temperature) ? $temperature->getId() : ''

    $humidity = $this->getCmd(null, 'humidity')
    $replace['#humidity#'] = is_object($humidity) ? $humidity->execCmd() : ''

    $pressure = $this->getCmd(null, 'pressure')
    $replace['#pressure#'] = is_object($pressure) ? $pressure->execCmd() : ''
    $replace['#pressureid#'] = is_object($pressure) ? $pressure->getId() : ''

    $wind_speed = $this->getCmd(null, 'wind_speed')
    $replace['#windspeed#'] = is_object($wind_speed) ? $wind_speed->execCmd() : ''
    $replace['#windid#'] = is_object($wind_speed) ? $wind_speed->getId() : ''

    $sunrise = $this->getCmd(null, 'sunrise')
    $replace['#sunrise#'] = is_object($sunrise) ? $sunrise->execCmd() : ''
    $replace['#sunid#'] = is_object($sunrise) ? $sunrise->getId() : ''
     (strlen($replace['#sunrise#']) == 3) {
        $replace['#sunrise#'] = substr($replace['#sunrise#'], 0, 1) . ':' . substr($replace['#sunrise#'], 1, 2)
    } else  (strlen($replace['#sunrise#']) == 4) {
        $replace['#sunrise#'] = substr($replace['#sunrise#'], 0, 2) . ':' . substr($replace['#sunrise#'], 2, 2)
    }

    $sunset = $this->getCmd(null, 'sunset')
    $replace['#sunset#'] = is_object($sunset) ? $sunset->execCmd() : ''
     (strlen($replace['#sunset#']) == 3) {
        $replace['#sunset#'] = substr($replace['#sunset#'], 0, 1) . ':' . substr($replace['#sunset#'], 1, 2)
    } else  (strlen($replace['#sunset#']) == 4) {
        $replace['#sunset#'] = substr($replace['#sunset#'], 0, 2) . ':' . substr($replace['#sunset#'], 2, 2)
    }

    $wind_direction = $this->getCmd(null, 'wind_direction')
    $replace['#wind_direction#'] = is_object($wind_direction) ? $wind_direction->execCmd() : 0

    $refresh = $this->getCmd(null, 'refresh')
    $replace['#refresh_id#'] = is_object($refresh) ? $refresh->getId() : ''

    $condition = $this->getCmd(null, 'condition_now')
    $sunset_time = is_object($sunset) ? $sunset->execCmd() : null
    $sunrise_time = is_object($sunrise) ? $sunrise->execCmd() : null
     (is_object($condition)) {
        $replace['#icone#'] = self::getIconFromCondition($condition->execCmd(), $sunrise_time, $sunset_time)
        $replace['#condition#'] = $condition->execCmd()
        $replace['#conditionid#'] = $condition->getId()
        $replace['#collectDate#'] = $condition->getCollectDate()
    } else {
        $replace['#icone#'] = ''
        $replace['#condition#'] = ''
        $replace['#collectDate#'] = ''
    }
     ($this->getConfiguration('modeImage', 0) == 1) {
        $replace['#visibilityIcon#'] = "none"
        $replace['#visibilityImage#'] = "block"
    } else {
        $replace['#visibilityIcon#'] = "block"
        $replace['#visibilityImage#'] = "none"
    }
    $ = template_replace($replace, getTemplate('core', $version, 'current', 'weather'))
    cache::set('widgetHtml' . $_version . $this->getId(), $html, 0)
    return $html
}

:

)

$_version = jeedom::versionAlias($_version)

Récupération d’un template de commande, le template de commande : pluginsweathercoretemplate$_versionforecast. ($_version valant mobile ou dashboard)

$forcast_template = getTemplate('core', $_version, 'forecast', 'weather')

$html_forecast .= template_replace($replace, $forcast_template)

Cela permet de récupérer la commande ayant le logical_ : temperature_min

$this->getCmd(null, 'temperature_min')

$replace['#temperature#'] = is_object($temperature) ? $temperature->execCmd() : ''

Passage important: cela permet de récupérer les personnalisations faites par l’utilisateur sur la page Générale → Affichage et de les réinjecter dans le template

$parameters = $this->getDisplay('parameters')
 (is_array($parameters)) {
    foreach ($parameters as $key => $value) {
        $replace['#' . $key . '#'] = $value
    }
}

: ).

cache::' . $_version . $this->getId(), $html, 0)

Enfin envoi du à Jeedom :

return $html

. .

. ).

.

###

:

) :

() {
      $weatherCmd = $this->getCmd(null, 'temperature')
       (!)) {
          $weatherCmd = new weatherCmd()
      }
      $weatherCmd->setName(__('Température', __FILE__))
      $weatherCmd->setLogicalId('temperature')
      $weatherCmd->setEqLogic_id($this->getId())
      $weatherCmd->setConfiguration('day', '-1')
      $weatherCmd->setConfiguration('data', 'temp')
      $weatherCmd->setUnite('°C')
      $weatherCmd->setType('info')
      $weatherCmd->setSubType('numeric')
      $weatherCmd->save()

      $cron = cron::byClassAndFunction('weather', 'updateWeatherData', array('weather_id' => intval($this->getId())))
       (!)) {
          $cron = new cron()
          $cron->setClass('weather')
          $cron->setFunction('updateWeatherData')
          $cron->setOption(array('weather_id' => intval($this->getId())))
      }
      $cron->setSchedule($this->getConfiguration('refreshCron', '*30 * * * *'))
      $cron->save()
}

Le début est assez standard avec la création d’une commande, la fin est plus intéressante avec la mise en place d’un cron qui va appeler la méthode weather::updateWeatherData en passant l’ de l’équipement à mettre à jour toute les 30min par défaut.

Ici la méthode updateWeatherData (simplifiée aussi) :

public static function updateWeatherData($_options) {
  $weather = weather::byId($_options['weather_id'])
   (is_object($weather)) {
      foreach ($weather->getCmd('info') as $cmd) {
        $weather->checkAndUpdateCmd($cmd,$cmd->execute())
      }
  }
}

.

:

$weather->checkAndUpdateCmd($cmd,$cmd->execute())

Au moment de la fonction checkAndUpdateCmd (qui permet de signaler à Jeedom une nouvelle mise à jour de la valeur, avec déclenchement de toutes les actions qui doivent être faites : mise à jour du dashboard, vérification des scénarios…​),

Pour la classe commande, un petit truc à savoir si vous utilisez le template de base. Lors de l’envoi de l’équipement Jeedom fait du différentiel sur les commandes et va supprimer celles qui sont en base mais pas dans la nouvelle définition de l’équipement. Voilà comment l’éviter :

public function dontRemoveCmd() {
  return true
}

:

$eqLogic->batteryStatus(56)
Nous utilisons des cookies pour vous garantir la meilleure expérience sur notre site web. Si vous continuez à utiliser ce site, nous supposerons que vous en êtes satisfait.