integration

package
v4.7.0 Latest Latest
Warning

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

 Go to latest Published: Mar 13, 2024 License: MIT Imports: 8 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	LogLevel_name = map[int32]string{
		0: "INFO",
		1: "WARNING",
		2: "ERROR",
	}
	LogLevel_value = map[string]int32{
		"INFO":    0,
		"WARNING": 1,
		"ERROR":   2,
	}
)

Enum value maps for LogLevel.

View Source 
var (
	LogCode_name = map[int32]string{
		0:  "UNKNOWN",
		1:  "DOWNLINK_PAYLOAD_SIZE",
		2:  "UPLINK_CODEC",
		3:  "DOWNLINK_CODEC",
		4:  "OTAA",
		5:  "UPLINK_F_CNT_RESET",
		6:  "UPLINK_MIC",
		7:  "UPLINK_F_CNT_RETRANSMISSION",
		8:  "DOWNLINK_GATEWAY",
		9:  "RELAY_NEW_END_DEVICE",
		10: "F_CNT_DOWN",
	}
	LogCode_value = map[string]int32{
		"UNKNOWN":                     0,
		"DOWNLINK_PAYLOAD_SIZE":       1,
		"UPLINK_CODEC":                2,
		"DOWNLINK_CODEC":              3,
		"OTAA":                        4,
		"UPLINK_F_CNT_RESET":          5,
		"UPLINK_MIC":                  6,
		"UPLINK_F_CNT_RETRANSMISSION": 7,
		"DOWNLINK_GATEWAY":            8,
		"RELAY_NEW_END_DEVICE":        9,
		"F_CNT_DOWN":                  10,
	}
)

Enum value maps for LogCode.

View Source 
var File_integration_integration_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AckEvent 

