api

package

v1.0.1 Latest Latest Go to latest Published: Jun 17, 2018 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/JaberBabaki/chirpstack-network-server

Links

Documentation ¶

Index ¶

type NetworkServerAPI
- func NewNetworkServerAPI() *NetworkServerAPI

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type NetworkServerAPI ¶

type NetworkServerAPI struct{}

NetworkServerAPI defines the nework-server API.

func NewNetworkServerAPI ¶

func NewNetworkServerAPI() *NetworkServerAPI

NewNetworkServerAPI returns a new NetworkServerAPI.

func (*NetworkServerAPI) ActivateDevice ¶

func (n *NetworkServerAPI) ActivateDevice(ctx context.Context, req *ns.ActivateDeviceRequest) (*ns.ActivateDeviceResponse, error)

ActivateDevice activates a device (ABP).

func (*NetworkServerAPI) CreateDevice ¶

func (n *NetworkServerAPI) CreateDevice(ctx context.Context, req *ns.CreateDeviceRequest) (*ns.CreateDeviceResponse, error)

CreateDevice creates the given device.

func (*NetworkServerAPI) CreateDeviceProfile ¶

func (n *NetworkServerAPI) CreateDeviceProfile(ctx context.Context, req *ns.CreateDeviceProfileRequest) (*ns.CreateDeviceProfileResponse, error)

CreateDeviceProfile creates the given device-profile. The RFRegion field will get set automatically according to the configured band.

func (*NetworkServerAPI) CreateDeviceQueueItem ¶

func (n *NetworkServerAPI) CreateDeviceQueueItem(ctx context.Context, req *ns.CreateDeviceQueueItemRequest) (*ns.CreateDeviceQueueItemResponse, error)

CreateDeviceQueueItem creates the given device-queue item.

func (*NetworkServerAPI) CreateGateway ¶

func (n *NetworkServerAPI) CreateGateway(ctx context.Context, req *ns.CreateGatewayRequest) (*ns.CreateGatewayResponse, error)

CreateGateway creates the given gateway.

func (*NetworkServerAPI) CreateGatewayProfile ¶

func (n *NetworkServerAPI) CreateGatewayProfile(ctx context.Context, req *ns.CreateGatewayProfileRequest) (*ns.CreateGatewayProfileResponse, error)

CreateGatewayProfile creates the given gateway-profile.

func (*NetworkServerAPI) CreateMACCommandQueueItem ¶

func (n *NetworkServerAPI) CreateMACCommandQueueItem(ctx context.Context, req *ns.CreateMACCommandQueueItemRequest) (*ns.CreateMACCommandQueueItemResponse, error)

CreateMACCommandQueueItem adds a data down MAC command to the queue. It replaces already enqueued mac-commands with the same CID.

func (*NetworkServerAPI) CreateRoutingProfile ¶

func (n *NetworkServerAPI) CreateRoutingProfile(ctx context.Context, req *ns.CreateRoutingProfileRequest) (*ns.CreateRoutingProfileResponse, error)

CreateRoutingProfile creates the given routing-profile.

func (*NetworkServerAPI) CreateServiceProfile ¶

func (n *NetworkServerAPI) CreateServiceProfile(ctx context.Context, req *ns.CreateServiceProfileRequest) (*ns.CreateServiceProfileResponse, error)

CreateServiceProfile creates the given service-profile.

func (*NetworkServerAPI) DeactivateDevice ¶

func (n *NetworkServerAPI) DeactivateDevice(ctx context.Context, req *ns.DeactivateDeviceRequest) (*ns.DeactivateDeviceResponse, error)

DeactivateDevice de-activates a device.

func (*NetworkServerAPI) DeleteDevice ¶

func (n *NetworkServerAPI) DeleteDevice(ctx context.Context, req *ns.DeleteDeviceRequest) (*ns.DeleteDeviceResponse, error)

DeleteDevice deletes the device matching the given DevEUI.

func (*NetworkServerAPI) DeleteDeviceProfile ¶

func (n *NetworkServerAPI) DeleteDeviceProfile(ctx context.Context, req *ns.DeleteDeviceProfileRequest) (*ns.DeleteDeviceProfileResponse, error)

DeleteDeviceProfile deletes the device-profile matching the given id.

