girouettes 0.1.0__tar.gz

girouettes-0.1.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: girouettes
+Version: 0.1.0
+Summary: Pilotage de girouettes LED Hanover et Mobitec via une API Python unifiee.
+Project-URL: Homepage, https://github.com/Ymo90/girouettes
+Project-URL: Repository, https://github.com/Ymo90/girouettes
+Keywords: rs485,hanover,mobitec,led,girouette
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pyserial
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# test_girouette
+
+Projet Python pour piloter des girouettes LED Hanover et Mobitec avec une API unifiee en francais.
+
+## Structure
+
+- girouette/
+  - __init__.py
+  - erreurs.py
+  - hanover.py
+  - mobitec.py
+  - generique.py
+- tests/
+  - conftest.py
+  - test_hanover.py
+  - test_mobitec.py
+  - test_generique.py
+- examples/
+  - demo_generique.py
+  - demo_horloge.py
+  - demo_lecture_texte.py
+  - demo_lecture_continue.py
+- docs/
+  - guide_debutant.md
+  - guide_superx_1_3.pdf
+  - hanover_communication_protocol.txt
+  - hanover_communications_protocol_0_14.pdf
+  - mobitec_protocol.md
+  - superx.txt
+
+## Installation
+
+1. Creer et activer un environnement virtuel Python.
+2. Installer les dependances d'execution:
+
+```bash
+pip install -r requirements.txt
+```
+
+3. (Optionnel) Installer aussi les dependances de developpement/tests:
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+## Lancer les tests
+
+```bash
+pytest -q tests/test_hanover.py tests/test_mobitec.py tests/test_generique.py
+```
+
+## Lancer les exemples
+
+Exemple principal (API unifiee):
+
+```bash
+python examples/demo_generique.py
+```
+
+Exemple horloge:
+
+```bash
+python examples/demo_horloge.py
+```
+
+Exemple lecture/affichage d'un texte:
+
+```bash
+python examples/demo_lecture_texte.py "Prochain depart 12:05"
+```
+
+Exemple lecture continue (mise a jour a chaque saisie):
+
+```bash
+python examples/demo_lecture_continue.py
+```
+
+## Utilisation rapide
+
+```python
+from girouette.generique import GirouetteGenerique
+
+with GirouetteGenerique(
+    port="COM5",
+    type_backend="hanover",  # ou "mobitec"
+    adresse=2,
+    vitesse=4800,
+) as g:
+    g.afficher_texte("BONJOUR", alignement_h="centre")
+```
+
+Acces direct backend Hanover (avance):
+
+```python
+from girouette.hanover import GirouetteHanover
+
+with GirouetteHanover("COM5", adresse=2) as g:
+  g.afficher("LIGNE 42")
+```
+
+Acces direct backend Mobitec (avance):
+
+```python
+from girouette.mobitec import GirouetteMobitec, Police, AlignementHorizontal
+
+with GirouetteMobitec("COM5") as g:
+  g.display_text("LIGNE 42", alignment=AlignementHorizontal.CENTRE, font=Police.MOYENNE_13PX)
+```
+
+## Notes
+
+- L'API debutant commune expose: afficher_texte, afficher_deux_lignes, afficher_defilant, effacer, regler_luminosite, lire_statut.
+- Certaines fonctions dependent du backend materiel. Si une fonction n'est pas supportee, une exception explicite est levee.
+- Pour afficher_defilant, la semantique de vitesse differe selon le backend: Mobitec accepte un delai float (ex. 0.08), alors que Hanover n'applique qu'un parametre entier >= 1.
+- Cote Mobitec, les enums francais sont disponibles: `Police`, `AlignementHorizontal`.
+- Les anciens noms anglais restent valides pour compatibilite: `Font`, `Alignment`.
+
+## Mobitec avance (noms francais)
+
+En acces direct backend Mobitec, privilegier les methodes francaises:
+
+- afficher_multiligne(...)
+- afficher_pixels(...)
+- afficher_clignotant(...)
+- afficher_machine_a_ecrire(...)
+- arreter_animation()
+
+Les noms anglais historiques sont conserves pour retrocompatibilite
+(display_multiline, display_pixel_art, display_blinking, display_typewriter,
+stop_current_animation).
+
+## Publier sur PyPI
+
+1. Mettre a jour la version dans `pyproject.toml` et `girouette/__init__.py`.
+2. Installer les outils de build:
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+3. Generer les artefacts:
+
+```bash
+python -m build
+```
+
+4. Verifier les artefacts:
+
+```bash
+python -m twine check dist/*
+```
+
+5. Publier (token PyPI recommande):
+
+```bash
+python -m twine upload dist/*
+```

girouettes-0.1.0/README.md

