noaa

Documentation

Index

• type DataResponse
  • func (r *DataResponse) Frames() (data.Frames, error)
• type Datum
• type NOAAClient
  • func NewNOAAClient() NOAAClient
  • func (c *NOAAClient) Fetch(ctx context.Context, q *models.NOAAQuery) ([]byte, error)
  • func (c *NOAAClient) Query(ctx context.Context, q *models.NOAAQuery) data.Framer
• type ResponseError
• type StationMeta

Types

type DataResponse

type DataResponse struct {
	Query *models.NOAAQuery
	URL   string

	Metadata    StationMeta   `json:"metadata,omitempty"`
	Data        []Datum       `json:"data,omitempty"`
	Predictions []Datum       `json:"predictions,omitempty"`
	Error       ResponseError `json:"error,omitempty"`
}

func (*DataResponse) Frames

func (r *DataResponse) Frames() (data.Frames, error)

type Datum

type Datum struct {
	T  string `json:"t,omitempty"`
	V  string `json:"v,omitempty"`
	S  string `json:"s,omitempty"`
	TY string `json:"ty,omitempty"`
	D  string `json:"d,omitempty"`
	DR string `json:"dr,omitempty"`
	G  string `json:"g,omitempty"`
	F  string `json:"f,omitempty"`
	Q  string `json:"q,omitempty"`
}

type NOAAClient

type NOAAClient struct {
	Client experimental.Client // https://api.tidesandcurrents.noaa.gov/api/prod/
}

func NewNOAAClient

func NewNOAAClient() NOAAClient

func (*NOAAClient) Fetch

func (c *NOAAClient) Fetch(ctx context.Context, q *models.NOAAQuery) ([]byte, error)

func (*NOAAClient) Query

func (c *NOAAClient) Query(ctx context.Context, q *models.NOAAQuery) data.Framer

type ResponseError

type ResponseError struct {
	Message string `json:"message,omitempty"`
}

type StationMeta

type StationMeta struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	Lat  string `json:"lat,omitempty"`
	Lon  string `json:"lon,omitempty"`
}