func (*NetworkServerAPI) DeleteGateway ¶

func (n *NetworkServerAPI) DeleteGateway(ctx context.Context, req *ns.DeleteGatewayRequest) (*ns.DeleteGatewayResponse, error)

DeleteGateway deletes a gateway.

func (*NetworkServerAPI) DeleteGatewayProfile ¶

func (n *NetworkServerAPI) DeleteGatewayProfile(ctx context.Context, req *ns.DeleteGatewayProfileRequest) (*ns.DeleteGatewayProfileResponse, error)

DeleteGatewayProfile deletes the gateway-profile matching a given id.

func (*NetworkServerAPI) DeleteRoutingProfile ¶

func (n *NetworkServerAPI) DeleteRoutingProfile(ctx context.Context, req *ns.DeleteRoutingProfileRequest) (*ns.DeleteRoutingProfileResponse, error)

DeleteRoutingProfile deletes the routing-profile matching the given id.

func (*NetworkServerAPI) DeleteServiceProfile ¶

func (n *NetworkServerAPI) DeleteServiceProfile(ctx context.Context, req *ns.DeleteServiceProfileRequest) (*ns.DeleteServiceProfileResponse, error)

DeleteServiceProfile deletes the service-profile matching the given id.

func (*NetworkServerAPI) FlushDeviceQueueForDevEUI ¶

func (n *NetworkServerAPI) FlushDeviceQueueForDevEUI(ctx context.Context, req *ns.FlushDeviceQueueForDevEUIRequest) (*ns.FlushDeviceQueueForDevEUIResponse, error)

FlushDeviceQueueForDevEUI flushes the device-queue for the given DevEUI.

func (*NetworkServerAPI) GetDevice ¶

func (n *NetworkServerAPI) GetDevice(ctx context.Context, req *ns.GetDeviceRequest) (*ns.GetDeviceResponse, error)

GetDevice returns the device matching the given DevEUI.

func (*NetworkServerAPI) GetDeviceActivation ¶

func (n *NetworkServerAPI) GetDeviceActivation(ctx context.Context, req *ns.GetDeviceActivationRequest) (*ns.GetDeviceActivationResponse, error)

GetDeviceActivation returns the device activation details.

func (*NetworkServerAPI) GetDeviceProfile ¶

func (n *NetworkServerAPI) GetDeviceProfile(ctx context.Context, req *ns.GetDeviceProfileRequest) (*ns.GetDeviceProfileResponse, error)

GetDeviceProfile returns the device-profile matching the given id.

func (*NetworkServerAPI) GetDeviceQueueItemsForDevEUI ¶

func (n *NetworkServerAPI) GetDeviceQueueItemsForDevEUI(ctx context.Context, req *ns.GetDeviceQueueItemsForDevEUIRequest) (*ns.GetDeviceQueueItemsForDevEUIResponse, error)

GetDeviceQueueItemsForDevEUI returns all device-queue items for the given DevEUI.

func (*NetworkServerAPI) GetGateway ¶

func (n *NetworkServerAPI) GetGateway(ctx context.Context, req *ns.GetGatewayRequest) (*ns.GetGatewayResponse, error)

GetGateway returns data for a particular gateway.

func (*NetworkServerAPI) GetGatewayProfile ¶

func (n *NetworkServerAPI) GetGatewayProfile(ctx context.Context, req *ns.GetGatewayProfileRequest) (*ns.GetGatewayProfileResponse, error)

GetGatewayProfile returns the gateway-profile given an id.

func (*NetworkServerAPI) GetGatewayStats ¶

func (n *NetworkServerAPI) GetGatewayStats(ctx context.Context, req *ns.GetGatewayStatsRequest) (*ns.GetGatewayStatsResponse, error)

GetGatewayStats returns stats of an existing gateway.

func (*NetworkServerAPI) GetNextDownlinkFCntForDevEUI ¶

func (n *NetworkServerAPI) GetNextDownlinkFCntForDevEUI(ctx context.Context, req *ns.GetNextDownlinkFCntForDevEUIRequest) (*ns.GetNextDownlinkFCntForDevEUIResponse, error)

