Doc widget code v3 à jour

pifou · Février 14, 2020, 6:22

Bonjour,

Je cherche une doc pour les fonctions utilisées dans les widgets v3 et je ne trouve rien…
la doc de base ne donne aucune info si ce n’est qu’il faut des connaissances js / html / css
https://jeedom.github.io/plugin-widget/fr_FR/
Je cherche en particulier les infos sur les objets JS jeedom.cmd.update et jeedom.cmd.execute : quand l’événement est déclenché, quels paramètres / méthodes / attributs, tout ce genre de détail ?

je viens de trouver ceci sur githut avec les classes CSS utiles:

github.com

jeedom/plugin-widget/blob/beta/docs/fr_FR/index.md

# Plugin Widget

Le plugin widget est un plugin un peu particulier, car il ne permet pas de créer des équipements mais de modifier le rendu (affichage) d’une commande. L’objectif de ce plugin est donc de permettre de personnaliser simplement la façon d’afficher une valeur, info, ou action en fonction de ses goûts et désirs.

Depuis la version 1.112 de Jeedom, il est possible de personnaliser les widgets avec des options spécifiques (créées par le développeur du widget). On peut donc avoir un widget qui s’affichera différemment d’une commande à l’autre.

Ainsi, on peut avoir un même widget écrit en bleu sur une commande et en vert sur une autre.

> **Note**
>
> Widget et Tuile, à ne pas confondre.
>
> Le widget, c’est la partie qui va se charger de mettre en forme et afficher une info ou commande. Un widget ne doit s’occuper que d’une seule commande ou info.
>
> La Tuile, c’est un regroupement de widgets pour un module. C’est la zone dans laquelle vont s’afficher les différents widgets appliqués aux commandes et infos du module.

# Installation du plugin Widget 

Comme pour tout plugin, le plugin Widget s’installe depuis l’interface Jeedom, menu "Général"⇒"Plugins"

This file has been truncated. show original

lien vers phpdoc

Salvialf · Février 14, 2020, 6:31

Salut,

La magie de l’open-source:

github.com

jeedom/core/blob/alpha/core/js/cmd.class.js

/* This file is part of Jeedom.
 *
 * Jeedom is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Jeedom is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Jeedom. If not, see <http://www.gnu.org/licenses/>.
 */

jeedom.cmd = function() {};
jeedom.cmd.disableExecute = false;
jeedom.cmd.cache = Array();
if (!isset(jeedom.cmd.cache.byId)) {

This file has been truncated. show original

pifou · Février 14, 2020, 6:45

ça aurait été magique si le code était un tant soi peu commenté… mais la !
En plus, tu es sûr de toi ? parce que je recherchais plutôt du coté widget, ton lien va sur le core
Du coup, question branche pour le core il faut se mettre sur « stablev3 » je suppose. Ou bien sur master?

pour l’instant j’ai pas mieux, merci pour le lien

Salvialf · Février 14, 2020, 6:51

Tu fais une demande technique donc je te donne une réponse technique…

Sinon ne te préoccupes pas des « paramètres / méthodes / attributs et tout ce genre de détail » et inspire toi simplement des widgets du core:

Y’a de quoi faire avec tous ces exemples je pense !! Après y’a pas de secrets: il faut s’y mettre, essayer, se tromper, réussir et à force de coder tout est clair… Il faut savoir que chaque type de commandes à ses spécificités à prendre en compte (normal).

Édit: désolé je viens de capter que tu es en V3 et je n’arrête pas de t’envoyer des liens vers la V4 donc oui sélectionne « stablev3 » ça correspond à la 3.3.39 sauf erreur (pour mon excuse je suis sur le tel)

pifou · Février 14, 2020, 6:57

justement, j’essaye de m’y mettre, j’ai fait un 1er essai j’ai tout cassé et plus rien ne marche c’est pour ça que je recherche des infos mais tu a raison, dans tous les cas aucune doc n’est plus à jour que le code brut! j’y retourne ^^

Salvialf · Février 14, 2020, 6:59

J’oubliais le principal: bien sûr il faut se faire la main sur un jeedom de test pas sur sa production hein?!

Pour relativiser aussi je n’ai aucun formation de développeur, j’essaye d’apprendre grâce à jeedom justement!

pifou · Février 14, 2020, 7:25

ha, moi je suis dev pro, c’est pour ça sans doute que j’ai de mauvais réflexes (genre, chercher de la doc qui n’existe pas…)
A la maison je travaille sur la prod, j’ai qu’1 seul jeedom. Bon, on n’a plus de chauffage depuis hier c’est juste un détail

Salvialf · Février 14, 2020, 7:39

Oh et la VM sur le pc sous virtualbox par exemple !!!

Si je ne dis pas de bêtise il y a bien une API JS mais elle n’est pas documentée:

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 ajax 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 ici.

En étudiant les widgets core ça va rentrer vite pour un dev confrmé !! Et au pire les classes js du 1er lien

Madame doit être contente sans chauffage en février

pifou · Février 15, 2020, 4:15

Bonjour,
aujourd’hui j’ai trouvé la « phpdoc »
bon comme c’est de la doc automatique basée sur les commentaires, évidemment ça fait un peu tout vide c’est bien dommage…

olive · Février 15, 2020, 4:33

Rien ne vaut le bon poêle a bois pas de plugin pas de widget juste un scénario :
Quand il fait froid remet du bois … bon je sort mais ça fonctionne très bien.

Salvialf · Février 15, 2020, 4:36

Tu prêche un convaincu je chauffe principalement au poêle à bois aussi

Par contre les ordres ne passent pas toujours bien du contrôleur (ma femme) au module actionneur (moi) concernant l’action: il faut rentrer du bois !

pifou · Février 15, 2020, 4:38

non madame ne se plaint pas, depuis qu’elle peut actionner les chauffages et les lumières sans se lever du canapé, et ça, au moins, ça marche

pifou · Février 16, 2020, 5:49

alors une petite question supplémentaire: j’ai fait mon widget (sur la base du multi-state existant) mais je n’ai plus la sélection de la valeur au chargement de la page. Quand la page charge aucune valeur n’est en surbrillance.
Ensuite je peux sélectionner les valeurs, ça modifie bien l’info (un slider donc) mais le 0 ne marche pas, je sais pas pourquoi, alors que toutes les autres valeurs fonctionnent bien!

voici mon code actuel, j’ai blindé de log pour vérifier et je ne comprends pas pourquoi le 0 ne marche pas:


 $( function() {
	console.log("init uid(#uid#) id(#id#) logicalId(#logicalId#) name(#name#) name_display(#name_display#) hideCmdName(#hideCmdName#) maxValue(#maxValue#)"
	+ " valueName(#valueName#) lastValue(#lastValue#) unite(#unite#) collectDate(#collectDate#) state(#state#) ");
	// remove radio button
    $( ".classSwitch6Ways#uid# input" ).checkboxradio({
      icon: false
    });
	// on label click, execute jeedom
    $('.switch2#uid#').each( function(index) {
	  $(this).on('click', function() {
	    console.log('click sur label #id# valeur=' + index);
	    jeedom.cmd.execute({id: '#id#', value: (index)});
	  });
	});
	// set the selected value
	$("input[type='radio'][name='key#uid#'][value='#state#']").attr('checked', 'checked');
  });
  
  jeedom.cmd.update['#id#'] = function(_options){
	console.log(_options);
  }
  
	jeedom.cmd.update['#id#']({display_value:'#state#',valueDate:'#valueDate#',collectDate:'#collectDate#',alertLevel:'#alertLevel#'});