api

package
v2.0.0-alpha.1+incompa... Latest Latest
Warning

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

 Go to latest Published: Jul 3, 2018 License: MIT Imports: 34 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewJoinServerAPI 

func NewJoinServerAPI() http.Handler

NewJoinServerAPI create a new JoinServerAPI.

Types

type ApplicationAPI 

type ApplicationAPI struct {
	// contains filtered or unexported fields
}

ApplicationAPI exports the Application related functions.

func NewApplicationAPI 

func NewApplicationAPI(validator auth.Validator) *ApplicationAPI

NewApplicationAPI creates a new ApplicationAPI.

func (*ApplicationAPI) Create 

func (a *ApplicationAPI) Create(ctx context.Context, req *pb.CreateApplicationRequest) (*pb.CreateApplicationResponse, error)

Create creates the given application.

func (*ApplicationAPI) CreateHTTPIntegration 

func (a *ApplicationAPI) CreateHTTPIntegration(ctx context.Context, in *pb.CreateHTTPIntegrationRequest) (*empty.Empty, error)

CreateHTTPIntegration creates an HTTP application-integration.

func (*ApplicationAPI) CreateInfluxDBIntegration 

func (a *ApplicationAPI) CreateInfluxDBIntegration(ctx context.Context, in *pb.CreateInfluxDBIntegrationRequest) (*empty.Empty, error)

CreateInfluxDBIntegration create an InfluxDB application-integration.

func (*ApplicationAPI) Delete 

func (a *ApplicationAPI) Delete(ctx context.Context, req *pb.DeleteApplicationRequest) (*empty.Empty, error)

Delete deletes the given application.

func (*ApplicationAPI) DeleteHTTPIntegration 

func (a *ApplicationAPI) DeleteHTTPIntegration(ctx context.Context, in *pb.DeleteHTTPIntegrationRequest) (*empty.Empty, error)

DeleteHTTPIntegration deletes the application-integration of the given type.

func (*ApplicationAPI) DeleteInfluxDBIntegration 

func (a *ApplicationAPI) DeleteInfluxDBIntegration(ctx context.Context, in *pb.DeleteInfluxDBIntegrationRequest) (*empty.Empty, error)

DeleteInfluxDBIntegration deletes the InfluxDB application-integration.

func (*ApplicationAPI) Get 

func (a *ApplicationAPI) Get(ctx context.Context, req *pb.GetApplicationRequest) (*pb.GetApplicationResponse, error)

Get returns the requested application.

func (*ApplicationAPI) GetHTTPIntegration 

func (a *ApplicationAPI) GetHTTPIntegration(ctx context.Context, in *pb.GetHTTPIntegrationRequest) (*pb.GetHTTPIntegrationResponse, error)

GetHTTPIntegration returns the HTTP application-itegration.

func (*ApplicationAPI) GetInfluxDBIntegration 

func (a *ApplicationAPI) GetInfluxDBIntegration(ctx context.Context, in *pb.GetInfluxDBIntegrationRequest) (*pb.GetInfluxDBIntegrationResponse, error)

GetInfluxDBIntegration returns the InfluxDB application-integration.

func (*ApplicationAPI) List 

func (a *ApplicationAPI) List(ctx context.Context, req *pb.ListApplicationRequest) (*pb.ListApplicationResponse, error)

List lists the available applications.

func (*ApplicationAPI) ListIntegrations 

func (a *ApplicationAPI) ListIntegrations(ctx context.Context, in *pb.ListIntegrationRequest) (*pb.ListIntegrationResponse, error)

ListIntegrations lists all configured integrations.

func (*ApplicationAPI) Update 

func (a *ApplicationAPI) Update(ctx context.Context, req *pb.UpdateApplicationRequest) (*empty.Empty, error)

Update updates the given application.

func (*ApplicationAPI) UpdateHTTPIntegration 

func (a *ApplicationAPI) UpdateHTTPIntegration(ctx context.Context, in *pb.UpdateHTTPIntegrationRequest) (*empty.Empty, error)

UpdateHTTPIntegration updates the HTTP application-integration.

func (*ApplicationAPI) UpdateInfluxDBIntegration 