@@ -0,0 +1,157 @@
+# test_girouette
+
+Projet Python pour piloter des girouettes LED Hanover et Mobitec avec une API unifiee en francais.
+
+## Structure
+
+- girouette/
+  - __init__.py
+  - erreurs.py
+  - hanover.py
+  - mobitec.py
+  - generique.py
+- tests/
+  - conftest.py
+  - test_hanover.py
+  - test_mobitec.py
+  - test_generique.py
+- examples/
+  - demo_generique.py
+  - demo_horloge.py
+  - demo_lecture_texte.py
+  - demo_lecture_continue.py
+- docs/
+  - guide_debutant.md
+  - guide_superx_1_3.pdf
+  - hanover_communication_protocol.txt
+  - hanover_communications_protocol_0_14.pdf
+  - mobitec_protocol.md
+  - superx.txt
+
+## Installation
+
+1. Creer et activer un environnement virtuel Python.
+2. Installer les dependances d'execution:
+
+```bash
+pip install -r requirements.txt
+```
+
+3. (Optionnel) Installer aussi les dependances de developpement/tests:
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+## Lancer les tests
+
+```bash
+pytest -q tests/test_hanover.py tests/test_mobitec.py tests/test_generique.py
+```
+
+## Lancer les exemples
+
+Exemple principal (API unifiee):
+
+```bash
+python examples/demo_generique.py
+```
+
+Exemple horloge:
+
+```bash
+python examples/demo_horloge.py
+```
+
+Exemple lecture/affichage d'un texte:
+
+```bash
+python examples/demo_lecture_texte.py "Prochain depart 12:05"
+```
+
+Exemple lecture continue (mise a jour a chaque saisie):
+
+```bash
+python examples/demo_lecture_continue.py
+```
+
+## Utilisation rapide
+
+```python
+from girouette.generique import GirouetteGenerique
+
+with GirouetteGenerique(
+    port="COM5",
+    type_backend="hanover",  # ou "mobitec"
+    adresse=2,
+    vitesse=4800,
+) as g:
+    g.afficher_texte("BONJOUR", alignement_h="centre")
+```
+
+Acces direct backend Hanover (avance):
+
+```python
+from girouette.hanover import GirouetteHanover
+
+with GirouetteHanover("COM5", adresse=2) as g:
+  g.afficher("LIGNE 42")
+```
+
+Acces direct backend Mobitec (avance):
+
+```python
+from girouette.mobitec import GirouetteMobitec, Police, AlignementHorizontal
+
+with GirouetteMobitec("COM5") as g:
+  g.display_text("LIGNE 42", alignment=AlignementHorizontal.CENTRE, font=Police.MOYENNE_13PX)
+```
+
+## Notes
+
+- L'API debutant commune expose: afficher_texte, afficher_deux_lignes, afficher_defilant, effacer, regler_luminosite, lire_statut.
+- Certaines fonctions dependent du backend materiel. Si une fonction n'est pas supportee, une exception explicite est levee.
+- Pour afficher_defilant, la semantique de vitesse differe selon le backend: Mobitec accepte un delai float (ex. 0.08), alors que Hanover n'applique qu'un parametre entier >= 1.
+- Cote Mobitec, les enums francais sont disponibles: `Police`, `AlignementHorizontal`.
+- Les anciens noms anglais restent valides pour compatibilite: `Font`, `Alignment`.
+
+## Mobitec avance (noms francais)
+
+En acces direct backend Mobitec, privilegier les methodes francaises:
+
+- afficher_multiligne(...)
+- afficher_pixels(...)
+- afficher_clignotant(...)
+- afficher_machine_a_ecrire(...)
+- arreter_animation()
+
+Les noms anglais historiques sont conserves pour retrocompatibilite
+(display_multiline, display_pixel_art, display_blinking, display_typewriter,
+stop_current_animation).
+
+## Publier sur PyPI
+
+1. Mettre a jour la version dans `pyproject.toml` et `girouette/__init__.py`.
+2. Installer les outils de build:
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+3. Generer les artefacts:
+
+```bash
+python -m build
+```
+
+4. Verifier les artefacts:
+
+```bash
+python -m twine check dist/*
+```
+
+5. Publier (token PyPI recommande):
+
+```bash
+python -m twine upload dist/*
+```

girouettes-0.1.0/girouette/__init__.py

@@ -0,0 +1,40 @@
+"""API publique du package girouette."""
+
+__version__ = "0.1.0"
+
+from girouette.erreurs import (
+	ErreurCapaciteNonSupportee,
+	ErreurConnexion,
+	ErreurGirouette,
+	ErreurParametre,
+	ErreurProtocole,
+)
+from girouette.generique import GirouetteGenerique
+from girouette.hanover import Girouette, GirouetteHanover
+from girouette.mobitec import (
+	AlignementHorizontal,
+	Alignment,
+	DisplayConfig,
+	Font,
+	GirouetteMobitec,
+	MobitecDisplay,
+	Police,
+)
+
+__all__ = [
+	"Alignment",
+	"AlignementHorizontal",
+	"DisplayConfig",
+	"ErreurCapaciteNonSupportee",
+	"ErreurConnexion",
+	"ErreurGirouette",
+	"ErreurParametre",
+	"ErreurProtocole",
+	"Font",
+	"Girouette",
+	"GirouetteHanover",
+	"GirouetteGenerique",
+	"GirouetteMobitec",
+	"MobitecDisplay",
+	"Police",
+]

