storage

package
v1.0.2 Latest Latest
Warning

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

Go to latest
Published: Jul 4, 2018 License: MIT Imports: 29 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ModulationFSK  = "FSK"
	ModulationLoRa = "LORA"
)

Modulations

Variables

View Source
var (
	ErrAlreadyExists                   = errors.New("object already exists")
	ErrDoesNotExist                    = errors.New("object does not exist")
	ErrUsedByOtherObjects              = errors.New("this object is used by other objects, remove them first")
	ErrApplicationInvalidName          = errors.New("invalid application name")
	ErrNodeInvalidName                 = errors.New("invalid node name")
	ErrNodeMaxRXDelay                  = errors.New("max value of RXDelay is 15")
	ErrCFListTooManyChannels           = errors.New("too many channels in channel-list")
	ErrUserInvalidUsername             = errors.New("username name may only be composed of upper and lower case characters and digits")
	ErrUserPasswordLength              = errors.New("passwords must be at least 6 characters long")
	ErrInvalidUsernameOrPassword       = errors.New("invalid username or password")
	ErrOrganizationInvalidName         = errors.New("invalid organization name")
	ErrGatewayInvalidName              = errors.New("invalid gateway name")
	ErrInvalidEmail                    = errors.New("invalid e-mail")
	ErrInvalidGatewayDiscoveryInterval = errors.New("invalid gateway-discovery interval, it must be greater than 0")
)

errors

View Source
var HashIterations = 100000

HashIterations defines the number of hash iterations.

Functions

func CreateApplication

func CreateApplication(db sqlx.Queryer, item *Application) error

CreateApplication creates the given Application.

func CreateDevice

func CreateDevice(db sqlx.Ext, d *Device) error

CreateDevice creates the given device.

func CreateDeviceActivation

func CreateDeviceActivation(db sqlx.Queryer, da *DeviceActivation) error

CreateDeviceActivation creates the given device-activation.

func CreateDeviceKeys

func CreateDeviceKeys(db sqlx.Execer, dc *DeviceKeys) error

CreateDeviceKeys creates the keys for the given device.

func CreateDeviceProfile

func CreateDeviceProfile(db sqlx.Ext, dp *DeviceProfile) error

CreateDeviceProfile creates the given device-profile. This will create the device-profile at the network-server side and will create a local reference record.

func CreateDeviceQueueMapping

func CreateDeviceQueueMapping(db sqlx.Queryer, dqm *DeviceQueueMapping) error

CreateDeviceQueueMapping creates the given device-queue mapping.

func CreateGateway

func CreateGateway(db sqlx.Execer, gw *Gateway) error

CreateGateway creates the given Gateway.

func CreateGatewayPing

func CreateGatewayPing(db sqlx.Queryer, ping *GatewayPing) error

CreateGatewayPing creates the given gateway ping.

func CreateGatewayPingRX

func CreateGatewayPingRX(db sqlx.Queryer, rx *GatewayPingRX) error

CreateGatewayPingRX creates the received ping.

func CreateGatewayProfile

func CreateGatewayProfile(db sqlx.Ext, gp *GatewayProfile) error

CreateGatewayProfile creates the given gateway-profile. This will create the gateway-profile at the network-server side and will create a local reference record.

func CreateIntegration

func CreateIntegration(db sqlx.Queryer, i *Integration) error

CreateIntegration creates the given Integration.

func CreateNetworkServer

func CreateNetworkServer(db sqlx.Queryer, n *NetworkServer) error

CreateNetworkServer creates the given network-server.

func CreateOrganization

func CreateOrganization(db sqlx.Queryer, org *Organization) error

CreateOrganization creates the given Organization.

func CreateOrganizationUser

func CreateOrganizationUser(db sqlx.Execer, organizationID, userID int64, isAdmin bool) error

CreateOrganizationUser adds the given user to the organization.

func CreateServiceProfile

func CreateServiceProfile(db sqlx.Ext, sp *ServiceProfile) error

CreateServiceProfile creates the given service-profile.

func CreateUser

func CreateUser(db sqlx.Queryer, user *User, password string) (int64, error)

CreateUser creates the given user.

func DeleteAllApplicationsForOrganizationID

func DeleteAllApplicationsForOrganizationID(db sqlx.Ext, organizationID int64) error

DeleteAllApplicationsForOrganizationID deletes all applications given an organization id.

func DeleteAllDeviceProfilesForOrganizationID

func DeleteAllDeviceProfilesForOrganizationID(db sqlx.Ext, organizationID int64) error

DeleteAllDeviceProfilesForOrganizationID deletes all device-profiles given an organization id.

func DeleteAllDevicesForApplicationID

func DeleteAllDevicesForApplicationID(db sqlx.Ext, applicationID int64) error

DeleteAllDevicesForApplicationID deletes all devices given an application id.

func DeleteAllGatewaysForOrganizationID

func DeleteAllGatewaysForOrganizationID(db sqlx.Ext, organizationID int64) error

