Skip to content

Latest commit

 

History

History
77 lines (46 loc) · 2 KB

README.md

File metadata and controls

77 lines (46 loc) · 2 KB

VATSIM Data Laravel Library

This Laravel library allows to easily query VATSIM's data feed, METAR information, and status data. It provides a simple and efficient way to access real-time data for virtual air traffic simulation, making it ideal for aviation enthusiasts, developers of flight simulation tools, or anyone interested in utilizing VATSIM's data.

Installation

To install the package, you can use Composer by running the following command in your Laravel project's root directory:

composer require paulhollmann/vatsim-data

Configuration

This package requires configuration to access VATSIM's data. Open the configuration file located at config/vatsimdata.php and update the settings as needed.

Usage

Fetch VATSIM Data Feed

To fetch the latest VATSIM data feed, use the VatsimData facade:

use VatsimData\Datafeed;

// Retrieve all online pilots
$pilots = Datafeed::getPilots();

// Retrieve all online controllers
$controllers = Datafeed::getControllers();

// ...

Fetch METAR Data

To fetch the latest METAR data for a specific airport:

use VatsimData\Metar;

$metars = Metar::get('eddf'); // Replace 'eddf' with any ICAO code

Fetch Transceiver Data

To fetch the latest transceiver data for a specific controller:

use VatsimData\TransceiverData;

$owner = TransceiverData::Owner('eddf_n_app');
$transceivers = $owner->transceivers;

Caching

The library supports caching of responses to reduce the number of requests to the VATSIM servers.

Contributing

Contributions are welcome! If you'd like to contribute to this library, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Implement your changes and add tests as necessary.
  4. Submit a pull request detailing your changes.

License

This project is licensed under the GNU GPLv3 License. See the LICENSE file for more information.

Contact

For any questions or issues, please contact me [email protected]