https://github.com/gabrielrf/trafficstatus2telegram
https://github.com/gabrielrf/trafficstatus2telegram
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/gabrielrf/trafficstatus2telegram
- Owner: GabrielRF
- License: gpl-3.0
- Created: 2023-09-30T18:24:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-05T16:26:35.000Z (over 2 years ago)
- Last Synced: 2025-01-10T04:36:28.607Z (over 1 year ago)
- Language: Python
- Size: 31.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Traffic Status to Telegram
Envio automático do tempo de viagem de carro entre dois pontos usando Google Maps.
## Sugestões
**Envie novas rotas**! Faça um *Pull Request* considerando as instruções em [GitHub Action](#github-action) e novas mensagens serão enviadas no canal [@BsbDF](https://t.me/BsbDF).
## trafficstatus.py
### Variáveis de ambiente
* `BOT_TOKEN`: Token do bot que faz o envio;
* `GOOGLE_API_KEY`: Chave de acesso à *Distance Matrix API* do Google [(Mais informações)](https://developers.google.com/maps/documentation/distance-matrix/overview?hl=pt-br);
* `MESSAGE_DESTINATION`: Destino da mensagem;
* `ORIGEM`: Ponto de início da viagem;
* `DESTINO`: Ponto de término da viagem;
* `TITULO`: Título da mensagem;
* `IGNORAR_ABAIXO_DE`: A mensagem não será enviada se o [indicativo do tempo de viagem](#indicativo-do-tempo-de-viagem) for abaixo do valor determinado. Exemplo: `1.25` para ignorar casos em que o trânsito está bom, ou seja, que seria enviado o 🟩.
### Indicativo do tempo de viagem
A API do Google retorna dois indicativos de tempo, o de viagem baseado na velocidade das vias e o de viagem baseado no trânsito atual. É feita a divisão do dos dois valores de tempo, obtendo-se o estado atual das vias.
* 🟩 Para viagens em que o tempo é de até 25% acima do tempo sem trânsito;
* 🟨 Caso seja entre 25% e 50%;
* 🟧 Entre 50% e 75%;
* 🟥 Acima de 75%.
## GitHub Action
> Localizadas em *.github/workflows*
Adicione um novo arquivo usando qualquer outro da mesma pasta como modelo e ajuste as variáveis abaixo:
* `name` (linha 1): Nome da ação. Este valor será o título da mensagem;
* `cron` (linha ~5): Ajuste do cronjob ([guia](https://crontab.guru/)). Horário em UTC;
* `ORIGEM` (linha ~27): Origem da viagem. Este valor deve funcionar perfeitamente na busca do Google Maps;
* `DESTINO` (linha ~28): Destino da viagem. Este valor também deve funcionar na busca.