luizcesar/olho-vivo-api

OlhoVivoAPI is a PHP implementation for SPTrans' OlhoVivo.

Maintainers

Details

github.com/luizcesard/OlhoVivoAPI

Source

Issues

Installs: 42

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

2.2 2017-05-31 13:02 UTC

Requires

MIT df951a93c8984f350a09398fc0c6c8cf9804e9a2

apiolhovivosptransSao PauloPublic Transport

This package is not auto-updated.

Last update: 2025-05-21 05:08:31 UTC

README

License

PHP implementation of SPTrans' OlhoVivo API v2.1.

Table of Contents

Introduction

This is a pure PHP Object Oriented implementation of SPTrans' OlhoVivoAPI v2.1. OlhoVivo official API provides real-time data of São Paulo's (BR) public transportation bus system. All methods documented in the official API have been implemented.

This API can:

  • Search for Bus Lines (optionally by way).
  • Search for Bus Stops.
  • Search for Bus Stops served by a given Bus Line.
  • List actual São Paulo's Busways (BRT).
  • Report all Companies that provide transportation services at a time.
  • Report all vehicles servicing the city by Bus Line and their position at a time.
  • Report all vehicles available on a given Bus Line and they position at a time.
  • Report all vehicles transmiting position from operator's garage (optionally) by Bus Line.
  • Forecast buses arrivals on a given Bus Stop for a given Bus Line at a time.
  • Forecast buses arrivals at all Bus Stops served by a given Bus Line.
  • Forecast buses arrivals at a given Bus Stop for all Bus Lines that serve it at a time.
  • Get KMZ files with actual traffic conditions.

Objects of this package may be used locally together with GTFS tables.

This code is available on Github. Pull requests are welcome.

Instructions

Get your token

  1. Sign up into SPTrans Devs Area.
  2. After loging in, you'll have to create an application name and ask for a token.

Require this package with Composer

Install this package through Composer. Edit your project's composer.json file to require luizcesar/olho-vivo-api.

Create composer.json file

{
    "name": "yourproject/yourproject",
    "type": "project",
    "require": {
        "php": ">=5.6",
        "luizcesar/olho-vivo-api": "*"
    }
}

and run composer update

or

run this command in your command line:

composer require luizcesar/olho-vivo-api

Configs

Open the olhoVivo.php and fill it with your api-key.

Usage Example

use LuizCesar\OlhoVivoAPI\Bulletins\ArrivalForecast;
use LuizCesar\OlhoVivoAPI\Entities\BusLine;
use LuizCesar\OlhoVivoAPI\Entities\BusStop;
use LuizCesar\OlhoVivoAPI\OlhoVivo;

//get an instance of OlhoVivo object
$spTrans = OlhoVivo::getInstance();

$aBusLine = ($spTrans->seekLines("875A",BusLine::WAY_FIRST_LEG))[0]; //The first match of a line search
$busStops = $spTrans->seekBusStopsByLine($aBusLine); //all stops served by $aBusLine
$aBusStop = $busStops[rand(0,count($busStops)-1)]; //get a random bus stop of $busStops'

//Get a Map of all Lines that have buses forecasted to arrive on the chosen bus stop.
$arrivalForecast = $spTrans->getArrivalForecastByStop($aBusStop);
$arrivalsMap = $arrivalForecast->getArrivalsMap(); //Map of Lines and array of buses

echo "Arrival forecast for bus stop at {$aBusStop->getName()}" . PHP_EOL .
	"Issued at: {$arrivalForecast->getTime()}" . PHP_EOL;

//The way to iterate over SplObjectStorage objects.
foreach($arrivalsMap as $line)
{
	echo "{$line->getFullSignCode()} {$line->getActualSignName()}" . PHP_EOL .
	"\t_______________________________" . PHP_EOL .
	"\t| Time  | Bus Id | Accessible |" . PHP_EOL .
	"\t|-------|--------|------------|" . PHP_EOL;
	foreach($arrivalsMap[$line] as $busForecast)
		echo "\t| {$busForecast->getTime()} | {$busForecast->getBus()->getId()}  |    " .
		($busForecast->getBus()->isAcc() == true ? ' YES' : ' NO ') . "    |" . PHP_EOL;
	echo "\t===============================" . PHP_EOL . PHP_EOL;
}

And an example output:

Arrival forecast for bus stop at R DR.  ALBUQUERQUE LINS
Issued at: 13:41
8000-10 TERM. LAPA
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	===============================

8622-10 MORRO DOCE
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	===============================

8400-10 TERM. PIRITUBA
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	===============================

8615-10 PQ. DA LAPA
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	| 13:46 | 82496  |     YES    |
	===============================

8594-10 CID. D'ABRIL 
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	| 13:46 | 82496  |     YES    |
	| 13:48 | 11448  |     YES    |
	===============================

874T-10 LAPA
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	| 13:46 | 82496  |     YES    |
	| 13:48 | 11448  |     YES    |
	| 14:08 | 52214  |     YES    |
	===============================

875A-10 PERDIZES
	_______________________________
	| Time  | Bus Id | Accessible |
	|-------|--------|------------|
	| 13:45 | 12125  |     NO     |
	| 13:46 | 12119  |     NO     |
	| 13:45 | 11771  |     NO     |
	| 13:46 | 11402  |     YES    |
	| 13:46 | 82496  |     YES    |
	| 13:48 | 11448  |     YES    |
	| 14:08 | 52214  |     YES    |
	| 14:22 | 62106  |     NO     |
	| 14:46 | 62096  |     NO     |
	===============================

Change Log

v2.2

  • Implementation of getOwners() on Bus Objects.
  • Issues fixes.
  • OlhoVivo object is now retrieved by the getInstance() method.

v2.1.0.1

  • Bug solving.

v2.1.0

  • Implemented the new version (v2.1) of SPTrans' API.
  • All methods are implemented.
  • Company objects.
  • Better error handling.
  • Objects redesigned.

v0.2

  • Bug Fixes.
  • Ability to retrieve bus color.

v0.1

  • Launched first version.

Troubleshooting

Please, if you find any bugs, report them on issues page.

License

Please see the LICENSE included in this repository for a full copy of the MIT license, which this project is licensed under.