integration

package
v3.13.4 Latest Latest
Warning

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

 Go to latest Published: Mar 23, 2023 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrorType_name = map[int32]string{
	0:  "UNKNOWN",
	1:  "DOWNLINK_PAYLOAD_SIZE",
	2:  "DOWNLINK_FCNT",
	3:  "UPLINK_CODEC",
	4:  "DOWNLINK_CODEC",
	5:  "OTAA",
	6:  "UPLINK_FCNT_RESET",
	7:  "UPLINK_MIC",
	8:  "UPLINK_FCNT_RETRANSMISSION",
	9:  "DOWNLINK_GATEWAY",
	10: "DOWNLINK_DEVICE_NOT_ACTIVATED",
}
View Source 
var ErrorType_value = map[string]int32{
	"UNKNOWN":                       0,
	"DOWNLINK_PAYLOAD_SIZE":         1,
	"DOWNLINK_FCNT":                 2,
	"UPLINK_CODEC":                  3,
	"DOWNLINK_CODEC":                4,
	"OTAA":                          5,
	"UPLINK_FCNT_RESET":             6,
	"UPLINK_MIC":                    7,
	"UPLINK_FCNT_RETRANSMISSION":    8,
	"DOWNLINK_GATEWAY":              9,
	"DOWNLINK_DEVICE_NOT_ACTIVATED": 10,
}

Functions

This section is empty.

Types

type AckEvent 

