model

package

Go to main page

Versions in this module

v0

v0.0.8

Jul 10, 2026

Changes in this version

+ type AICopilotSettings struct

+ APIKey string

+ APIKeyHeader string

+ AuthType string

+ AzureAPIVersion string

+ BaseURL string

+ CustomHeaders map[string]string

+ DeploymentMode string

+ EnableCloud bool

+ GrpcEndpoint string

+ Model string

+ Password string

+ Provider string

+ TasksLimit int

+ TokensLimit int

+ Username string

+ func DefaultAICopilotSettings() AICopilotSettings

+ func (s AICopilotSettings) ProviderLabel() string

+ func (s AICopilotSettings) RuntimeMode() string

+ func (s AICopilotSettings) ToPublic() AICopilotSettingsPublic

+ type AICopilotSettingsPublic struct

+ APIKey string

+ APIKeySet bool

+ Password string

+ PasswordSet bool

type Device

+ PointsCount int

+ func (d Device) WithPointsSummary() Device

v0.0.7

Jul 6, 2026

Changes in this version

+ const EdgeErrorTypeDispatch

+ const EdgeErrorTypeExecution

+ const EdgeErrorTypeFormula

+ const EdgeErrorTypeOther

+ const EdgeErrorTypeTimeout

+ const LogCategoryEdgeCompute

+ const LogCategoryNorthbound

+ const LogCategorySouthbound

+ const LogCategorySystem

+ func CalculateQualityScore(m *ChannelMetrics) int

+ func GenerateShortID(length int) string

+ func InferVirtualShadowChannel(points []VirtualShadowPointDef) string

+ func IsEndpointLikeDeviceID(id string) bool

+ func IsNorthboundVirtualDevice(deviceID string, virtualDevices OpcUaDeviceMap) bool

+ func NormalizeOpcUaDeviceID(dev *Device)

type ChannelMetrics

+ CircuitBreakerOpen int

+ LinkUp bool

+ SLAWarnings []map[string]any

+ ScanDriftAvgMs float64

+ ScanDriftAvgMsWindow float64

+ ScanLagP95Ms float64

+ ScanMissDeadlineTotal uint64

+ ScanMissDeadlineWindow uint64

+ ScanSLA *ChannelScanSLA

+ type ChannelScanSLA struct

+ CircuitBreakerOpen int

+ SLAWarnings []map[string]any

+ ScanDriftAvgMs float64

+ ScanDriftAvgMsWindow float64

+ ScanLagP95Ms float64

+ ScanMissDeadlineTotal uint64

+ ScanMissDeadlineWindow uint64

type DevicePublishConfig

+ func LookupNorthboundPublishConfig(deviceID string, devices, virtualDevices OpcUaDeviceMap) (DevicePublishConfig, bool)

+ type EdgeFailureRecord struct

+ ActionIndex int

+ ActionType string

+ Category string

+ ChannelID string

+ Condition string

+ Context map[string]any

+ DeviceID string

+ Error string

+ ErrorType string

+ ID string

+ Phase string

+ RuleID string

+ RuleName string

+ Timestamp time.Time

+ TriggerValue any

type EdgeOSMQTTConfig

+ VirtualDevices OpcUaDeviceMap

type EdgeOSNATSConfig

+ VirtualDevices OpcUaDeviceMap

+ type EdgeRuleEvent struct

+ Actions []EdgeRuleEventAction

+ Condition string

+ DurationMs int64

+ EndedAt time.Time

+ ErrorMessage string

+ ID string

+ OutputValue any

+ Phases []EdgeRuleEventPhase

+ RuleID string

+ RuleName string

+ StartedAt time.Time

+ Status string

+ TriggerSource Value

+ TriggerValue any

+ Triggered bool

+ type EdgeRuleEventAction struct

+ DurationMs int64

+ EndedAt time.Time

+ Error string

+ Index int

+ StartedAt time.Time

+ Status string

+ Type string

+ type EdgeRuleEventPhase struct

+ Detail map[string]any

+ DurationMs int64

+ EndedAt time.Time

+ Error string

+ Phase string

+ StartedAt time.Time

type HTTPConfig

+ VirtualDevices OpcUaDeviceMap

type MQTTConfig

+ VirtualDevices OpcUaDeviceMap

