Skip to content

MatthieuLeboeuf/shutters-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Api qui permet de controller des télécommandes de volets

Installation

Installation

Les télécommandes ayant un fil commun entre les deux boutons je connecte uniquement 3 fils.

Configuration de l'api

Tout d'abord vous pouvez récupérer le fichier build dans les actions github

Ensuite il faut créer un fichier config.json en se basant sur config.example.json.

app_token contient le token d'authentification, app_port le port du serveur web et shutters contient un tableau de tout les volets de cette forme :

  "shutters": [
    {
      "name": "example",
      "up": 1,
      "down": 0,
      "trigger": "low"
    }
  ]

le numéro de up et down correspond au numéro du GPIO, le nom servira pour home assistant et trigger contient soit low ou high ce qui permet de presser le bouton avec tout les relais.

Intégration dans home assistant

Tout d'abord il faut créer une "commande" qui permettera de contacter l'api

Dans le fichier configuration.yaml ajouter ceci :

rest_command:                    
  shutter:                                                       
    url: "http://ip:port/?s={{name}}&p={{position}}"
    headers:                  
      Authorization: !secret shutters_secret

La variable name sert a déterminer le volet et position permet d'envoyer soit up ou down

le token d'accès lui est stocké dans le fichier secrets.yaml :

shutters_secret: "Bearer example"

Ensuite il faut ajouter un nouveau volet toujours dans configuration.yaml :

cover:
  - platform: template
    covers:
      shutter_example:
        device_class: shutter
        friendly_name: "Volet Exemple"
        open_cover:
          service: rest_command.shutter
          data:
            name: "example"
            position: "up"
        close_cover:
          service: rest_command.shutter
          data:
            name: "example"
            position: "down"

About

API to control shutters

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages