external

package
v0.4.1 Latest Latest
Warning

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

Go to latest
Published: Dec 9, 2019 License: MIT Imports: 57 Imported by: 0

Documentation

Index

Constants

View Source
const GatewayLocationsRedisKey = "gateway_locations"

Variables

This section is empty.

Functions

func IsPassVerifyingGoogleRecaptcha

func IsPassVerifyingGoogleRecaptcha(response string, remoteip string) (*pb.GoogleRecaptchaResponse, error)

func Setup

func Setup(conf config.Config) error

Setup configures the API package.

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

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) CreateThingsBoardIntegration

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

CreateThingsBoardIntegration creates a ThingsBoard application-integration.

func (*ApplicationAPI) Delete

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) DeleteThingsBoardIntegration

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

DeleteThingsBoardIntegration deletes the ThingsBoard application-integration.

func (*ApplicationAPI) Get

Get returns the requested application.

func (*ApplicationAPI) GetHTTPIntegration

GetHTTPIntegration returns the HTTP application-itegration.

func (*ApplicationAPI) GetInfluxDBIntegration

GetInfluxDBIntegration returns the InfluxDB application-integration.

func (*ApplicationAPI) GetThingsBoardIntegration

GetThingsBoardIntegration returns the ThingsBoard application-integration.

func (*ApplicationAPI) List

List lists the available applications.

func (*ApplicationAPI) ListIntegrations

ListIntegrations lists all configured integrations.

func (*ApplicationAPI) Update

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.

func (*ApplicationAPI) UpdateThingsBoardIntegration

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

UpdateThingsBoardIntegration updates the ThingsBoard application-integration.

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) Deactivate

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

Deactivate de-activates the device.

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

Get returns the device matching the given DevEUI.

func (*DeviceAPI) GetActivation

GetActivation returns the device activation for the given DevEUI.

func (*DeviceAPI) GetKeys

GetKeys returns the device-keys for the given DevEUI.

func (*DeviceAPI) GetRandomDevAddr

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

func (*DeviceAPI) List

List lists the available applications.

func (*DeviceAPI) StreamEventLogs

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

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

Create creates the given device-profile.

func (*DeviceProfileServiceAPI) Delete

Delete deletes the device-profile matching the given id.

func (*DeviceProfileServiceAPI) Get

Get returns the device-profile matching the given id.

func (*DeviceProfileServiceAPI) List

List lists the available device-profiles.

func (*DeviceProfileServiceAPI) Update

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

Enqueue adds the given item to the device-queue.

func (*DeviceQueueAPI) Flush

Flush flushes the downlink device-queue.

func (*DeviceQueueAPI) List

List lists the items in the device-queue.

type FUOTADeploymentAPI

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

FUOTADeploymentAPI exports the FUOTA deployment related functions.

func NewFUOTADeploymentAPI

func NewFUOTADeploymentAPI(validator auth.Validator) *FUOTADeploymentAPI

NewFUOTADeploymentAPI creates a new FUOTADeploymentAPI.

func (*FUOTADeploymentAPI) CreateForDevice

CreateForDevice creates a deployment for the given DevEUI.

func (*FUOTADeploymentAPI) Get

Get returns the fuota deployment for the given id.

func (*FUOTADeploymentAPI) GetDeploymentDevice

GetDeploymentDevice returns the deployment device.

func (*FUOTADeploymentAPI) List

List lists the fuota deployments.

func (*FUOTADeploymentAPI) ListDeploymentDevices

ListDevices lists the devices (and status) for the given fuota deployment ID.

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

Get returns the gateway matching the given Mac.

func (*GatewayAPI) GetLastPing

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

func (*GatewayAPI) GetStats

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

func (*GatewayAPI) List

List lists the gateways.

func (*GatewayAPI) ListLocations

ListLocations lists the gateway locations.

func (*GatewayAPI) StreamFrameLogs

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

Create creates the given gateway-profile.

func (*GatewayProfileAPI) Delete

Delete deletes the gateway-profile matching the given id.

func (*GatewayProfileAPI) Get

Get returns the gateway-profile matching the given id.

func (*GatewayProfileAPI) List

List returns the existing gateway-profiles.

func (*GatewayProfileAPI) Update

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) ConfirmRegistration

