Contents

wadetregaskis/swiftweather

A Swift weather package to support multiple weather APIs.

Use Case #1: Retrieve the most recent report

let report = try await device.latestReport

Use Case #2: Retrieve the N most recent reports

for try await report in device.latestReports(count: N) {
    …
}

Reports are returned in reverse chronological order (i.e. starting with the most recent). The date interval between them is weather-platform-dependent and/or device-dependent, and also may be irregular if e.g. the weather device in question had internet connectivity issues.

Note: not currently supported for Wunderground.

Use Case #3: Retrieve the report for a past date

for try await report in device.reports(count: 1, upToAndIncluding: date) {
    …
}

Note: not currently supported for Wunderground.

Use Case #4: Retrieve N reports leading up to a given date

for try await report in device.reports(count: N, upToAndIncluding: date) {
    …
}

Note: not currently supported for Wunderground.

📋 Working with reports

Exactly what each report contains depends both on the weather platform and weather device in use. An example from AmbientWeather:

MAC Address: A1:B2:C3:D4:E5:F6
  Info:
      Name: My Station
      Location: My Roof
      GeoLocation:
		Location: Somewhere
		Address: Some Address
		Elevation: Some Elevation
	  Coordiates:
 		Type: Point
 		Latitude: Some Latitutde
 		Longitude: Some Longitude

Outdoor Battery Status: 0
Date: 1590605700000 ms
Relative Pressure: 29.62 inHg
Absolute Pressure: 29.58 inHg
Hourly Rain: 0.0 in/hr
Rain Today: 0.0 in
Monthly Rain: 1.54 in
Yearly Rain: 13.85 in
Last Time it Rained: 2020-05-23T08:32:00.000Z
Indoor Temperature: 90.7 ºF
Outdoor Temperature: 77.2 ºF
Outdoor Dew Point: 63.61 ºF
Outdoor Temperature Feels Like: 77.58 ºF
Wind Direction: 116 º
Wind Speed: 6.5 MPH
Wind Gust: 15.0 MPH
Max Wind Gust Today: 17.4 MPH
Wind Gust Direction: 190 º
2 Minute Wind Speed Avg: 5.2 MPH
10 Minute Wind Speed Avg: 5.2 MPH
10 Minute Wind Direction Avg: 133 º
UV Index: 5
Solar Radiation: 358.0 W/m^2
Outdoor Humidity: 63 %
Indoor Humidity: 30 %

Each report contains at least a date & time of when it was generated, along with all available measures from that point in time.

public protocol WeatherReport {
    var date: Date { get }
    var sensors: [WeatherSensorID: WeatherSensor] { get }
}

…where WeatherSensor is defined as:

open class WeatherSensor {
    public let type: WeatherSensorType
    public let ID: WeatherSensorID
    public let name: String
    public let description: String?
    public let measurement: Any
}

Measurements vary in their type - Foundation's Measurement class is used wherever applicable, but some are more primitive types (e.g. Date for the last time it rained).

Have a look in the package - and experiment with this library against a real station of interest - for details on sensors available to use in your application.

🗒 To Do

  • Add real-time AmbientWeather API support (blocked by said API being broken - https://github.com/ambient-weather/api-docs/issues/42).
  • Complete the Wunderground support.
  • Extensive testing for multiple reporting devices per service.
  • Complete localization (some parts of the code are localisation-aware and -ready, some are not - in any case, no translations have been performed; English is the only supported language).

Package Metadata

Repository: wadetregaskis/swiftweather

Default branch: main

README: README.md