integration

package
v3.10.2 Latest Latest
Warning

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

 Go to latest Published: Sep 26, 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",
	}
	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,
	}
)

Enum value maps for ErrorType.

View Source 
var File_as_integration_integration_proto protoreflect.FileDescriptor

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 *timestamp.Timestamp `protobuf:"bytes,8,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// contains filtered or unexported fields
}

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

func (*AckEvent) Descriptor deprecated 

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

Deprecated: Use AckEvent.ProtoReflect.Descriptor instead.

func (*AckEvent) GetAcknowledged 

func (x *AckEvent) GetAcknowledged() bool

func (*AckEvent) GetApplicationId 

func (x *AckEvent) GetApplicationId() uint64

func (*AckEvent) GetApplicationName 

func (x *AckEvent) GetApplicationName() string

func (*AckEvent) GetDevEui 

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

func (*AckEvent) GetDeviceName 

func (x *AckEvent) GetDeviceName() string

func (*AckEvent) GetFCnt 

func (x *AckEvent) GetFCnt() uint32

func (*AckEvent) GetPublishedAt 

func (x *AckEvent) GetPublishedAt() *timestamp.Timestamp

func (*AckEvent) GetTags 

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

func (*AckEvent) ProtoMessage 

func (*AckEvent) ProtoMessage()

func (*AckEvent) ProtoReflect added in v3.10.2 

func (x *AckEvent) ProtoReflect() protoreflect.Message

func (*AckEvent) Reset 

func (x *AckEvent) Reset()

func (*AckEvent) String 

func (x *AckEvent) String() string

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 *timestamp.Timestamp `protobuf:"bytes,9,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// contains filtered or unexported fields
}

ErrorEvent is the message sent when an error occurred.

func (*ErrorEvent) Descriptor deprecated 

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

Deprecated: Use ErrorEvent.ProtoReflect.Descriptor instead.

func (*ErrorEvent) GetApplicationId 

func (x *ErrorEvent) GetApplicationId() uint64

func (*ErrorEvent) GetApplicationName 

func (x *ErrorEvent) GetApplicationName() string

func (*ErrorEvent) GetDevEui 

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

func (*ErrorEvent) GetDeviceName 

func (x *ErrorEvent) GetDeviceName() string

func (*ErrorEvent) GetError 

func (x *ErrorEvent) GetError() string

func (*ErrorEvent) GetFCnt 

func (x *ErrorEvent) GetFCnt() uint32

func (*ErrorEvent) GetPublishedAt 

func (x *ErrorEvent) GetPublishedAt() *timestamp.Timestamp

func (*ErrorEvent) GetTags 

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

func (*ErrorEvent) GetType 

func (x *ErrorEvent) GetType() ErrorType

func (*ErrorEvent) ProtoMessage 

func (*ErrorEvent) ProtoMessage()

func (*ErrorEvent) ProtoReflect added in v3.10.2 

func (x *ErrorEvent) ProtoReflect() protoreflect.Message

func (*ErrorEvent) Reset 

func (x *ErrorEvent) Reset()

func (*ErrorEvent) String 

func (x *ErrorEvent) String() string

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
)

func (ErrorType) Descriptor added in v3.10.2 

func (ErrorType) Descriptor() protoreflect.EnumDescriptor

func (ErrorType) Enum added in v3.10.2 

func (x ErrorType) Enum() *ErrorType

func (ErrorType) EnumDescriptor deprecated 

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

Deprecated: Use ErrorType.Descriptor instead.

func (ErrorType) Number added in v3.10.2 

func (x ErrorType) Number() protoreflect.EnumNumber

func (ErrorType) String 

func (x ErrorType) String() string

func (ErrorType) Type added in v3.10.2 