func (a *ApplicationAPI) UpdateInfluxDBIntegration(ctx context.Context, in *pb.UpdateInfluxDBIntegrationRequest) (*empty.Empty, error)

UpdateInfluxDBIntegration updates the InfluxDB application-integration.

type ApplicationServerAPI 

type ApplicationServerAPI struct {
}

ApplicationServerAPI implements the as.ApplicationServerServer interface.

func NewApplicationServerAPI 

func NewApplicationServerAPI() *ApplicationServerAPI

NewApplicationServerAPI returns a new ApplicationServerAPI.

func (*ApplicationServerAPI) HandleDownlinkACK 

func (a *ApplicationServerAPI) HandleDownlinkACK(ctx context.Context, req *as.HandleDownlinkACKRequest) (*empty.Empty, error)

HandleDownlinkACK handles an ack on a downlink transmission.

func (*ApplicationServerAPI) HandleError 

func (a *ApplicationServerAPI) HandleError(ctx context.Context, req *as.HandleErrorRequest) (*empty.Empty, error)

HandleError handles an incoming error. 

func (a *ApplicationServerAPI) HandleProprietaryUplink(ctx context.Context, req *as.HandleProprietaryUplinkRequest) (*empty.Empty, error)

HandleProprietaryUplink handles proprietary uplink payloads.

func (*ApplicationServerAPI) HandleUplinkData 

func (a *ApplicationServerAPI) HandleUplinkData(ctx context.Context, req *as.HandleUplinkDataRequest) (*empty.Empty, error)

HandleUplinkData handles incoming (uplink) data.

func (*ApplicationServerAPI) SetDeviceStatus 

func (a *ApplicationServerAPI) SetDeviceStatus(ctx context.Context, req *as.SetDeviceStatusRequest) (*empty.Empty, error)

SetDeviceStatus updates the device-status for the given device.

type DeviceAPI 

type DeviceAPI struct {
	// contains filtered or unexported fields
}

DeviceAPI exports the Node related functions.

func NewDeviceAPI 

func NewDeviceAPI(validator auth.Validator) *DeviceAPI

NewDeviceAPI creates a new NodeAPI.

func (*DeviceAPI) Activate 

func (a *DeviceAPI) Activate(ctx context.Context, req *pb.ActivateDeviceRequest) (*empty.Empty, error)

Activate activates the node (ABP only).

func (*DeviceAPI) Create 

func (a *DeviceAPI) Create(ctx context.Context, req *pb.CreateDeviceRequest) (*empty.Empty, error)

Create creates the given device.

func (*DeviceAPI) CreateKeys 

func (a *DeviceAPI) CreateKeys(ctx context.Context, req *pb.CreateDeviceKeysRequest) (*empty.Empty, error)

CreateKeys creates the given device-keys.

func (*DeviceAPI) Delete 

func (a *DeviceAPI) Delete(ctx context.Context, req *pb.DeleteDeviceRequest) (*empty.Empty, error)

Delete deletes the node matching the given name.

func (*DeviceAPI) DeleteKeys 

func (a *DeviceAPI) DeleteKeys(ctx context.Context, req *pb.DeleteDeviceKeysRequest) (*empty.Empty, error)

DeleteKeys deletes the device-keys for the given DevEUI.

func (*DeviceAPI) Get 

func (a *DeviceAPI) Get(ctx context.Context, req *pb.GetDeviceRequest) (*pb.GetDeviceResponse, error)

Get returns the device matching the given DevEUI.

func (*DeviceAPI) GetActivation 

func (a *DeviceAPI) GetActivation(ctx context.Context, req *pb.GetDeviceActivationRequest) (*pb.GetDeviceActivationResponse, error)

GetActivation returns the device activation for the given DevEUI.

func (*DeviceAPI) GetKeys 

func (a *DeviceAPI) GetKeys(ctx context.Context, req *pb.GetDeviceKeysRequest) (*pb.GetDeviceKeysResponse, error)

GetKeys returns the device-keys for the given DevEUI.

func (*DeviceAPI) GetRandomDevAddr 

func (a *DeviceAPI) GetRandomDevAddr(ctx context.Context, req *pb.GetRandomDevAddrRequest) (*pb.GetRandomDevAddrResponse, error)