DeleteAllGatewaysForOrganizationID deletes all gateways for a given organization id.

func DeleteAllServiceProfilesForOrganizationID

func DeleteAllServiceProfilesForOrganizationID(db sqlx.Ext, organizationID int64) error

DeleteAllServiceProfilesForOrganizationID deletes all service-profiles given an organization id.

func DeleteApplication

func DeleteApplication(db sqlx.Ext, id int64) error

DeleteApplication deletes the Application matching the given ID.

func DeleteDevice

func DeleteDevice(db sqlx.Ext, devEUI lorawan.EUI64) error

DeleteDevice deletes the device matching the given DevEUI.

func DeleteDeviceKeys

func DeleteDeviceKeys(db sqlx.Execer, devEUI lorawan.EUI64) error

DeleteDeviceKeys deletes the device-keys for the given DevEUI.

func DeleteDeviceProfile

func DeleteDeviceProfile(db sqlx.Ext, id string) error

DeleteDeviceProfile deletes the device-profile matching the given id.

func DeleteDeviceQueueMapping

func DeleteDeviceQueueMapping(db sqlx.Execer, id int64) error

DeleteDeviceQueueMapping deletes the device-queue mapping matching the given ID.

func DeleteGateway

func DeleteGateway(db sqlx.Ext, mac lorawan.EUI64) error

DeleteGateway deletes the gateway matching the given MAC.

func DeleteGatewayProfile

func DeleteGatewayProfile(db sqlx.Ext, id string) error

DeleteGatewayProfile deletes the gateway-profile matching the given id.

func DeleteIntegration

func DeleteIntegration(db sqlx.Execer, id int64) error

DeleteIntegration deletes the integration matching the given id.

func DeleteNetworkServer

func DeleteNetworkServer(db sqlx.Ext, id int64) error

DeleteNetworkServer deletes the network-server matching the given id.

func DeleteOrganization

func DeleteOrganization(db sqlx.Ext, id int64) error

DeleteOrganization deletes the organization matching the given id.

func DeleteOrganizationUser

func DeleteOrganizationUser(db sqlx.Execer, organizationID, userID int64) error

DeleteOrganizationUser deletes the given organization user.

func DeleteServiceProfile

func DeleteServiceProfile(db sqlx.Ext, id string) error

DeleteServiceProfile deletes the service-profile matching the given id.

func DeleteUser

func DeleteUser(db sqlx.Execer, id int64) error

DeleteUser deletes the User record matching the given ID.

func FlushDeviceQueueMappingForDevEUI

func FlushDeviceQueueMappingForDevEUI(db sqlx.Execer, devEUI lorawan.EUI64) error

FlushDeviceQueueMappingForDevEUI flushes the device-queue mapping for the given DevEUI.

func GetApplicationCount

func GetApplicationCount(db sqlx.Queryer, search string) (int, error)

GetApplicationCount returns the total number of applications.

func GetApplicationCountForOrganizationID

func GetApplicationCountForOrganizationID(db sqlx.Queryer, organizationID int64, search string) (int, error)

GetApplicationCountForOrganizationID returns the total number of applications for the given organization.

func GetApplicationCountForUser

func GetApplicationCountForUser(db sqlx.Queryer, username string, organizationID int64, search string) (int, error)

GetApplicationCountForUser returns the total number of applications available for the given user. When an organizationID is given, the results will be filtered by this organization ID.

func GetDeviceCountForApplicationID

func GetDeviceCountForApplicationID(db sqlx.Queryer, applicationID int64, search string) (int, error)

GetDeviceCountForApplicationID returns the total number of devices for the given application id.

func GetDeviceProfileCount

func GetDeviceProfileCount(db sqlx.Queryer) (int, error)

GetDeviceProfileCount returns the total number of device-profiles.

func GetDeviceProfileCountForApplicationID

func GetDeviceProfileCountForApplicationID(db sqlx.Queryer, applicationID int64) (int, error)

GetDeviceProfileCountForApplicationID returns the total number of device-profiles that can be used for the given application id (based on the service-profile of the application).

func GetDeviceProfileCountForOrganizationID

func GetDeviceProfileCountForOrganizationID(db sqlx.Queryer, organizationID int64) (int, error)

GetDeviceProfileCountForOrganizationID returns the total number of device-profiles for the given organization id.

func GetDeviceProfileCountForUser

func GetDeviceProfileCountForUser(db sqlx.Queryer, username string) (int, error)

GetDeviceProfileCountForUser returns the total number of device-profiles for the given username.

func GetGatewayCount

func GetGatewayCount(db sqlx.Queryer, search string) (int, error)

GetGatewayCount returns the total number of gateways.

func GetGatewayCountForOrganizationID

func GetGatewayCountForOrganizationID(db sqlx.Queryer, organizationID int64, search string) (int, error)

GetGatewayCountForOrganizationID returns the total number of gateways given an organization ID.

func GetGatewayCountForUser

func GetGatewayCountForUser(db sqlx.Queryer, username string, search string) (int, error)

