cadMyDCFacilities/README.md

# cadMyDC - Alternative à Command

*English version below*

**Version:** 2.1\
**Auteur:** Charles-Arthur DAVID\
**Plateforme:** Distech Controls Designer\
**Compatibilité:** Automates Eclypse (Version V2)\
**Version V1** Disponible dans ce projet : https://git.cadjou.net/DistechControls/cadMyDC

## Description

cadMyDC est un projet d'interface graphique automatique pour l'application Designer de Distech Controls.
Il s'adapte aux points contenus dans le programme GFX en affichant les points par type, 
ainsi que les tendances, les programmes horaires, les alarmes et les points en dérogation. 
Il crée une interface utilisateur intuitive ressemblant à MyDC Control pour visualiser et contrôler les points BACnet 
des automates de la gamme Eclypse en version V2 (Facilities).

Ce projet offre une navigation structurée par catégories de points (entrées/sorties analogiques, digitales, multi-états, tendances, programmes horaires, etc.) avec support multilingue (Français/Anglais).

## Fonctionnalités

- **Navigation par catégories** : Organisation automatique des points BACnet par type
  - Entrées Analogiques (Analog Input)
  - Sorties Analogiques (Analog Output)
  - Valeurs Analogiques (Analog Value)
  - Entrées Digitales (Binary Input)
  - Sorties Digitales (Binary Output)
  - Valeurs Digitales (Binary Value)
  - Entrées Multi-états (Multi State Input)
  - Valeurs Multi-états (Multi State Value)
  - Tendances (Trend Log)
  - Programmes Horaires (Schedule)
  - Dérogations (Override)
  - Alarmes (Alarms)

- **Support multilingue** : Interface disponible en Français et Anglais
- **Thème clair/sombre** : Personnalisation de l'apparence selon les préférences
- **Interface responsive** : Adaptation automatique à différentes tailles d'écran

## Prérequis