type AckEvent struct {
	// Application ID.
	ApplicationId uint64 `protobuf:"varint,1,opt,name=application_id,json=applicationID,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,2,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui []byte `protobuf:"bytes,4,opt,name=dev_eui,json=devEUI,proto3" json:"dev_eui,omitempty"`
	// Frame was acknowledged.
	Acknowledged bool `protobuf:"varint,5,opt,name=acknowledged,proto3" json:"acknowledged,omitempty"`
	// Downlink frame counter to which the acknowledgement relates.
	FCnt uint32 `protobuf:"varint,6,opt,name=f_cnt,json=fCnt,proto3" json:"f_cnt,omitempty"`
	// User-defined device tags.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// Published at timestamp.
	PublishedAt          *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

AckEvent is the message sent when a confirmation on a confirmed downlink has been received -or- when the downlink timed out.

func (*AckEvent) Descriptor 

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

func (*AckEvent) GetAcknowledged 

func (m *AckEvent) GetAcknowledged() bool

func (*AckEvent) GetApplicationId 

func (m *AckEvent) GetApplicationId() uint64

func (*AckEvent) GetApplicationName 

func (m *AckEvent) GetApplicationName() string

func (*AckEvent) GetDevEui 

func (m *AckEvent) GetDevEui() []byte

func (*AckEvent) GetDeviceName 

func (m *AckEvent) GetDeviceName() string

func (*AckEvent) GetFCnt 

func (m *AckEvent) GetFCnt() uint32

func (*AckEvent) GetPublishedAt added in v3.9.2 

func (m *AckEvent) GetPublishedAt() *timestamppb.Timestamp

func (*AckEvent) GetTags 

func (m *AckEvent) GetTags() map[string]string

func (*AckEvent) ProtoMessage 

func (*AckEvent) ProtoMessage()

func (*AckEvent) Reset 

func (m *AckEvent) Reset()

func (*AckEvent) String 

func (m *AckEvent) String() string

func (*AckEvent) XXX_DiscardUnknown 

func (m *AckEvent) XXX_DiscardUnknown()

func (*AckEvent) XXX_Marshal 

func (m *AckEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AckEvent) XXX_Merge 

func (m *AckEvent) XXX_Merge(src proto.Message)

func (*AckEvent) XXX_Size 

func (m *AckEvent) XXX_Size() int

func (*AckEvent) XXX_Unmarshal 

func (m *AckEvent) XXX_Unmarshal(b []byte) error

type ErrorEvent 

type ErrorEvent struct {
	// Application ID.
	ApplicationId uint64 `protobuf:"varint,1,opt,name=application_id,json=applicationID,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,2,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui []byte `protobuf:"bytes,4,opt,name=dev_eui,json=devEUI,proto3" json:"dev_eui,omitempty"`
	// Error type.
	Type ErrorType `protobuf:"varint,5,opt,name=type,proto3,enum=integration.ErrorType" json:"type,omitempty"`
	// Error message.
	Error string `protobuf:"bytes,6,opt,name=error,proto3" json:"error,omitempty"`
	// Downlink frame-counter (in case the downlink is related to a scheduled downlink).
	FCnt uint32 `protobuf:"varint,7,opt,name=f_cnt,json=fCnt,proto3" json:"f_cnt,omitempty"`
	// User-defined device tags.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// Published at timestamp.
	PublishedAt *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// Error context related to the error.
	Context              map[string]string `` /* 156-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

ErrorEvent is the message sent when an error occurred.

func (*ErrorEvent) Descriptor 

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

func (*ErrorEvent) GetApplicationId 

func (m *ErrorEvent) GetApplicationId() uint64

func (*ErrorEvent) GetApplicationName 

func (m *ErrorEvent) GetApplicationName() string

func (*ErrorEvent) GetContext added in v3.13.1 

func (m *ErrorEvent) GetContext() map[string]string

func (*ErrorEvent) GetDevEui 

func (m *ErrorEvent) GetDevEui() []byte

func (*ErrorEvent) GetDeviceName 

func (m *ErrorEvent) GetDeviceName() string

func (*ErrorEvent) GetError 

func (m *ErrorEvent) GetError() string

func (*ErrorEvent) GetFCnt 

func (m *ErrorEvent) GetFCnt() uint32

func (*ErrorEvent) GetPublishedAt added in v3.9.2 

func (m *ErrorEvent) GetPublishedAt() *timestamppb.Timestamp

func (*ErrorEvent) GetTags 

func (m *ErrorEvent) GetTags() map[string]string

func (*ErrorEvent) GetType 

func (m *ErrorEvent) GetType() ErrorType

func (*ErrorEvent) ProtoMessage 

func (*ErrorEvent) ProtoMessage()

func (*ErrorEvent) Reset 

func (m *ErrorEvent) Reset()

func (*ErrorEvent) String 

func (m *ErrorEvent) String() string

func (*ErrorEvent) XXX_DiscardUnknown 

func (m *ErrorEvent) XXX_DiscardUnknown()

func (*ErrorEvent) XXX_Marshal 

func (m *ErrorEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ErrorEvent) XXX_Merge 

func (m *ErrorEvent) XXX_Merge(src proto.Message)

func (*ErrorEvent) XXX_Size 

func (m *ErrorEvent) XXX_Size() int

func (*ErrorEvent) XXX_Unmarshal 

func (m *ErrorEvent) XXX_Unmarshal(b []byte) error

type ErrorType 

type ErrorType int32
const (
	// Unknown type.
	ErrorType_UNKNOWN ErrorType = 0
	// Error related to the downlink payload size.
	// Usually seen when the payload exceeded the maximum allowed payload size.
	ErrorType_DOWNLINK_PAYLOAD_SIZE ErrorType = 1
	// Error related to the downlink frame-counter.
	// Usually seen when the frame-counter has already been used.
	ErrorType_DOWNLINK_FCNT ErrorType = 2
	// Uplink codec error.
	ErrorType_UPLINK_CODEC ErrorType = 3
	// Downlink codec error.
	ErrorType_DOWNLINK_CODEC ErrorType = 4
	// OTAA error.
	ErrorType_OTAA ErrorType = 5
	// Uplink frame-counter was reset.
	ErrorType_UPLINK_FCNT_RESET ErrorType = 6
	// Uplink MIC error.
	ErrorType_UPLINK_MIC ErrorType = 7
	// Uplink frame-counter retransmission.
	ErrorType_UPLINK_FCNT_RETRANSMISSION ErrorType = 8
	// Downlink gateway error.
	ErrorType_DOWNLINK_GATEWAY ErrorType = 9
	// Downlink queue device not activated error.
	ErrorType_DOWNLINK_DEVICE_NOT_ACTIVATED ErrorType = 10
)

func (ErrorType) EnumDescriptor 

func (ErrorType) EnumDescriptor() ([]byte, []int)

func (ErrorType) String 

func (x ErrorType) String() string

type GatewayConnStatEvent added in v3.10.3 

type GatewayConnStatEvent struct {
	// Gateway ID.
	GatewayId []byte `protobuf:"bytes,1,opt,name=gateway_id,json=gatewayID,proto3" json:"gateway_id,omitempty"`
	// Stat contains Gateway connection status ONLINE/OFFLINE
	State gw.State `protobuf:"varint,2,opt,name=state,proto3,enum=gw.State" json:"state,omitempty"`
	// Additional gateway meta-data.
	MetaData map[string]string `` /* 173-byte string literal not displayed */
	// Tags (user defined).
	// These tags are exposed in the stat event payloads or to integration. Tags are
	// intended for aggregation and filtering.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// Stats ID (UUID).
	// Unique identifier for the gateway stats.
	StatsId []byte `protobuf:"bytes,5,opt,name=stats_id,json=statsID,proto3" json:"stats_id,omitempty"`
	// MQTT Message Retained or not.
	IsRetained bool `protobuf:"varint,6,opt,name=is_retained,json=isRetained,proto3" json:"is_retained,omitempty"`
	// Published at timestamp.
	PublishedAt          *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

GatewayConnStatEvent is the message sent gateway connection stats.

func (*GatewayConnStatEvent) Descriptor added in v3.10.3 

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

func (*GatewayConnStatEvent) GetGatewayId added in v3.10.3 

func (m *GatewayConnStatEvent) GetGatewayId() []byte

func (*GatewayConnStatEvent) GetIsRetained added in v3.12.8 

func (m *GatewayConnStatEvent) GetIsRetained() bool

func (*GatewayConnStatEvent) GetMetaData added in v3.10.3 

func (m *GatewayConnStatEvent) GetMetaData() map[string]string

func (*GatewayConnStatEvent) GetPublishedAt added in v3.12.0 

func (m *GatewayConnStatEvent) GetPublishedAt() *timestamppb.Timestamp

func (*GatewayConnStatEvent) GetState added in v3.10.3 

func (m *GatewayConnStatEvent) GetState() gw.State

func (*GatewayConnStatEvent) GetStatsId added in v3.12.8 

func (m *GatewayConnStatEvent) GetStatsId() []byte

func (*GatewayConnStatEvent) GetTags added in v3.10.3 

func (m *GatewayConnStatEvent) GetTags() map[string]string

func (*GatewayConnStatEvent) ProtoMessage added in v3.10.3 

func (*GatewayConnStatEvent) ProtoMessage()

func (*GatewayConnStatEvent) Reset added in v3.10.3 

func (m *GatewayConnStatEvent) Reset()

func (*GatewayConnStatEvent) String added in v3.10.3 

func (m *GatewayConnStatEvent) String() string

func (*GatewayConnStatEvent) XXX_DiscardUnknown added in v3.10.3 

func (m *GatewayConnStatEvent) XXX_DiscardUnknown()

func (*GatewayConnStatEvent) XXX_Marshal added in v3.10.3 

func (m *GatewayConnStatEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GatewayConnStatEvent) XXX_Merge added in v3.10.3 

func (m *GatewayConnStatEvent) XXX_Merge(src proto.Message)

func (*GatewayConnStatEvent) XXX_Size added in v3.10.3 

func (m *GatewayConnStatEvent) XXX_Size() int

func (*GatewayConnStatEvent) XXX_Unmarshal added in v3.10.3 

func (m *GatewayConnStatEvent) XXX_Unmarshal(b []byte) error

type GatewayStatsEvent 

type GatewayStatsEvent struct {
	// Gateway ID.
	GatewayId []byte `protobuf:"bytes,1,opt,name=gateway_id,json=gatewayID,proto3" json:"gateway_id,omitempty"`
	// Gateway IP.
	Ip string `protobuf:"bytes,9,opt,name=ip,proto3" json:"ip,omitempty"`
	// Gateway time.
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// Gateway location.
	Location *common.Location `protobuf:"bytes,3,opt,name=location,proto3" json:"location,omitempty"`
	// Gateway configuration version (this maps to the config_version sent
	// by LoRa Server to the gateway).
	ConfigVersion string `protobuf:"bytes,4,opt,name=config_version,json=configVersion,proto3" json:"config_version,omitempty"`
	// Number of radio packets received.
	RxPacketsReceived uint32 `protobuf:"varint,5,opt,name=rx_packets_received,json=rxPacketsReceived,proto3" json:"rx_packets_received,omitempty"`
	// Number of radio packets received with valid PHY CRC.
	RxPacketsReceivedOk uint32 `protobuf:"varint,6,opt,name=rx_packets_received_ok,json=rxPacketsReceivedOK,proto3" json:"rx_packets_received_ok,omitempty"`
	// Number of downlink packets received for transmission.
	TxPacketsReceived uint32 `protobuf:"varint,7,opt,name=tx_packets_received,json=txPacketsReceived,proto3" json:"tx_packets_received,omitempty"`
	// Number of downlink packets emitted.
	TxPacketsEmitted uint32 `protobuf:"varint,8,opt,name=tx_packets_emitted,json=txPacketsEmitted,proto3" json:"tx_packets_emitted,omitempty"`
	// Additional gateway meta-data.
	MetaData map[string]string `` /* 174-byte string literal not displayed */
	// Stats ID (UUID).
	// Unique identifier for the gateway stats.
	StatsId []byte `protobuf:"bytes,11,opt,name=stats_id,json=statsID,proto3" json:"stats_id,omitempty"`
	// Tags (user defined).
	// These tags are exposed in the stat event payloads or to integration. Tags are
	// intended for aggregation and filtering.
	Tags map[string]string `` /* 150-byte string literal not displayed */
	// As the exposed ack-rate represents the last reported ack-rate by the GW,
	// it is also important to monitor the ack-rate count. If this value does
	// not increment, it could mean that the GW is no longer reporting the
	// ack-rate and thus the exposed ack-rate is stale.
	AckRate              float32  `protobuf:"fixed32,13,opt,name=ack_rate,json=ackRate,proto3" json:"ack_rate,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

GatewayStatsEvent is the message sent gateway stats.

func (*GatewayStatsEvent) Descriptor 

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

func (*GatewayStatsEvent) GetAckRate added in v3.13.1 

func (m *GatewayStatsEvent) GetAckRate() float32

func (*GatewayStatsEvent) GetConfigVersion 

func (m *GatewayStatsEvent) GetConfigVersion() string

func (*GatewayStatsEvent) GetGatewayId 

func (m *GatewayStatsEvent) GetGatewayId() []byte

func (*GatewayStatsEvent) GetIp 

func (m *GatewayStatsEvent) GetIp() string

func (*GatewayStatsEvent) GetLocation 

func (m *GatewayStatsEvent) GetLocation() *common.Location

func (*GatewayStatsEvent) GetMetaData 

func (m *GatewayStatsEvent) GetMetaData() map[string]string

func (*GatewayStatsEvent) GetRxPacketsReceived 

func (m *GatewayStatsEvent) GetRxPacketsReceived() uint32

func (*GatewayStatsEvent) GetRxPacketsReceivedOk 

func (m *GatewayStatsEvent) GetRxPacketsReceivedOk() uint32

func (*GatewayStatsEvent) GetStatsId 

func (m *GatewayStatsEvent) GetStatsId() []byte

func (*GatewayStatsEvent) GetTags added in v3.10.0 

func (m *GatewayStatsEvent) GetTags() map[string]string

func (*GatewayStatsEvent) GetTime 

func (m *GatewayStatsEvent) GetTime() *timestamppb.Timestamp

func (*GatewayStatsEvent) GetTxPacketsEmitted 

func (m *GatewayStatsEvent) GetTxPacketsEmitted() uint32

func (*GatewayStatsEvent) GetTxPacketsReceived 

func (m *GatewayStatsEvent) GetTxPacketsReceived() uint32

func (*GatewayStatsEvent) ProtoMessage 

func (*GatewayStatsEvent) ProtoMessage()

func (*GatewayStatsEvent) Reset 

func (m *GatewayStatsEvent) Reset()

func (*GatewayStatsEvent) String 

func (m *GatewayStatsEvent) String() string

func (*GatewayStatsEvent) XXX_DiscardUnknown 

func (m *GatewayStatsEvent) XXX_DiscardUnknown()

func (*GatewayStatsEvent) XXX_Marshal 

func (m *GatewayStatsEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GatewayStatsEvent) XXX_Merge 

func (m *GatewayStatsEvent) XXX_Merge(src proto.Message)

func (*GatewayStatsEvent) XXX_Size 

func (m *GatewayStatsEvent) XXX_Size() int

func (*GatewayStatsEvent) XXX_Unmarshal 

func (m *GatewayStatsEvent) XXX_Unmarshal(b []byte) error

type IntegrationEvent 

type IntegrationEvent struct {
	// Application ID.
	ApplicationId uint64 `protobuf:"varint,1,opt,name=application_id,json=applicationID,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,2,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui []byte `protobuf:"bytes,4,opt,name=dev_eui,json=devEUI,proto3" json:"dev_eui,omitempty"`
	// User-defined device tags.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// Integration name.
	IntegrationName string `protobuf:"bytes,6,opt,name=integration_name,json=integrationName,proto3" json:"integration_name,omitempty"`
	// Event type.
	EventType string `protobuf:"bytes,7,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	// JSON string containing the event object.
	ObjectJson string `protobuf:"bytes,8,opt,name=object_json,json=objectJSON,proto3" json:"object_json,omitempty"`
	// Published at timestamp.
	PublishedAt          *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

IntegrationEvent is the message that can be sent by an integration. It allows for sending events which are provided by an external integration which are "not native" to ChirpStack.

func (*IntegrationEvent) Descriptor 

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

func (*IntegrationEvent) GetApplicationId 

func (m *IntegrationEvent) GetApplicationId() uint64

func (*IntegrationEvent) GetApplicationName 

func (m *IntegrationEvent) GetApplicationName() string

func (*IntegrationEvent) GetDevEui 

func (m *IntegrationEvent) GetDevEui() []byte

func (*IntegrationEvent) GetDeviceName 

func (m *IntegrationEvent) GetDeviceName() string

func (*IntegrationEvent) GetEventType 

func (m *IntegrationEvent) GetEventType() string

func (*IntegrationEvent) GetIntegrationName 

func (m *IntegrationEvent) GetIntegrationName() string

func (*IntegrationEvent) GetObjectJson 

func (m *IntegrationEvent) GetObjectJson() string

func (*IntegrationEvent) GetPublishedAt added in v3.9.2 

func (m *IntegrationEvent) GetPublishedAt() *timestamppb.Timestamp

func (*IntegrationEvent) GetTags 

func (m *IntegrationEvent) GetTags() map[string]string

func (*IntegrationEvent) ProtoMessage 

func (*IntegrationEvent) ProtoMessage()

func (*IntegrationEvent) Reset 

func (m *IntegrationEvent) Reset()

func (*IntegrationEvent) String 

func (m *IntegrationEvent) String() string

func (*IntegrationEvent) XXX_DiscardUnknown 

func (m *IntegrationEvent) XXX_DiscardUnknown()

func (*IntegrationEvent) XXX_Marshal 

func (m *IntegrationEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*IntegrationEvent) XXX_Merge 

func (m *IntegrationEvent) XXX_Merge(src proto.Message)

func (*IntegrationEvent) XXX_Size 

func (m *IntegrationEvent) XXX_Size() int

func (*IntegrationEvent) XXX_Unmarshal 

func (m *IntegrationEvent) XXX_Unmarshal(b []byte) error

type JoinEvent 

type JoinEvent struct {
	// Application ID.
	ApplicationId uint64 `protobuf:"varint,1,opt,name=application_id,json=applicationID,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,2,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui []byte `protobuf:"bytes,4,opt,name=dev_eui,json=devEUI,proto3" json:"dev_eui,omitempty"`
	// Device address.
	DevAddr []byte `protobuf:"bytes,5,opt,name=dev_addr,json=devAddr,proto3" json:"dev_addr,omitempty"`
	// Receiving gateway RX info.
	RxInfo []*gw.UplinkRXInfo `protobuf:"bytes,6,rep,name=rx_info,json=rxInfo,proto3" json:"rx_info,omitempty"`
	// TX info.
	TxInfo *gw.UplinkTXInfo `protobuf:"bytes,7,opt,name=tx_info,json=txInfo,proto3" json:"tx_info,omitempty"`
	// Data-rate.
	Dr uint32 `protobuf:"varint,8,opt,name=dr,proto3" json:"dr,omitempty"`
	// User-defined device tags.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// Published at timestamp.
	PublishedAt          *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

JoinEvent is the message sent when a device joined the network. Note that this is only sent after the first received uplink after the device (re)activation.

func (*JoinEvent) Descriptor 

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

func (*JoinEvent) GetApplicationId 

func (m *JoinEvent) GetApplicationId() uint64

func (*JoinEvent) GetApplicationName 

func (m *JoinEvent) GetApplicationName() string

func (*JoinEvent) GetDevAddr 

func (m *JoinEvent) GetDevAddr() []byte

func (*JoinEvent) GetDevEui 

func (m *JoinEvent) GetDevEui() []byte

func (*JoinEvent) GetDeviceName 

func (m *JoinEvent) GetDeviceName() string

func (*JoinEvent) GetDr 

func (m *JoinEvent) GetDr() uint32

func (*JoinEvent) GetPublishedAt added in v3.9.2 

func (m *JoinEvent) GetPublishedAt() *timestamppb.Timestamp

func (*JoinEvent) GetRxInfo 

func (m *JoinEvent) GetRxInfo() []*gw.UplinkRXInfo

func (*JoinEvent) GetTags 

func (m *JoinEvent) GetTags() map[string]string

func (*JoinEvent) GetTxInfo 

func (m *JoinEvent) GetTxInfo() *gw.UplinkTXInfo

func (*JoinEvent) ProtoMessage 

func (*JoinEvent) ProtoMessage()

func (*JoinEvent) Reset 

func (m *JoinEvent) Reset()

func (*JoinEvent) String 

func (m *JoinEvent) String() string

func (*JoinEvent) XXX_DiscardUnknown 

func (m *JoinEvent) XXX_DiscardUnknown()

func (*JoinEvent) XXX_Marshal 

func (m *JoinEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*JoinEvent) XXX_Merge 

func (m *JoinEvent) XXX_Merge(src proto.Message)

func (*JoinEvent) XXX_Size 

func (m *JoinEvent) XXX_Size() int

func (*JoinEvent) XXX_Unmarshal 

func (m *JoinEvent) XXX_Unmarshal(b []byte) error

type LocationEvent 

type LocationEvent struct {
	// Application ID.
	ApplicationId uint64 `protobuf:"varint,1,opt,name=application_id,json=applicationID,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,2,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui []byte `protobuf:"bytes,4,opt,name=dev_eui,json=devEUI,proto3" json:"dev_eui,omitempty"`
	// Location.
	Location *common.Location `protobuf:"bytes,5,opt,name=location,proto3" json:"location,omitempty"`
	// User-defined device tags.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// Uplink IDs used for geolocation.
	// This is set in case the geolocation is based on the uplink meta-data.
	UplinkIds [][]byte `protobuf:"bytes,7,rep,name=uplink_ids,json=uplinkIDs,proto3" json:"uplink_ids,omitempty"`
	// Frame counter (in case the geolocation is based on the payload).
	// This is set in case the geolocation is based on the uplink payload content.
	FCnt uint32 `protobuf:"varint,8,opt,name=f_cnt,json=fCnt,proto3" json:"f_cnt,omitempty"`
	// Published at timestamp.
	PublishedAt          *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

LocationEvent is the message sent when a geolocation resolve was returned.

func (*LocationEvent) Descriptor 

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

func (*LocationEvent) GetApplicationId 

func (m *LocationEvent) GetApplicationId() uint64

func (*LocationEvent) GetApplicationName 

func (m *LocationEvent) GetApplicationName() string

func (*LocationEvent) GetDevEui 

func (m *LocationEvent) GetDevEui() []byte

func (*LocationEvent) GetDeviceName 

func (m *LocationEvent) GetDeviceName() string

func (*LocationEvent) GetFCnt 

func (m *LocationEvent) GetFCnt() uint32

func (*LocationEvent) GetLocation 

func (m *LocationEvent) GetLocation() *common.Location

func (*LocationEvent) GetPublishedAt added in v3.9.2 

func (m *LocationEvent) GetPublishedAt() *timestamppb.Timestamp

func (*LocationEvent) GetTags 

func (m *LocationEvent) GetTags() map[string]string

func (*LocationEvent) GetUplinkIds 

func (m *LocationEvent) GetUplinkIds() [][]byte

func (*LocationEvent) ProtoMessage 

func (*LocationEvent) ProtoMessage()

func (*LocationEvent) Reset 

func (m *LocationEvent) Reset()

func (*LocationEvent) String 

func (m *LocationEvent) String() string

func (*LocationEvent) XXX_DiscardUnknown 

func (m *LocationEvent) XXX_DiscardUnknown()

func (*LocationEvent) XXX_Marshal 

func (m *LocationEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LocationEvent) XXX_Merge 

func (m *LocationEvent) XXX_Merge(src proto.Message)

func (*LocationEvent) XXX_Size 

func (m *LocationEvent) XXX_Size() int

func (*LocationEvent) XXX_Unmarshal 

func (m *LocationEvent) XXX_Unmarshal(b []byte) error

type StatusEvent 

type StatusEvent struct {
	// Application ID.
	ApplicationId uint64 `protobuf:"varint,1,opt,name=application_id,json=applicationID,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,2,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui []byte `protobuf:"bytes,4,opt,name=dev_eui,json=devEUI,proto3" json:"dev_eui,omitempty"`
	// The demodulation signal-to-noise ratio in dB for the last successfully
	// received device-status request by the Network Server.
	Margin int32 `protobuf:"varint,5,opt,name=margin,proto3" json:"margin,omitempty"`
	// Device is connected to an external power source.
	ExternalPowerSource bool `protobuf:"varint,6,opt,name=external_power_source,json=externalPowerSource,proto3" json:"external_power_source,omitempty"`
	// Battery level is not available.
	BatteryLevelUnavailable bool `` /* 133-byte string literal not displayed */
	// Battery level.
	BatteryLevel float32 `protobuf:"fixed32,8,opt,name=battery_level,json=batteryLevel,proto3" json:"battery_level,omitempty"`
	// User-defined device tags.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// Published at timestamp.
	PublishedAt          *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

StatusEvent is the message sent when a device-status mac-command was sent by the device.

func (*StatusEvent) Descriptor 

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

func (*StatusEvent) GetApplicationId 

func (m *StatusEvent) GetApplicationId() uint64

func (*StatusEvent) GetApplicationName 

func (m *StatusEvent) GetApplicationName() string

func (*StatusEvent) GetBatteryLevel 

func (m *StatusEvent) GetBatteryLevel() float32

func (*StatusEvent) GetBatteryLevelUnavailable 

func (m *StatusEvent) GetBatteryLevelUnavailable() bool

func (*StatusEvent) GetDevEui 

func (m *StatusEvent) GetDevEui() []byte

func (*StatusEvent) GetDeviceName 

func (m *StatusEvent) GetDeviceName() string

func (*StatusEvent) GetExternalPowerSource 

func (m *StatusEvent) GetExternalPowerSource() bool

func (*StatusEvent) GetMargin 

func (m *StatusEvent) GetMargin() int32

func (*StatusEvent) GetPublishedAt added in v3.9.2 

func (m *StatusEvent) GetPublishedAt() *timestamppb.Timestamp

func (*StatusEvent) GetTags 

func (m *StatusEvent) GetTags() map[string]string

func (*StatusEvent) ProtoMessage 

func (*StatusEvent) ProtoMessage()

func (*StatusEvent) Reset 

func (m *StatusEvent) Reset()

func (*StatusEvent) String 

func (m *StatusEvent) String() string

func (*StatusEvent) XXX_DiscardUnknown 

func (m *StatusEvent) XXX_DiscardUnknown()

func (*StatusEvent) XXX_Marshal 

func (m *StatusEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatusEvent) XXX_Merge 

func (m *StatusEvent) XXX_Merge(src proto.Message)

func (*StatusEvent) XXX_Size 

func (m *StatusEvent) XXX_Size() int

func (*StatusEvent) XXX_Unmarshal 

func (m *StatusEvent) XXX_Unmarshal(b []byte) error

type TxAckEvent 

type TxAckEvent struct {
	// Application ID.
	ApplicationId uint64 `protobuf:"varint,1,opt,name=application_id,json=applicationID,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,2,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui []byte `protobuf:"bytes,4,opt,name=dev_eui,json=devEUI,proto3" json:"dev_eui,omitempty"`
	// Downlink frame-counter.
	FCnt uint32 `protobuf:"varint,5,opt,name=f_cnt,json=fCnt,proto3" json:"f_cnt,omitempty"`
	// User-defined device tags.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// Gateway ID.
	GatewayId []byte `protobuf:"bytes,7,opt,name=gateway_id,json=gatewayID,proto3" json:"gateway_id,omitempty"`
	// TX info.
	TxInfo *gw.DownlinkTXInfo `protobuf:"bytes,8,opt,name=tx_info,json=txInfo,proto3" json:"tx_info,omitempty"`
	// Published at timestamp.
	PublishedAt          *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

TxAckEvent is the message sent when a downlink was acknowledged by the gateway for transmission. As a downlink can be scheduled in the future, this event does not confirm that the message has already been transmitted.

func (*TxAckEvent) Descriptor 

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

func (*TxAckEvent) GetApplicationId 

func (m *TxAckEvent) GetApplicationId() uint64

func (*TxAckEvent) GetApplicationName 

func (m *TxAckEvent) GetApplicationName() string

func (*TxAckEvent) GetDevEui 

func (m *TxAckEvent) GetDevEui() []byte

func (*TxAckEvent) GetDeviceName 

func (m *TxAckEvent) GetDeviceName() string

func (*TxAckEvent) GetFCnt 

func (m *TxAckEvent) GetFCnt() uint32

func (*TxAckEvent) GetGatewayId 

func (m *TxAckEvent) GetGatewayId() []byte

func (*TxAckEvent) GetPublishedAt added in v3.9.2 

func (m *TxAckEvent) GetPublishedAt() *timestamppb.Timestamp

func (*TxAckEvent) GetTags 

func (m *TxAckEvent) GetTags() map[string]string

func (*TxAckEvent) GetTxInfo 

func (m *TxAckEvent) GetTxInfo() *gw.DownlinkTXInfo

func (*TxAckEvent) ProtoMessage 

func (*TxAckEvent) ProtoMessage()

func (*TxAckEvent) Reset 

func (m *TxAckEvent) Reset()

func (*TxAckEvent) String 

func (m *TxAckEvent) String() string

func (*TxAckEvent) XXX_DiscardUnknown 

func (m *TxAckEvent) XXX_DiscardUnknown()

func (*TxAckEvent) XXX_Marshal 

func (m *TxAckEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TxAckEvent) XXX_Merge 

func (m *TxAckEvent) XXX_Merge(src proto.Message)

func (*TxAckEvent) XXX_Size 

func (m *TxAckEvent) XXX_Size() int

func (*TxAckEvent) XXX_Unmarshal 

func (m *TxAckEvent) XXX_Unmarshal(b []byte) error

type UplinkEvent 

type UplinkEvent struct {
	// Application ID.
	ApplicationId uint64 `protobuf:"varint,1,opt,name=application_id,json=applicationID,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,2,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui []byte `protobuf:"bytes,4,opt,name=dev_eui,json=devEUI,proto3" json:"dev_eui,omitempty"`
	// Receiving gateway RX info.
	RxInfo []*gw.UplinkRXInfo `protobuf:"bytes,5,rep,name=rx_info,json=rxInfo,proto3" json:"rx_info,omitempty"`
	// TX info.
	TxInfo *gw.UplinkTXInfo `protobuf:"bytes,6,opt,name=tx_info,json=txInfo,proto3" json:"tx_info,omitempty"`
	// Device has ADR bit set.
	Adr bool `protobuf:"varint,7,opt,name=adr,proto3" json:"adr,omitempty"`
	// Data-rate.
	Dr uint32 `protobuf:"varint,8,opt,name=dr,proto3" json:"dr,omitempty"`
	// Frame counter.
	FCnt uint32 `protobuf:"varint,9,opt,name=f_cnt,json=fCnt,proto3" json:"f_cnt,omitempty"`
	// Frame port.
	FPort uint32 `protobuf:"varint,10,opt,name=f_port,json=fPort,proto3" json:"f_port,omitempty"`
	// FRMPayload data.
	Data []byte `protobuf:"bytes,11,opt,name=data,proto3" json:"data,omitempty"`
	// JSON string containing the decoded object.
	// Note that this is only set when a codec is configured in the Device Profile.
	ObjectJson string `protobuf:"bytes,12,opt,name=object_json,json=objectJSON,proto3" json:"object_json,omitempty"`
	// User-defined device tags.
	Tags map[string]string `` /* 150-byte string literal not displayed */
	// Uplink was of type confirmed.
	ConfirmedUplink bool `protobuf:"varint,14,opt,name=confirmed_uplink,json=confirmedUplink,proto3" json:"confirmed_uplink,omitempty"`
	// Device address.
	DevAddr []byte `protobuf:"bytes,15,opt,name=dev_addr,json=devAddr,proto3" json:"dev_addr,omitempty"`
	// Published at timestamp.
	PublishedAt *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// Device Profile UUID as string
	DeviceProfileId string `protobuf:"bytes,17,opt,name=device_profile_id,json=deviceProfileID,proto3" json:"device_profile_id,omitempty"`
	// Device Profile name
	DeviceProfileName string `protobuf:"bytes,18,opt,name=device_profile_name,json=deviceProfileName,proto3" json:"device_profile_name,omitempty"`
	// Time-on-air, calculated by the Application Server using payload size and
	// transmission settings
	ConsumedAirtime      *durationpb.Duration `protobuf:"bytes,19,opt,name=consumed_airtime,json=consumedAirtime,proto3" json:"consumed_airtime,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

UplinkEvent is the message sent when an uplink payload has been received.

func (*UplinkEvent) Descriptor 

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

func (*UplinkEvent) GetAdr 

func (m *UplinkEvent) GetAdr() bool

func (*UplinkEvent) GetApplicationId 

func (m *UplinkEvent) GetApplicationId() uint64

func (*UplinkEvent) GetApplicationName 

func (m *UplinkEvent) GetApplicationName() string
func (m *UplinkEvent) GetConfirmedUplink() bool

func (*UplinkEvent) GetConsumedAirtime added in v3.11.5 

func (m *UplinkEvent) GetConsumedAirtime() *durationpb.Duration

func (*UplinkEvent) GetData 

func (m *UplinkEvent) GetData() []byte

func (*UplinkEvent) GetDevAddr 

func (m *UplinkEvent) GetDevAddr() []byte

func (*UplinkEvent) GetDevEui 

func (m *UplinkEvent) GetDevEui() []byte

func (*UplinkEvent) GetDeviceName 

func (m *UplinkEvent) GetDeviceName() string

func (*UplinkEvent) GetDeviceProfileId added in v3.11.0 

func (m *UplinkEvent) GetDeviceProfileId() string

func (*UplinkEvent) GetDeviceProfileName added in v3.11.0 

func (m *UplinkEvent) GetDeviceProfileName() string

func (*UplinkEvent) GetDr 

func (m *UplinkEvent) GetDr() uint32

func (*UplinkEvent) GetFCnt 

func (m *UplinkEvent) GetFCnt() uint32

func (*UplinkEvent) GetFPort 

func (m *UplinkEvent) GetFPort() uint32

func (*UplinkEvent) GetObjectJson 

func (m *UplinkEvent) GetObjectJson() string

func (*UplinkEvent) GetPublishedAt added in v3.9.2 

func (m *UplinkEvent) GetPublishedAt() *timestamppb.Timestamp

func (*UplinkEvent) GetRxInfo 

func (m *UplinkEvent) GetRxInfo() []*gw.UplinkRXInfo

func (*UplinkEvent) GetTags 

func (m *UplinkEvent) GetTags() map[string]string

func (*UplinkEvent) GetTxInfo 

func (m *UplinkEvent) GetTxInfo() *gw.UplinkTXInfo

func (*UplinkEvent) ProtoMessage 

func (*UplinkEvent) ProtoMessage()

func (*UplinkEvent) Reset 

func (m *UplinkEvent) Reset()

func (*UplinkEvent) String 

func (m *UplinkEvent) String() string

func (*UplinkEvent) XXX_DiscardUnknown 

func (m *UplinkEvent) XXX_DiscardUnknown()

func (*UplinkEvent) XXX_Marshal 

func (m *UplinkEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UplinkEvent) XXX_Merge 

func (m *UplinkEvent) XXX_Merge(src proto.Message)

func (*UplinkEvent) XXX_Size 

func (m *UplinkEvent) XXX_Size() int

func (*UplinkEvent) XXX_Unmarshal 

func (m *UplinkEvent) XXX_Unmarshal(b []byte) error

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.