GetGatewayCountForUser returns the total number of gateways to which the given user has access.

func GetGatewayProfileCount

func GetGatewayProfileCount(db sqlx.Queryer) (int, error)

GetGatewayProfileCount returns the total number of gateway-profiles.

func GetGatewayProfileCountForNetworkServerID

func GetGatewayProfileCountForNetworkServerID(db sqlx.Queryer, networkServerID int64) (int, error)

GetGatewayProfileCountForNetworkServerID returns the total number of gateway-profiles given a network-server ID.

func GetLastGatewayPingAndRX

func GetLastGatewayPingAndRX(db sqlx.Queryer, mac lorawan.EUI64) (GatewayPing, []GatewayPingRX, error)

GetLastGatewayPingAndRX returns the last gateway ping and RX for the given gateway MAC.

func GetNetworkServerCount

func GetNetworkServerCount(db sqlx.Queryer) (int, error)

GetNetworkServerCount returns the total number of network-servers.

func GetNetworkServerCountForOrganizationID

func GetNetworkServerCountForOrganizationID(db sqlx.Queryer, organizationID int64) (int, error)

GetNetworkServerCountForOrganizationID returns the total number of network-servers accessible for the given organization id. A network-server is accessible for an organization when it is used by one of its service-profiles.

func GetOrganizationCount

func GetOrganizationCount(db sqlx.Queryer, search string) (int, error)

GetOrganizationCount returns the total number of organizations.

func GetOrganizationCountForUser

func GetOrganizationCountForUser(db sqlx.Queryer, username string, search string) (int, error)

GetOrganizationCountForUser returns the number of organizations to which the given user is member of.

func GetOrganizationUserCount

func GetOrganizationUserCount(db sqlx.Queryer, organizationID int64) (int, error)

GetOrganizationUserCount returns the number of users for the given organization.

func GetServiceProfileCount

func GetServiceProfileCount(db sqlx.Queryer) (int, error)

GetServiceProfileCount returns the total number of service-profiles.

func GetServiceProfileCountForOrganizationID

func GetServiceProfileCountForOrganizationID(db sqlx.Queryer, organizationID int64) (int, error)

GetServiceProfileCountForOrganizationID returns the total number of service-profiles for the given organization id.

func GetServiceProfileCountForUser

func GetServiceProfileCountForUser(db sqlx.Queryer, username string) (int, error)

GetServiceProfileCountForUser returns the total number of service-profiles for the given username.

func GetUserCount

func GetUserCount(db sqlx.Queryer, search string) (int32, error)

GetUserCount returns the total number of users.

func LoginUser

func LoginUser(db sqlx.Queryer, username string, password string) (string, error)

LoginUser returns a JWT token for the user matching the given username and password.

func NewRedisPool

func NewRedisPool(redisURL string) *redis.Pool

NewRedisPool returns a new Redis connection pool.

func OpenDatabase

func OpenDatabase(dsn string) (*common.DBLogger, error)

OpenDatabase opens the database and performs a ping to make sure the database is up.

func SetUserSecret

func SetUserSecret(s string)

SetUserSecret sets the JWT secret.

func Transaction

func Transaction(db *common.DBLogger, f func(tx sqlx.Ext) error) error

Transaction wraps the given function in a transaction. In case the given functions returns an error, the transaction will be rolled back.

func UpdateApplication

func UpdateApplication(db sqlx.Execer, item Application) error

UpdateApplication updates the given Application.

func UpdateDevice

func UpdateDevice(db sqlx.Ext, d *Device) error

UpdateDevice updates the given device.

func UpdateDeviceKeys

func UpdateDeviceKeys(db sqlx.Execer, dc *DeviceKeys) error

UpdateDeviceKeys updates the given device-keys.

func UpdateDeviceProfile

func UpdateDeviceProfile(db sqlx.Ext, dp *DeviceProfile) error

UpdateDeviceProfile updates the given device-profile.

func UpdateGateway

func UpdateGateway(db sqlx.Execer, gw *Gateway) error

UpdateGateway updates the given Gateway.

func UpdateGatewayProfile

func UpdateGatewayProfile(db sqlx.Ext, gp *GatewayProfile) error

UpdateGatewayProfile updates the given gateway-profile.

func UpdateIntegration

func UpdateIntegration(db sqlx.Execer, i *Integration) error

UpdateIntegration updates the given Integration.

func UpdateNetworkServer

func UpdateNetworkServer(db sqlx.Execer, n *NetworkServer) error

UpdateNetworkServer updates the given network-server.

func UpdateOrganization

func UpdateOrganization(db sqlx.Execer, org *Organization) error

UpdateOrganization updates the given organization.

func UpdateOrganizationUser

func UpdateOrganizationUser(db sqlx.Execer, organizationID, userID int64, isAdmin bool) error

UpdateOrganizationUser updates the given user of the organization.

func UpdatePassword

func UpdatePassword(db sqlx.Execer, id int64, newpassword string) error

UpdatePassword updates the user with the new password.

func UpdateServiceProfile

