astrodog/laravel-weather

Package for get the weather data

v1.0.3 2024-03-20 00:41 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^7.5
• illuminate/contracts: ^11.0
• spatie/laravel-package-tools: ^1.16.2

Requires (Dev)

• laravel/pint: ^1.6
• nunomaduro/collision: ^6.0
• nunomaduro/larastan: ^2.4
• orchestra/testbench: ^8.0
• pestphp/pest: ^1.22
• pestphp/pest-plugin-laravel: ^1.4
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^9.5

MIT

• Michael Nabil
• Joe McClorey

• laravel
• laravel-weather
• MichaelNabil230

README

Download Meteorological Data from OPEN-METEO API (https://open-meteo.com/en)

Open-Meteo collaborates with National Weather Services providing Open Data with 11 to 2 km resolution. Our high performance APIs select the best weather model for your location and provide data as a simple JSON API.

APIs are free without any API key for open-source developers and non-commercial use. You can embed them directly into your app.

Installation

You can install the package via composer:

composer require michaelnabil230/laravel-weather

You can publish the config file with:

php artisan vendor:publish --tag="laravel-weather-config"

This is the contents of the published config file:

return [
    'temperature_unit' => 'celsius',
    'wind_speed_unit' => 'kmh',
    'precipitation_unit' => 'mm',
    'time_format' => 'iso8601',
    'timezone' => 'GMT',
];

Usage

$weather = \MichaelNabil230\Weather\Weather::location(30.0812558, 31.2511902)
    ->current()
    ->get();

Functions:

Parameter	Format	Required	Default
currentWeather	Bool	No	false
temperatureUnit	String	No	celsius
windSpeedUnit	String	No	kmh
precipitationUnit	String	No	kmh
timeFormat	String	No	iso8601
timezone	String	No	UTC
pastDays	Integer (0-2)	No	0

Hourly Functions:

Variable	Valid time	Unit
temperature_2m	Instant	°C (°F)
relativeHumidity_2m	Instant	%
dewPoint_2m	Instant	°C (°F)
apparentTemperature	Instant	°C (°F)
pressureMsl	Instant	hPa
cloudCover	Instant	%
cloudCoverLow	Instant	%
cloudCoverMid	Instant	%
cloudCoverHigh	Instant	%
windSpeed_10m	Instant	km/h (mph, m/s, knots)
windSpeed_80m	Instant	km/h (mph, m/s, knots)
windSpeed_120m	Instant	km/h (mph, m/s, knots)
windSpeed_180m	Instant	km/h (mph, m/s, knots)
windDirection_10m	Instant	°
windDirection_80m	Instant	°
windDirection_120m	Instant	°
windDirection_180m	Instant	°
windGusts_10m	Preceding hour max	km/h (mph, m/s)
shortwaveRadiation	Preceding hour mean W/m²
directRadiation	Preceding hour mean	W/m²
diffuseRadiation	Preceding hour mean	W/mv²
vaporPressureDeficit	Instant	kPa
evapotranspiration	Preceding hour sum	mm (inch)
precipitation	Preceding hour sum	mm (inch)
hourlyWeatherCode	Instant	WMO code
snowHeight	Instant	meters
freezingLevelHeight	Instant	meters
soilTemperature_0cm	Instant	°C (°F)
soilTemperature_6cm	Instant	°C (°F)
soilTemperature_18cm	Instant	°C (°F)
soilTemperature_54cm	Instant	°C (°F)
soilMoisture_0_1cm	Instant	m³/m³
soilMoisture_1_3cm	Instant	m³/m³
soilMoisture_3_9cm	Instant	m³/m³
soilMoisture_9_27cm	Instant	m³/m³
soilMoisture_27_81cm	Instant	m³/m³
allHourly	-	-

Daily Functions:

Variable	Unit
temperature_2mMax	°C (°F)
temperature_2mMin	°C (°F)
apparentTemperatureMax	°C (°F)
apparentTemperatureMin	°C (°F)
precipitationSum	mm
precipitationHours	hours
dailyWeatherCode	WMO code
sunrise	iso8601
sunset	iso8601
windSpeed_10mMax	km/h (mph, m/s, knots)
windGusts_10mMax	km/h (mph, m/s, knots)
windDirection_10mDominant	°
shortwaveRadiationSum	MJ/m²
allDaily	-

WMO Weather interpretation codes (WW):

Code	Description
0	Clear sky
1, 2, 3	Mainly clear, partly cloudy, and overcast
45, 48	Fog and depositing rime fog
51, 53, 55	Drizzle: Light, moderate, and dense intensity
56, 57	Freezing Drizzle: Light and dense intensity
61, 63, 65	Rain: Slight, moderate, and heavy intensity
66, 67	Freezing Rain: Light and heavy intensity
71, 73, 75	Snowfall: Slight, moderate, and heavy intensity
77	Snow grains
80, 81, 82	Rain showers: Slight, moderate, and violent
85, 86	Snow showers slight and heavy
95 *	Thunderstorm: Slight or moderate
96, 99 *	Thunderstorm with slight and heavy hail

Testing

composer test

Support

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Michael Nabil
• All Contributors

License

The MIT License (MIT). Please see License File for more information.