README.md

Mise à jour codec

S'il faut modifier le codec, la marche à suivre est la suivante: (sujet à évolution)

Changement du cœur du codec

La plupart du temps le changement sera dans standard.js ou le [device].js

build mains

On lance rebuild_mains.js ici.

jest tests

On lance run_tests.js ici pour lancer les tests jest sur chaque capteur l'un après l'autre, il plante au premier capteur ayant un payload qui ne fonctionne pas.
c'est là qu'on se sert de debug.js ici afin de tester le payload, puis mettre à jour examples.json.

Si on rencontre un problème entre le decoder et la normalisation, il faudra log des étapes intermédiaires dans le cœur du codec et on utilisera debug_in.js ici.

déploiement

distrib

On exécute copy.js ici.

actility

On doit effectuer un fork de la main branch d'actility dans laquelle on modifie les fichiers javascript du codec dans devices et les fichiers javascript spécifiques dans le dossier [device]_v4, ainsi que example.json.
On push et on ouvre une pull-request une fois sûr que le tout fonctionne. Le script actility_deployement.js facilite cela ici.

ttn

On doit effectuer un fork de la branche main de ttn, puis il suffit de remplacer le [device].js par le main.js, qu'il faut renommer.
On push et on ouvre une pull-request une fois sûr que le tout fonctionne.

npm

On se connecte avec le compte watteco :

    npm login

Pour la première publication (après avoir fait un package.json correct. → voir ici) :

    npm publish

Si le package existe déjà sur le compte watteco, il faut faire une nouvelle révision (patch/minor/major):

    npm version <révision>

On peut ensuite refaire un publish.

Pour télécharger le package, on fait :

    npm install <npm-package>

La liste des packets npm est disponible ici ou sur la liste sur le site npm.

debug

Le fichier debug.js permet d'observer l'entrée et la sortie du codec dans la console.
On l'exécute comme un capteur, mais en rajoutant l'argument device avant :

    node ./codec/debug.js <device> <port> <payload> <date>

Il exécute le fichier javascript du capteur choisit se trouvant dans le dossier distrib.
Si des modifications dans l'arborescance sont effectués, assurez-vous que le chemin d'appel ait encore du sens.

La liste des devices est la suivante :

name
atm'o
clos'o
flash'o
in'o
inclin'o
indoor_temperature
intens'o
lev'o
modbus
monit'o
move'o
outdoor_temperature
pilot_wire
press'o
pulse_sens'o
pulse_sens'o_atex
remote_temperature
remote_temperature_2
smartplug
th
tics'o
toran'o_atex
triphas'o
vaqa'o
vaqa'o_lt
vaqa'o_plus
ventil'o

debug in

Le fichier debug.js permet d'observer l'entrée et la sortie du codec dans la console.
On l'exécute comme un capteur, mais en rajoutant l'argument device avant:

    node ./codec/debug_in.js <device> <port> <payload> <date>

Il exécute le .js du capteur choisit se trouvant dans le dossier devices.
Si des modifications dans l'arborescance sont effectués, assurez-vous que le chemin d'appel ait encore du sens.

La liste des devices est la suivante :

name
atm'o
clos'o
flash'o
in'o
inclin'o
indoor_temperature
intens'o
lev'o
modbus
monit'o
move'o
outdoor_temperature
pilot_wire
press'o
pulse_sens'o
pulse_sens'o_atex
remote_temperature
remote_temperature_2
smartplug
th
tics'o
toran'o_atex
triphas'o
vaqa'o
vaqa'o_lt
vaqa'o_plus
ventil'o

rebuild mains

Le fichier rebuild_mains.js permet de recompiler le main.js de tous les devices.
Il utilise un script rebuild.js dans le dossier scripts.
On rajoute l'utilisation du script dans le package.json de chaque device, sous le nom rebuild.
Il faut aussi rajouter le nom du capteur dans la liste devices.
Son execution doit être faite dans le dossier utilities, car le chemin écrit dans le execSync() est relatif à notre positon :

    node rebuild_mains.js

run tests

Le fichier run_tests.js permet de lancer tous les tests JEST à la suite.
Il faut aussi rajouter le nom du capteur dans la liste devices pour un nouveau capteur.
Son execution doit être faite dans le dossier utilities, car le chemin écrit dans le execSync() est relatif à notre positon :

    node run_tests.js

copy

Le fichier copy.js permet de copier les fichiers souhaités de devices à distrib pour tous les capteurs.
On peut rajouter un autre fichier en rajoutant une autre ligne :

    fs.copyFile(source+"/[file]", dest+"/[file]", (err) => {
        if (err) throw err;
        console.log('[file] was copied to destination');
    })

On peut aussi changer de répertoire en modifiant source ou destination. Le chemin est relatif à la position d'exécution, il faut donc se trouver dans le répertoire utilities pour que cela fonctionne :

    node copy.js

install dependencies

Permet d'installer webpack, webpack-cli et jest pour chaque capteur sans le faire à la main :

    node install_dependencies.js 

actility deployement

Il faut donner le chemin absolu du repo watteco puis celui du fork actility sur votre machine :

    node actility_deployement <watteco-path> <actility-path>

La liste actility_devices est due au changement de nom qu'a fait actility sur certains dossiers (ex: outdoor-temperature).