type OPCUAConfig

+ VirtualDevices OpcUaDeviceMap

type RuleMinuteSnapshot

+ Category string

+ ChannelID string

+ DeviceID string

+ ErrorType string

type RuleRuntimeState

+ ActionFailureCount int64

+ ActionSuccessCount int64

+ ExecutionActionIndex int

+ ExecutionPhase string

+ FailureCount int64

+ LastWindowEval time.Time

+ SuccessCount int64

type SourceDeviceSummary

+ Online bool

+ State int

type SparkplugBConfig

+ VirtualDevices OpcUaDeviceMap

v0.0.6

Jun 26, 2026

Changes in this version

+ const ScanClassFast

+ const ScanClassNormal

+ const ScanClassSlow

+ var BuildTime = "unknown"

+ var CommitID = "unknown"

+ var Version = "dev"

+ func BuildVirtualShadowFormulas(points []VirtualShadowPointDef) (map[string]string, error)

+ func EnsureChannelID(ch *Channel) error

+ func EnsureDeviceID(dev *Device) error

+ func EnsureEdgeRuleID(rule *EdgeRule) error

+ func EnsurePointID(p *Point) error

+ func GroupPointsByScanClass(points []Point) map[string][]Point

+ func MakePointRef(channelID, deviceID, pointID string) string

+ func MatchSearchQuery(haystack, query string) bool

+ func MergeOpcUaDeviceConfig(channelConfig, deviceConfig map[string]any) map[string]any

+ func NormalizeOpcUaChannelConfig(config map[string]any)

+ func NormalizeScanClass(scanClass string) string

+ func NormalizeVirtualShadowDevice(cfg *VirtualShadowDeviceConfig) error

+ func ResolveOpcUaEndpoint(channelConfig, deviceConfig map[string]any) string

+ func ScanClassInterval(scanClass string, deviceInterval Duration) time.Duration

+ func SetGlobalMetricsCollector(mc *MetricsCollector)

+ type BackupInfo struct

+ BackupPath string

+ BackupTime time.Time

+ Checksum string

+ FileSizeBytes int64

+ OriginalPath string

+ Version string

+ type BatchReadSnapshot struct

+ CurrentGap int

+ FillEfficiency float64

+ MaxGap int

+ MergedRequests uint64

+ SavedRequests uint64

+ type Channel struct

+ Config map[string]any

+ Devices []Device

+ Enable bool

+ ID string

+ Name string

+ NodeRuntime *NodeRuntime

+ Protocol string

+ StopChan chan struct{}

+ type ChannelMetrics struct

+ AvgRtt float64

+ ConnectionSeconds int64

+ CrcError int64

+ CrcErrorRate float64

+ ExceptionCode int64

+ FailureCount int64

+ LastDisconnectTime time.Time

+ LocalAddr string

+ MaxRtt float64

+ MinRtt float64

+ PacketLoss float64

+ Protocol string

+ QualityScore int

+ RecentErrors []ErrorRecord

+ ReconnectCount int64

+ RemoteAddr string

+ RetryRate float64

+ SuccessCount int64

+ SuccessRate float64

+ TimeoutCount int64

+ Timestamp time.Time

+ TotalRequests int64

+ Trend []TrendPoint

+ type ConnectivityReport struct

+ Details []ConnectivityResult

+ Success bool

+ type ConnectivityResult struct

+ Message string

+ Success bool

+ Target string

+ type ConnectivityTarget struct

+ Target string

+ Timeout int

+ Type string

+ type ConsistencyCheckResult struct

+ DiffPoints []ShadowDiffPoint

+ DiffSource string

+ Pass bool

+ RepairSuggest string

+ type CycleRecord struct

+ Success bool

+ Timestamp time.Time

+ type DataCacheConfig struct

+ Enable bool

+ FlushInterval string

+ MaxCount int

+ type Device struct

+ Config map[string]any

+ DegradeOnFailure *bool

+ DeviceFile string

+ Enable bool

+ ID string

+ Interval Duration

+ Name string

+ NodeRuntime *NodeRuntime

+ Points []Point

+ QualityScore int

+ State int

+ StopChan chan struct{}

+ Storage DeviceStorage

+ func NormalizeDevicesForSave(devices []Device) ([]Device, error)

