Skip to content

Latest commit

 

History

History
141 lines (109 loc) · 5.76 KB

README-en.md

File metadata and controls

141 lines (109 loc) · 5.76 KB
Raw

São Paulo Subway and Train

Leia isso em Brazillian Portuguese.

The data of the lines 1 (Blue), 2 (Green), 3 (Red), 4 (Yellow), 5 (Purple) and 15 (Silver) of the São Paulo's subway are taken from Metro.

The data of the lines 7 (Ruby), 8 (Diamond), 9 (Emerald), 10 (Turquoise), 11 (Coral), 12 (Sapphire) and 13 (Jade) of the São Paulo's train are taken from CPTM.

The custom_component can create up to 13 sensors:

  • sensor.linha_1_azul
  • sensor.linha_2_verde
  • sensor.linha_3_vermelha
  • sensor.linha_4_amarela
  • sensor.linha_5_lilas
  • sensor.linha_15_prata
  • sensor.linha_7_rubi
  • sensor.linha_8_diamante
  • sensor.linha_9_esmeralda
  • sensor.linha_10_turquesa
  • sensor.linha_11_coral
  • sensor.linha_12_safira
  • sensor.linha_13_jade

The 4 possible results for Metro sensors:

  • Normal (Normal)
  • Velocidade Reduzida (Reduced Speed)
  • Paralisada (Paralyzed)
  • Fechado (Closed)

The 4 possible results for CPTM sensors:

  • Normal (Normal)
  • Velocidade Reduzida (Reduced Speed)
  • Parcial (Partial)
  • Fechado (Closed)

Installation

Download the .zip file (here) and copy the folder metro_sp and paste on config/custom_components/, where the files would look like this:

  • config/custom_components/metro_sp/__init__.py
  • config/custom_components/metro_sp/device_tracker.py
  • config/custom_components/metro_sp/manifest.json

Add to configuration.yaml:

sensor:
  - platform: metro_sp
    scan_interval: 120  # Optional
    selecionar: metro # Optional

Configuration variable:

  • scan_interval (Optional): The default is value is 300 (5 minutes) if you don't want to declare this variable. You can change to any value you want but keep in mind that the lowest value will make more updates, and will pick up an information on the Subway website and may have a speed drop on the Home Assist system and a maybe a crash. I think the lowest safest value is 60 seconds (1 minute).

  • selecionar (Optional): The default is ambos (which means "both") if you don't want to declare this variable. You can switch to metro or cptm. If you choose metro, it will only create entities of the Metro lines, which are: 1 (Blue), 2 (Green), 3 (Red), 4 (Yellow), 5 (Purple), and 15 (Silver). If you choose cptm, it will only create entities from CPTM lines, which are: 7 (Ruby), 8 (Diamond), 9 (Emerald), 10 (Turquoise), 11 (Coral), 12 (Sapphire) and 13 (Jade).

Restart your Home Assistant.

PS: There are two ways to update this custom_component (metro_sp) directly in the Home Assistant. Except that the two of them can not be installed together. Choose only one of them!

Config custom_updater

Add to configuration.yaml:

custom_updater:
  component_urls:
    - https://raw.githubusercontent.com/vitinhosessa/metro_sp/master/custom_components.json

Whenever metro_sp is updated by custom_updater, restart your Home Assistant.

Config HACS (Home Assistant Community Store)

Go to Community tab, then go to Settings tab on HACS.

Copy this link: https://github.com/vitinhosessa/metro_sp

Paste this link into CUSTOM INTEGRATION REPO'S and click on the floppy disk.

Now go to Store tab, search Metro, click on Manage and click on Install. Even if you have already installed this custom_component before.

Restart your Home Assistant.

Lovelace Card Example

lovelace-card-metro-cptm

type: entities
title: Metro
show_header_toggle: false
entities:
  - entity: sensor.linha_1_azul
  - entity: sensor.linha_2_verde
  - entity: sensor.linha_3_vermelha
  - entity: sensor.linha_4_amarela
  - entity: sensor.linha_5_lilas
  - entity: sensor.linha_15_prata
type: entities
title: CPTM
show_header_toggle: false
entities:
  - entity: sensor.linha_7_rubi
  - entity: sensor.linha_8_diamante
  - entity: sensor.linha_9_esmeralda
  - entity: sensor.linha_10_turquesa
  - entity: sensor.linha_11_coral
  - entity: sensor.linha_12_safira
  - entity: sensor.linha_13_jade

Changelog

[0.2] - 2019-05-26

New

  • Lines 7 (Ruby), 8 (Diamond), 9 (Emerald), 10 (Turquoise), 11 (Coral), 12 (Sapphire) and 13 (Jade) from CPTM of São Paulo were added.
  • Now entities are created with the "mdi: subway-variant" icon when the line is functioning normally, and when it is with Reduced Speed, Partial, Paralyzed or Closed the icon changes to "mdi: subway-alert-variant".
  • Option to choose which entities will be created, the Metro lines or the CPTM lines or both.

[0.1b4] - 2019-05-23

New

  • Now it's possible to add the custom_component on HACS (Home Assistant Community Store).

[0.1b3] - 2019-05-21

New

  • Added the configuration variable "scan_interval" to change the update rate to get the line information.

Improvement

  • A better way to do the update every 5 minutes was implemented.

Thanks to the Home Assistant chat on Discord that helped me make this implementation.

[0.1b2] - 2019-05-19

Changed

  • Lines informations will be checked every 5 min.

[0.1b1] - 2019-05-19

  • First release.

License

This code is public domain. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation. http://www.gnu.org/licenses/. Certain libraries used may be under a different license.

Buy Me A Coffee