gateway

package
v2.6.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 23, 2017 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package gateway is a generated protocol buffer package.

It is generated from these files: 

github.com/TheThingsNetwork/ttn/api/gateway/gateway.proto

It has these top-level messages: 

GPSMetadata
RxMetadata
TxConfiguration
Status

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthGateway = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGateway   = fmt.Errorf("proto: integer overflow")
)

Functions

This section is empty.

Types

type GPSMetadata 

type GPSMetadata struct {
	// Time in Unix nanoseconds
	Time      int64   `protobuf:"varint,1,opt,name=time,proto3" json:"time,omitempty"`
	Latitude  float32 `protobuf:"fixed32,2,opt,name=latitude,proto3" json:"latitude,omitempty"`
	Longitude float32 `protobuf:"fixed32,3,opt,name=longitude,proto3" json:"longitude,omitempty"`
	Altitude  int32   `protobuf:"varint,4,opt,name=altitude,proto3" json:"altitude,omitempty"`
}

func RandomLocation 

func RandomLocation() (gps *GPSMetadata)

RandomLocation returns randomly generated gateway location. Used for testing.

func (*GPSMetadata) Descriptor 

func (*GPSMetadata) Descriptor() ([]byte, []int)

func (*GPSMetadata) GetAltitude 

func (m *GPSMetadata) GetAltitude() int32

func (*GPSMetadata) GetLatitude 

func (m *GPSMetadata) GetLatitude() float32

func (*GPSMetadata) GetLongitude 

func (m *GPSMetadata) GetLongitude() float32

func (*GPSMetadata) GetTime 

func (m *GPSMetadata) GetTime() int64

func (GPSMetadata) IsZero 

func (m GPSMetadata) IsZero() bool

func (*GPSMetadata) Marshal 

func (m *GPSMetadata) Marshal() (dAtA []byte, err error)

func (*GPSMetadata) MarshalTo 

func (m *GPSMetadata) MarshalTo(dAtA []byte) (int, error)

func (*GPSMetadata) ProtoMessage 

func (*GPSMetadata) ProtoMessage()

func (*GPSMetadata) Reset 

func (m *GPSMetadata) Reset()

func (*GPSMetadata) Size 

func (m *GPSMetadata) Size() (n int)

func (*GPSMetadata) String 

func (m *GPSMetadata) String() string

func (*GPSMetadata) Unmarshal 

func (m *GPSMetadata) Unmarshal(dAtA []byte) error

func (*GPSMetadata) Validate 

func (m *GPSMetadata) Validate() error

Validate implements the api.Validator interface

type RxMetadata 