+ type DeviceCommunicationProfile struct

+ AbnormalPointCount int

+ AvgResponseTime time.Duration

+ BatchSize int

+ ChannelID string

+ CollectionSuccessRate float64

+ ConsecutiveFailures int

+ CurrentGap int

+ CurrentMTU int

+ DeviceID string

+ EWMARTT int64

+ ErrorRate float64

+ GapFillStrategy int

+ HeartbeatInterval int

+ LastActivity time.Time

+ LastUpdated time.Time

+ MaxGap int

+ MaxMTU int

+ MaxResponseTime time.Duration

+ MinMTU int

+ OptimalInterval time.Duration

+ OptimalTimeout time.Duration

+ ProtocolParams map[string]interface{}

+ ProtocolType string

+ RTTSampleWindow int

+ RTTSamples []int64

+ RetryCount int

+ SlaveID interface{}

+ StabilityScore float64

+ type DeviceMetrics struct

+ AbnormalPoints int

+ AvgCollectTime float64

+ CommunicationProfile map[string]interface{}

+ ConsecutiveFailures int

+ Degraded bool

+ HealthScore int

+ InvalidValues int

+ LastCollectTime time.Time

+ NullValueRate float64

+ PointSuccessRate float64

+ Recovering bool

+ State int

+ Timestamp time.Time

+ type DevicePublishConfig struct

+ Enable bool

+ Interval Duration

+ Strategy string

+ type DeviceStorage struct

+ Enable bool

+ Interval int

+ MaxRecords int

+ Strategy string

+ type DriverConfig struct

+ ChannelID string

+ Config map[string]any

+ Protocol string

+ type Duration time.Duration

+ func (d *Duration) UnmarshalJSON(b []byte) error

+ func (d *Duration) UnmarshalText(text []byte) error

+ func (d Duration) MarshalJSON() ([]byte, error)

+ func (d Duration) MarshalText() ([]byte, error)

+ type EdgeOSMQTTConfig struct

+ AutoReconnect bool

+ Broker string

+ CleanSession bool

+ ClientID string

+ ConnectTimeout int

+ Devices map[string]DevicePublishConfig

+ Enable bool

+ HeartbeatInterval string

+ ID string

+ KeepAlive int

+ MaxReconnectInterval int

+ Name string

+ NodeID string

+ Password string

+ QoS byte

+ Retain bool

+ Username string

+ type EdgeOSNATSConfig struct

+ ClientID string

+ ConnectTimeout int

+ Devices map[string]DevicePublishConfig

+ Enable bool

+ HeartbeatInterval string

+ ID string

+ JetStreamEnabled bool

+ MaxPingsOutstanding int

+ MaxReconnects int

+ Name string

+ NodeID string

+ Password string

+ PingInterval int

+ ReconnectWait int

+ Token string

+ URL string

+ Username string

+ type EdgeRule struct

+ Actions []RuleAction

+ CheckInterval string

+ Condition string

+ Enable bool

+ Expression string

+ ID string

+ Name string

+ Priority int

+ Source RuleSource

+ Sources []RuleSource

+ State *StateConfig

+ TriggerLogic string

+ TriggerMode string

+ Type string

+ Window *WindowConfig

+ func NormalizeEdgeRulesForSave(rules []EdgeRule) ([]EdgeRule, error)

+ type ErrorRecord struct

+ Code string

+ Message string

+ Time time.Time

+ Type string

+ type FailedAction struct

+ Action RuleAction

+ Env map[string]any

+ ID string

+ LastError string

+ RetryCount int

+ RuleID string

+ Timestamp time.Time

+ Value Value

+ type GatewayConfig struct

+ Enabled bool

+ Gateway string

+ Interface string

+ Metric int

+ Scope string

+ type HAConfig struct

+ HeartbeatType string

+ Interval int

+ Retries int

+ Role string

+ Timeout int

+ type HTTPConfig struct

+ APIKeyName string

+ APIKeyValue string

+ AuthType string

+ Cache DataCacheConfig

+ DataEndpoint string

+ DeviceEventEndpoint string

+ Devices map[string]bool

+ Enable bool

+ Headers map[string]string

+ ID string

+ Method string

+ Name string

+ Password string

+ Token string

+ URL string

+ Username string