type AckEvent struct {

	// Deduplication ID (UUID).
	DeduplicationId string `protobuf:"bytes,1,opt,name=deduplication_id,json=deduplicationId,proto3" json:"deduplication_id,omitempty"`
	// Timestamp.
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// Device info.
	DeviceInfo *DeviceInfo `protobuf:"bytes,3,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"`
	// Downlink queue item ID (UUID).
	QueueItemId string `protobuf:"bytes,4,opt,name=queue_item_id,json=queueItemId,proto3" json:"queue_item_id,omitempty"`
	// Frame was acknowledged.
	Acknowledged bool `protobuf:"varint,5,opt,name=acknowledged,proto3" json:"acknowledged,omitempty"`
	// Downlink frame counter to which the acknowledgement relates.
	FCntDown uint32 `protobuf:"varint,6,opt,name=f_cnt_down,json=fCntDown,proto3" json:"f_cnt_down,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) GetDeduplicationId 

func (x *AckEvent) GetDeduplicationId() string

func (*AckEvent) GetDeviceInfo 

func (x *AckEvent) GetDeviceInfo() *DeviceInfo

func (*AckEvent) GetFCntDown 

func (x *AckEvent) GetFCntDown() uint32

func (*AckEvent) GetQueueItemId 

func (x *AckEvent) GetQueueItemId() string

func (*AckEvent) GetTime 

func (x *AckEvent) GetTime() *timestamppb.Timestamp

func (*AckEvent) ProtoMessage 

func (*AckEvent) ProtoMessage()

func (*AckEvent) ProtoReflect 

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

func (*AckEvent) Reset 

func (x *AckEvent) Reset()

func (*AckEvent) String 

func (x *AckEvent) String() string

type DeviceInfo 

type DeviceInfo struct {

	// Tenant ID (UUID).
	TenantId string `protobuf:"bytes,1,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	// Tenant name.
	TenantName string `protobuf:"bytes,2,opt,name=tenant_name,json=tenantName,proto3" json:"tenant_name,omitempty"`
	// Application ID (UUID).
	ApplicationId string `protobuf:"bytes,3,opt,name=application_id,json=applicationId,proto3" json:"application_id,omitempty"`
	// Application name.
	ApplicationName string `protobuf:"bytes,4,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// Device-profile ID (UUID).
	DeviceProfileId string `protobuf:"bytes,5,opt,name=device_profile_id,json=deviceProfileId,proto3" json:"device_profile_id,omitempty"`
	// Device-profile name.
	DeviceProfileName string `protobuf:"bytes,6,opt,name=device_profile_name,json=deviceProfileName,proto3" json:"device_profile_name,omitempty"`
	// Device name.
	DeviceName string `protobuf:"bytes,7,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Device EUI.
	DevEui string `protobuf:"bytes,8,opt,name=dev_eui,json=devEui,proto3" json:"dev_eui,omitempty"`
	// Device class.
	DeviceClassEnabled common.DeviceClass `` /* 143-byte string literal not displayed */
	// Device-profile and device tags.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Device information.

func (*DeviceInfo) Descriptor deprecated 

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

Deprecated: Use DeviceInfo.ProtoReflect.Descriptor instead.

func (*DeviceInfo) GetApplicationId 

func (x *DeviceInfo) GetApplicationId() string

func (*DeviceInfo) GetApplicationName 

func (x *DeviceInfo) GetApplicationName() string

func (*DeviceInfo) GetDevEui 

func (x *DeviceInfo) GetDevEui() string

func (*DeviceInfo) GetDeviceClassEnabled added in v4.4.0 

func (x *DeviceInfo) GetDeviceClassEnabled() common.DeviceClass

func (*DeviceInfo) GetDeviceName 

func (x *DeviceInfo) GetDeviceName() string

func (*DeviceInfo) GetDeviceProfileId 

func (x *DeviceInfo) GetDeviceProfileId() string

func (*DeviceInfo) GetDeviceProfileName 

func (x *DeviceInfo) GetDeviceProfileName() string

func (*DeviceInfo) GetTags 

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

func (*DeviceInfo) GetTenantId 

func (x *DeviceInfo) GetTenantId() string

func (*DeviceInfo) GetTenantName 

func (x *DeviceInfo) GetTenantName() string

func (*DeviceInfo) ProtoMessage 

func (*DeviceInfo) ProtoMessage()

func (*DeviceInfo) ProtoReflect 

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

func (*DeviceInfo) Reset 

func (x *DeviceInfo) Reset()

func (*DeviceInfo) String 

func (x *DeviceInfo) String() string

type DownlinkCommand 

type DownlinkCommand struct {

	// ID (UUID).
	// If left blank, a random UUID will be generated.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Device EUI (EUI64).
	DevEui string `protobuf:"bytes,2,opt,name=dev_eui,json=devEui,proto3" json:"dev_eui,omitempty"`
	// Confirmed.
	Confirmed bool `protobuf:"varint,3,opt,name=confirmed,proto3" json:"confirmed,omitempty"`
	// FPort (must be > 0).
	FPort uint32 `protobuf:"varint,4,opt,name=f_port,json=fPort,proto3" json:"f_port,omitempty"`
	// Data.
	// Or use the json_object field when a codec has been configured.
	Data []byte `protobuf:"bytes,5,opt,name=data,proto3" json:"data,omitempty"`
	// Only use this when a codec has been configured that can encode this
	// object to bytes.
	Object *structpb.Struct `protobuf:"bytes,6,opt,name=object,proto3" json:"object,omitempty"`
	// contains filtered or unexported fields
}

DownlinkCommand is the command to enqueue a downlink payload for the given device.

func (*DownlinkCommand) Descriptor deprecated 

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

Deprecated: Use DownlinkCommand.ProtoReflect.Descriptor instead.

func (*DownlinkCommand) GetConfirmed 

func (x *DownlinkCommand) GetConfirmed() bool

func (*DownlinkCommand) GetData 

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

func (*DownlinkCommand) GetDevEui 

func (x *DownlinkCommand) GetDevEui() string

func (*DownlinkCommand) GetFPort 

func (x *DownlinkCommand) GetFPort() uint32

func (*DownlinkCommand) GetId 

func (x *DownlinkCommand) GetId() string

func (*DownlinkCommand) GetObject 

func (x *DownlinkCommand) GetObject() *structpb.Struct

func (*DownlinkCommand) ProtoMessage 

func (*DownlinkCommand) ProtoMessage()

func (*DownlinkCommand) ProtoReflect 

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

func (*DownlinkCommand) Reset 

func (x *DownlinkCommand) Reset()

func (*DownlinkCommand) String 

func (x *DownlinkCommand) String() string

type IntegrationEvent 

type IntegrationEvent struct {

	// Deduplication ID (UUID).
	DeduplicationId string `protobuf:"bytes,1,opt,name=deduplication_id,json=deduplicationId,proto3" json:"deduplication_id,omitempty"`
	// Timestamp.
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// Device info.
	DeviceInfo *DeviceInfo `protobuf:"bytes,3,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"`
	// Integration name.
	IntegrationName string `protobuf:"bytes,4,opt,name=integration_name,json=integrationName,proto3" json:"integration_name,omitempty"`
	// Event type.
	EventType string `protobuf:"bytes,5,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	// Struct containing the event object.
	Object *structpb.Struct `protobuf:"bytes,6,opt,name=object,proto3" json:"object,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) GetDeduplicationId 

func (x *IntegrationEvent) GetDeduplicationId() string

func (*IntegrationEvent) GetDeviceInfo 

func (x *IntegrationEvent) GetDeviceInfo() *DeviceInfo

func (*IntegrationEvent) GetEventType 

func (x *IntegrationEvent) GetEventType() string

func (*IntegrationEvent) GetIntegrationName 

func (x *IntegrationEvent) GetIntegrationName() string

func (*IntegrationEvent) GetObject 

func (x *IntegrationEvent) GetObject() *structpb.Struct

func (*IntegrationEvent) GetTime 

func (x *IntegrationEvent) GetTime() *timestamppb.Timestamp

func (*IntegrationEvent) ProtoMessage 

func (*IntegrationEvent) ProtoMessage()

func (*IntegrationEvent) ProtoReflect 

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 {

	// Deduplication ID (UUID).
	DeduplicationId string `protobuf:"bytes,1,opt,name=deduplication_id,json=deduplicationId,proto3" json:"deduplication_id,omitempty"`
	// Timestamp.
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// Device info.
	DeviceInfo *DeviceInfo `protobuf:"bytes,3,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"`
	// Device address.
	DevAddr string `protobuf:"bytes,4,opt,name=dev_addr,json=devAddr,proto3" json:"dev_addr,omitempty"`
	// Relay info.
	RelayRxInfo *UplinkRelayRxInfo `protobuf:"bytes,5,opt,name=relay_rx_info,json=relayRxInfo,proto3" json:"relay_rx_info,omitempty"`
	// Join-Server context.
	// A non-empty value indicatest that ChirpStack does not have access to
	// the AppSKey and that the encryption / decryption of the payloads is
	// the responsibility of the end-application.
	JoinServerContext *common.JoinServerContext `protobuf:"bytes,6,opt,name=join_server_context,json=joinServerContext,proto3" json:"join_server_context,omitempty"`
	// contains filtered or unexported fields
}

JoinEvent is the message sent when a device joined the network. Note: this event is sent at the first uplink after OTAA.

func (*JoinEvent) Descriptor deprecated 

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

Deprecated: Use JoinEvent.ProtoReflect.Descriptor instead.

func (*JoinEvent) GetDeduplicationId 

func (x *JoinEvent) GetDeduplicationId() string

func (*JoinEvent) GetDevAddr 

func (x *JoinEvent) GetDevAddr() string

func (*JoinEvent) GetDeviceInfo 

func (x *JoinEvent) GetDeviceInfo() *DeviceInfo

func (*JoinEvent) GetJoinServerContext added in v4.6.0 

func (x *JoinEvent) GetJoinServerContext() *common.JoinServerContext

func (*JoinEvent) GetRelayRxInfo added in v4.4.0 

func (x *JoinEvent) GetRelayRxInfo() *UplinkRelayRxInfo

func (*JoinEvent) GetTime 

func (x *JoinEvent) GetTime() *timestamppb.Timestamp

func (*JoinEvent) ProtoMessage 

func (*JoinEvent) ProtoMessage()

func (*JoinEvent) ProtoReflect 

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 {

	// Deduplication ID (UUID).
	DeduplicationId string `protobuf:"bytes,1,opt,name=deduplication_id,json=deduplicationId,proto3" json:"deduplication_id,omitempty"`
	// Timestamp.
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// Device info.
	DeviceInfo *DeviceInfo `protobuf:"bytes,3,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"`
	// Location.
	Location *common.Location `protobuf:"bytes,4,opt,name=location,proto3" json:"location,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) GetDeduplicationId 

func (x *LocationEvent) GetDeduplicationId() string

func (*LocationEvent) GetDeviceInfo 

func (x *LocationEvent) GetDeviceInfo() *DeviceInfo

func (*LocationEvent) GetLocation 

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

func (*LocationEvent) GetTime 

func (x *LocationEvent) GetTime() *timestamppb.Timestamp

func (*LocationEvent) ProtoMessage 

func (*LocationEvent) ProtoMessage()

func (*LocationEvent) ProtoReflect 

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

func (*LocationEvent) Reset 

func (x *LocationEvent) Reset()

func (*LocationEvent) String 

func (x *LocationEvent) String() string

type LogCode 

type LogCode int32
const (
	// Unknown type.
	LogCode_UNKNOWN LogCode = 0
	// Error related to the downlink payload size.
	// Usually seen when the payload exceeded the maximum allowed payload size.
	LogCode_DOWNLINK_PAYLOAD_SIZE LogCode = 1
	// Uplink codec error.
	LogCode_UPLINK_CODEC LogCode = 2
	// Downlink codec error.
	LogCode_DOWNLINK_CODEC LogCode = 3
	// OTAA error.
	LogCode_OTAA LogCode = 4
	// Uplink frame-counter was reset.
	LogCode_UPLINK_F_CNT_RESET LogCode = 5
	// Uplink MIC error.
	LogCode_UPLINK_MIC LogCode = 6
	// Uplink frame-counter retransmission.
	LogCode_UPLINK_F_CNT_RETRANSMISSION LogCode = 7
	// Downlink gateway error.
	LogCode_DOWNLINK_GATEWAY LogCode = 8
	// Relay new end-device.
	LogCode_RELAY_NEW_END_DEVICE LogCode = 9
	// Downlink frame-counter.
	LogCode_F_CNT_DOWN LogCode = 10
)

func (LogCode) Descriptor 

func (LogCode) Descriptor() protoreflect.EnumDescriptor

func (LogCode) Enum 

func (x LogCode) Enum() *LogCode

func (LogCode) EnumDescriptor deprecated 

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

Deprecated: Use LogCode.Descriptor instead.

func (LogCode) Number 

func (x LogCode) Number() protoreflect.EnumNumber

func (LogCode) String 

func (x LogCode) String() string

func (LogCode) Type 

func (LogCode) Type() protoreflect.EnumType

type LogEvent 

type LogEvent struct {

	// Timestamp.
	Time *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=time,proto3" json:"time,omitempty"`
	// Device info.
	DeviceInfo *DeviceInfo `protobuf:"bytes,2,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"`
	// Log level.
	Level LogLevel `protobuf:"varint,3,opt,name=level,proto3,enum=integration.LogLevel" json:"level,omitempty"`
	// Log code.
	Code LogCode `protobuf:"varint,4,opt,name=code,proto3,enum=integration.LogCode" json:"code,omitempty"`
	// Description message.
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// Context map.
	Context map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

LogEvent is the message sent when a device-related log was sent.

func (*LogEvent) Descriptor deprecated 

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

Deprecated: Use LogEvent.ProtoReflect.Descriptor instead.

func (*LogEvent) GetCode 

func (x *LogEvent) GetCode() LogCode

func (*LogEvent) GetContext 

func (x *LogEvent) GetContext() map[string]string

func (*LogEvent) GetDescription 

func (x *LogEvent) GetDescription() string

func (*LogEvent) GetDeviceInfo 

func (x *LogEvent) GetDeviceInfo() *DeviceInfo

func (*LogEvent) GetLevel 

func (x *LogEvent) GetLevel() LogLevel

func (*LogEvent) GetTime 

func (x *LogEvent) GetTime() *timestamppb.Timestamp

func (*LogEvent) ProtoMessage 

func (*LogEvent) ProtoMessage()

func (*LogEvent) ProtoReflect 

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

func (*LogEvent) Reset 

func (x *LogEvent) Reset()

func (*LogEvent) String 

func (x *LogEvent) String() string

type LogLevel 

type LogLevel int32
const (
	// Info.
	LogLevel_INFO LogLevel = 0
	// Warning.
	LogLevel_WARNING LogLevel = 1
	// Error.
	LogLevel_ERROR LogLevel = 2
)

func (LogLevel) Descriptor 

func (LogLevel) Descriptor() protoreflect.EnumDescriptor

func (LogLevel) Enum 

func (x LogLevel) Enum() *LogLevel

func (LogLevel) EnumDescriptor deprecated 

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

Deprecated: Use LogLevel.Descriptor instead.

func (LogLevel) Number 

func (x LogLevel) Number() protoreflect.EnumNumber

func (LogLevel) String 

func (x LogLevel) String() string

func (LogLevel) Type 

func (LogLevel) Type() protoreflect.EnumType

type StatusEvent 

type StatusEvent struct {

	// Deduplication ID (UUID).
	DeduplicationId string `protobuf:"bytes,1,opt,name=deduplication_id,json=deduplicationId,proto3" json:"deduplication_id,omitempty"`
	// Timestamp.
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// Device info.
	DeviceInfo *DeviceInfo `protobuf:"bytes,3,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,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"`
	// 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) GetBatteryLevel 

func (x *StatusEvent) GetBatteryLevel() float32

func (*StatusEvent) GetBatteryLevelUnavailable 

func (x *StatusEvent) GetBatteryLevelUnavailable() bool

func (*StatusEvent) GetDeduplicationId 

func (x *StatusEvent) GetDeduplicationId() string

func (*StatusEvent) GetDeviceInfo 

func (x *StatusEvent) GetDeviceInfo() *DeviceInfo

func (*StatusEvent) GetExternalPowerSource 

func (x *StatusEvent) GetExternalPowerSource() bool

func (*StatusEvent) GetMargin 

func (x *StatusEvent) GetMargin() int32

func (*StatusEvent) GetTime 

func (x *StatusEvent) GetTime() *timestamppb.Timestamp

func (*StatusEvent) ProtoMessage 

func (*StatusEvent) ProtoMessage()

func (*StatusEvent) ProtoReflect 

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 {

	// Downlink ID.
	DownlinkId uint32 `protobuf:"varint,1,opt,name=downlink_id,json=downlinkId,proto3" json:"downlink_id,omitempty"`
	// Timestamp.
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// Device info.
	DeviceInfo *DeviceInfo `protobuf:"bytes,3,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"`
	// Downlink queue item ID (UUID).
	QueueItemId string `protobuf:"bytes,4,opt,name=queue_item_id,json=queueItemId,proto3" json:"queue_item_id,omitempty"`
	// Downlink frame-counter.
	FCntDown uint32 `protobuf:"varint,5,opt,name=f_cnt_down,json=fCntDown,proto3" json:"f_cnt_down,omitempty"`
	// Gateway ID.
	GatewayId string `protobuf:"bytes,6,opt,name=gateway_id,json=gatewayId,proto3" json:"gateway_id,omitempty"`
	// TX info.
	TxInfo *gw.DownlinkTxInfo `protobuf:"bytes,7,opt,name=tx_info,json=txInfo,proto3" json:"tx_info,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) GetDeviceInfo 

func (x *TxAckEvent) GetDeviceInfo() *DeviceInfo

func (*TxAckEvent) GetDownlinkId 

func (x *TxAckEvent) GetDownlinkId() uint32

func (*TxAckEvent) GetFCntDown 

func (x *TxAckEvent) GetFCntDown() uint32

func (*TxAckEvent) GetGatewayId 

func (x *TxAckEvent) GetGatewayId() string

func (*TxAckEvent) GetQueueItemId 

func (x *TxAckEvent) GetQueueItemId() string

func (*TxAckEvent) GetTime 

func (x *TxAckEvent) GetTime() *timestamppb.Timestamp

func (*TxAckEvent) GetTxInfo 

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

func (*TxAckEvent) ProtoMessage 

func (*TxAckEvent) ProtoMessage()

func (*TxAckEvent) ProtoReflect 

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 {

	// Deduplication ID (UUID).
	DeduplicationId string `protobuf:"bytes,1,opt,name=deduplication_id,json=deduplicationId,proto3" json:"deduplication_id,omitempty"`
	// Timestamp.
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// Device information.
	DeviceInfo *DeviceInfo `protobuf:"bytes,3,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"`
	// Device address.
	DevAddr string `protobuf:"bytes,4,opt,name=dev_addr,json=devAddr,proto3" json:"dev_addr,omitempty"`
	// Device has ADR bit set.
	Adr bool `protobuf:"varint,5,opt,name=adr,proto3" json:"adr,omitempty"`
	// Data-rate.
	Dr uint32 `protobuf:"varint,6,opt,name=dr,proto3" json:"dr,omitempty"`
	// Frame counter.
	FCnt uint32 `protobuf:"varint,7,opt,name=f_cnt,json=fCnt,proto3" json:"f_cnt,omitempty"`
	// Frame port.
	FPort uint32 `protobuf:"varint,8,opt,name=f_port,json=fPort,proto3" json:"f_port,omitempty"`
	// Uplink was of type confirmed.
	Confirmed bool `protobuf:"varint,9,opt,name=confirmed,proto3" json:"confirmed,omitempty"`
	// FRMPayload data.
	Data []byte `protobuf:"bytes,10,opt,name=data,proto3" json:"data,omitempty"`
	// Note that this is only set when a codec is configured in the Device
	// Profile.
	Object *structpb.Struct `protobuf:"bytes,11,opt,name=object,proto3" json:"object,omitempty"`
	// Receiving gateway RX info.
	RxInfo []*gw.UplinkRxInfo `protobuf:"bytes,12,rep,name=rx_info,json=rxInfo,proto3" json:"rx_info,omitempty"`
	// TX info.
	TxInfo *gw.UplinkTxInfo `protobuf:"bytes,13,opt,name=tx_info,json=txInfo,proto3" json:"tx_info,omitempty"`
	// Relay info.
	RelayRxInfo *UplinkRelayRxInfo `protobuf:"bytes,14,opt,name=relay_rx_info,json=relayRxInfo,proto3" json:"relay_rx_info,omitempty"`
	// Join-Server context.
	// A non-empty value indicatest that ChirpStack does not have access to
	// the AppSKey and that the encryption / decryption of the payloads is
	// the responsibility of the end-application.
	JoinServerContext *common.JoinServerContext `protobuf:"bytes,15,opt,name=join_server_context,json=joinServerContext,proto3" json:"join_server_context,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) GetConfirmed 

func (x *UplinkEvent) GetConfirmed() bool

func (*UplinkEvent) GetData 

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

func (*UplinkEvent) GetDeduplicationId 

func (x *UplinkEvent) GetDeduplicationId() string

func (*UplinkEvent) GetDevAddr 

func (x *UplinkEvent) GetDevAddr() string

func (*UplinkEvent) GetDeviceInfo 

func (x *UplinkEvent) GetDeviceInfo() *DeviceInfo

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) GetJoinServerContext added in v4.6.0 

func (x *UplinkEvent) GetJoinServerContext() *common.JoinServerContext

func (*UplinkEvent) GetObject 

func (x *UplinkEvent) GetObject() *structpb.Struct

func (*UplinkEvent) GetRelayRxInfo added in v4.4.0 

func (x *UplinkEvent) GetRelayRxInfo() *UplinkRelayRxInfo

func (*UplinkEvent) GetRxInfo 

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

func (*UplinkEvent) GetTime 

func (x *UplinkEvent) GetTime() *timestamppb.Timestamp

func (*UplinkEvent) GetTxInfo 

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

func (*UplinkEvent) ProtoMessage 

func (*UplinkEvent) ProtoMessage()

func (*UplinkEvent) ProtoReflect 

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

func (*UplinkEvent) Reset 

func (x *UplinkEvent) Reset()

func (*UplinkEvent) String 

func (x *UplinkEvent) String() string

type UplinkRelayRxInfo added in v4.4.0 

type UplinkRelayRxInfo struct {

	// Relay DevEUI.
	DevEui string `protobuf:"bytes,1,opt,name=dev_eui,json=devEui,proto3" json:"dev_eui,omitempty"`
	// Frequency.
	Frequency uint32 `protobuf:"varint,2,opt,name=frequency,proto3" json:"frequency,omitempty"`
	// Data-rate.
	Dr uint32 `protobuf:"varint,3,opt,name=dr,proto3" json:"dr,omitempty"`
	// SNR.
	Snr int32 `protobuf:"varint,4,opt,name=snr,proto3" json:"snr,omitempty"`
	// RSSI.
	Rssi int32 `protobuf:"varint,5,opt,name=rssi,proto3" json:"rssi,omitempty"`
	// WOR channel.
	WorChannel uint32 `protobuf:"varint,6,opt,name=wor_channel,json=worChannel,proto3" json:"wor_channel,omitempty"`
	// contains filtered or unexported fields
}

Uplink relay RX information.

func (*UplinkRelayRxInfo) Descriptor deprecated added in v4.4.0 

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

Deprecated: Use UplinkRelayRxInfo.ProtoReflect.Descriptor instead.

func (*UplinkRelayRxInfo) GetDevEui added in v4.4.0 

func (x *UplinkRelayRxInfo) GetDevEui() string

func (*UplinkRelayRxInfo) GetDr added in v4.4.0 

func (x *UplinkRelayRxInfo) GetDr() uint32

func (*UplinkRelayRxInfo) GetFrequency added in v4.4.0 

func (x *UplinkRelayRxInfo) GetFrequency() uint32

func (*UplinkRelayRxInfo) GetRssi added in v4.4.0 

func (x *UplinkRelayRxInfo) GetRssi() int32

func (*UplinkRelayRxInfo) GetSnr added in v4.4.0 

func (x *UplinkRelayRxInfo) GetSnr() int32

func (*UplinkRelayRxInfo) GetWorChannel added in v4.4.0 

func (x *UplinkRelayRxInfo) GetWorChannel() uint32

func (*UplinkRelayRxInfo) ProtoMessage added in v4.4.0 

func (*UplinkRelayRxInfo) ProtoMessage()

func (*UplinkRelayRxInfo) ProtoReflect added in v4.4.0 

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

func (*UplinkRelayRxInfo) Reset added in v4.4.0 

func (x *UplinkRelayRxInfo) Reset()

func (*UplinkRelayRxInfo) String added in v4.4.0 

func (x *UplinkRelayRxInfo) 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.