func UpdateServiceProfile(db sqlx.Ext, sp *ServiceProfile) error

UpdateServiceProfile updates the given service-profile.

func UpdateUser

func UpdateUser(db sqlx.Execer, item UserUpdate) error

UpdateUser updates the given User.

func ValidateEmail

func ValidateEmail(email string) error

ValidateEmail validates the given e-mail.

func ValidatePassword

func ValidatePassword(password string) error

ValidatePassword validates the given password.

func ValidateUsername

func ValidateUsername(username string) error

ValidateUsername validates the given username.

Types

type Action

type Action int

Action defines the action type.

const (
	Select Action = iota
	Insert
	Update
	Delete
	Scan
)

Possible actions

type Application

type Application struct {
	ID                   int64      `db:"id"`
	Name                 string     `db:"name"`
	Description          string     `db:"description"`
	OrganizationID       int64      `db:"organization_id"`
	ServiceProfileID     string     `db:"service_profile_id"`
	PayloadCodec         codec.Type `db:"payload_codec"`
	PayloadEncoderScript string     `db:"payload_encoder_script"`
	PayloadDecoderScript string     `db:"payload_decoder_script"`
}

Application represents an application.

func GetApplication

func GetApplication(db sqlx.Queryer, id int64) (Application, error)

GetApplication returns the Application for the given id.

func (Application) Validate

func (a Application) Validate() error

Validate validates the data of the Application.

type ApplicationListItem

type ApplicationListItem struct {
	Application
	ServiceProfileName string `db:"service_profile_name"`
}

ApplicationListItem devices the application as a list item.

func GetApplications

func GetApplications(db sqlx.Queryer, limit, offset int, search string) ([]ApplicationListItem, error)

GetApplications returns a slice of applications, sorted by name and respecting the given limit and offset.

func GetApplicationsForOrganizationID

func GetApplicationsForOrganizationID(db sqlx.Queryer, organizationID int64, limit, offset int, search string) ([]ApplicationListItem, error)

GetApplicationsForOrganizationID returns a slice of applications for the given organization.

func GetApplicationsForUser

func GetApplicationsForUser(db sqlx.Queryer, username string, organizationID int64, limit, offset int, search string) ([]ApplicationListItem, error)

GetApplicationsForUser returns a slice of application of which the given user is a member of.

type Device

type Device struct {
	DevEUI              lorawan.EUI64 `db:"dev_eui"`
	CreatedAt           time.Time     `db:"created_at"`
	UpdatedAt           time.Time     `db:"updated_at"`
	LastSeenAt          *time.Time    `db:"last_seen_at"`
	ApplicationID       int64         `db:"application_id"`
	DeviceProfileID     string        `db:"device_profile_id"`
	Name                string        `db:"name"`
	Description         string        `db:"description"`
	SkipFCntCheck       bool          `db:"-"`
	DeviceStatusBattery *int          `db:"device_status_battery"`
	DeviceStatusMargin  *int          `db:"device_status_margin"`
}

Device defines a LoRaWAN device.

func GetDevice

func GetDevice(db sqlx.Queryer, devEUI lorawan.EUI64, forUpdate bool) (Device, error)

GetDevice returns the device matching the given DevEUI. when forUpdate is set to true, then db must be a db transaction.

func (Device) Validate

func (d Device) Validate() error

Validate validates the device data.

type DeviceActivation

type DeviceActivation struct {
	ID        int64             `db:"id"`
	CreatedAt time.Time         `db:"created_at"`
	DevEUI    lorawan.EUI64     `db:"dev_eui"`
	DevAddr   lorawan.DevAddr   `db:"dev_addr"`
	AppSKey   lorawan.AES128Key `db:"app_s_key"`
	NwkSKey   lorawan.AES128Key `db:"nwk_s_key"`
}

DeviceActivation defines the device-activation for a LoRaWAN device.

func GetLastDeviceActivationForDevEUI

func GetLastDeviceActivationForDevEUI(db sqlx.Queryer, devEUI lorawan.EUI64) (DeviceActivation, error)

GetLastDeviceActivationForDevEUI returns the most recent device-activation for the given DevEUI.

type DeviceKeys

type DeviceKeys struct {
	CreatedAt time.Time         `db:"created_at"`
	UpdatedAt time.Time         `db:"updated_at"`
	DevEUI    lorawan.EUI64     `db:"dev_eui"`
	AppKey    lorawan.AES128Key `db:"app_key"`
	JoinNonce int               `db:"join_nonce"`
}

DeviceKeys defines the keys for a LoRaWAN device.

func GetDeviceKeys

func GetDeviceKeys(db sqlx.Queryer, devEUI lorawan.EUI64) (DeviceKeys, error)

GetDeviceKeys returns the device-keys for the given DevEUI.

type DeviceListItem

type DeviceListItem struct {
	Device
	DeviceProfileName string `db:"device_profile_name"`
}

DeviceListItem defines the Device as list item.

func GetDevicesForApplicationID