GetRandomDevAddr returns a random DevAddr taking the NwkID prefix into account.

func (*DeviceAPI) List 

func (a *DeviceAPI) List(ctx context.Context, req *pb.ListDeviceRequest) (*pb.ListDeviceResponse, error)

List lists the available applications.

func (*DeviceAPI) StreamEventLogs 

func (a *DeviceAPI) StreamEventLogs(req *pb.StreamDeviceEventLogsRequest, srv pb.DeviceService_StreamEventLogsServer) error

StreamEventLogs stream the device events (uplink payloads, ACKs, joins, errors). Note: this endpoint is intended for debugging and should not be used for building integrations.

func (*DeviceAPI) StreamFrameLogs 

func (a *DeviceAPI) StreamFrameLogs(req *pb.StreamDeviceFrameLogsRequest, srv pb.DeviceService_StreamFrameLogsServer) error

StreamFrameLogs streams the uplink and downlink frame-logs for the given DevEUI. Note: these are the raw LoRaWAN frames and this endpoint is intended for debugging.

func (*DeviceAPI) Update 

func (a *DeviceAPI) Update(ctx context.Context, req *pb.UpdateDeviceRequest) (*empty.Empty, error)

Update updates the device matching the given DevEUI.

func (*DeviceAPI) UpdateKeys 

func (a *DeviceAPI) UpdateKeys(ctx context.Context, req *pb.UpdateDeviceKeysRequest) (*empty.Empty, error)

UpdateKeys updates the device-keys.

type DeviceProfileServiceAPI 

type DeviceProfileServiceAPI struct {
	// contains filtered or unexported fields
}

DeviceProfileServiceAPI exports the ServiceProfile related functions.

func NewDeviceProfileServiceAPI 

func NewDeviceProfileServiceAPI(validator auth.Validator) *DeviceProfileServiceAPI

NewDeviceProfileServiceAPI creates a new DeviceProfileServiceAPI.

func (*DeviceProfileServiceAPI) Create 

func (a *DeviceProfileServiceAPI) Create(ctx context.Context, req *pb.CreateDeviceProfileRequest) (*pb.CreateDeviceProfileResponse, error)

Create creates the given device-profile.

func (*DeviceProfileServiceAPI) Delete 

func (a *DeviceProfileServiceAPI) Delete(ctx context.Context, req *pb.DeleteDeviceProfileRequest) (*empty.Empty, error)

Delete deletes the device-profile matching the given id.

func (*DeviceProfileServiceAPI) Get 

func (a *DeviceProfileServiceAPI) Get(ctx context.Context, req *pb.GetDeviceProfileRequest) (*pb.GetDeviceProfileResponse, error)

Get returns the device-profile matching the given id.

func (*DeviceProfileServiceAPI) List 

func (a *DeviceProfileServiceAPI) List(ctx context.Context, req *pb.ListDeviceProfileRequest) (*pb.ListDeviceProfileResponse, error)

List lists the available device-profiles.

func (*DeviceProfileServiceAPI) Update 

func (a *DeviceProfileServiceAPI) Update(ctx context.Context, req *pb.UpdateDeviceProfileRequest) (*empty.Empty, error)

Update updates the given device-profile.

type DeviceQueueAPI 

type DeviceQueueAPI struct {
	// contains filtered or unexported fields
}

DeviceQueueAPI exposes the downlink queue methods.

func NewDeviceQueueAPI 

func NewDeviceQueueAPI(validator auth.Validator) *DeviceQueueAPI

NewDeviceQueueAPI creates a new DeviceQueueAPI.

func (*DeviceQueueAPI) Enqueue 

func (d *DeviceQueueAPI) Enqueue(ctx context.Context, req *pb.EnqueueDeviceQueueItemRequest) (*empty.Empty, error)

Enqueue adds the given item to the device-queue.

func (*DeviceQueueAPI) Flush 

func (d *DeviceQueueAPI) Flush(ctx context.Context, req *pb.FlushDeviceQueueRequest) (*empty.Empty, error)

Flush flushes the downlink device-queue.

func (*DeviceQueueAPI) List 

func (d *DeviceQueueAPI) List(ctx context.Context, req *pb.ListDeviceQueueItemsRequest) (*pb.ListDeviceQueueItemsResponse, error)