type RxMetadata struct {
	GatewayId string `protobuf:"bytes,1,opt,name=gateway_id,json=gatewayId,proto3" json:"gateway_id,omitempty"`
	// Indicates whether the gateway is trusted. Components that are able to verify gateway trust MUST do so and set this value accordingly
	GatewayTrusted bool `protobuf:"varint,2,opt,name=gateway_trusted,json=gatewayTrusted,proto3" json:"gateway_trusted,omitempty"`
	// Timestamp (uptime of LoRa module) in microseconds with rollover
	Timestamp uint32 `protobuf:"varint,11,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Time in Unix nanoseconds
	Time int64 `protobuf:"varint,12,opt,name=time,proto3" json:"time,omitempty"`
	// Encrypted time from the Gateway FPGA
	EncryptedTime []byte                `protobuf:"bytes,13,opt,name=encrypted_time,json=encryptedTime,proto3" json:"encrypted_time,omitempty"`
	RfChain       uint32                `protobuf:"varint,21,opt,name=rf_chain,json=rfChain,proto3" json:"rf_chain,omitempty"`
	Channel       uint32                `protobuf:"varint,22,opt,name=channel,proto3" json:"channel,omitempty"`
	Antennas      []*RxMetadata_Antenna `protobuf:"bytes,30,rep,name=antennas" json:"antennas,omitempty"`
	// Frequency in Hz
	Frequency uint64 `protobuf:"varint,31,opt,name=frequency,proto3" json:"frequency,omitempty"`
	// Received signal strength in dBm
	Rssi float32 `protobuf:"fixed32,32,opt,name=rssi,proto3" json:"rssi,omitempty"`
	// Signal-to-noise-ratio in dB
	Snr float32      `protobuf:"fixed32,33,opt,name=snr,proto3" json:"snr,omitempty"`
	Gps *GPSMetadata `protobuf:"bytes,41,opt,name=gps" json:"gps,omitempty"`
}

func RandomRxMetadata 

func RandomRxMetadata() *RxMetadata

RandomRxMetadata returns randomly generated gateway rx metadata. Used for testing.

func (*RxMetadata) Descriptor 

func (*RxMetadata) Descriptor() ([]byte, []int)

func (*RxMetadata) GetAntennas 

func (m *RxMetadata) GetAntennas() []*RxMetadata_Antenna

func (*RxMetadata) GetChannel 

func (m *RxMetadata) GetChannel() uint32

func (*RxMetadata) GetEncryptedTime 

func (m *RxMetadata) GetEncryptedTime() []byte

func (*RxMetadata) GetFrequency 

func (m *RxMetadata) GetFrequency() uint64

func (*RxMetadata) GetGatewayId 

func (m *RxMetadata) GetGatewayId() string

func (*RxMetadata) GetGatewayTrusted 

func (m *RxMetadata) GetGatewayTrusted() bool

func (*RxMetadata) GetGps 

func (m *RxMetadata) GetGps() *GPSMetadata

func (*RxMetadata) GetRfChain 

func (m *RxMetadata) GetRfChain() uint32

func (*RxMetadata) GetRssi 

func (m *RxMetadata) GetRssi() float32

func (*RxMetadata) GetSnr 

func (m *RxMetadata) GetSnr() float32

func (*RxMetadata) GetTime 

func (m *RxMetadata) GetTime() int64

func (*RxMetadata) GetTimestamp 

func (m *RxMetadata) GetTimestamp() uint32

func (*RxMetadata) Marshal 

func (m *RxMetadata) Marshal() (dAtA []byte, err error)

func (*RxMetadata) MarshalTo 

func (m *RxMetadata) MarshalTo(dAtA []byte) (int, error)

func (*RxMetadata) ProtoMessage 

func (*RxMetadata) ProtoMessage()

func (*RxMetadata) Reset 

func (m *RxMetadata) Reset()

func (*RxMetadata) Size 

func (m *RxMetadata) Size() (n int)

func (*RxMetadata) String 

func (m *RxMetadata) String() string

func (*RxMetadata) Unmarshal 

func (m *RxMetadata) Unmarshal(dAtA []byte) error

func (*RxMetadata) Validate 

func (m *RxMetadata) Validate() error

Validate implements the api.Validator interface

type RxMetadata_Antenna 

type RxMetadata_Antenna struct {
	Antenna uint32 `protobuf:"varint,1,opt,name=antenna,proto3" json:"antenna,omitempty"`
	Channel uint32 `protobuf:"varint,2,opt,name=channel,proto3" json:"channel,omitempty"`
	// Received signal strength in dBm
	Rssi float32 `protobuf:"fixed32,3,opt,name=rssi,proto3" json:"rssi,omitempty"`
	// Signal-to-noise-ratio in dB
	Snr float32 `protobuf:"fixed32,4,opt,name=snr,proto3" json:"snr,omitempty"`
	// Encrypted time from the Gateway FPGA
	EncryptedTime []byte `protobuf:"bytes,10,opt,name=encrypted_time,json=encryptedTime,proto3" json:"encrypted_time,omitempty"`
}

func (*RxMetadata_Antenna) Descriptor 

func (*RxMetadata_Antenna) Descriptor() ([]byte, []int)

func (*RxMetadata_Antenna) GetAntenna 

func (m *RxMetadata_Antenna) GetAntenna() uint32

func (*RxMetadata_Antenna) GetChannel 

func (m *RxMetadata_Antenna) GetChannel() uint32

func (*RxMetadata_Antenna) GetEncryptedTime 

func (m *RxMetadata_Antenna) GetEncryptedTime() []byte

func (*RxMetadata_Antenna) GetRssi 

func (m *RxMetadata_Antenna) GetRssi() float32

func (*RxMetadata_Antenna) GetSnr 

func (m *RxMetadata_Antenna) GetSnr() float32

func (*RxMetadata_Antenna) Marshal 

func (m *RxMetadata_Antenna) Marshal() (dAtA []byte, err error)

func (*RxMetadata_Antenna) MarshalTo 

func (m *RxMetadata_Antenna) MarshalTo(dAtA []byte) (int, error)

func (*RxMetadata_Antenna) ProtoMessage 

func (*RxMetadata_Antenna) ProtoMessage()

func (*RxMetadata_Antenna) Reset 

func (m *RxMetadata_Antenna) Reset()

func (*RxMetadata_Antenna) Size 

func (m *RxMetadata_Antenna) Size() (n int)

func (*RxMetadata_Antenna) String 

func (m *RxMetadata_Antenna) String() string

func (*RxMetadata_Antenna) Unmarshal 

func (m *RxMetadata_Antenna) Unmarshal(dAtA []byte) error

type Status 

type Status struct {
	// Timestamp (uptime of gateway) in microseconds with rollover
	Timestamp uint32 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Time in Unix nanoseconds
	Time int64 `protobuf:"varint,2,opt,name=time,proto3" json:"time,omitempty"`
	// Indicates whether the gateway is trusted. Components that are able to verify gateway trust MUST do so and set this value accordingly
	GatewayTrusted bool `protobuf:"varint,3,opt,name=gateway_trusted,json=gatewayTrusted,proto3" json:"gateway_trusted,omitempty"`
	// Boot time in Unix nanoseconds
	BootTime     int64    `protobuf:"varint,4,opt,name=boot_time,json=bootTime,proto3" json:"boot_time,omitempty"`
	Ip           []string `protobuf:"bytes,11,rep,name=ip" json:"ip,omitempty"`
	Platform     string   `protobuf:"bytes,12,opt,name=platform,proto3" json:"platform,omitempty"`
	ContactEmail string   `protobuf:"bytes,13,opt,name=contact_email,json=contactEmail,proto3" json:"contact_email,omitempty"`
	Description  string   `protobuf:"bytes,14,opt,name=description,proto3" json:"description,omitempty"`
	// The gateway's frequency plan: one of EU_863_870, US_902_928, CN_779_787, EU_433, AU_915_928, CN_470_510, AS_923, AS_920_923, AS_923_925, KR_920_923
	FrequencyPlan string `protobuf:"bytes,15,opt,name=frequency_plan,json=frequencyPlan,proto3" json:"frequency_plan,omitempty"`
	// The value of Bridge is set by the Bridge
	Bridge string `protobuf:"bytes,16,opt,name=bridge,proto3" json:"bridge,omitempty"`
	// The value of Router is set by the Router
	Router string `protobuf:"bytes,17,opt,name=router,proto3" json:"router,omitempty"`
	// Version of Gateway FPGA
	Fpga uint32 `protobuf:"varint,18,opt,name=fpga,proto3" json:"fpga,omitempty"`
	// Version of Gateway DSP software
	Dsp uint32 `protobuf:"varint,19,opt,name=dsp,proto3" json:"dsp,omitempty"`
	// Version of gateway driver (in X.X.X format)
	Hal string       `protobuf:"bytes,20,opt,name=hal,proto3" json:"hal,omitempty"`
	Gps *GPSMetadata `protobuf:"bytes,21,opt,name=gps" json:"gps,omitempty"`
	// Round-trip time to the server in milliseconds
	Rtt uint32 `protobuf:"varint,31,opt,name=rtt,proto3" json:"rtt,omitempty"`
	// Total number of received uplink packets since boot
	RxIn uint32 `protobuf:"varint,41,opt,name=rx_in,json=rxIn,proto3" json:"rx_in,omitempty"`
	// Total number of successful (correct) uplink packets since boot
	RxOk uint32 `protobuf:"varint,42,opt,name=rx_ok,json=rxOk,proto3" json:"rx_ok,omitempty"`
	// Total number of received downlink packets since boot
	TxIn uint32 `protobuf:"varint,43,opt,name=tx_in,json=txIn,proto3" json:"tx_in,omitempty"`
	// Total number of successfully sent downlink packets since boot
	TxOk uint32 `protobuf:"varint,44,opt,name=tx_ok,json=txOk,proto3" json:"tx_ok,omitempty"`
	// Total number of packets received from link testing mote, with CRC OK
	LmOk uint32 `protobuf:"varint,45,opt,name=lm_ok,json=lmOk,proto3" json:"lm_ok,omitempty"`
	// Sequence number of the first packet received from the link testing mote
	LmSt uint32 `protobuf:"varint,46,opt,name=lm_st,json=lmSt,proto3" json:"lm_st,omitempty"`
	// Sequence number of the last packet received from the link testing mote
	LmNw uint32 `protobuf:"varint,47,opt,name=lm_nw,json=lmNw,proto3" json:"lm_nw,omitempty"`
	// Number of lost PPS pulses
	LPps uint32            `protobuf:"varint,48,opt,name=l_pps,json=lPps,proto3" json:"l_pps,omitempty"`
	Os   *Status_OSMetrics `protobuf:"bytes,51,opt,name=os" json:"os,omitempty"`
}

message Status represents a status update from a Gateway.

func RandomStatus 

func RandomStatus() *Status

RandomStatus returns randomly generated gateway status. Used for testing.

func (*Status) Descriptor 

func (*Status) Descriptor() ([]byte, []int)

func (*Status) GetBootTime 

func (m *Status) GetBootTime() int64

func (*Status) GetBridge 

func (m *Status) GetBridge() string

func (*Status) GetContactEmail 

func (m *Status) GetContactEmail() string

func (*Status) GetDescription 

func (m *Status) GetDescription() string

func (*Status) GetDsp 

func (m *Status) GetDsp() uint32

func (*Status) GetFpga 

func (m *Status) GetFpga() uint32

func (*Status) GetFrequencyPlan 

func (m *Status) GetFrequencyPlan() string

func (*Status) GetGatewayTrusted 

func (m *Status) GetGatewayTrusted() bool

func (*Status) GetGps 

func (m *Status) GetGps() *GPSMetadata

func (*Status) GetHal 

func (m *Status) GetHal() string

func (*Status) GetIp 

func (m *Status) GetIp() []string

func (*Status) GetLPps 

func (m *Status) GetLPps() uint32

func (*Status) GetLmNw 

func (m *Status) GetLmNw() uint32

func (*Status) GetLmOk 

func (m *Status) GetLmOk() uint32

func (*Status) GetLmSt 

func (m *Status) GetLmSt() uint32

func (*Status) GetOs 

func (m *Status) GetOs() *Status_OSMetrics

func (*Status) GetPlatform 

func (m *Status) GetPlatform() string

func (*Status) GetRouter 

func (m *Status) GetRouter() string

func (*Status) GetRtt 

func (m *Status) GetRtt() uint32

func (*Status) GetRxIn 

func (m *Status) GetRxIn() uint32

func (*Status) GetRxOk 

func (m *Status) GetRxOk() uint32

func (*Status) GetTime 

func (m *Status) GetTime() int64

func (*Status) GetTimestamp 

func (m *Status) GetTimestamp() uint32

func (*Status) GetTxIn 

func (m *Status) GetTxIn() uint32

func (*Status) GetTxOk 

func (m *Status) GetTxOk() uint32

func (*Status) Marshal 

func (m *Status) Marshal() (dAtA []byte, err error)

func (*Status) MarshalTo 

func (m *Status) MarshalTo(dAtA []byte) (int, error)

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) Reset 

func (m *Status) Reset()

func (*Status) Size 

func (m *Status) Size() (n int)

func (*Status) String 

func (m *Status) String() string

func (*Status) Unmarshal 

func (m *Status) Unmarshal(dAtA []byte) error

func (*Status) Validate 

func (m *Status) Validate() error

Validate implements the api.Validator interface

type Status_OSMetrics 

type Status_OSMetrics struct {
	Load_1           float32 `protobuf:"fixed32,1,opt,name=load_1,json=load1,proto3" json:"load_1,omitempty"`
	Load_5           float32 `protobuf:"fixed32,2,opt,name=load_5,json=load5,proto3" json:"load_5,omitempty"`
	Load_15          float32 `protobuf:"fixed32,3,opt,name=load_15,json=load15,proto3" json:"load_15,omitempty"`
	CpuPercentage    float32 `protobuf:"fixed32,11,opt,name=cpu_percentage,json=cpuPercentage,proto3" json:"cpu_percentage,omitempty"`
	MemoryPercentage float32 `protobuf:"fixed32,21,opt,name=memory_percentage,json=memoryPercentage,proto3" json:"memory_percentage,omitempty"`
	Temperature      float32 `protobuf:"fixed32,31,opt,name=temperature,proto3" json:"temperature,omitempty"`
}

Additional metrics from the operating system

func (*Status_OSMetrics) Descriptor 

func (*Status_OSMetrics) Descriptor() ([]byte, []int)

func (*Status_OSMetrics) GetCpuPercentage 

func (m *Status_OSMetrics) GetCpuPercentage() float32

func (*Status_OSMetrics) GetLoad_1 

func (m *Status_OSMetrics) GetLoad_1() float32

func (*Status_OSMetrics) GetLoad_15 

func (m *Status_OSMetrics) GetLoad_15() float32

func (*Status_OSMetrics) GetLoad_5 

func (m *Status_OSMetrics) GetLoad_5() float32

func (*Status_OSMetrics) GetMemoryPercentage 

func (m *Status_OSMetrics) GetMemoryPercentage() float32

func (*Status_OSMetrics) GetTemperature 

func (m *Status_OSMetrics) GetTemperature() float32

func (*Status_OSMetrics) Marshal 

func (m *Status_OSMetrics) Marshal() (dAtA []byte, err error)

func (*Status_OSMetrics) MarshalTo 

func (m *Status_OSMetrics) MarshalTo(dAtA []byte) (int, error)

func (*Status_OSMetrics) ProtoMessage 

func (*Status_OSMetrics) ProtoMessage()

func (*Status_OSMetrics) Reset 

func (m *Status_OSMetrics) Reset()

func (*Status_OSMetrics) Size 

func (m *Status_OSMetrics) Size() (n int)

func (*Status_OSMetrics) String 

func (m *Status_OSMetrics) String() string

func (*Status_OSMetrics) Unmarshal 

func (m *Status_OSMetrics) Unmarshal(dAtA []byte) error

type TxConfiguration 

type TxConfiguration struct {
	// Timestamp (uptime of LoRa module) in microseconds with rollover
	Timestamp uint32 `protobuf:"varint,11,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	RfChain   uint32 `protobuf:"varint,21,opt,name=rf_chain,json=rfChain,proto3" json:"rf_chain,omitempty"`
	// Frequency in Hz
	Frequency uint64 `protobuf:"varint,22,opt,name=frequency,proto3" json:"frequency,omitempty"`
	// Transmit power in dBm
	Power int32 `protobuf:"varint,23,opt,name=power,proto3" json:"power,omitempty"`
	// LoRa polarization inversion (basically always true for messages from gateway to node)
	PolarizationInversion bool `` /* 126-byte string literal not displayed */
	// FSK frequency deviation in Hz
	FrequencyDeviation uint32 `protobuf:"varint,32,opt,name=frequency_deviation,json=frequencyDeviation,proto3" json:"frequency_deviation,omitempty"`
}

