loracloudgeolocationv3

Documentation

Index

• Constants
• func New(server io.Server, registry packages.Registry) packages.ApplicationPackageHandler
• type Data
  • func (d *Data) FromStruct(st *types.Struct) error
  • func (d *Data) Struct() *types.Struct
• type GeolocationPackage
  • func (p *GeolocationPackage) HandleUp(ctx context.Context, def *ttnpb.ApplicationPackageDefaultAssociation, ...) (err error)
  • func (p *GeolocationPackage) Package() *ttnpb.ApplicationPackage
• type QueryType
  • func (t *QueryType) FromValue(v *types.Value) error
  • func (t QueryType) Value() *types.Value

Constants

const PackageName = "lora-cloud-geolocation-v3"

PackageName defines the package name.

Functions

func New

func New(server io.Server, registry packages.Registry) packages.ApplicationPackageHandler

New instantiates the LoRa Cloud Geolocation package.

Types

type Data

type Data struct {
	// Query is the query type used by the package.
	Query QueryType
	// MultiFrame enables multi frame requests for TOARSSI queries.
	MultiFrame bool
	// MultiFrameWindowSize represents the number of historical frames to consider for the query.
	// A window size of 0 automatically determines the number of frames based on the first byte
	// of the uplink message.
	MultiFrameWindowSize int
	// MultiFrameWindowAge limits the maximum age of the historical frames considered for the query.
	MultiFrameWindowAge time.Duration
	// ServerURL represents the remote server to which the GLS queries are sent.
	ServerURL *url.URL
	// Token is the API token to be used when comunicating with the GLS server.
	Token string
}

Data contains the package configuration.

func (*Data) FromStruct

func (d *Data) FromStruct(st *types.Struct) error

FromStruct deserializes the configuration from *types.Struct.

func (*Data) Struct

func (d *Data) Struct() *types.Struct

Struct serializes the configuration to *types.Struct.

type GeolocationPackage

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

GeolocationPackage is the LoRa Cloud Geolocation application package.

func (*GeolocationPackage) HandleUp

func (p *GeolocationPackage) HandleUp(ctx context.Context, def *ttnpb.ApplicationPackageDefaultAssociation, assoc *ttnpb.ApplicationPackageAssociation, up *ttnpb.ApplicationUp) (err error)

HandleUp implements packages.ApplicationPackageHandler.

func (*GeolocationPackage) Package

func (p *GeolocationPackage) Package() *ttnpb.ApplicationPackage

Package implements packages.ApplicationPackageHandler.

type QueryType

type QueryType uint8

QueryType enum defines the location query types of the package.

const (
	// QUERY_TOARSSI uses the TOA and RSSI information from the gateway metadata to compute the location of the end device.
	QUERY_TOARSSI QueryType = iota
	// QUERY_GNSS uses the GNSS scan operations payload of the LR1110 transceiver.
	QUERY_GNSS
	// QUERY_TOAWIFI uses the TOA and RSSI information, in addition to nearby WiFi access points.
	QUERY_TOAWIFI
)

func (*QueryType) FromValue

func (t *QueryType) FromValue(v *types.Value) error

FromValue sets the query type from a protobuf value.

func (QueryType) Value

func (t QueryType) Value() *types.Value

Value returns the protobuf value for the query type.