Aller au contenu principal

Intégration domotique STM Montréal, gratuite et open source

Intégration STM Montréal pour Gladys Assistant

Prochains passages d'autobus STM, état du métro et stations BIXI à Montréal.

Voir sur GitHubToutes les intégrations externes

Les prochains autobus de la STM, l'état du métro et les vélos BIXI près de chez vous, dans Gladys.

Cette intégration n'est affiliée ni à la Société de transport de Montréal (STM) ni à BIXI Montréal.

Démarrer en 3 étapes​

Aucune connaissance technique n'est nécessaire, et aucun compte non plus pour commencer.

  1. Vérifiez l'adresse de votre maison dans Gladys : Paramètres → Maisons. La maison doit avoir une position sur la carte. L'intégration s'en sert pour trouver les arrêts proches de chez vous. La position reste dans votre Gladys.
  2. Installez l'intégration depuis le catalogue des intégrations, et acceptez l'accès à la position de la maison. Ouvrez sa page de configuration et cliquez sur Enregistrer, sans rien remplir.
  3. Ouvrez l'onglet Découverte de l'intégration. Les 3 arrêts d'autobus et les 2 stations BIXI les plus proches de chez vous y sont proposés, avec leur nom et la direction des lignes, par exemple « Bus – Notre-Dame / Peel (36 → Ouest) ». Cliquez sur Ajouter pour chacun de ceux qui vous intéressent.

C'est tout. Vous avez maintenant, pour chaque arrêt, les horaires prévus des prochains autobus, et pour chaque station BIXI, les vélos et les places libres.

Le message en haut de la page de configuration indique toujours la prochaine chose à faire. Par exemple : « Prêt : 3 arrêts et 2 stations BIXI à ajouter. Ouvrez l'onglet Découverte… ».

Les noms des appareils commencent par Bus – ou BIXI –, pour les reconnaître d'un coup d'œil dans la liste des appareils de Gladys. Vous pouvez les renommer librement dans Gladys.

Afficher les passages sur le tableau de bord​

  1. Ouvrez le tableau de bord, puis cliquez sur Modifier.
  2. Ajoutez un widget et choisissez Passages d'autobus STM.
  3. Choisissez l'arrêt, puis enregistrez.

Le widget Station BIXI s'ajoute de la même façon. Le widget État du métro STM demande une clé STM (voir plus bas).

Les horaires prévus sont marqués d'un ~, comme sur les panneaux de la STM : « ~12 min » signifie « prévu dans 12 minutes ».

Passer au temps réel et ajouter le métro (facultatif)​

Avec une clé d'API STM, gratuite et personnelle :

  • les horaires prévus deviennent des prédictions en temps réel (la position réelle des autobus) ;
  • l'appareil Métro STM apparaît, avec l'état des lignes verte, orange, jaune et bleue.

Obtenir la clé d'API STM (5 minutes)​

  1. Allez sur le portail développeurs de la STM et créez un compte (adresse courriel et mot de passe). Confirmez le courriel que vous recevez.
  2. Une fois connecté, ajoutez une application. Le nom n'a pas d'importance, par exemple « Gladys maison ».
  3. Dans cette application, abonnez-vous aux deux API :
    • GTFS-realtime : les passages des autobus en temps réel ;
    • i3 : l'état du service du métro.
  4. Créez une clé, puis publiez-la. Le portail affiche une « clé d'API » et un « secret partagé ». Seule la clé d'API est nécessaire.
  5. Dans Gladys, ouvrez la configuration de l'intégration. Collez la clé dans Clé d'API STM, puis cliquez sur Enregistrer.
  6. Cliquez sur Tester la clé d'API STM. Les deux lignes doivent afficher ✔. Une ligne ✖ indique quelle API manque dans votre application.
  7. Retournez dans l'onglet Découverte et ajoutez l'appareil Métro STM.

Les libellés du portail STM peuvent varier légèrement : en cas de doute, la FAQ du portail décrit les mêmes étapes.

Quota. La STM accorde 10 000 requêtes par jour et par compte. Avec les réglages par défaut, l'intégration en utilise environ 2 200, quel que soit le nombre d'arrêts : une seule lecture des données de la STM sert tous vos arrêts. Le message de la page de configuration affiche l'estimation pour votre installation.

Surveiller d'autres arrêts (travail, école…)​

