integration

Documentation

Index

• Constants
• func Setup(conf config.Config) error
• type Integration
  • func GetIntegration() Integration

Constants

const (
	EventUp    = "up"
	EventStats = "stats"
	EventAck   = "ack"
	EventRaw   = "raw"
)

Event types.

Functions

func Setup

func Setup(conf config.Config) error

Setup configures the integration.

Types

type Integration

type Integration interface {
	// SetGatewaySubscription updates the gateway subscription for the given
	// gateway ID. The integration must implement this such that it is safe
	// to call the same action multiple times.
	SetGatewaySubscription(subscribe bool, gatewayID lorawan.EUI64) error

	// PublishEvent publishes the given event.
	PublishEvent(lorawan.EUI64, string, uint32, proto.Message) error

	// PublishState publishes the given state as retained message.
	PublishState(lorawan.EUI64, string, proto.Message) error

	// SetDownlinkFrameFunc sets the DownlinkFrame handler func.
	SetDownlinkFrameFunc(func(*gw.DownlinkFrame))

	// SetRawPacketForwarderCommandFunc sets the RawPacketForwarderCommand handler func.
	SetRawPacketForwarderCommandFunc(func(*gw.RawPacketForwarderCommand))

	// SetGatewayConfigurationFunc sets the GatewayConfiguration handler func.
	SetGatewayConfigurationFunc(func(*gw.GatewayConfiguration))

	// SetGatewayCommandExecRequestFunc sets the GatewayCommandExecRequest handler func.
	SetGatewayCommandExecRequestFunc(func(*gw.GatewayCommandExecRequest))

	// Start starts the integration.
	Start() error

	// Stop stops the integration.
	Stop() error
}

Integration defines the interface that an integration must implement.

func GetIntegration

func GetIntegration() Integration

GetIntegration returns the integration.