common

package
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Dec 21, 2020 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ClientData     = "Data"
	ClientMetadata = "Metadata"

	EnvInstanceName = "EDGEX_INSTANCE_NAME"

	Colon      = ":"
	HttpScheme = "http://"
	HttpProto  = "HTTP"

	ConfigStemDevice   = "edgex/devices/"
	ConfigMajorVersion = "1.0/"

	APICallbackRoute        = clients.ApiCallbackRoute
	APIValueDescriptorRoute = clients.ApiValueDescriptorRoute
	APIPingRoute            = clients.ApiPingRoute
	APIVersionRoute         = clients.ApiVersionRoute
	APIMetricsRoute         = clients.ApiMetricsRoute
	APIConfigRoute          = clients.ApiConfigRoute
	APIAllCommandRoute      = clients.ApiDeviceRoute + "/all/{command}"
	APIIdCommandRoute       = clients.ApiDeviceRoute + "/{id}/{command}"
	APINameCommandRoute     = clients.ApiDeviceRoute + "/name/{name}/{command}"
	APIDiscoveryRoute       = clients.ApiBase + "/discovery"
	APITransformRoute       = clients.ApiBase + "/debug/transformData/{transformData}"

	APIV2DeviceCallbackRoute    = v2.ApiBase + "/callback/device"
	APIV2DeviceCallbackIdRoute  = v2.ApiBase + "/callback/device/id/{id}"
	APIV2ProfileCallbackRoute   = v2.ApiBase + "/callback/profile"
	APIV2ProfileCallbackIdRoute = v2.ApiBase + "/callback/profile/id/{id}"
	APIV2WatcherCallbackRoute   = v2.ApiBase + "/callback/watcher"
	APIV2WatcherCallbackIdRoute = v2.ApiBase + "/callback/watcher/id/{id}"
	APIV2DiscoveryRoute         = v2.ApiBase + "/discovery"
	APIV2IdCommandRoute         = v2.ApiBase + "/device/{id}/{command}"
	APIV2NameCommandRoute       = v2.ApiBase + "/device/name/{name}/{command}"

	IdVar        string = "id"
	NameVar      string = "name"
	CommandVar   string = "command"
	GetCmdMethod string = "get"
	SetCmdMethod string = "set"

	DeviceResourceReadOnly  string = "R"
	DeviceResourceWriteOnly string = "W"

	CorrelationHeader = clients.CorrelationHeader
	URLRawQuery       = "urlRawQuery"
	SDKReservedPrefix = "ds-"
)

Variables

View Source 
var SDKVersion string = "0.0.0"

SDKVersion indicates the version of the SDK - will be overwritten by build

View Source 
var ServiceVersion string = "0.0.0"

ServiceVersion indicates the version of the device service itself, not the SDK - will be overwritten by build

Functions

func BuildAddr 

func BuildAddr(host string, port string) string

func CommandValueToReading 

func CommandValueToReading(cv *dsModels.CommandValue, devName string, mediaType string, encoding string) *contract.Reading

func CompareCoreCommands 

func CompareCoreCommands(a []contract.Command, b []contract.Command) bool

func CompareDeviceCommands 

func CompareDeviceCommands(a []contract.ProfileResource, b []contract.ProfileResource) bool

func CompareDeviceProfiles 

func CompareDeviceProfiles(a contract.DeviceProfile, b contract.DeviceProfile) bool

func CompareDeviceResources 

func CompareDeviceResources(a []contract.DeviceResource, b []contract.DeviceResource) bool

func CompareDeviceServices 

func CompareDeviceServices(a contract.DeviceService, b contract.DeviceService) bool

func CompareDevices 

func CompareDevices(a contract.Device, b contract.Device) bool

func CompareResourceOperations 

func CompareResourceOperations(a []contract.ResourceOperation, b []contract.ResourceOperation) bool

func CompareServices 

func CompareServices(a contract.DeviceService, b contract.DeviceService) bool