Pour un arrêt loin de chez vous :

  1. En bas de la page de configuration, cliquez sur Chercher un arrêt. Tapez une intersection, par exemple « Sherbrooke Papineau ».
  2. La réponse liste les arrêts avec leur code et la direction de leurs lignes, par exemple 52682 — Papineau / Sherbrooke (24 → Est, 45 → Sud).
  3. Copiez le code (52682) dans Arrêts d'autobus, enregistrez, puis ajoutez l'arrêt dans l'onglet Découverte.

Le code est aussi le numéro à cinq chiffres inscrit sur chaque panneau d'arrêt de la STM.

Pour les stations BIXI, le bouton Chercher une station BIXI fonctionne de la même façon.

Pour aller plus loin​

Le champ Arrêts d'autobus accepte plusieurs codes séparés par des virgules, un filtre de lignes après @ et un nom après :.

SaisieSignification
52743tous les autobus qui passent à l'arrêt 52743
51003@24seulement la ligne 24
61503@69|469les lignes 69 et 469
51003@24:Bus du travailligne 24, affiché sous le nom « Bus du travail »

Ce que contient chaque appareil​

Arrêt d'autobus :

  • Prochain passage, Passage 2… : les minutes d'attente. 999 signifie qu'aucun passage n'est prévu.
  • Ligne du prochain passage… : le numéro de ligne.
  • Prochains passages : un résumé, par exemple 24 3 min · 747 14 min.

Métro STM (avec une clé) : pour chaque ligne, un état (Normal, Perturbé, Avis ou Inconnu) et le message de la STM. La STM ne publie pas d'horaires des rames en temps réel : seul l'état des lignes est disponible.

Station BIXI : les vélos (électriques compris), les vélos électriques, les points d'ancrage libres et l'état de la station.

Une partie des stations BIXI est retirée chaque hiver. Une station qui disparaît du réseau affiche 0 vélo, 0 place et l'état « Retirée du réseau BIXI (saisonnier ?) », avec un point orange sur l'appareil. Le déclencheur « Hors service » se déclenche une fois, puis « Remise en service » quand la station revient au printemps. Il n'y a rien à faire : l'appareil reprend tout seul. Pendant son absence, la station n'est vérifiée que toutes les 15 minutes.

Scènes​

Déclencheurs :

  • Autobus STM imminent : un autobus passe sous 1, 2, 3, 5, 10 ou 15 minutes. Exemple : « quand le 24 est à 5 minutes, allumer la lampe de l'entrée ».
  • État du métro STM modifié : une ligne est perturbée, revient à la normale, ou reçoit un avis. Exemple : « si la ligne orange est perturbée, m'envoyer un message ».
  • Station BIXI modifiée : la station n'a plus de vélos ou de places, ou en retrouve.

Actions :

  • Lire les prochains autobus STM : par exemple, un message chaque matin « Ton 24 passe dans {{minutes}} minutes ».
  • État d'une ligne de métro : renvoie l'état, le message de la STM et normal (vrai ou faux).

Dépannage​

Message ou symptômeQue faire
« indiquez l'adresse de votre maison »Paramètres → Maisons : placez la maison sur la carte, puis enregistrez à nouveau la configuration de l'intégration.
« Gladys n'a pas partagé la position de votre maison »Réinstallez l'intégration et acceptez l'accès à la position, ou tapez des codes d'arrêt.
Rien dans l'onglet DécouverteLisez le message de la page de configuration : il dit ce qui manque.
« La STM a refusé la clé d'API »Vérifiez la clé, et que l'application est abonnée aux deux API (GTFS-realtime et i3).
« Quota épuisé »Augmentez les intervalles (section Avancé), ou vérifiez qu'une autre application n'utilise pas le même compte STM.
Station BIXI « Retirée du réseau »La station n'est plus dans le réseau BIXI, souvent pour l'hiver : elle reviendra seule. Pour en suivre une autre, voir « Chercher une station BIXI ».
Un arrêt reste à 999Aucun autobus prévu (la nuit), ou un filtre de ligne qui ne correspond à aucune ligne de l'arrêt.

Vie privée, données et licences​

  • La position de la maison ne sert qu'à chercher les arrêts proches. Seul un rectangle de quelques centaines de mètres autour de la maison est envoyé à Transitous. Rien n'est envoyé ailleurs.
  • Horaires prévus, noms d'arrêts et recherche : Transitous, un service communautaire gratuit, à partir des données de la STM.
  • Temps réel et état du métro : données ouvertes de la STM, licence CC BY 4.0, source : Société de transport de Montréal.
  • Vélos : flux GBFS public de BIXI Montréal.
  • Code de l'intégration : licence Apache 2.0.

Paramètres de configuration​

Voici les paramètres demandés par STM Montréal dans son écran de configuration dans Gladys.