GetNextDownlinkFCntForDevEUI returns the next FCnt that must be used. This also takes device-queue items for the given DevEUI into consideration. In case the device is not activated, this will return an error as no device-session exists.

func (*NetworkServerAPI) GetRandomDevAddr ¶

func (n *NetworkServerAPI) GetRandomDevAddr(ctx context.Context, req *ns.GetRandomDevAddrRequest) (*ns.GetRandomDevAddrResponse, error)

GetRandomDevAddr returns a random DevAddr.

func (*NetworkServerAPI) GetRoutingProfile ¶

func (n *NetworkServerAPI) GetRoutingProfile(ctx context.Context, req *ns.GetRoutingProfileRequest) (*ns.GetRoutingProfileResponse, error)

GetRoutingProfile returns the routing-profile matching the given id.

func (*NetworkServerAPI) GetServiceProfile ¶

func (n *NetworkServerAPI) GetServiceProfile(ctx context.Context, req *ns.GetServiceProfileRequest) (*ns.GetServiceProfileResponse, error)

GetServiceProfile returns the service-profile matching the given id.

func (*NetworkServerAPI) GetVersion ¶

func (n *NetworkServerAPI) GetVersion(ctx context.Context, req *ns.GetVersionRequest) (*ns.GetVersionResponse, error)

GetVersion returns the LoRa Server version.

func (*NetworkServerAPI) SendProprietaryPayload ¶

func (n *NetworkServerAPI) SendProprietaryPayload(ctx context.Context, req *ns.SendProprietaryPayloadRequest) (*ns.SendProprietaryPayloadResponse, error)

SendProprietaryPayload send a payload using the 'Proprietary' LoRaWAN message-type.

func (*NetworkServerAPI) StreamFrameLogsForDevice ¶

func (n *NetworkServerAPI) StreamFrameLogsForDevice(req *ns.StreamFrameLogsForDeviceRequest, srv ns.NetworkServer_StreamFrameLogsForDeviceServer) error

StreamFrameLogsForDevice returns a stream of frames seen by the given device.

func (*NetworkServerAPI) StreamFrameLogsForGateway ¶

func (n *NetworkServerAPI) StreamFrameLogsForGateway(req *ns.StreamFrameLogsForGatewayRequest, srv ns.NetworkServer_StreamFrameLogsForGatewayServer) error

StreamFrameLogsForGateway returns a stream of frames seen by the given gateway.

func (*NetworkServerAPI) UpdateDevice ¶

func (n *NetworkServerAPI) UpdateDevice(ctx context.Context, req *ns.UpdateDeviceRequest) (*ns.UpdateDeviceResponse, error)

UpdateDevice updates the given device.

func (*NetworkServerAPI) UpdateDeviceProfile ¶

func (n *NetworkServerAPI) UpdateDeviceProfile(ctx context.Context, req *ns.UpdateDeviceProfileRequest) (*ns.UpdateDeviceProfileResponse, error)

UpdateDeviceProfile updates the given device-profile. The RFRegion field will get set automatically according to the configured band.

func (*NetworkServerAPI) UpdateGateway ¶

func (n *NetworkServerAPI) UpdateGateway(ctx context.Context, req *ns.UpdateGatewayRequest) (*ns.UpdateGatewayResponse, error)

UpdateGateway updates an existing gateway.

func (*NetworkServerAPI) UpdateGatewayProfile ¶

func (n *NetworkServerAPI) UpdateGatewayProfile(ctx context.Context, req *ns.UpdateGatewayProfileRequest) (*ns.UpdateGatewayProfileResponse, error)

UpdateGatewayProfile updates the given gateway-profile.

func (*NetworkServerAPI) UpdateRoutingProfile ¶

func (n *NetworkServerAPI) UpdateRoutingProfile(ctx context.Context, req *ns.UpdateRoutingProfileRequest) (*ns.UpdateRoutingProfileResponse, error)

UpdateRoutingProfile updates the given routing-profile.

func (*NetworkServerAPI) UpdateServiceProfile ¶

func (n *NetworkServerAPI) UpdateServiceProfile(ctx context.Context, req *ns.UpdateServiceProfileRequest) (*ns.UpdateServiceProfileResponse, error)

UpdateServiceProfile updates the given service-profile.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
client
asclient
jsclient

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL