blitzortungc

README

Blitzortungc 🌩️

Go library for listening to lightning strike and thunderstorm events from blitzortung.org. Please make sure to read their terms of services before using this library. This library is not affiliated in any way with the blitzortung.org project.

The service provided by blitzortung.org is not an official authority for lightning or thunderstorm data. The data provided is only for private and entertainment purposes. The project blitzortung.org is for the contributors merely a voluntary leisure activity.

Installation

$ go get -u github.com/0x5a17ed/blitzortungc

Documentation

Index

• func Inflate(d []byte) (out []byte)
• type Client
  • func (c *Client) Run(ctx context.Context, dialer Dialer) error
  • func (c *Client) Shutdown()
• type Dialer
• type Handler
• type HandlerFunc
  • func (f HandlerFunc) HandleStrike(s *Strike)
• type Station
• type Strike
  • func (s Strike) Delay() time.Duration
  • func (s Strike) Time() time.Time
• type UnmarshalError
  • func (e UnmarshalError) Error() string
  • func (e UnmarshalError) Is(target error) bool
  • func (e UnmarshalError) Unwrap() error

Functions

func Inflate

func Inflate(d []byte) (out []byte)

Types

type Client

type Client struct {
	// Handler is called for handling lightning strike events.
	Handler Handler

	// ErrorHook is called when the read hit an error while
	// processing server data.
	ErrorHook func(error)
	// contains filtered or unexported fields
}

Client represents a client for the service of https://www.blitzortung.org/en/ for tracking lightning and thunderstorms in real time.

func (*Client) Run

func (c *Client) Run(ctx context.Context, dialer Dialer) error

Run runs the given client, connecting to the lightning events source server and tries to keep the connection alive. Calls Handler.HandleStrike for incoming events.

func (*Client) Shutdown

func (c *Client) Shutdown()

Shutdown shuts the client down cleanly and prevents it from reconnecting to the data source again.

type Dialer

type Dialer interface {
	DialContext(context.Context, string, http.Header) (*websocket.Conn, *http.Response, error)
}

type Handler

type Handler interface {
	HandleStrike(s *Strike)
}

type HandlerFunc

type HandlerFunc func(s *Strike)

func (HandlerFunc) HandleStrike

func (f HandlerFunc) HandleStrike(s *Strike)

type Station

type Station struct {
	// Station that has reported the signal.
	ID int `json:"sta"`

	// Status of the signal.
	// bit 1 = polarity negative
	// bit 2 = polarity positive
	// bit 3 = signal is used for the computation
	Status int `json:"status"`

	// Time difference to the time of the lightning strike in nanoseconds.
	TimeDeltaValue int `json:"time"`

	Latitude  float64 `json:"lat"` // Latitude of the detector in degree (decimal).
	Longitude float64 `json:"lon"` // Longitude of the detector in degree (decimal).
	Altitude  int     `json:"alt"` // Altitude of the detector in meter.
}

Station represents a single station that reported a given lightning strike.

type Strike

type Strike struct {
	Status   *int `json:"status,omitempty"`
	Polarity int  `json:"pol"`

	Signals []Station `json:"sig"`

	TimeValue  big.Int `json:"time"`
	DelayValue float64 `json:"delay"`

	// MaxDeviationSpan is the maximal deviation span in nanoseconds.
	MaxDeviationSpan int `json:"mds"`
	// MaxCircularGap is the maximal circular gap in degree between two stations.
	MaxCircularGap *int `json:"mcg,omitempty"`

	Region    int     `json:"region"`
	Latitude  float64 `json:"lat"` // Latitude in degree (decimal).
	Longitude float64 `json:"lon"` // Longitude in degree (decimal).
	Altitude  int     `json:"alt"` // Altitude in meter.
}

Strike represents a single lightning strike as reported by the remote server.

func (Strike) Delay

func (s Strike) Delay() time.Duration

Delay interprets the DelayValue field as a time.Duration value.

func (Strike) Time

func (s Strike) Time() time.Time

Time interprets the TimeValue field as a time.Time value.

type UnmarshalError

type UnmarshalError struct {
	Wrapped error
	RawData []byte
}

func (UnmarshalError) Error

func (e UnmarshalError) Error() string

func (UnmarshalError) Is

func (e UnmarshalError) Is(target error) bool

func (UnmarshalError) Unwrap

func (e UnmarshalError) Unwrap() error