List lists the items in the device-queue.

type GatewayAPI 

type GatewayAPI struct {
	// contains filtered or unexported fields
}

GatewayAPI exports the Gateway related functions.

func NewGatewayAPI 

func NewGatewayAPI(validator auth.Validator) *GatewayAPI

NewGatewayAPI creates a new GatewayAPI.

func (*GatewayAPI) Create 

func (a *GatewayAPI) Create(ctx context.Context, req *pb.CreateGatewayRequest) (*empty.Empty, error)

Create creates the given gateway.

func (*GatewayAPI) Delete 

func (a *GatewayAPI) Delete(ctx context.Context, req *pb.DeleteGatewayRequest) (*empty.Empty, error)

Delete deletes the gateway matching the given ID.

func (*GatewayAPI) Get 

func (a *GatewayAPI) Get(ctx context.Context, req *pb.GetGatewayRequest) (*pb.GetGatewayResponse, error)

Get returns the gateway matching the given Mac.

func (*GatewayAPI) GetLastPing 

func (a *GatewayAPI) GetLastPing(ctx context.Context, req *pb.GetLastPingRequest) (*pb.GetLastPingResponse, error)

GetLastPing returns the last emitted ping and gateways receiving this ping.

func (*GatewayAPI) GetStats 

func (a *GatewayAPI) GetStats(ctx context.Context, req *pb.GetGatewayStatsRequest) (*pb.GetGatewayStatsResponse, error)

GetStats gets the gateway statistics for the gateway with the given Mac.

func (*GatewayAPI) List 

func (a *GatewayAPI) List(ctx context.Context, req *pb.ListGatewayRequest) (*pb.ListGatewayResponse, error)

List lists the gateways.

func (*GatewayAPI) StreamFrameLogs 

func (a *GatewayAPI) StreamFrameLogs(req *pb.StreamGatewayFrameLogsRequest, srv pb.GatewayService_StreamFrameLogsServer) error

StreamFrameLogs streams the uplink and downlink frame-logs for the given mac. Note: these are the raw LoRaWAN frames and this endpoint is intended for debugging.

func (*GatewayAPI) Update 

func (a *GatewayAPI) Update(ctx context.Context, req *pb.UpdateGatewayRequest) (*empty.Empty, error)

Update updates the given gateway.

type GatewayProfileAPI 

type GatewayProfileAPI struct {
	// contains filtered or unexported fields
}

GatewayProfileAPI exports the GatewayProfile related functions.

func NewGatewayProfileAPI 

func NewGatewayProfileAPI(validator auth.Validator) *GatewayProfileAPI

NewGatewayProfileAPI creates a new GatewayProfileAPI.

func (*GatewayProfileAPI) Create 

func (a *GatewayProfileAPI) Create(ctx context.Context, req *pb.CreateGatewayProfileRequest) (*pb.CreateGatewayProfileResponse, error)

Create creates the given gateway-profile.

func (*GatewayProfileAPI) Delete 

func (a *GatewayProfileAPI) Delete(ctx context.Context, req *pb.DeleteGatewayProfileRequest) (*empty.Empty, error)

Delete deletes the gateway-profile matching the given id.

func (*GatewayProfileAPI) Get 

func (a *GatewayProfileAPI) Get(ctx context.Context, req *pb.GetGatewayProfileRequest) (*pb.GetGatewayProfileResponse, error)

Get returns the gateway-profile matching the given id.

func (*GatewayProfileAPI) List 

func (a *GatewayProfileAPI) List(ctx context.Context, req *pb.ListGatewayProfilesRequest) (*pb.ListGatewayProfilesResponse, error)

List returns the existing gateway-profiles.

func (*GatewayProfileAPI) Update 

func (a *GatewayProfileAPI) Update(ctx context.Context, req *pb.UpdateGatewayProfileRequest) (*empty.Empty, error)

Update updates the given gateway-profile.

type InternalUserAPI 

type InternalUserAPI struct {
	// contains filtered or unexported fields
}

InternalUserAPI exports the internal User related functions.

func NewInternalUserAPI 

func NewInternalUserAPI(validator auth.Validator) *InternalUserAPI

NewInternalUserAPI creates a new InternalUserAPI.