+ type HostnameConfig struct

+ EnableBare bool

+ EnableMDNS bool

+ HTTPPort int

+ HTTPSPort int

+ Interfaces []string

+ Name string

+ type IPConfig struct

+ Address string

+ Enabled bool

+ Prefix int

+ Source string

+ Version string

+ type InstallConfig struct

+ DeviceSerial string

+ GatewayLocation string

+ GatewayName string

+ MigrateConfig bool

+ MigrateFromDB string

+ MigrateRuntime bool

+ Password string

+ Port int

+ StoragePath string

+ Username string

+ type InstallResult struct

+ Error string

+ Message string

+ Success bool

+ type InstallStatus struct

+ CurrentStep int

+ IsInstalled bool

+ LogMessages []string

+ Progress int

+ Status string

+ TotalSteps int

+ type LDAPConfig struct

+ Attributes string

+ BaseDN string

+ BindDN string

+ BindPassword string

+ Enabled bool

+ Port int

+ Server string

+ SkipVerify bool

+ UseSSL bool

+ UserFilter string

+ type MQTTConfig struct

+ Broker string

+ Cache DataCacheConfig

+ ClientID string

+ DeviceLifecycleTopic string

+ DeviceStatusTopic string

+ Devices map[string]DevicePublishConfig

+ Enable bool

+ ID string

+ IgnoreOfflineData bool

+ LwtPayload string

+ LwtTopic string

+ Name string

+ OfflinePayload string

+ OnlinePayload string

+ Password string

+ StatusTopic string

+ SubscribeTopic string

+ Topic string

+ Username string

+ WriteResponseTopic string

+ type MTUNegotiationRecord struct

+ AttemptValue int

+ ResponseTime int64

+ RetryCount int

+ Success bool

+ Timestamp time.Time

+ type ManualTime struct

+ Datetime string

+ SyncRTC bool

+ Timezone string

+ type MetricsCollector struct

+ func GetGlobalMetricsCollector() *MetricsCollector

+ func NewMetricsCollector() *MetricsCollector

+ func (mc *MetricsCollector) GetChannelMetrics(channelID string) *ChannelMetrics

+ func (mc *MetricsCollector) GetDeviceMetrics(deviceID string) *DeviceMetrics

+ func (mc *MetricsCollector) GetPointMetrics(pointID string) *PointMetrics

+ func (mc *MetricsCollector) RecordConnectionStart(channelID string)

+ func (mc *MetricsCollector) RecordCycle(channelID string, success bool)

+ func (mc *MetricsCollector) RecordError(channelID string, errType, code, message string)

+ func (mc *MetricsCollector) RecordPointDebug(channelID, pointID string, raw []byte, parsed any, quality string)

+ func (mc *MetricsCollector) RecordReconnect(channelID string)

+ func (mc *MetricsCollector) RecordRequest(channelID string, success bool, duration time.Duration, errorType string)

+ func (mc *MetricsCollector) UpdateDeviceMetrics(deviceID string, update func(*DeviceMetrics))

+ type NTPConfig struct

+ Enabled bool

+ Interval int

+ Servers []string

+ type NetworkInterface struct

+ Enabled bool

+ Gateways []GatewayConfig

+ IPConfigs []IPConfig

+ InterfaceMetric int

+ MAC string

+ Name string

+ Status string

+ type NodeRuntime struct

+ FailCount int

+ LastFailTime time.Time

+ NextRetryTime time.Time

+ State int

+ SuccessCount int

+ type NorthboundConfig struct

+ EdgeOSMQTT []EdgeOSMQTTConfig

+ EdgeOSNATS []EdgeOSNATSConfig

+ HTTP []HTTPConfig

+ MQTT []MQTTConfig

+ OPCUA []OPCUAConfig

+ SparkplugB []SparkplugBConfig

+ Status map[string]int

+ func NormalizeNorthboundForSave(cfg NorthboundConfig) (NorthboundConfig, error)

+ func SanitizeNorthboundForClient(cfg NorthboundConfig) NorthboundConfig

+ type OPCUAConfig struct

+ AuthMethods []string

+ CertFile string

+ Devices OpcUaDeviceMap

+ Enable bool

+ Endpoint string

+ HasServerCert bool

+ HasServerKey bool

+ ID string

