Serveur flybox¶
Introduction¶
Flybox console est le logiciel de base de la flybox. Il instancie les contrôleurs du projet puis les modules de chaque contrôleur.
Lancement¶
Flybox s'exécute par défaut en mode console. Si vous voulez l'installer en tant que service Windows, merci de contacter le service technique de Linaware.
- Ouvrir une fenêtre de commandes (CMD) avec les droits d'administrateur
- Aller dans le dossier de base du projet à lancer (dossier qui contient le fichier
flybox.xml
) - Taper
start flybox/console/flybox
Utilisation¶
La console flybox utilise deux modes :
- mode watch : la console affiche les traces générées par les contrôleurs et les modules
- mode command : la console permet la saisie de commande en lignes
Pour passer du mode watch au mode command, utiliser la touche Entrée
du clavier. Le prompt de saisie de commande apparaît.
Dans ce mode, les traces ne sont pas affichées dans la console. Cependant, elle continuent d'être enregistrées dans le fichier des traces.
Pour revenir au mode watch, utiliser la touche Entrée
du clavier sans entrer de commande (commande vide).
Commandes générales¶
Les commandes sont destinées à tous les contrôleurs, à un contrôleur ou à un module. Le prompt indique le destinataire des commandes :
- s'il est vide : la commande sera une commandes pour tous les contrôleurs
- s'il contient le nom d'un controleur : la commande exéctuée par ce contrôleur
Dans cet exemple, le contrôleur mono3 exécutera les commandes du prompt.
- s'il contient le nom d'un contrôleur / le nom d'un module : la commande sera exécuté par ce module
Dans cet exemple, le module USER du contrôleur mono3 exécutera les commandes du prompt.
Par défaut au démarrage, le prompt est positionné sur le premier contrôleur (qui est souvent le seul dans la plupart des projets).
Le déplacement du prompt se fait sur le même principe que le changement de dossier en mode DOS (commandes CD) :
- Pour obtenir la liste des modules du contrôleur :
dir
- Pour se positionner depuis le contrôleur vers un module :
cd nomdumodule
- Pour revenir au contrôleur :
cd ..
- Pour revenir à tous les contrôleurs, taper encore une fois :
cd ..
- Pour se positionner sur un contrôleur :
cd nomducontroleur
Exemple de navigation entre les modules d'un contrôleur nommé MONO3 et ses modules APIMONO3 et USER :
# >CD MONO3 # MONO3>CD .. # >CD MONO3 # MONO3>CD APIMONO3 # MONO3/APIMONO3>CD .. # MONO3>CD USER # MONO3/USER>
- Pour obtenir la liste des modules du contrôleur :
dir
# mono3>DIR MODULE CLASSNAME PATH ------ --------- ---- USER ...hbox.access.BasicUserModule controller\users JOURNAL ...tatelog.BasicStateLogModule controller\journal APIMONO3 ...hbox.modbus.ModbusTcpModule controller\apimono3 MONO3FORMULES ...s.mono3.Mono3FormulesModule controller\formules # mono3>
- Pour obtenir la liste des contrôleurs instanciés : revenir au prompt racine (
cd ..
), puisdir
Commande d'arrêt de la console Flybox¶
- Arrêt de la console flybox :
stop
ouexit
ouquit
Commande pour effacer la console¶
- Effacer la console :
clear
oucls
ouclr
Commande générique des modules¶
Chaque module possède une propriété booléenne watch qui est utilisé dans le code du module pour tracer des messages de mise au point. En affectant la valeur true à cette propriété, cela permet d'obtenir plus de traces de fonctionnement du module. La liste des traces concernées dépend du module. Par exemple, pour le module Modbus RTU, si watch est à true, les échanges avec l'équipement Modbus seront tracées (trames envoyées et trames reçues).
Pour modifier la propriété watch d'un module :
- aller dans le module avec la commande
cd nomdumodule
- taper :
watch
- cette commande inverse la valeur de la propriété watch du module.
Exemple d'utilisation :