func (*InternalUserAPI) Branding 

func (a *InternalUserAPI) Branding(ctx context.Context, req *empty.Empty) (*pb.BrandingResponse, error)

Branding returns UI branding.

func (*InternalUserAPI) GlobalSearch 

func (a *InternalUserAPI) GlobalSearch(ctx context.Context, req *pb.GlobalSearchRequest) (*pb.GlobalSearchResponse, error)

GlobalSearch performs a global search.

func (*InternalUserAPI) Login 

func (a *InternalUserAPI) Login(ctx context.Context, req *pb.LoginRequest) (*pb.LoginResponse, error)

Login validates the login request and returns a JWT token.

func (*InternalUserAPI) Profile 

func (a *InternalUserAPI) Profile(ctx context.Context, req *empty.Empty) (*pb.ProfileResponse, error)

Profile returns the user profile.

type JoinServerAPI 

type JoinServerAPI struct{}

JoinServerAPI implements the join-server API as documented in the LoRaWAN backend interfaces specification.

func (*JoinServerAPI) ServeHTTP 

func (a *JoinServerAPI) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements the http.Handler interface.

type NetworkServerAPI 

type NetworkServerAPI struct {
	// contains filtered or unexported fields
}

NetworkServerAPI exports the NetworkServer related functions.

func NewNetworkServerAPI 

func NewNetworkServerAPI(validator auth.Validator) *NetworkServerAPI

NewNetworkServerAPI creates a new NetworkServerAPI.

func (*NetworkServerAPI) Create 

func (a *NetworkServerAPI) Create(ctx context.Context, req *pb.CreateNetworkServerRequest) (*pb.CreateNetworkServerResponse, error)

Create creates the given network-server.

func (*NetworkServerAPI) Delete 

func (a *NetworkServerAPI) Delete(ctx context.Context, req *pb.DeleteNetworkServerRequest) (*empty.Empty, error)

Delete deletes the network-server matching the given id.

func (*NetworkServerAPI) Get 

func (a *NetworkServerAPI) Get(ctx context.Context, req *pb.GetNetworkServerRequest) (*pb.GetNetworkServerResponse, error)

Get returns the network-server matching the given id.

func (*NetworkServerAPI) List 

func (a *NetworkServerAPI) List(ctx context.Context, req *pb.ListNetworkServerRequest) (*pb.ListNetworkServerResponse, error)

List lists the available network-servers.

func (*NetworkServerAPI) Update 

func (a *NetworkServerAPI) Update(ctx context.Context, req *pb.UpdateNetworkServerRequest) (*empty.Empty, error)

Update updates the given network-server.

type OrganizationAPI 

type OrganizationAPI struct {
	// contains filtered or unexported fields
}

OrganizationAPI exports the organization related functions.

func NewOrganizationAPI 

func NewOrganizationAPI(validator auth.Validator) *OrganizationAPI

NewOrganizationAPI creates a new OrganizationAPI.

func (*OrganizationAPI) AddUser 

func (a *OrganizationAPI) AddUser(ctx context.Context, req *pb.AddOrganizationUserRequest) (*empty.Empty, error)

AddUser creates the given organization-user link.

func (*OrganizationAPI) Create 

func (a *OrganizationAPI) Create(ctx context.Context, req *pb.CreateOrganizationRequest) (*pb.CreateOrganizationResponse, error)

Create creates the given organization.

func (*OrganizationAPI) Delete 

func (a *OrganizationAPI) Delete(ctx context.Context, req *pb.DeleteOrganizationRequest) (*empty.Empty, error)

Delete deletes the organization matching the given ID.

func (*OrganizationAPI) DeleteUser 

func (a *OrganizationAPI) DeleteUser(ctx context.Context, req *pb.DeleteOrganizationUserRequest) (*empty.Empty, error)

DeleteUser deletes the given user from the organization.

func (*OrganizationAPI) Get 

func (a *OrganizationAPI) Get(ctx context.Context, req *pb.GetOrganizationRequest) (*pb.GetOrganizationResponse, error)

Get returns the organization matching the given ID.

func (*OrganizationAPI) GetUser 