func RandomTxConfiguration 

func RandomTxConfiguration() *TxConfiguration

RandomTxConfiguration returns randomly generated gateway tx configuration. Used for testing.

func (*TxConfiguration) Descriptor 

func (*TxConfiguration) Descriptor() ([]byte, []int)

func (*TxConfiguration) GetFrequency 

func (m *TxConfiguration) GetFrequency() uint64

func (*TxConfiguration) GetFrequencyDeviation 

func (m *TxConfiguration) GetFrequencyDeviation() uint32

func (*TxConfiguration) GetPolarizationInversion 

func (m *TxConfiguration) GetPolarizationInversion() bool

func (*TxConfiguration) GetPower 

func (m *TxConfiguration) GetPower() int32

func (*TxConfiguration) GetRfChain 

func (m *TxConfiguration) GetRfChain() uint32

func (*TxConfiguration) GetTimestamp 

func (m *TxConfiguration) GetTimestamp() uint32

func (*TxConfiguration) Marshal 

func (m *TxConfiguration) Marshal() (dAtA []byte, err error)

func (*TxConfiguration) MarshalTo 

func (m *TxConfiguration) MarshalTo(dAtA []byte) (int, error)

func (*TxConfiguration) ProtoMessage 

func (*TxConfiguration) ProtoMessage()

func (*TxConfiguration) Reset 

func (m *TxConfiguration) Reset()

func (*TxConfiguration) Size 

func (m *TxConfiguration) Size() (n int)

func (*TxConfiguration) String 

func (m *TxConfiguration) String() string

func (*TxConfiguration) Unmarshal 

func (m *TxConfiguration) Unmarshal(dAtA []byte) error

func (*TxConfiguration) Validate 

func (m *TxConfiguration) Validate() error

Validate implements the api.Validator interface

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.