func GetDevicesForApplicationID(db sqlx.Queryer, applicationID int64, limit, offset int, search string) ([]DeviceListItem, error)

GetDevicesForApplicationID returns a slice of devices for the given application id.

type DeviceProfile

type DeviceProfile struct {
	NetworkServerID int64                 `db:"network_server_id"`
	OrganizationID  int64                 `db:"organization_id"`
	CreatedAt       time.Time             `db:"created_at"`
	UpdatedAt       time.Time             `db:"updated_at"`
	Name            string                `db:"name"`
	DeviceProfile   backend.DeviceProfile `db:"-"`
}

DeviceProfile defines the device-profile.

func GetDeviceProfile

func GetDeviceProfile(db sqlx.Queryer, id string) (DeviceProfile, error)

GetDeviceProfile returns the device-profile matching the given id.

func (DeviceProfile) Validate

func (dp DeviceProfile) Validate() error

Validate validates the device-profile data.

type DeviceProfileMeta

type DeviceProfileMeta struct {
	DeviceProfileID string    `db:"device_profile_id"`
	NetworkServerID int64     `db:"network_server_id"`
	OrganizationID  int64     `db:"organization_id"`
	CreatedAt       time.Time `db:"created_at"`
	UpdatedAt       time.Time `db:"updated_at"`
	Name            string    `db:"name"`
}

DeviceProfileMeta defines the device-profile meta record.

func GetDeviceProfiles

func GetDeviceProfiles(db sqlx.Queryer, limit, offset int) ([]DeviceProfileMeta, error)

GetDeviceProfiles returns a slice of device-profiles.

func GetDeviceProfilesForApplicationID

func GetDeviceProfilesForApplicationID(db sqlx.Queryer, applicationID int64, limit, offset int) ([]DeviceProfileMeta, error)

GetDeviceProfilesForApplicationID returns a slice of device-profiles that can be used for the given application id (based on the service-profile of the application).

func GetDeviceProfilesForOrganizationID

func GetDeviceProfilesForOrganizationID(db sqlx.Queryer, organizationID int64, limit, offset int) ([]DeviceProfileMeta, error)

GetDeviceProfilesForOrganizationID returns a slice of device-profiles for the given organization id.

func GetDeviceProfilesForUser

func GetDeviceProfilesForUser(db sqlx.Queryer, username string, limit, offset int) ([]DeviceProfileMeta, error)

GetDeviceProfilesForUser returns a slice of device-profiles for the given username.

type DeviceQueueMapping

type DeviceQueueMapping struct {
	ID        int64         `db:"id"`
	CreatedAt time.Time     `db:"created_at"`
	Reference string        `db:"reference"`
	DevEUI    lorawan.EUI64 `db:"dev_eui"`
	FCnt      uint32        `db:"f_cnt"`
}

DeviceQueueMapping holds the data mapping a device-queue item to a reference.

func GetDeviceQueueMappingForDevEUIAndFCnt

func GetDeviceQueueMappingForDevEUIAndFCnt(db sqlx.Ext, devEUI lorawan.EUI64, fCnt uint32) (DeviceQueueMapping, error)

GetDeviceQueueMappingForDevEUIAndFCnt returns the device-queue mapping for the given DevEUI and FCnt.

type ExtraChannel

type ExtraChannel struct {
	Modulation       string
	Frequency        int
	Bandwidth        int
	Bitrate          int
	SpreadingFactors []int
}

ExtraChannel defines an extra channel for the gateway-profile.

type GPSPoint

type GPSPoint struct {
	Latitude  float64
	Longitude float64
}

GPSPoint contains a GPS point.

func (*GPSPoint) Scan

func (l *GPSPoint) Scan(src interface{}) error

Scan implements the sql.Scanner interface.

func (GPSPoint) Value

func (l GPSPoint) Value() (driver.Value, error)

Value implements the driver.Valuer interface.

type Gateway

type Gateway struct {
	MAC              lorawan.EUI64 `db:"mac"`
	CreatedAt        time.Time     `db:"created_at"`
	UpdatedAt        time.Time     `db:"updated_at"`
	Name             string        `db:"name"`
	Description      string        `db:"description"`
	OrganizationID   int64         `db:"organization_id"`
	Ping             bool          `db:"ping"`
	LastPingID       *int64        `db:"last_ping_id"`
	LastPingSentAt   *time.Time    `db:"last_ping_sent_at"`
	NetworkServerID  int64         `db:"network_server_id"`
	GatewayProfileID *string       `db:"gateway_profile_id"`
}

Gateway represents a gateway.

func GetGateway

func GetGateway(db sqlx.Queryer, mac lorawan.EUI64, forUpdate bool) (Gateway, error)

GetGateway returns the gateway for the given mac.

func GetGateways

func GetGateways(db sqlx.Queryer, limit, offset int, search string) ([]Gateway, error)

GetGateways returns a slice of gateways sorted by name.

func GetGatewaysForOrganizationID

func GetGatewaysForOrganizationID(db sqlx.Queryer, organizationID int64, limit, offset int, search string) ([]Gateway, error)