func CompareStrStrMap 

func CompareStrStrMap(a map[string]string, b map[string]string) bool

func CompareStrings 

func CompareStrings(a []string, b []string) bool

func FilterQueryParams added in v1.1.1 

func FilterQueryParams(queryParams string, lc logger.LoggingClient) url.Values

func GetUniqueOrigin added in v1.1.0 

func GetUniqueOrigin() int64

func SendEvent 

func SendEvent(event *dsModels.Event, lc logger.LoggingClient, ec coredata.EventClient)

func UpdateLastConnected added in v1.2.0 

func UpdateLastConnected(name string, configuration *ConfigurationStruct, lc logger.LoggingClient, dc metadata.DeviceClient)

func VerifyIdFormat 

func VerifyIdFormat(id string, drName string) error

Types

type AppError 

type AppError interface {
	Error() error
	Message() string
	Code() int
}

func NewBadRequestError 

func NewBadRequestError(msg string, err error) AppError

func NewLockedError 

func NewLockedError(msg string, err error) AppError

func NewNotFoundError 

func NewNotFoundError(msg string, err error) AppError

func NewServerError 

func NewServerError(msg string, err error) AppError

type ConfigurationStruct added in v1.2.0 

type ConfigurationStruct struct {
	// WritableInfo contains configuration settings that can be changed in the Registry .
	Writable WritableInfo
	// Clients is a map of services used by a DS.
	Clients map[string]bootstrapConfig.ClientInfo
	// Logging contains logging-specific configuration settings.
	Logging bootstrapConfig.LoggingInfo
	// Registry contains registry-specific settings.
	Registry bootstrapConfig.RegistryInfo
	// Service contains DeviceService-specific settings.
	Service ServiceInfo
	// Device contains device-specific configuration settings.
	Device DeviceInfo
	// DeviceList is the list of pre-define Devices
	DeviceList []DeviceConfig `consul:"-"`
	// Driver is a string map contains customized configuration for the protocol driver implemented based on Device SDK
	Driver map[string]string
}

ConfigurationStruct contains the configuration properties for the device service.

func (*ConfigurationStruct) EmptyWritablePtr added in v1.2.0 

func (c *ConfigurationStruct) EmptyWritablePtr() interface{}

EmptyWritablePtr returns a pointer to a service-specific empty WritableInfo struct. It is used by the bootstrap to provide the appropriate structure to registry.Client's WatchForChanges().

func (*ConfigurationStruct) GetBootstrap added in v1.2.0 

func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfiguration

GetBootstrap returns the configuration elements required by the bootstrap. Currently, a copy of the configuration data is returned. This is intended to be temporary -- since ConfigurationStruct drives the configuration.toml's structure -- until we can make backwards-breaking configuration.toml changes (which would consolidate these fields into an bootstrapConfig.BootstrapConfiguration struct contained within ConfigurationStruct).

func (*ConfigurationStruct) GetLogLevel added in v1.2.0 

func (c *ConfigurationStruct) GetLogLevel() string

GetLogLevel returns the current ConfigurationStruct's log level.

func (*ConfigurationStruct) GetRegistryInfo added in v1.2.0 

func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo

GetRegistryInfo gets the config.RegistryInfo field from the ConfigurationStruct.

func (*ConfigurationStruct) UpdateFromRaw added in v1.2.0 

func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool

UpdateFromRaw converts configuration received from the registry to a service-specific configuration struct which is then used to overwrite the service's existing configuration struct.

func (*ConfigurationStruct) UpdateWritableFromRaw added in v1.2.0 

func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool

UpdateWritableFromRaw converts configuration received from the registry to a service-specific WritableInfo struct which is then used to overwrite the service's existing configuration's WritableInfo struct.

type DeviceConfig 