- Automate **Eclypse V2** (minimum) de Distech Controls
- Accès réseau à l'automate
- **XpressNetwork Utilities** (pour l'importation via XNU) ou accès à l'**interface web Designer**
- **DC Library** (à importer séparément - obligatoire pour le bon fonctionnement du projet)

## Installation

### 1. Téléchargement du projet

Téléchargez la version souhaitée dans la section Paquets:

[cadMyDCFacilities_V2.1.zip](https://git.cadjou.net/api/packages/DistechControls/generic/cadMyDCFacilities/2.1/cadMyDCFacilities_V2.1.zip)

### 2. Importation dans Designer

#### a. Via l'interface web
1. Ouvrez l'interface web **Designer**
2. Dans le menu principal, allez dans **Projet > Importer un projet** (ou **Project > Import Project**)
3. Naviguez jusqu'au dossier qui contient `cadMyDCFacilities_V2.XX.zip`
4. Sélectionnez le fichier zip **cadMyDCFacilities_V2.XX.zip**
5. Cliquez sur **Ok**

#### b. Via XpressNetwork Utilities
1. Ouvrez XpressNetwork Utilities
2. Ajoutez le ou les automates ECY V2 (minimum) soit avec le Find / l'import ou manuellement
3. Sélectionnez le ou les automates souhaités
4. Cliquer sur l'icone Eclypse Designer
3. Naviguez jusqu'au dossier qui contient `cadMyDCFacilities_V2.XX.zip`
4. Sélectionnez le fichier zip **cadMyDCFacilities_V2.XX.zip**
5. Cliquez sur **Ok**

### 3. Importer la DC Library

**IMPORTANT :** Le projet cadMyDCFacilities nécessite impérativement la **DC Library** pour fonctionner correctement.
Il est disponible dans Software Center.
Importez la DC Library de la même manière que le projet cadMyDCFacilities en suivant les mêmes étapes (via l'interface web ou via XpressNetwork Utilities).

## Structure du projet

```
cadMyDC/
├── _proj.json              # Configuration du projet
├── index.dg5               # Page principale avec navigation
├── pages/                  # Pages spécialisées
│   ├── alarms.dg5         # Gestion des alarmes
│   ├── loadingPage.dg5    # Page de chargement
│   ├── noData.dg5         # Page sans données
│   ├── override.dg5       # Gestion des dérogations
│   ├── schedule.dg5       # Gestion des programmes horaires
│   ├── showData.dg5       # Affichage des données
│   └── trend.dg5          # Affichage des tendances
├── palette/                # Widgets personnalisés (vide actuellement)
└── fonts/                  # Polices personnalisées
```

## Utilisation

### Accès à l'interface

Une fois le projet importé et l'automate configuré, accédez à l'interface via le navigateur web en utilisant l'une des URL suivantes :

#### Français
```
https://[IP_AUTOMATE]/viewer.html?proj=cadMyDC&force-redirect=true
```

#### Anglais
```
https://[IP_AUTOMATE]/viewer.html?proj=cadMyDC&force-redirect=true
```

**Note :** Remplacez `[IP_AUTOMATE]` par l'adresse IP de votre automate Eclypse.
**Note :** L'option `force-redirect=true` bloque l'accès aux autres pages web de l'automate si utilisateur n'est pas admin

### Configuration de la page d'accueil utilisateur

Vous pouvez configurer l'URL avec le paramètre de langue dans la **page d'accueil utilisateur** de l'automate pour définir la langue par défaut.

### Navigation

L'interface présente un menu latéral avec toutes les catégories de points détectées automatiquement. Cliquez sur une catégorie pour afficher les points correspondants.

### Visualisation des données

- Les **points standards** (AI, AO, AV, BI, BO, BV, MSI, MSV) affichent leurs valeurs et permettent les modifications (selon les droits)
- Les **tendances** (Trend Log) affichent les graphiques historiques
- Les **programmes** (Schedule) permettent la visualisation et modification des plannings
- Les **dérogations** (Override) permettent de forcer temporairement des valeurs
- Les **alarmes** (Alarms) affichent l'état des alarmes actives

## Dépannage

### Le projet ne s'importe pas

- Vérifiez que vous importez bien le fichier ZIP `cadMyDCFacilities_V2.XX.zip`
- Assurez-vous d'avoir importé la **DC Library** avant ou après le projet
- Vérifiez que votre automate est en version **V2 minimum**

### Aucun point n'apparaît

- Vérifiez que l'automate est bien connecté au réseau
- Vérifiez que votre programme GFX contient des points BACnet
- Actualisez la page du navigateur

### Problème de langue

- Vérifiez que vous utilisez le bon paramètre dans l'URL : `&lan=fr` pour le français
- Pour forcer la langue française, utilisez l'URL complète : `/viewer.html?proj=cadMyDC&lan=fr`
- Sans paramètre de langue, l'interface s'affiche en anglais par défaut

### Le projet ne fonctionne pas correctement

- **Vérifiez impérativement que la DC Library est importée** - c'est la cause la plus fréquente de dysfonctionnement
- Vérifiez les logs dans l'interface Designer pour identifier les erreurs
- Réimportez le projet et la DC Library si nécessaire

## Support et Contribution

**IMPORTANT : Ce projet est un développement personnel indépendant.**

- Ce projet a été développé par Charles-Arthur DAVID à titre personnel
- **Distech Controls n'est pas responsable de ce projet et ne le supporte pas**
- **Aucune demande de support ne sera prise en charge par Distech Controls**
- Distech Controls ne fournit aucune garantie ni assistance technique pour ce projet

### Comment obtenir de l'aide

La **seule façon de remonter un problème ou une suggestion** est de passer par le système de tickets sur Gitea :

**Ouvrir un ticket sur : https://git.cadjou.net/DistechControls/cadMyDCFacilities/issues**

Toute demande de support adressée à Distech Controls concernant ce projet sera refusée.

## Historique des versions

### Version 2.1 (Actuelle)
- Interface de navigation structurée par catégories
- Support multilingue FR/EN (via paramètre URL)
- Thèmes clair/sombre
- Pages spécialisées pour alarmes, tendances, programmes, dérogations
- Auto-découverte des points BACnet
- Compatible Eclypse V2+

---

# cadMyDC - Alternative to Command

*Version française ci-dessus*

**Version:** 2.1\
**Author:** Charles-Arthur DAVID\
**Platform:** Distech Controls Designer\
**Compatibility:** Eclypse Controllers (Version V2)\
**Version V1** Available in this project: https://git.cadjou.net/DistechControls/cadMyDC

## Description

cadMyDC is an automatic graphical interface project for Distech Controls' Designer application.
It adapts to the points contained in the GFX program by displaying points by type,
as well as trends, schedules, alarms, and override points.
It creates an intuitive user interface similar to MyDC Control to view and control BACnet points
from Eclypse controllers in V2 version (Facilities).

This project offers structured navigation by point categories (analog/digital/multi-state inputs/outputs, trends, schedules, etc.) with multilingual support (French/English).

## Features

- **Category-based navigation**: Automatic organization of BACnet points by type
  - Analog Inputs
  - Analog Outputs
  - Analog Values
  - Binary Inputs
  - Binary Outputs
  - Binary Values
  - Multi State Inputs
  - Multi State Values
  - Trend Logs
  - Schedules
  - Overrides
  - Alarms

- **Multilingual support**: Interface available in French and English
- **Light/Dark theme**: Customization of appearance according to preferences
- **Responsive interface**: Automatic adaptation to different screen sizes

## Prerequisites

- Distech Controls **Eclypse V2** controller (minimum)
- Network access to the controller
- **XpressNetwork Utilities** (for import via XNU) or access to **Designer web interface**
- **DC Library** (to be imported separately - mandatory for proper project operation)

## Installation

### 1. Project Download

Download the desired version from the Packages section:

[cadMyDCFacilities_V2.1.zip](https://git.cadjou.net/api/packages/DistechControls/generic/cadMyDCFacilities/2.1/cadMyDCFacilities_V2.1.zip)

### 2. Import into Designer

#### a. Via web interface
1. Open the **Designer** web interface
2. In the main menu, go to **Project > Import Project**
3. Navigate to the folder containing `cadMyDCFacilities_V2.XX.zip`
4. Select the zip file **cadMyDCFacilities_V2.XX.zip**
5. Click **Ok**

#### b. Via XpressNetwork Utilities
1. Open XpressNetwork Utilities
2. Add the ECY V2 controller(s) (minimum) either with Find/Import or manually
3. Select the desired controller(s)
4. Click on the Eclypse Designer icon
3. Navigate to the folder containing `cadMyDCFacilities_V2.XX.zip`
4. Select the zip file **cadMyDCFacilities_V2.XX.zip**
5. Click **Ok**

### 3. Import the DC Library

**IMPORTANT:** The cadMyDCFacilities project absolutely requires the **DC Library** to function correctly.
It is available in the Software Center.
Import the DC Library in the same way as the cadMyDCFacilities project by following the same steps (via web interface or via XpressNetwork Utilities).

## Project Structure

```
cadMyDC/
├── _proj.json              # Project configuration
├── index.dg5               # Main page with navigation
├── pages/                  # Specialized pages
│   ├── alarms.dg5         # Alarms management
│   ├── loadingPage.dg5    # Loading page
│   ├── noData.dg5         # No data page
│   ├── override.dg5       # Override management
│   ├── schedule.dg5       # Schedule management
│   ├── showData.dg5       # Data display
│   └── trend.dg5          # Trends display
├── palette/                # Custom widgets (currently empty)
└── fonts/                  # Custom fonts
```

## Usage

### Interface Access

Once the project is imported and the controller configured, access the interface via web browser using one of the following URLs:

#### French
```
https://[CONTROLLER_IP]/viewer.html?proj=cadMyDC&force-redirect=true
```

#### English
```
https://[CONTROLLER_IP]/viewer.html?proj=cadMyDC&force-redirect=true
```

**Note:** Replace `[CONTROLLER_IP]` with your Eclypse controller's IP address.
**Note:** The `force-redirect=true` option blocks access to other web pages of the controller if the user is not an admin

### User Home Page Configuration

You can configure the URL with the language parameter in the controller's **user home page** to set the default language.

### Navigation

The interface presents a side menu with all automatically detected point categories. Click on a category to display the corresponding points.

### Data Visualization

- **Standard points** (AI, AO, AV, BI, BO, BV, MSI, MSV) display their values and allow modifications (according to rights)
- **Trends** (Trend Log) display historical graphs
- **Schedules** allow viewing and modification of schedules
- **Overrides** allow temporarily forcing values
- **Alarms** display the status of active alarms

## Troubleshooting

### The project does not import

- Verify that you are importing the ZIP file `cadMyDCFacilities_V2.XX.zip`
- Make sure you have imported the **DC Library** before or after the project
- Verify that your controller is version **V2 minimum**

### No points appear

- Verify that the controller is properly connected to the network
- Verify that your GFX program contains BACnet points
- Refresh the browser page

### Language issue

- Verify that you are using the correct parameter in the URL: `&lan=fr` for French
- To force the French language, use the full URL: `/viewer.html?proj=cadMyDC&lan=fr`
- Without a language parameter, the interface displays in English by default

### The project does not work correctly

- **Absolutely verify that the DC Library is imported** - this is the most common cause of malfunction
- Check the logs in the Designer interface to identify errors
- Reimport the project and DC Library if necessary

## Support and Contribution

**IMPORTANT: This project is an independent personal development.**

- This project was developed by Charles-Arthur DAVID on a personal basis
- **Distech Controls is not responsible for this project and does not support it**
- **No support requests will be handled by Distech Controls**
- Distech Controls provides no warranty or technical assistance for this project

### How to Get Help

The **only way to report a problem or suggestion** is through the ticket system on Gitea:

**Open a ticket at: https://git.cadjou.net/DistechControls/cadMyDCFacilities/issues**

Any support request addressed to Distech Controls concerning this project will be refused.

## Version History

### Version 2.1 (Current)
- Category-based navigation interface
- Multilingual support FR/EN (via URL parameter)
- Light/Dark themes
- Specialized pages for alarms, trends, schedules, overrides
- BACnet points auto-discovery
- Compatible with Eclypse V2+

---