GetGatewaysForOrganizationID returns a slice of gateways sorted by name for the given organization ID.

func GetGatewaysForUser

func GetGatewaysForUser(db sqlx.Queryer, username string, limit, offset int, search string) ([]Gateway, error)

GetGatewaysForUser returns a slice of gateways sorted by name to which the given user has access.

func (Gateway) Validate

func (g Gateway) Validate() error

Validate validates the gateway data.

type GatewayPing

type GatewayPing struct {
	ID         int64         `db:"id"`
	CreatedAt  time.Time     `db:"created_at"`
	GatewayMAC lorawan.EUI64 `db:"gateway_mac"`
	Frequency  int           `db:"frequency"`
	DR         int           `db:"dr"`
}

GatewayPing represents a gateway ping.

func GetGatewayPing

func GetGatewayPing(db sqlx.Queryer, id int64) (GatewayPing, error)

GetGatewayPing returns the ping matching the given id.

type GatewayPingRX

type GatewayPingRX struct {
	ID         int64         `db:"id"`
	PingID     int64         `db:"ping_id"`
	CreatedAt  time.Time     `db:"created_at"`
	GatewayMAC lorawan.EUI64 `db:"gateway_mac"`
	ReceivedAt *time.Time    `db:"received_at"`
	RSSI       int           `db:"rssi"`
	LoRaSNR    float64       `db:"lora_snr"`
	Location   GPSPoint      `db:"location"`
	Altitude   float64       `db:"altitude"`
}

GatewayPingRX represents a ping received by one of the gateways.

func GetGatewayPingRXForPingID

func GetGatewayPingRXForPingID(db sqlx.Queryer, pingID int64) ([]GatewayPingRX, error)

GetGatewayPingRXForPingID returns the received gateway pings for the given ping ID.

type GatewayProfile

type GatewayProfile struct {
	GatewayProfileID string         `db:"gateway_profile_id"`
	NetworkServerID  int64          `db:"network_server_id"`
	CreatedAt        time.Time      `db:"created_at"`
	UpdatedAt        time.Time      `db:"updated_at"`
	Name             string         `db:"name"`
	Channels         []int          `db:"-"`
	ExtraChannels    []ExtraChannel `db:"-"`
}

GatewayProfile defines a gateway-profile.

func GetGatewayProfile

func GetGatewayProfile(db sqlx.Queryer, id string) (GatewayProfile, error)

GetGatewayProfile returns the gateway-profile matching the given id.

type GatewayProfileMeta

type GatewayProfileMeta struct {
	GatewayProfileID string    `db:"gateway_profile_id"`
	NetworkServerID  int64     `db:"network_server_id"`
	CreatedAt        time.Time `db:"created_at"`
	UpdatedAt        time.Time `db:"updated_at"`
	Name             string    `db:"name"`
}

GatewayProfileMeta defines the gateway-profile meta record.

func GetGatewayProfiles

func GetGatewayProfiles(db sqlx.Queryer, limit, offset int) ([]GatewayProfileMeta, error)

GetGatewayProfiles returns a slice of gateway-profiles.

func GetGatewayProfilesForNetworkServerID

func GetGatewayProfilesForNetworkServerID(db sqlx.Queryer, networkServerID int64, limit, offset int) ([]GatewayProfileMeta, error)

GetGatewayProfilesForNetworkServerID returns a slice of gateway-profiles for the given network-server ID.

type Integration

type Integration struct {
	ID            int64           `db:"id"`
	CreatedAt     time.Time       `db:"created_at"`
	UpdatedAt     time.Time       `db:"updated_at"`
	ApplicationID int64           `db:"application_id"`
	Kind          string          `db:"kind"`
	Settings      json.RawMessage `db:"settings"`
}

Integration represents an integration.

func GetIntegration

func GetIntegration(db sqlx.Queryer, id int64) (Integration, error)

GetIntegration returns the Integration for the given id.

func GetIntegrationByApplicationID

func GetIntegrationByApplicationID(db sqlx.Queryer, applicationID int64, kind string) (Integration, error)

GetIntegrationByApplicationID returns the Integration for the given application id and kind.

func GetIntegrationsForApplicationID

func GetIntegrationsForApplicationID(db sqlx.Queryer, applicationID int64) ([]Integration, error)

GetIntegrationsForApplicationID returns the integrations for the given application id.

type NetworkServer

type NetworkServer struct {
	ID                          int64     `db:"id"`
	CreatedAt                   time.Time `db:"created_at"`
	UpdatedAt                   time.Time `db:"updated_at"`
	Name                        string    `db:"name"`
	Server                      string    `db:"server"`
	CACert                      string    `db:"ca_cert"`
	TLSCert                     string    `db:"tls_cert"`
	TLSKey                      string    `db:"tls_key"`
	RoutingProfileCACert        string    `db:"routing_profile_ca_cert"`
	RoutingProfileTLSCert       string    `db:"routing_profile_tls_cert"`
	RoutingProfileTLSKey        string    `db:"routing_profile_tls_key"`
	GatewayDiscoveryEnabled     bool      `db:"gateway_discovery_enabled"`
	GatewayDiscoveryInterval    int       `db:"gateway_discovery_interval"`
	GatewayDiscoveryTXFrequency int       `db:"gateway_discovery_tx_frequency"`
	GatewayDiscoveryDR          int       `db:"gateway_discovery_dr"`
}