func (ErrorType) Type() protoreflect.EnumType

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 *timestamp.Timestamp `protobuf:"bytes,9,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// contains filtered or unexported fields
}

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 deprecated 

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

Deprecated: Use IntegrationEvent.ProtoReflect.Descriptor instead.

func (*IntegrationEvent) GetApplicationId 

func (x *IntegrationEvent) GetApplicationId() uint64

func (*IntegrationEvent) GetApplicationName 

func (x *IntegrationEvent) GetApplicationName() string

func (*IntegrationEvent) GetDevEui 

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

func (*IntegrationEvent) GetDeviceName 

func (x *IntegrationEvent) GetDeviceName() string

func (*IntegrationEvent) GetEventType 

func (x *IntegrationEvent) GetEventType() string

func (*IntegrationEvent) GetIntegrationName 

func (x *IntegrationEvent) GetIntegrationName() string

func (*IntegrationEvent) GetObjectJson 

func (x *IntegrationEvent) GetObjectJson() string

func (*IntegrationEvent) GetPublishedAt 

func (x *IntegrationEvent) GetPublishedAt() *timestamp.Timestamp

func (*IntegrationEvent) GetTags 

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

func (*IntegrationEvent) ProtoMessage 

func (*IntegrationEvent) ProtoMessage()

func (*IntegrationEvent) ProtoReflect added in v3.10.2 

func (x *IntegrationEvent) ProtoReflect() protoreflect.Message

func (*IntegrationEvent) Reset 

func (x *IntegrationEvent) Reset()

func (*IntegrationEvent) String 

func (x *IntegrationEvent) String() string

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 *timestamp.Timestamp `protobuf:"bytes,10,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// contains filtered or unexported fields
}

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 deprecated 

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

Deprecated: Use JoinEvent.ProtoReflect.Descriptor instead.

func (*JoinEvent) GetApplicationId 

func (x *JoinEvent) GetApplicationId() uint64

func (*JoinEvent) GetApplicationName 

func (x *JoinEvent) GetApplicationName() string

func (*JoinEvent) GetDevAddr 

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

func (*JoinEvent) GetDevEui 

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

func (*JoinEvent) GetDeviceName 

func (x *JoinEvent) GetDeviceName() string

func (*JoinEvent) GetDr 

func (x *JoinEvent) GetDr() uint32

func (*JoinEvent) GetPublishedAt 

func (x *JoinEvent) GetPublishedAt() *timestamp.Timestamp

func (*JoinEvent) GetRxInfo 

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

func (*JoinEvent) GetTags 

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

func (*JoinEvent) GetTxInfo 

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

func (*JoinEvent) ProtoMessage 

func (*JoinEvent) ProtoMessage()

func (*JoinEvent) ProtoReflect added in v3.10.2 

func (x *JoinEvent) ProtoReflect() protoreflect.Message

func (*JoinEvent) Reset 

func (x *JoinEvent) Reset()

func (*JoinEvent) String 

func (x *JoinEvent) String() string

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 *timestamp.Timestamp `protobuf:"bytes,9,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// contains filtered or unexported fields
}

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

func (*LocationEvent) Descriptor deprecated 

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

Deprecated: Use LocationEvent.ProtoReflect.Descriptor instead.

func (*LocationEvent) GetApplicationId 

func (x *LocationEvent) GetApplicationId() uint64

func (*LocationEvent) GetApplicationName 

func (x *LocationEvent) GetApplicationName() string

func (*LocationEvent) GetDevEui 

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

func (*LocationEvent) GetDeviceName 

func (x *LocationEvent) GetDeviceName() string

func (*LocationEvent) GetFCnt 

func (x *LocationEvent) GetFCnt() uint32

func (*LocationEvent) GetLocation 

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

func (*LocationEvent) GetPublishedAt 

func (x *LocationEvent) GetPublishedAt() *timestamp.Timestamp

func (*LocationEvent) GetTags 

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

func (*LocationEvent) GetUplinkIds 

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

func (*LocationEvent) ProtoMessage 

func (*LocationEvent) ProtoMessage()

func (*LocationEvent) ProtoReflect added in v3.10.2 

func (x *LocationEvent) ProtoReflect() protoreflect.Message

func (*LocationEvent) Reset 

func (x *LocationEvent) Reset()

func (*LocationEvent) String 

func (x *LocationEvent) String() string

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 *timestamp.Timestamp `protobuf:"bytes,10,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// contains filtered or unexported fields
}

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

func (*StatusEvent) Descriptor deprecated 

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

Deprecated: Use StatusEvent.ProtoReflect.Descriptor instead.

func (*StatusEvent) GetApplicationId 

func (x *StatusEvent) GetApplicationId() uint64

func (*StatusEvent) GetApplicationName 

func (x *StatusEvent) GetApplicationName() string

func (*StatusEvent) GetBatteryLevel 

func (x *StatusEvent) GetBatteryLevel() float32

func (*StatusEvent) GetBatteryLevelUnavailable 

func (x *StatusEvent) GetBatteryLevelUnavailable() bool

