Skip to main content

FRDomoticz

Le package pour simplifier le contrôle de la Freebox Révolution avec Domoticz

Exemples - Reporter un bug

TABLE DES MATIÈRES
  1. A propos du projet
  2. Commencer
  3. Utilisation
  4. Contribuer
  5. Licence
  6. Contact

A propos du projet

Tout d'abord, mon souhait était de faire de domoticz une télécommande personnalisée pour mon freebox player. J'avais envie d'appuyer sur un seul bouton pour lancer ma station radio préférée, ma série en replay, etc...

Après s'être rendu compte que la tâche de programmation était rébarbative, mais que le résultat était à la hauteur de mes attentes. J'ai décidé de simplifier mon code afin de faire une "librairie".

C'est ainsi que de fil en aiguille, j'ai créé ce package qui, pourquoi pas, pourrait intéresser l'un d'entre vous.

Ce projet est en constante évolution, n'hésitez pas à me faire part de vos remarques afin d'améliorer le code.

Commencer

L'installation du package est très simple, il suffit de bien suivre les instructions ci-dessous. Si vous rencontrer un problème, n'hésitez pas à créer un ticket.

Prérequis

Afin d'installer le package, il est nécessaire de vérifier que Python et PIP soit bien installé.

  • Python > 3.0
    python --version
    
  • PIP
    pip --version
    
  • Package "time"
  • Package "requests"

Installation

Une fois les prérequis respectés, il suffit de lancer la commande suivante :

pip install frdomoticz

Utilisation

Afin d'utiliser au mieux le package, merci de suivre les instructions ci-dessous. Si vous le souhaitez, vous pouvez également utiliser les exemples du repo.

Code télécommande

Afin d'obtenir le code télécommande nécessaire dans le script, il faut suivre les étapes ci-dessous :

  1. Avec la télécommande de votre Freebox révolution, allez dans "Réglages" puis "Système" puis "Informations Freebox Player et Server" et pour terminer "Player"

  2. Récupérez le code télécommande réseau qui se trouve dans les lignes de droite. Ce dernier sera à intégrer dans vos futurs scripts.

Préparation du script shell

  1. Dans le dossier ci-dessous, créez un nouveau script shell "exec.sh".

    /domoticz/scripts/exec.sh
    

    Ce dernier permettra de lancer nos divers scripts python sans interrompre domoticz.

  2. Dans ce fichier, placez les lignes de code suivantes :

     #! /bin/sh
     /usr/bin/python /home/pi/domoticz/scripts/$1.py $2 $3 > /dev/null 2>&1 &
    

Script python

  1. Toujours dans le dossier "script" de domoticz, créez un nouveau script python.
    /domoticz/scripts/nom_du_script.py
    
  2. Ensuite, importez la librairie dans votre script avec la ligne suivante :
     from frdomoticz import lib
    
  3. Puis, renseignez le code de votre télécommande :
      code = 123456789 
    
  4. Pour terminer, insérez les différentes ligne de code correspondantes à votre demande :
      lib.init(code) # Initialise le player sur la page d'accueil
      lib.radio(code) # Sélectionne le menu Radio du player
      lib.down(code)  # Simule un appui sur la touche bas de la télécommande.
    

Domoticz

  1. Dans l'onglet "Configuration" puis dans "Matériel", créer un nouveau matériel de type "Dummy" ayant le nom que vous souhaitez (par ex. "Télécommande freebox")

  2. Ensuite, créer cliquer sur "Créer un capteur virtuel" et vous sélectionnerez le type "Interrupteur".

  3. Retrouvez l'interrupteur que vous venez de créer dans l'onglet "Interrupteurs" puis sélectionnez "Modifier".

  4. Configurez le type de l'interrupteur en "Push On Button" puis dans "Action On" renseignez le nom de votre script python :

      script://exec.sh nom_du_script.py
    
  5. Domoticz est maintenant configuré pour éxécuter le script python à chaque fois que vous appuyerez sur l'interrupteur.

Contribuer

Les contributions sont ce qui fait de la communauté open source un endroit incroyable pour apprendre, inspirer et créer. Toutes les contributions que vous apportez sont très appréciées.

  1. "Forker" le projet
  2. Créer une nouvelle "Branch" (git checkout -b feature/AmazingFeature)
  3. Validez vos modifications (git commit -m 'Add some AmazingFeature')
  4. "Push" la nouvelle "Branch" (git push origin feature/AmazingFeature)
  5. Ouvrir une "Pull Request"

Licence

Distribué sous la licence "GNU General Public License v3 (GPLv3)". Voir Licence pour plus d'informations.

Contact

MatthieuF44 - mattdevue[at]gmail.com

Lien du projet : https://github.com/MatthieuF44/frdomoticz/

Metadata

Release files for frdomoticz 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for frdomoticz 0.0.3
File Size Uploaded Provenance Actions
frdomoticz-0.0.3.tar.gz 17.6 kB Without provenance Details for frdomoticz-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for frdomoticz 0.0.3
File Interpreter ABI Platform Actions
frdomoticz-0.0.3-py3-none-any.whl Python 3 none any Details for frdomoticz-0.0.3-py3-none-any.whl

Total release size: 35.3 kB

Release files / frdomoticz-0.0.3.tar.gz

Download URL frdomoticz-0.0.3.tar.gz
Size 17.6 kB
Tags Source
SHA-256 checksum
How to use checksums
39fc1704cde1f3064338f20ce506e2684bf84985fbd5b7030a93c4fb5a0df3dd
BLAKE2b-256 checksum
How to use checksums
27c1c480bc7471cfffbd761960e36ecbdeb7e97b2687eaf04b680605b4bcef68
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

Release files / frdomoticz-0.0.3-py3-none-any.whl

Download URL frdomoticz-0.0.3-py3-none-any.whl
Size 17.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e8f9ad16c865de5465f13f9904dbdaf37f0322e3b6457ed73ea7e7350b6b87ce
BLAKE2b-256 checksum
How to use checksums
44c9d32ea07f191dd52f12c73d9c39c7ab6683ff9bd1d6304707ec20f80f3177
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

Security for frdomoticz 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page