NetworkServer defines the information to connect to a network-server.

func GetNetworkServer

func GetNetworkServer(db sqlx.Queryer, id int64) (NetworkServer, error)

GetNetworkServer returns the network-server matching the given id.

func GetNetworkServerForDevEUI

func GetNetworkServerForDevEUI(db sqlx.Queryer, devEUI lorawan.EUI64) (NetworkServer, error)

GetNetworkServerForDevEUI returns the network-server for the given DevEUI.

func GetNetworkServerForDeviceProfileID

func GetNetworkServerForDeviceProfileID(db sqlx.Queryer, id string) (NetworkServer, error)

GetNetworkServerForDeviceProfileID returns the network-server for the given device-profile id.

func GetNetworkServerForGatewayMAC

func GetNetworkServerForGatewayMAC(db sqlx.Queryer, mac lorawan.EUI64) (NetworkServer, error)

GetNetworkServerForGatewayMAC returns the network-server for a given gateway mac.

func GetNetworkServerForGatewayProfileID

func GetNetworkServerForGatewayProfileID(db sqlx.Queryer, id string) (NetworkServer, error)

GetNetworkServerForGatewayProfileID returns the network-server for the given gateway-profile id.

func GetNetworkServerForServiceProfileID

func GetNetworkServerForServiceProfileID(db sqlx.Queryer, id string) (NetworkServer, error)

GetNetworkServerForServiceProfileID returns the network-server for the given service-profile id.

func GetNetworkServers

func GetNetworkServers(db sqlx.Queryer, limit, offset int) ([]NetworkServer, error)

GetNetworkServers returns a slice of network-servers.

func GetNetworkServersForOrganizationID

func GetNetworkServersForOrganizationID(db sqlx.Queryer, organizationID int64, limit, offset int) ([]NetworkServer, error)

GetNetworkServersForOrganizationID returns a slice of network-server accessible for the given organization id. A network-server is accessible for an organization when it is used by one of its service-profiles.

func (NetworkServer) Validate

func (ns NetworkServer) Validate() error

Validate validates the network-server data.

type Organization

type Organization struct {
	ID              int64     `db:"id"`
	CreatedAt       time.Time `db:"created_at"`
	UpdatedAt       time.Time `db:"updated_at"`
	Name            string    `db:"name"`
	DisplayName     string    `db:"display_name"`
	CanHaveGateways bool      `db:"can_have_gateways"`
}

Organization represents an organization.

func GetOrganization

func GetOrganization(db sqlx.Queryer, id int64) (Organization, error)

GetOrganization returns the Organization for the given id.

func GetOrganizations

func GetOrganizations(db sqlx.Queryer, limit, offset int, search string) ([]Organization, error)

GetOrganizations returns a slice of organizations, sorted by name and respecting the given limit and offset.

func GetOrganizationsForUser

func GetOrganizationsForUser(db sqlx.Queryer, username string, limit, offset int, search string) ([]Organization, error)

GetOrganizationsForUser returns a slice of organizations to which the given user is member of.

func (Organization) Validate

func (o Organization) Validate() error

Validate validates the data of the Organization.

type OrganizationUser

type OrganizationUser struct {
	UserID    int64     `db:"user_id"`
	Username  string    `db:"username"`
	IsAdmin   bool      `db:"is_admin"`
	CreatedAt time.Time `db:"created_at"`
	UpdatedAt time.Time `db:"updated_at"`
}

OrganizationUser represents an organization user.

func GetOrganizationUser

func GetOrganizationUser(db sqlx.Queryer, organizationID, userID int64) (OrganizationUser, error)

GetOrganizationUser gets the information of the given organization user.

func GetOrganizationUsers

func GetOrganizationUsers(db sqlx.Queryer, organizationID int64, limit, offset int) ([]OrganizationUser, error)

GetOrganizationUsers returns the users for the given organization.

type SearchResult

type SearchResult struct {
	Kind             string         `db:"kind"`
	Score            float64        `db:"score"`
	OrganizationID   *int64         `db:"organization_id"`
	OrganizationName *string        `db:"organization_name"`
	ApplicationID    *int64         `db:"application_id"`
	ApplicationName  *string        `db:"application_name"`
	DeviceDevEUI     *lorawan.EUI64 `db:"device_dev_eui"`
	DeviceName       *string        `db:"device_name"`
	GatewayMAC       *lorawan.EUI64 `db:"gateway_mac"`
	GatewayName      *string        `db:"gateway_name"`
}

SearchResult defines a search result.

func GlobalSearch

func GlobalSearch(db sqlx.Queryer, username string, globalAdmin bool, search string, limit, offset int) ([]SearchResult, error)