func (*StatusEvent) GetDevEui 

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

func (*StatusEvent) GetDeviceName 

func (x *StatusEvent) GetDeviceName() string

func (*StatusEvent) GetExternalPowerSource 

func (x *StatusEvent) GetExternalPowerSource() bool

func (*StatusEvent) GetMargin 

func (x *StatusEvent) GetMargin() int32

func (*StatusEvent) GetPublishedAt 

func (x *StatusEvent) GetPublishedAt() *timestamp.Timestamp

func (*StatusEvent) GetTags 

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

func (*StatusEvent) ProtoMessage 

func (*StatusEvent) ProtoMessage()

func (*StatusEvent) ProtoReflect added in v3.10.2 

func (x *StatusEvent) ProtoReflect() protoreflect.Message

func (*StatusEvent) Reset 

func (x *StatusEvent) Reset()

func (*StatusEvent) String 

func (x *StatusEvent) String() string

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 *timestamp.Timestamp `protobuf:"bytes,9,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// contains filtered or unexported fields
}

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 deprecated 

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

Deprecated: Use TxAckEvent.ProtoReflect.Descriptor instead.

func (*TxAckEvent) GetApplicationId 

func (x *TxAckEvent) GetApplicationId() uint64

func (*TxAckEvent) GetApplicationName 

func (x *TxAckEvent) GetApplicationName() string

func (*TxAckEvent) GetDevEui 

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

func (*TxAckEvent) GetDeviceName 

func (x *TxAckEvent) GetDeviceName() string

func (*TxAckEvent) GetFCnt 

func (x *TxAckEvent) GetFCnt() uint32

func (*TxAckEvent) GetGatewayId 

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

func (*TxAckEvent) GetPublishedAt 

func (x *TxAckEvent) GetPublishedAt() *timestamp.Timestamp

func (*TxAckEvent) GetTags 

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

func (*TxAckEvent) GetTxInfo 

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

func (*TxAckEvent) ProtoMessage 

func (*TxAckEvent) ProtoMessage()

func (*TxAckEvent) ProtoReflect added in v3.10.2 

func (x *TxAckEvent) ProtoReflect() protoreflect.Message

func (*TxAckEvent) Reset 

func (x *TxAckEvent) Reset()

func (*TxAckEvent) String 

func (x *TxAckEvent) String() string

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 *timestamp.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"`
	// contains filtered or unexported fields
}

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

func (*UplinkEvent) Descriptor deprecated 

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

Deprecated: Use UplinkEvent.ProtoReflect.Descriptor instead.

func (*UplinkEvent) GetAdr 

func (x *UplinkEvent) GetAdr() bool

func (*UplinkEvent) GetApplicationId 

func (x *UplinkEvent) GetApplicationId() uint64

func (*UplinkEvent) GetApplicationName 

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

func (*UplinkEvent) GetData 

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

func (*UplinkEvent) GetDevAddr 

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

func (*UplinkEvent) GetDevEui 

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

func (*UplinkEvent) GetDeviceName 

func (x *UplinkEvent) GetDeviceName() string

func (*UplinkEvent) GetDeviceProfileId 

func (x *UplinkEvent) GetDeviceProfileId() string

func (*UplinkEvent) GetDeviceProfileName 

func (x *UplinkEvent) GetDeviceProfileName() string

func (*UplinkEvent) GetDr 

func (x *UplinkEvent) GetDr() uint32

func (*UplinkEvent) GetFCnt 

func (x *UplinkEvent) GetFCnt() uint32

func (*UplinkEvent) GetFPort 

func (x *UplinkEvent) GetFPort() uint32

func (*UplinkEvent) GetObjectJson 

func (x *UplinkEvent) GetObjectJson() string

func (*UplinkEvent) GetPublishedAt 

func (x *UplinkEvent) GetPublishedAt() *timestamp.Timestamp

func (*UplinkEvent) GetRxInfo 

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

func (*UplinkEvent) GetTags 

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

func (*UplinkEvent) GetTxInfo 

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

func (*UplinkEvent) ProtoMessage 

func (*UplinkEvent) ProtoMessage()

func (*UplinkEvent) ProtoReflect added in v3.10.2 

func (x *UplinkEvent) ProtoReflect() protoreflect.Message

func (*UplinkEvent) Reset 

func (x *UplinkEvent) Reset()

func (*UplinkEvent) String 

func (x *UplinkEvent) String() string

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.