+ KeyFile string

+ Name string

+ Port int

+ SecurityMode string

+ SecurityPolicy string

+ ServerCertPEM string

+ ServerKeyPEM string

+ TrustedCertPath string

+ TrustedCertsPEM []string

+ Users map[string]string

+ func MergeOPCUAConfig(existing, incoming OPCUAConfig) OPCUAConfig

+ func SanitizeOPCUAForClient(cfg OPCUAConfig) OPCUAConfig

+ type OpcUaDeviceMap map[string]DevicePublishConfig

+ func (m *OpcUaDeviceMap) UnmarshalJSON(data []byte) error

+ func (m *OpcUaDeviceMap) UnmarshalYAML(unmarshal func(any) error) error

+ func (m OpcUaDeviceMap) AllowsDevice(deviceID string) bool

+ type PathCheckResult struct

+ Accessible bool

+ Error string

+ Path string

+ type Point struct

+ Address string

+ DataType string

+ DeviceID string

+ Format string

+ FunctionCode byte

+ Group string

+ ID string

+ Name string

+ Offset float64

+ ReadFormula string

+ ReadWrite string

+ RegisterType RegisterType

+ ReportMode string

+ Scale float64

+ ScanClass string

+ Threshold *ThresholdConfig

+ Unit string

+ WordOrder string

+ WriteFormula string

+ type PointData struct

+ Address string

+ CollectedAt time.Time

+ DataType string

+ FunctionCode byte

+ ID string

+ Name string

+ Quality string

+ ReadWrite string

+ RegisterType string

+ SlaveID uint8

+ Timestamp time.Time

+ Unit string

+ UpdatedAt time.Time

+ Value any

+ type PointMetrics struct

+ ByteOrder string

+ DataType string

+ ErrorCount int64

+ LastError string

+ LastErrorTime time.Time

+ LastUpdateTime time.Time

+ ParsedValue any

+ PointID string

+ Quality string

+ RawValue []byte

+ UpdateCount int64

+ type PointSourceRef struct

+ ChannelID string

+ ChannelName string

+ DeviceID string

+ DeviceName string

+ PointID string

+ PointName string

+ Ref string

+ type PortCheckResult struct

+ Available bool

+ Error string

+ Port int

+ type ProtocolConfig struct

+ HeartbeatInterval int

+ type RTTNode struct

+ AckStatus bool

+ RTT int64

+ RecvTS time.Time

+ SendTS time.Time

+ SeqNo uint16

+ type RegisterType int

+ const RegCoil

+ const RegCustom

+ const RegDiscreteInput

+ const RegHolding

+ const RegInput

+ func ParseRegisterType(s string) RegisterType

+ func (r *RegisterType) UnmarshalJSON(data []byte) error

+ func (r *RegisterType) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (r RegisterType) Code() byte

+ func (r RegisterType) FunctionCode() byte

+ func (r RegisterType) MarshalJSON() ([]byte, error)

+ func (r RegisterType) MarshalYAML() (interface{}, error)

+ func (r RegisterType) ShortString() string

+ func (r RegisterType) String() string

+ type RequestRecord struct

+ Duration time.Duration

+ ErrorType string

+ Success bool

+ Timestamp time.Time

+ type RuleAction struct

+ Config map[string]any

+ Type string

+ type RuleMinuteSnapshot struct

+ ErrorMessage string

+ LastTrigger time.Time

+ LastValue any

+ Minute string

+ RuleID string

+ RuleName string

+ Status string

+ TriggerCount int64

+ UpdatedAt time.Time

+ type RuleRuntimeState struct

+ ActionLastRuns map[int]time.Time

+ ConditionCount int

+ ConditionStart time.Time

+ CurrentStatus string

+ Enable bool

+ ErrorMessage string

+ LastCheckTime time.Time

+ LastTrigger time.Time

+ LastValue any

+ RuleID string

+ RuleName string

+ TriggerCount int64

+ type RuleSource struct

+ Alias string

+ ChannelID string

+ DeviceID string

+ PointID string

+ PointName string

+ type ServerConfig struct

+ LogLevel string

+ Port int

+ type ShadowDevice struct

+ ChannelID string

+ CommunicationProfile *DeviceCommunicationProfile

+ PhysicalDeviceID string