GlobalSearch performs a search on organizations, applications, gateways and devices.

type ServiceProfile

type ServiceProfile struct {
	NetworkServerID int64                  `db:"network_server_id"`
	OrganizationID  int64                  `db:"organization_id"`
	CreatedAt       time.Time              `db:"created_at"`
	UpdatedAt       time.Time              `db:"updated_at"`
	Name            string                 `db:"name"`
	ServiceProfile  backend.ServiceProfile `db:"-"`
}

ServiceProfile defines the service-profile.

func GetServiceProfile

func GetServiceProfile(db sqlx.Queryer, id string) (ServiceProfile, error)

GetServiceProfile returns the service-profile matching the given id.

func (ServiceProfile) Validate

func (sp ServiceProfile) Validate() error

Validate validates the service-profile data.

type ServiceProfileMeta

type ServiceProfileMeta struct {
	ServiceProfileID string    `db:"service_profile_id"`
	NetworkServerID  int64     `db:"network_server_id"`
	OrganizationID   int64     `db:"organization_id"`
	CreatedAt        time.Time `db:"created_at"`
	UpdatedAt        time.Time `db:"updated_at"`
	Name             string    `db:"name"`
}

ServiceProfileMeta defines the service-profile meta record.

func GetServiceProfiles

func GetServiceProfiles(db sqlx.Queryer, limit, offset int) ([]ServiceProfileMeta, error)

GetServiceProfiles returns a slice of service-profiles.

func GetServiceProfilesForOrganizationID

func GetServiceProfilesForOrganizationID(db sqlx.Queryer, organizationID int64, limit, offset int) ([]ServiceProfileMeta, error)

GetServiceProfilesForOrganizationID returns a slice of service-profiles for the given organization id.

func GetServiceProfilesForUser

func GetServiceProfilesForUser(db sqlx.Queryer, username string, limit, offset int) ([]ServiceProfileMeta, error)

GetServiceProfilesForUser returns a slice of service-profile for the given username.

type User

type User struct {
	ID           int64     `db:"id"`
	Username     string    `db:"username"`
	IsAdmin      bool      `db:"is_admin"`
	IsActive     bool      `db:"is_active"`
	SessionTTL   int32     `db:"session_ttl"`
	CreatedAt    time.Time `db:"created_at"`
	UpdatedAt    time.Time `db:"updated_at"`
	PasswordHash string    `db:"password_hash"`
	Email        string    `db:"email"`
	Note         string    `db:"note"`
}

User represents a user to external code.

func GetUser

func GetUser(db sqlx.Queryer, id int64) (User, error)

GetUser returns the User for the given id.

func GetUserByUsername

func GetUserByUsername(db sqlx.Queryer, username string) (User, error)

GetUserByUsername returns the User for the given username.

func GetUsers

func GetUsers(db sqlx.Queryer, limit, offset int32, search string) ([]User, error)

GetUsers returns a slice of users, respecting the given limit and offset.

type UserProfile

type UserProfile struct {
	User          UserProfileUser
	Organizations []UserProfileOrganization
}

UserProfile contains the profile of the user.

func GetProfile

func GetProfile(db sqlx.Queryer, id int64) (UserProfile, error)

GetProfile returns the user profile (user, applications and organizations to which the user is linked).

type UserProfileApplication

type UserProfileApplication struct {
	ID        int64     `db:"application_id"`
	Name      string    `db:"application_name"`
	IsAdmin   bool      `db:"is_admin"`
	CreatedAt time.Time `db:"created_at"`
	UpdatedAt time.Time `db:"updated_at"`
}

UserProfileApplication contains the applications to which the user is linked.

type UserProfileOrganization

type UserProfileOrganization struct {
	ID        int64     `db:"organization_id"`
	Name      string    `db:"organization_name"`
	IsAdmin   bool      `db:"is_admin"`
	CreatedAt time.Time `db:"created_at"`
	UpdatedAt time.Time `db:"updated_at"`
}

UserProfileOrganization contains the organizations to which the user is linked.

type UserProfileUser

type UserProfileUser struct {
	ID         int64     `db:"id"`
	Username   string    `db:"username"`
	IsAdmin    bool      `db:"is_admin"`
	IsActive   bool      `db:"is_active"`
	SessionTTL int32     `db:"session_ttl"`
	CreatedAt  time.Time `db:"created_at"`
	UpdatedAt  time.Time `db:"updated_at"`
}

UserProfileUser contains the user information of the profile.

type UserUpdate

type UserUpdate struct {
	ID         int64  `db:"id"`
	Username   string `db:"username"`
	IsAdmin    bool   `db:"is_admin"`
	IsActive   bool   `db:"is_active"`
	SessionTTL int32  `db:"session_ttl"`
	Email      string `db:"email"`
	Note       string `db:"note"`
}

UserUpdate represents the user fields that can be "updated" in the simple case. This excludes id, which identifies the record to be updated.

Jump to

Keyboard shortcuts

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