girouettes-0.1.0/girouette/erreurs.py

@@ -0,0 +1,21 @@
+"""Exceptions metier pour le pilotage de girouettes."""
+
+
+class ErreurGirouette(Exception):
+    """Exception de base du domaine girouette."""
+
+
+class ErreurConnexion(ErreurGirouette):
+    """Connexion serie indisponible, timeout, ou absence de reponse."""
+
+
+class ErreurParametre(ErreurGirouette, ValueError):
+    """Parametre utilisateur invalide."""
+
+
+class ErreurProtocole(ErreurGirouette):
+    """Donnee ou trame incompatible avec le protocole."""
+
+
+class ErreurCapaciteNonSupportee(ErreurGirouette, NotImplementedError):
+    """Fonction demandee non supportee par le materiel cible."""

girouettes-0.1.0/girouette/generique.py

@@ -0,0 +1,116 @@
+"""Facade generique en francais pour piloter Hanover ou Mobitec."""
+
+from typing import Literal
+
+from girouette.hanover import GirouetteHanover
+from girouette.mobitec import DisplayConfig, GirouetteMobitec
+from girouette.erreurs import ErreurParametre
+
+
+TypeBackend = Literal["hanover", "mobitec"]
+
+
+class GirouetteGenerique:
+    """
+    API unifiee et pedagogique pour debutants.
+
+    Meme surface de methodes quel que soit le materiel physique:
+    - afficher_texte
+    - afficher_deux_lignes
+    - afficher_defilant
+    - effacer
+    - regler_luminosite
+    - lire_statut
+    """
+
+    def __init__(
+        self,
+        port: str,
+        type_backend: TypeBackend,
+        adresse: int = 1,
+        vitesse: int = 4800,
+        timeout: float = 1.0,
+        largeur: int = 112,
+        hauteur: int = 16,
+    ):
+        """
+        Initialise une girouette avec un backend explicite.
+
+        Parametres:
+            port: port serie, par exemple COM5
+            type_backend: hanover ou mobitec
+            adresse: adresse logique de l'afficheur
+            vitesse: debit en bauds
+            timeout: timeout de communication en secondes
+            largeur: largeur en pixels (utile pour Mobitec)
+            hauteur: hauteur en pixels (utile pour Mobitec)
+        """
+        self.backend = type_backend
+
+        if type_backend == "hanover":
+            self._impl = GirouetteHanover(port=port, adresse=adresse, vitesse=vitesse, timeout=timeout)
+        elif type_backend == "mobitec":
+            config = DisplayConfig(width=largeur, height=hauteur, address=adresse)
+            self._impl = GirouetteMobitec(port=port, config=config, baudrate=vitesse, timeout=timeout)
+        else:
+            raise ErreurParametre("type_backend doit valoir 'hanover' ou 'mobitec'.")
+
+    def __enter__(self):
+        """Support du bloc with."""
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Fermeture automatique du port serie en sortie de bloc with."""
+        self.fermer()
+
+    def fermer(self):
+        """Ferme proprement la connexion selon le backend choisi."""
+        if hasattr(self._impl, "fermer"):
+            self._impl.fermer()
+            return
+        if hasattr(self._impl, "close"):
+            self._impl.close()
+            return
+
+    def afficher_texte(self, texte: str, alignement_h: str = "centre", alignement_v: str = "centre") -> bool:
+        """Affiche un texte simple."""
+        if self.backend == "hanover":
+            return self._impl.afficher_texte(texte=texte, alignement_h=alignement_h)
+        return self._impl.afficher_texte(
+            texte=texte,
+            alignement_h=alignement_h,
+            alignement_v=alignement_v,
+        )
+
+    def afficher_deux_lignes(self, ligne1: str, ligne2: str, alignement_h: str = "centre") -> bool:
+        """Affiche un texte sur deux lignes."""
+        return self._impl.afficher_deux_lignes(ligne1=ligne1, ligne2=ligne2, alignement_h=alignement_h)
+
+    def afficher_defilant(self, texte: str, vitesse: float = 0.1,
+                          direction: str = "gauche", bloquant: bool = False) -> bool:
+        """
+        Affiche un texte defilant.
+
+        Note compatibilite backend:
+        - Mobitec interprete `vitesse` comme delai entre frames (float, ex. 0.08).
+        - Hanover ne supporte pas ce mode temporel: seul un parametre SuperX
+          entier est transmis quand `vitesse >= 1`.
+        """
+        return self._impl.afficher_defilant(
+            texte=texte,
+            vitesse=vitesse,
+            direction=direction,
+            bloquant=bloquant,
+        )
+
+    def effacer(self) -> bool:
+        """Efface l'afficheur."""
+        return self._impl.effacer()
+
+    def regler_luminosite(self, valeur: int) -> bool:
+        """Regle la luminosite si la fonction est supportee."""
+        return self._impl.regler_luminosite(valeur)
+
+    def lire_statut(self) -> dict:
+        """Lit le statut si la fonction est supportee."""
+        return self._impl.lire_statut()