ParamètreTypeObligatoireDescription
Démarrer en 2 minutessectionNon1. Vérifiez que votre maison a une adresse dans Gladys (Paramètres → Maisons). 2. Enregistrez cette page. 3. Ouvrez l’onglet « Découverte » de cette intégration et cliquez sur « Ajouter » sur les arrêts et stations BIXI près de chez vous. C’est tout : vous avez tout de suite les horaires prévus des autobus et les vélos BIXI. Une clé STM (facultative, gratuite) ajoute le temps réel et l’état du métro.
Près de chez moisectionNonCombien d’arrêts d’autobus (à moins de 600 m) et de stations BIXI (à moins de 1 km) parmi les plus proches sont proposés dans l’onglet « Découverte ». 0 désactive la suggestion.
Arrêts près de chez moinumberNon
Stations BIXI près de chez moinumberNon
Temps réel et métro (facultatif)sectionNonSans clé, vous avez les horaires prévus. Avec une clé STM gratuite, vous avez les prédictions en temps réel des autobus et l’état des lignes de métro. L’obtenir prend 5 minutes : suivez le guide pas à pas.
Clé d'API STMsecretNonLa clé de votre application sur le portail développeurs de la STM (le secret partagé n'est pas nécessaire).
Surveiller le métrobooleanNonCrée un appareil « Métro STM » avec l'état des lignes verte, orange, jaune et bleue.
Horaires prévus sans clébooleanNonSans clé STM, afficher les horaires prévus des autobus (via le service gratuit Transitous).
Autres arrêts et stations (facultatif)sectionNonPour surveiller un arrêt qui n’est pas près de chez vous (travail, école…) : tapez son code à cinq chiffres, inscrit sur le panneau de l’arrêt, ou trouvez-le avec le bouton « Chercher un arrêt » en bas de cette page.
Arrêts d'autobusstringNonCodes d'arrêt. Filtre de lignes optionnel après @ et nom personnalisé après : — ex. « 52743, 51003@24:Bus du travail, 61503@69|469 ».
Stations BIXIstringNonIdentifiants de stations BIXI, avec un nom personnalisé optionnel après : — ex. « 1, 42:Station de la maison ».
AvancésectionNonLes valeurs par défaut conviennent à presque tout le monde. Avec une clé STM, une seule lecture du flux autobus sert tous les arrêts : environ 2 200 de vos 10 000 requêtes STM quotidiennes.
Rafraîchissement des passages (s)numberNonFréquence de rafraîchissement des passages d'autobus, en secondes.
Rafraîchissement du métro (s)numberNonFréquence de rafraîchissement de l'état du métro, en secondes.
Rafraîchissement BIXI (s)numberNonFréquence de rafraîchissement des stations BIXI, en secondes.
Passages par arrêtnumberNonNombre de prochains passages exposés en fonctionnalités par arrêt.
Langue des valeursselectNonLangue des noms de fonctionnalités et des textes publiés (messages du métro, états).

Comment installer STM Montréal dans Gladys​

  1. Dans Gladys, ouvrez Intégrations : STM Montréal apparaît dans le catalogue, aux côtés des intégrations natives, avec un badge communautaire.
  2. Cliquez sur Installer. Gladys télécharge l'image Docker (ghcr.io/lm1lc3n7/gladys-stm:0.2.2), la démarre dans un bac à sable isolé du cœur, et génère l'interface de l'intégration (appareils, découverte et configuration).
  3. Ouvrez l'écran Configuration de l'intégration, remplissez les paramètres, puis enregistrez.
  4. Vous pouvez aussi l'installer directement depuis l'URL de son dépôt : https://github.com/LM1LC3N7/gladys-stm.

STM Montréal nécessite Gladys >=5.1.0. Le catalogue dans Gladys se rafraîchit toutes les heures : une nouvelle version est donc disponible au plus tard une heure après sa sortie.

Vous n'utilisez pas encore Gladys ? C'est gratuit et open source : suivez le guide d'installation pour démarrer.

À propos des intégrations externes​

STM Montréal est une intégration externe : une intégration communautaire empaquetée dans un conteneur Docker et publiée sur GitHub, que Gladys installe en un clic et exécute dans un bac à sable isolé de son cœur. Elle est publiée et maintenue par LM1LC3N7, et non par l'équipe cœur de Gladys.

Inscrivez-vous à la newsletter Gladys Assistant

Quelques emails par mois sur les nouveautés et l'actualité du projet. Envoyés par Pierre-Gilles Leymarie, le fondateur du projet. Désinscription possible à tout moment 🙂
Dernière mise à jour le