Skip to content

Commit

Permalink
[Jenkins] Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed Mar 5, 2025
1 parent 2dda394 commit b3271b9
Show file tree
Hide file tree
Showing 10 changed files with 382 additions and 382 deletions.
2 changes: 1 addition & 1 deletion en_US/dev/core4.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
- :
- :
- :
- . : ::::all()
- .php : ::::all()

- .

Expand Down
2 changes: 1 addition & 1 deletion en_US/dev/core4.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

En v4.1 l'affichage de la sélection de l'objet parent d'un équipement a été revu et unifié. La liste est indentée en fonction du parent, et ordonnée comme dans le menu **Accueil → Dashboard**, tel que définit dans **Outils → Objets**, Vue d'ensemble.

Pour avoir la même logique dans les plugins, fichier plugindesktopphpplugin. :
Pour avoir la même logique dans les plugins, fichier plugindesktopphpplugin.php :

````php
<select id="sel_object" class="eqLogicAttr form-control" data-l1key="object_id">
Expand Down
2 changes: 1 addition & 1 deletion en_US/dev/core4.2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ html
#([0-9]*)#
) {
)) {
(!cmd::))) {
if (!cmd::))) {
$return[] = array(
'?>',
'),
Expand Down
8 changes: 4 additions & 4 deletions en_US/dev/daemon_plugin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -468,7 +468,7 @@ php
{
(!jeedom::
if (!jeedom::
die();
}
Expand All @@ -477,7 +477,7 @@ php
die();
}
$result = json_decode(file_get_contents("php://input"), true);
(!)) {
if (!)) {
die();
}
Expand All @@ -496,7 +496,7 @@ php
:
php
(!jeedom::
if (!jeedom::
die();
}
Expand All @@ -515,7 +515,7 @@ php
php
$result = json_decode(file_get_contents("php://input"), true);
(!)) {
if (!)) {
die();
}
Expand Down
4 changes: 2 additions & 2 deletions en_US/dev/documentation_plugin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Principe

. [](https://doc.jeedom.com/en_US/dev/structure_info_json) ) .
. [here](https://doc.jeedom.com/en_US/dev/structure_info_json) ) .

.

Expand All @@ -30,7 +30,7 @@

### Emplacement

[](https://doc.jeedom.com/en_US/dev/plugin_template) )
[here](https://doc.jeedom.com/en_US/dev/plugin_template) )

). :

Expand Down
78 changes: 39 additions & 39 deletions en_US/dev/plugin_template.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#

[](https:github.comjeedomplugin-template)
[here](https:github.comjeedomplugin-template)

# : l'arborescence

Expand Down Expand Up @@ -46,7 +46,7 @@
## ``info.json``
[](https:doc.jeedom.com/en_US/devstructure_info_json)
[here](https:doc.jeedom.com/en_US/devstructure_info_json)
## ``install.php``
Expand Down Expand Up @@ -83,7 +83,7 @@
() {
$cron = cron::byClassAndFunction('zwave', 'pull')
(!)) {
if (!)) {
$cron = new cron()
$cron->setClass('zwave')
$cron->setFunction('pull')
Expand All @@ -96,7 +96,7 @@
() {
$cron = cron::byClassAndFunction('zwave', 'pull')
(!)) {
if (!)) {
$cron = new cron()
$cron->setClass('zwave')
$cron->setFunction('pull')
Expand Down Expand Up @@ -151,7 +151,7 @@ Ensuite vient le paramètre demandé (il peut en avoir plusieurs), c'est une syn



(!isConnect()) {
if (!isConnect()) {
include_file('desktop', '404', 'php')
die()
}
Expand Down Expand Up @@ -190,21 +190,21 @@ Ensuite vient le paramètre demandé (il peut en avoir plusieurs), c'est une syn

````php
<?php
(!')) {
if (!')) {

}

?>
````

Une fois sur cette page vous aurez accès en à toutes les fonctions du core de jeedom (voir [](https:www.jeedom.comdocdocumentationcode) ) ainsi qu'à celles de tous les modules installés donc le vôtre aussi.
Une fois sur cette page vous aurez accès en php à toutes les fonctions du core de jeedom (voir [here](https:www.jeedom.comdocdocumentationcode) ) 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](http:getbootstrap.com) est applicable.

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

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

. ).
Expand Down Expand Up @@ -235,7 +235,7 @@ Là, par exemple, lors du chargement des données jeedom mettra la valeur du nom

````php
) {
(!)) {
if (!)) {
: {}}
}

Expand Down Expand Up @@ -264,10 +264,10 @@ Dernier point: un exemple plus complet avec type et sous-type de commande :

````php
) {
(!)) {
if (!)) {
var _cmd = {}
}
(!.configuration)) {
if (!.configuration)) {
_cmd.configuration = {}
}
var selRequestType = '<select style="width : 90px" class="cmdAttr form-control input-sm" data-l1key="configuration" data-l2key="requestType">'
Expand Down Expand Up @@ -305,12 +305,12 @@ Dernier point: un exemple plus complet avec type et sous-type de commande :
$('#table_cmd tbody').append(tr)
$('#table_cmd tbody tr:last').setValues(_cmd, '.cmdAttr')
(.configuration.requestType)) {
if (.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)) {
if (.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))
Expand All @@ -330,17 +330,17 @@ Dernier point: un exemple plus complet avec type et sous-type de commande :
- ``saveEqLogic`` :
````php
<? include_file('desktop', 'weather', 'js', 'weather') ?>
<?php 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 :
Ce dossier contient vos fichiers CSS (il ne devrait pas être trop utilisé) , vohere comment les inclure sur votre page :
````php
<? include_file('desktop', 'weather', 'css', 'weather') ?>
<?php include_file('desktop', 'weather', 'css', 'weather') ?>
````
.
Expand All @@ -357,11 +357,11 @@ $('#md_modal').dialog({title: "{{Classe du périphérique}}"}).load('index.php?v
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
La deuxième ligne charge votre modal et l'affichage. : plugin, l' de votre plugin, modal, le nom de votre modal sans le php 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 .
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 here.
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.
Expand Down Expand Up @@ -425,7 +425,7 @@ $('body').delegate('.helpSelectCron','click',function() {
(!')) {
if (!')) {
}
Expand All @@ -448,7 +448,7 @@ Dossier très important, c'est le moteur de votre plugin. C'est là que viennent
- ````
- ``Cmd``
La première devant hériter de la classe eqLogic et la deuxième de cmd. Vo un template :
La première devant hériter de la classe eqLogic et la deuxième de cmd. Vohere un template :
````php
<?php
Expand Down Expand Up @@ -511,7 +511,7 @@ class plugin_idCmd extends cmd {
````php
()) {
(! !'])) {
if (! !'])) {
}
$eqLogic = $this->getEqLogic()
Expand All @@ -527,44 +527,44 @@ class plugin_idCmd extends cmd {
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).
Dans notre exemple here 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
Fonction utilisable dans la commande ou dans l'équipement, en fonction des besoins, vohere un exemple pour l'équipement
````php
public function toHtml($_version = 'dashboard') {
$replace = $this->preToHtml($_version)
(!is_array($replace)) {
if (!is_array($replace)) {
return $replace
}
$version = jeedom::versionAlias($_version)
$replace['#forecast#'] = ''
($version != 'mobile' || $this->getConfiguration('fullMobileDisplay', 0) == 1) {
if ($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) {
if ($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) {
if ($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) {
if ($i == 0) {
$condition = $this->getCmd(null, 'condition')
} else {
$condition = $this->getCmd(null, 'condition_' . $i)
Expand Down Expand Up @@ -592,17 +592,17 @@ public function toHtml($_version = 'dashboard') {
$sunrise = $this->getCmd(null, 'sunrise')
$replace['#sunrise#'] = is_object($sunrise) ? $sunrise->execCmd() : ''
$replace['#sunid#'] = is_object($sunrise) ? $sunrise->getId() : ''
(strlen($replace['#sunrise#']) == 3) {
if (strlen($replace['#sunrise#']) == 3) {
$replace['#sunrise#'] = substr($replace['#sunrise#'], 0, 1) . ':' . substr($replace['#sunrise#'], 1, 2)
} else (strlen($replace['#sunrise#']) == 4) {
} else if (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) {
if (strlen($replace['#sunset#']) == 3) {
$replace['#sunset#'] = substr($replace['#sunset#'], 0, 1) . ':' . substr($replace['#sunset#'], 1, 2)
} else (strlen($replace['#sunset#']) == 4) {
} else if (strlen($replace['#sunset#']) == 4) {
$replace['#sunset#'] = substr($replace['#sunset#'], 0, 2) . ':' . substr($replace['#sunset#'], 2, 2)
}
Expand All @@ -615,7 +615,7 @@ public function toHtml($_version = 'dashboard') {
$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)) {
if (is_object($condition)) {
$replace['#icone#'] = self::getIconFromCondition($condition->execCmd(), $sunrise_time, $sunset_time)
$replace['#condition#'] = $condition->execCmd()
$replace['#conditionid#'] = $condition->getId()
Expand All @@ -625,7 +625,7 @@ public function toHtml($_version = 'dashboard') {
$replace['#condition#'] = ''
$replace['#collectDate#'] = ''
}
($this->getConfiguration('modeImage', 0) == 1) {
if ($this->getConfiguration('modeImage', 0) == 1) {
$replace['#visibilityIcon#'] = "none"
$replace['#visibilityImage#'] = "block"
} else {
Expand All @@ -646,7 +646,7 @@ public function toHtml($_version = 'dashboard') {
$_version = jeedom::versionAlias($_version)
````
Récupération d'un template de commande, le template de commande : pluginsweathercoretemplate\$\_versionforecast. (\$\_version valant mobile ou dashboard)
Récupération d'un template de commande, here le template de commande : pluginsweathercoretemplate\$\_versionforecast. (\$\_version valant mobile ou dashboard)
````php
$forcast_template = getTemplate('core', $_version, 'forecast', 'weather')
Expand Down Expand Up @@ -674,7 +674,7 @@ Passage important: cela permet de récupérer les personnalisations faites par l
````php
$parameters = $this->getDisplay('parameters')
(is_array($parameters)) {
if (is_array($parameters)) {
foreach ($parameters as $key => $value) {
$replace['#' . $key . '#'] = $value
}
Expand Down Expand Up @@ -717,7 +717,7 @@ return $html
````php
() {
$weatherCmd = $this->getCmd(null, 'temperature')
(!)) {
if (!)) {
$weatherCmd = new weatherCmd()
}
$weatherCmd->setName(__('Température', __FILE__))
Expand All @@ -731,7 +731,7 @@ return $html
$weatherCmd->save()
$cron = cron::byClassAndFunction('weather', 'updateWeatherData', array('weather_id' => intval($this->getId())))
(!)) {
if (!)) {
$cron = new cron()
$cron->setClass('weather')
$cron->setFunction('updateWeatherData')
Expand All @@ -749,7 +749,7 @@ Ici la méthode updateWeatherData (simplifiée aussi) :
````php
public static function updateWeatherData($_options) {
$weather = weather::byId($_options['weather_id'])
(is_object($weather)) {
if (is_object($weather)) {
foreach ($weather->getCmd('info') as $cmd) {
$weather->checkAndUpdateCmd($cmd,$cmd->execute())
}
Expand Down
2 changes: 1 addition & 1 deletion en_US/dev/publication_plugin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

##

- [](https://www.jeedom.com/site/fr/dev.html).
- [here](https://www.jeedom.com/site/fr/dev.html).
- .
- ".
- ).
Expand Down
Loading

0 comments on commit b3271b9

Please sign in to comment.