func (a *OrganizationAPI) GetUser(ctx context.Context, req *pb.GetOrganizationUserRequest) (*pb.GetOrganizationUserResponse, error)

GetUser returns the user details for the given user ID.

func (*OrganizationAPI) List 

func (a *OrganizationAPI) List(ctx context.Context, req *pb.ListOrganizationRequest) (*pb.ListOrganizationResponse, error)

List lists the organizations to which the user has access.

func (*OrganizationAPI) ListUsers 

func (a *OrganizationAPI) ListUsers(ctx context.Context, req *pb.ListOrganizationUsersRequest) (*pb.ListOrganizationUsersResponse, error)

ListUsers lists the users assigned to the given organization.

func (*OrganizationAPI) Update 

func (a *OrganizationAPI) Update(ctx context.Context, req *pb.UpdateOrganizationRequest) (*empty.Empty, error)

Update updates the given organization.

func (*OrganizationAPI) UpdateUser 

func (a *OrganizationAPI) UpdateUser(ctx context.Context, req *pb.UpdateOrganizationUserRequest) (*empty.Empty, error)

UpdateUser updates the given user.

type ServiceProfileServiceAPI 

type ServiceProfileServiceAPI struct {
	// contains filtered or unexported fields
}

ServiceProfileServiceAPI export the ServiceProfile related functions.

func NewServiceProfileServiceAPI 

func NewServiceProfileServiceAPI(validator auth.Validator) *ServiceProfileServiceAPI

NewServiceProfileServiceAPI creates a new ServiceProfileServiceAPI.

func (*ServiceProfileServiceAPI) Create 

func (a *ServiceProfileServiceAPI) Create(ctx context.Context, req *pb.CreateServiceProfileRequest) (*pb.CreateServiceProfileResponse, error)

Create creates the given service-profile.

func (*ServiceProfileServiceAPI) Delete 

func (a *ServiceProfileServiceAPI) Delete(ctx context.Context, req *pb.DeleteServiceProfileRequest) (*empty.Empty, error)

Delete deletes the service-profile matching the given id.

func (*ServiceProfileServiceAPI) Get 

func (a *ServiceProfileServiceAPI) Get(ctx context.Context, req *pb.GetServiceProfileRequest) (*pb.GetServiceProfileResponse, error)

Get returns the service-profile matching the given id.

func (*ServiceProfileServiceAPI) List 

func (a *ServiceProfileServiceAPI) List(ctx context.Context, req *pb.ListServiceProfileRequest) (*pb.ListServiceProfileResponse, error)

List lists the available service-profiles.

func (*ServiceProfileServiceAPI) Update 

func (a *ServiceProfileServiceAPI) Update(ctx context.Context, req *pb.UpdateServiceProfileRequest) (*empty.Empty, error)

Update updates the given serviceprofile.

type UserAPI 

type UserAPI struct {
	// contains filtered or unexported fields
}

UserAPI exports the User related functions.

func NewUserAPI 

func NewUserAPI(validator auth.Validator) *UserAPI

NewUserAPI creates a new UserAPI.

func (*UserAPI) Create 

func (a *UserAPI) Create(ctx context.Context, req *pb.CreateUserRequest) (*pb.CreateUserResponse, error)

Create creates the given user.

func (*UserAPI) Delete 

func (a *UserAPI) Delete(ctx context.Context, req *pb.DeleteUserRequest) (*empty.Empty, error)

Delete deletes the user matching the given ID.

func (*UserAPI) Get 

func (a *UserAPI) Get(ctx context.Context, req *pb.GetUserRequest) (*pb.GetUserResponse, error)

Get returns the user matching the given ID.

func (*UserAPI) List 

func (a *UserAPI) List(ctx context.Context, req *pb.ListUserRequest) (*pb.ListUserResponse, error)

List lists the users.

func (*UserAPI) Update 

func (a *UserAPI) Update(ctx context.Context, req *pb.UpdateUserRequest) (*empty.Empty, error)

Update updates the given user.

func (*UserAPI) UpdatePassword 

func (a *UserAPI) UpdatePassword(ctx context.Context, req *pb.UpdateUserPasswordRequest) (*empty.Empty, error)

UpdatePassword updates the password for the user matching the given ID.

Source Files

View all Source files

Directories

Path Synopsis

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.