envcan

README

envcan

This package provides a service for interfacing with the Environment Canad Weather Office service. It needs to be bootstrapped by running the getstations tool to initialize the list of locations and URLs to retrieve weather data from; once setup the envcan.Service implementation can be used as a weather service for Canadian locations.

Documentation

Index

• Variables
• type Service
  • func NewService(logger *zap.Logger, api *weather.API, weatherStationFile string) (*Service, error)
• type Station
  • func (s *Station) GetForecast(ctx context.Context) ([]*weather.WeatherForecast, error)
  • func (s *Station) GetReport(ctx context.Context) (*weather.WeatherReport, error)
  • func (s *Station) Name() string

Variables

var (
	// ErrInvalidDate is returned if an invalid date qualifier is supplied.
	ErrInvalidDate = errors.New("invalid date supplied")
)

Types

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service is a very basic weather feed provided by Environment Canada

func NewService

func NewService(logger *zap.Logger, api *weather.API, weatherStationFile string) (*Service, error)

NewService creates a new weather feed for Environment Canada.

type Station

type Station struct {
	URL   string `json:"url"`
	Title string `json:"title"`

	Latitude         float64 `json:"latitude"`
	Longitude        float64 `json:"longitude"`
	SiteType         string  `json:"site_type"`
	SiteProvinceCode string  `json:"site_province_code"`
	// contains filtered or unexported fields
}

Station contains the data about a single weather location reported on by Environment Canada

func (*Station) GetForecast

func (s *Station) GetForecast(ctx context.Context) ([]*weather.WeatherForecast, error)

GetForecast returns the forecast for this station

func (*Station) GetReport

func (s *Station) GetReport(ctx context.Context) (*weather.WeatherReport, error)

GetReport returns the current weather report for this station.

func (*Station) Name

func (s *Station) Name() string

Name returns the printable name of this weather station