type DeviceConfig struct {
	// Name is the Device name
	Name string
	// Profile is the profile name of the Device
	Profile string
	// Description describes the device
	Description string
	// Other labels applied to the device to help with searching
	Labels []string
	// Protocols for the device - stores protocol properties
	Protocols map[string]dsModels.ProtocolProperties
	// AutoEvent supports auto-generated events sourced from a device service
	AutoEvents []dsModels.AutoEvent
}

DeviceConfig is the definition of Devices which will be auto created when the Device Service starts up

type DeviceInfo 

type DeviceInfo struct {
	// DataTransform specifies whether or not the DS perform transformations
	// specified by valuedescriptor on a actuation or query command.
	DataTransform bool
	// InitCmd specifies a device resource command which is automatically
	// generated whenever a new device is added to the DS.
	InitCmd string
	// InitCmdArgs specify arguments to be used when building the InitCmd.
	InitCmdArgs string
	// MaxCmdOps defines the maximum number of resource operations that
	// can be sent to a Driver in a single command.
	MaxCmdOps int
	// MaxCmdValueLen is the maximum string length of a command parameter or
	// result (including the valuedescriptor name) that can be returned
	// by a Driver.
	MaxCmdValueLen int
	// InitCmd specifies a device resource command which is automatically
	// generated whenever a new device is removed from the DS.
	RemoveCmd string
	// RemoveCmdArgs specify arguments to be used when building the RemoveCmd.
	RemoveCmdArgs string
	// ProfilesDir specifies a directory which contains deviceprofile
	// files which should be imported on startup.
	ProfilesDir string
	// UpdateLastConnected specifies whether to update device's LastConnected
	// timestamp in metadata.
	UpdateLastConnected bool

	Discovery DiscoveryInfo
}

DeviceInfo is a struct which contains device specific configuration settings.

type DiscoveryInfo added in v1.2.0 

type DiscoveryInfo struct {
	// Enabled controls whether or not device discovery is enabled.
	Enabled bool
	// Interval indicates how often the discovery process will be triggered.
	// It represents as a duration string.
	Interval string
}

DiscoveryInfo is a struct which contains configuration of device auto discovery.

type ServiceInfo 

type ServiceInfo struct {
	// BootTimeout indicates, in milliseconds, how long the service will retry connecting to upstream dependencies
	// before giving up. Default is 30,000.
	BootTimeout int
	// Health check interval
	CheckInterval string
	// Host is the hostname or IP address of the service.
	Host string
	// Port is the HTTP port of the service.
	Port int
	// ServerBindAddr specifies an IP address or hostname
	// for ListenAndServe to bind to, such as 0.0.0.0
	ServerBindAddr string
	// The protocol that should be used to call this service
	Protocol string
	// StartupMsg specifies a string to log once service
	// initialization and startup is completed.
	StartupMsg string
	// MaxResultCount specifies the maximum size list supported
	// in response to REST calls to other services.
	MaxResultCount int
	// Timeout (in milliseconds) specifies both
	// - timeout for processing REST calls and
	// - interval time the DS will wait between each retry call.
	Timeout int
	// Labels are properties applied to the device service to help with searching
	Labels []string
	// EnableAsyncReadings to determine whether the Device Service would deal with the asynchronous readings
	EnableAsyncReadings bool
	// AsyncBufferSize defines the size of asynchronous channel
	AsyncBufferSize int
}

ServiceInfo is a struct which contains service related configuration settings.

func (ServiceInfo) GetBootstrapServiceInfo added in v1.2.0 

func (s ServiceInfo) GetBootstrapServiceInfo() bootstrapConfig.ServiceInfo

type Telemetry 

type Telemetry struct {
	Alloc,
	TotalAlloc,
	Sys,
	Mallocs,
	Frees,
	LiveObjects uint64
}

Telemetry provides metrics (on a given device service) to system management.

type WritableInfo 

type WritableInfo struct {
	// Level is the logging level of writing log message
	LogLevel string
}

WritableInfo is a struct which contains configuration settings that can be changed in the Registry .

Source Files

View all Source files

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.