+ Points map[string]ShadowPoint

+ ShadowDeviceID string

+ UpdatedAt time.Time

+ Version uint64

+ type ShadowDiffPoint struct

+ Actual any

+ Expected any

+ Field string

+ PointID string

+ type ShadowIngressMessage struct

+ ChannelID string

+ DeviceID string

+ MessageID string

+ Meta ShadowIngressMeta

+ Points []ShadowIngressPoint

+ QoS int

+ Timestamp time.Time

+ type ShadowIngressMeta struct

+ Sequence uint64

+ Source string

+ type ShadowIngressPoint struct

+ CollectedAt time.Time

+ Degraded bool

+ PointID string

+ Quality string

+ SamplePeriodMs int

+ Unit string

+ Value any

+ type ShadowPoint struct

+ CollectedAt time.Time

+ Degraded bool

+ Quality string

+ RW string

+ SamplePeriodMs int

+ Timestamp time.Time

+ Unit string

+ UpdatedAt time.Time

+ Value any

+ Version uint64

+ type ShadowWriteRequest struct

+ PointID string

+ QoS int

+ ShadowDeviceID string

+ Timestamp time.Time

+ Value any

+ type ShadowWriteResponse struct

+ Error string

+ Success bool

+ Timestamp time.Time

+ Version uint64

+ type SourceDeviceSummary struct

+ ChannelID string

+ ChannelName string

+ DeviceID string

+ DeviceName string

+ Key string

+ PointCount int

+ type SouthboundManager interface

+ GetChannelDevices func(channelID string) []Device

+ GetChannels func() []Channel

+ GetDevice func(channelID, deviceID string) *Device

+ GetDevicePoints func(channelID, deviceID string) ([]PointData, error)

+ GetShadowPoint func(channelID, deviceID, pointID string) (*ShadowPoint, error)

+ WritePoint func(channelID, deviceID, pointID string, value any) error

+ type SparkplugBConfig struct

+ Broker string

+ CACert string

+ CacheDiskSize int

+ CacheMemSize int

+ CacheResendInt int

+ ClientCert string

+ ClientID string

+ ClientKey string

+ Devices map[string]bool

+ Enable bool

+ EnableAlias bool

+ GroupID string

+ GroupPath bool

+ ID string

+ KeyPassword string

+ Name string

+ NodeID string

+ OfflineCache bool

+ Password string

+ Port int

+ SSL bool

+ Username string

+ type StateConfig struct

+ Count int

+ Duration string

+ type StaticRoute struct

+ Destination string

+ Enabled bool

+ Gateway string

+ Interface string

+ Metric int

+ Prefix int

+ type SyncConfig struct

+ Enabled bool

+ Port int

+ type SystemConfig struct

+ ConnectivityTargets []ConnectivityTarget

+ HA HAConfig

+ Hostname HostnameConfig

+ LDAP LDAPConfig

+ Location string

+ Network []NetworkInterface

+ Routes []StaticRoute

+ Sync SyncConfig

+ Time TimeConfig

+ type ThresholdConfig struct

+ High float64

+ Low float64

+ type TimeConfig struct

+ Manual ManualTime

+ Mode string

+ NTP NTPConfig

+ type TrendPoint struct

+ Rate float64

+ Time time.Time

+ type UserConfig struct

+ Password string

+ Role string

+ Username string

+ type Value struct

+ CachedAt time.Time

+ ChannelID string

+ DeviceID string

+ Meta map[string]any

+ PointID string

+ Quality string

+ TS time.Time

+ Value any

+ type VirtualDevice struct

+ ChannelID string

+ Dependencies []string

+ FormulaPoints map[string]string

+ Points map[string]ShadowPoint

+ UpdatedAt time.Time

+ Version uint64

+ VirtualDeviceID string

+ type VirtualShadowDeviceConfig struct

+ ChannelID string

+ Description string

+ Enable bool

+ ID string

+ Name string

+ Points []VirtualShadowPointDef

+ type VirtualShadowPointDef struct

+ Formula string

+ Mode string

+ Name string

+ PointID string

+ SourceRef string

+ Unit string

+ type WindowConfig struct

+ AggrFunc string

+ Interval string

+ Size string

+ Type string

v0.0.5

Jun 10, 2026

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