ConfirmRegistration checks provided security token and activates user

func (*InternalUserAPI) FinishRegistration

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

FinishRegistration sets new user password and creates a new organization

func (*InternalUserAPI) GetVerifyingGoogleRecaptcha

func (a *InternalUserAPI) GetVerifyingGoogleRecaptcha(ctx context.Context, req *pb.GoogleRecaptchaRequest) (*pb.GoogleRecaptchaResponse, error)

func (*InternalUserAPI) GetVerigyingAliyunRecaptcha

func (a *InternalUserAPI) GetVerigyingAliyunRecaptcha(ctx context.Context, req *pb.AliyunRecaptchaRequest) (*pb.AliyunRecaptchaResponse, error)

func (*InternalUserAPI) GlobalSearch

GlobalSearch performs a global search.

func (*InternalUserAPI) Login

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.

func (*InternalUserAPI) RegisterUser

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

RegisterUser adds new user and sends activation email

type MulticastGroupAPI

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

MulticastGroupAPI implements the multicast-group api.

func NewMulticastGroupAPI

func NewMulticastGroupAPI(validator auth.Validator, routingProfileID uuid.UUID) *MulticastGroupAPI

NewMulticastGroupAPI creates a new multicast-group API.

func (*MulticastGroupAPI) AddDevice

AddDevice adds the given device to the multicast-group.

func (*MulticastGroupAPI) Create

Create creates the given multicast-group.

func (*MulticastGroupAPI) Delete

Delete deletes a multicast-group given an ID.

func (*MulticastGroupAPI) Enqueue

Enqueue adds the given item to the multicast-queue.

func (*MulticastGroupAPI) FlushQueue

FlushQueue flushes the multicast-group queue.

func (*MulticastGroupAPI) Get

Get returns a multicast-group given an ID.

func (*MulticastGroupAPI) List

List lists the available multicast-groups.

func (*MulticastGroupAPI) ListQueue

ListQueue lists the items in the multicast-group queue.

func (*MulticastGroupAPI) RemoveDevice

RemoveDevice removes the given device from the multicast-group.

func (*MulticastGroupAPI) Update

Update updates the given multicast-group.

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

Create creates the given network-server.

func (*NetworkServerAPI) Delete

Delete deletes the network-server matching the given id.

func (*NetworkServerAPI) Get

Get returns the network-server matching the given id.

func (*NetworkServerAPI) List

List lists the available network-servers.

func (*NetworkServerAPI) Update

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

AddUser creates the given organization-user link.

func (*OrganizationAPI) Create

Create creates the given organization.

func (*OrganizationAPI) Delete

Delete deletes the organization matching the given ID.

func (*OrganizationAPI) DeleteUser

DeleteUser deletes the given user from the organization.

func (*OrganizationAPI) Get

Get returns the organization matching the given ID.

func (*OrganizationAPI) GetUser

GetUser returns the user details for the given user ID.

func (*OrganizationAPI) List

List lists the organizations to which the user has access.

func (*OrganizationAPI) ListUsers

ListUsers lists the users assigned to the given organization.

func (*OrganizationAPI) Update

Update updates the given organization.

func (*OrganizationAPI) UpdateUser

UpdateUser updates the given user.

type ProxyRequestAPI

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

func NewProxyRequestAPI

func NewProxyRequestAPI(validator auth.Validator) *ProxyRequestAPI

func (*ProxyRequestAPI) GetWalletBalance

type ServerInfoAPI

type ServerInfoAPI struct {
}

func NewServerInfoAPI

func NewServerInfoAPI() *ServerInfoAPI

func (*ServerInfoAPI) GetAppserverVersion

func (s *ServerInfoAPI) GetAppserverVersion(ctx context.Context, req *empty.Empty) (*pb.GetAppserverVersionResponse, error)

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

Create creates the given service-profile.

func (*ServiceProfileServiceAPI) Delete

Delete deletes the service-profile matching the given id.

func (*ServiceProfileServiceAPI) Get

Get returns the service-profile matching the given id.

func (*ServiceProfileServiceAPI) List

List lists the available service-profiles.

func (*ServiceProfileServiceAPI) Update

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

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

Get returns the user matching the given ID.

func (*UserAPI) List

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.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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