ads

package
v0.0.0-...-2d02f19 Latest Latest
Warning

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

 Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetZeroTerminatedString 

func GetZeroTerminatedString(data []byte) string

func NewDriver 

func NewDriver(_options ...options.WithOption) plc4go.PlcDriver

func ReadWithTimeout 

func ReadWithTimeout[T spi.Message](ctx context.Context, ch <-chan T) (T, error)

Types

type Connection 

type Connection struct {
	_default.DefaultConnection
	// contains filtered or unexported fields
}

func NewConnection 

func NewConnection(messageCodec spi.MessageCodec, configuration model.Configuration, connectionOptions map[string][]string, _options ...options.WithOption) (*Connection, error)

func (*Connection) Browse 

func (m *Connection) Browse(ctx context.Context, browseRequest apiModel.PlcBrowseRequest) <-chan apiModel.PlcBrowseRequestResult

func (*Connection) BrowseQuery 

func (m *Connection) BrowseQuery(_ context.Context, _ func(result apiModel.PlcBrowseItem) bool, _ string, query apiModel.PlcQuery) (apiModel.PlcResponseCode, []apiModel.PlcBrowseItem)

func (*Connection) BrowseRequestBuilder 

func (m *Connection) BrowseRequestBuilder() apiModel.PlcBrowseRequestBuilder

func (*Connection) BrowseWithInterceptor 

func (m *Connection) BrowseWithInterceptor(ctx context.Context, browseRequest apiModel.PlcBrowseRequest, interceptor func(result apiModel.PlcBrowseItem) bool) <-chan apiModel.PlcBrowseRequestResult

func (*Connection) ConnectWithContext 

func (m *Connection) ConnectWithContext(ctx context.Context) <-chan plc4go.PlcConnectionConnectResult

func (*Connection) ExecuteAdsAddDeviceNotificationRequest 

func (m *Connection) ExecuteAdsAddDeviceNotificationRequest(ctx context.Context, indexGroup uint32, indexOffset uint32, length uint32, transmissionMode model.AdsTransMode, maxDelay uint32, cycleTime uint32) (model.AdsAddDeviceNotificationResponse, error)

func (*Connection) ExecuteAdsDeleteDeviceNotificationRequest 

func (m *Connection) ExecuteAdsDeleteDeviceNotificationRequest(ctx context.Context, notificationHandle uint32) (model.AdsDeleteDeviceNotificationResponse, error)

func (*Connection) ExecuteAdsReadDeviceInfoRequest 

func (m *Connection) ExecuteAdsReadDeviceInfoRequest(ctx context.Context) (model.AdsReadDeviceInfoResponse, error)

func (*Connection) ExecuteAdsReadRequest 

func (m *Connection) ExecuteAdsReadRequest(ctx context.Context, indexGroup uint32, indexOffset uint32, length uint32) (model.AdsReadResponse, error)

func (*Connection) ExecuteAdsReadWriteRequest 

func (m *Connection) ExecuteAdsReadWriteRequest(ctx context.Context, indexGroup uint32, indexOffset uint32, readLength uint32, items []model.AdsMultiRequestItem, writeData []byte) (model.AdsReadWriteResponse, error)

func (*Connection) ExecuteAdsWriteRequest 

func (m *Connection) ExecuteAdsWriteRequest(ctx context.Context, indexGroup uint32, indexOffset uint32, data []byte) (model.AdsWriteResponse, error)

func (*Connection) GetConnection 

func (m *Connection) GetConnection() plc4go.PlcConnection

func (*Connection) GetConnectionId 

func (m *Connection) GetConnectionId() string

func (*Connection) GetMessageCodec 

func (m *Connection) GetMessageCodec() spi.MessageCodec

func (*Connection) GetMetadata 

func (m *Connection) GetMetadata() apiModel.PlcConnectionMetadata

func (*Connection) GetTracer 

func (m *Connection) GetTracer() tracer.Tracer

func (*Connection) GetTransportInstance 

func (m *Connection) GetTransportInstance() transports.TransportInstance

func (*Connection) IsTraceEnabled 

func (m *Connection) IsTraceEnabled() bool

func (*Connection) NewAdsAddDeviceNotificationRequest 

func (m *Connection) NewAdsAddDeviceNotificationRequest(indexGroup uint32, indexOffset uint32, length uint32, transmissionMode adsModel.AdsTransMode, maxDelay uint32, cycleTime uint32) adsModel.AmsTCPPacket

func (*Connection) NewAdsDeleteDeviceNotificationRequest 

func (m *Connection) NewAdsDeleteDeviceNotificationRequest(notificationHandle uint32) adsModel.AmsTCPPacket

func (*Connection) NewAdsReadDeviceInfoRequest 

func (m *Connection) NewAdsReadDeviceInfoRequest() adsModel.AmsTCPPacket

func (*Connection) NewAdsReadRequest 

func (m *Connection) NewAdsReadRequest(indexGroup uint32, indexOffset uint32, length uint32) adsModel.AmsTCPPacket

func (*Connection) NewAdsReadWriteRequest 

func (m *Connection) NewAdsReadWriteRequest(indexGroup uint32, indexOffset uint32, readLength uint32, items []adsModel.AdsMultiRequestItem, writeData []byte) adsModel.AmsTCPPacket

func (*Connection) NewAdsWriteRequest 

func (m *Connection) NewAdsWriteRequest(indexGroup uint32, indexOffset uint32, data []byte) adsModel.AmsTCPPacket

func (*Connection) Read 

func (m *Connection) Read(ctx context.Context, readRequest apiModel.PlcReadRequest) <-chan apiModel.PlcReadRequestResult

func (*Connection) ReadRequestBuilder 

func (m *Connection) ReadRequestBuilder() apiModel.PlcReadRequestBuilder

func (*Connection) Register 

func (m *Connection) Register(consumer apiModel.PlcSubscriptionEventConsumer, handles []apiModel.PlcSubscriptionHandle) apiModel.PlcConsumerRegistration

func (*Connection) String 

func (m *Connection) String() string

func (*Connection) Subscribe 

func (m *Connection) Subscribe(ctx context.Context, subscriptionRequest apiModel.PlcSubscriptionRequest) <-chan apiModel.PlcSubscriptionRequestResult

func (*Connection) SubscriptionRequestBuilder 

func (m *Connection) SubscriptionRequestBuilder() apiModel.PlcSubscriptionRequestBuilder

func (*Connection) Unregister 

func (m *Connection) Unregister(registration apiModel.PlcConsumerRegistration)

func (*Connection) Unsubscribe 

func (m *Connection) Unsubscribe(ctx context.Context, unsubscriptionRequest apiModel.PlcUnsubscriptionRequest) <-chan apiModel.PlcUnsubscriptionRequestResult

func (*Connection) UnsubscriptionRequestBuilder 

func (m *Connection) UnsubscriptionRequestBuilder() apiModel.PlcUnsubscriptionRequestBuilder

func (*Connection) Write 

func (m *Connection) Write(ctx context.Context, writeRequest apiModel.PlcWriteRequest) <-chan apiModel.PlcWriteRequestResult

func (*Connection) WriteRequestBuilder 

func (m *Connection) WriteRequestBuilder() apiModel.PlcWriteRequestBuilder

type Discoverer 

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

func NewDiscoverer 

func NewDiscoverer(_options ...options.WithOption) *Discoverer

func (*Discoverer) Discover 

func (d *Discoverer) Discover(ctx context.Context, callback func(event apiModel.PlcDiscoveryItem), discoveryOptions ...options.WithDiscoveryOption) error

type DiscoveryMessageCodec 

type DiscoveryMessageCodec struct {
	_default.DefaultCodec
	// contains filtered or unexported fields
}

func NewDiscoveryMessageCodec 

func NewDiscoveryMessageCodec(transportInstance transports.TransportInstance, _options ...options.WithOption) *DiscoveryMessageCodec

func (*DiscoveryMessageCodec) GetCodec 

func (m *DiscoveryMessageCodec) GetCodec() spi.MessageCodec

func (*DiscoveryMessageCodec) Receive 

func (m *DiscoveryMessageCodec) Receive() (spi.Message, error)

func (*DiscoveryMessageCodec) Send 

func (m *DiscoveryMessageCodec) Send(message spi.Message) error

type Driver 

type Driver struct {
	_default.DefaultDriver
	// contains filtered or unexported fields
}

func (*Driver) DiscoverWithContext 

func (m *Driver) DiscoverWithContext(ctx context.Context, callback func(event apiModel.PlcDiscoveryItem), discoveryOptions ...options.WithDiscoveryOption) error

func (*Driver) GetConnectionWithContext 

func (m *Driver) GetConnectionWithContext(ctx context.Context, transportUrl url.URL, transports map[string]transports.Transport, driverOptions map[string][]string) <-chan plc4go.PlcConnectionConnectResult

func (*Driver) SupportsDiscovery 

func (m *Driver) SupportsDiscovery() bool

type DriverContext 

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

func NewDriverContext 

func NewDriverContext(configuration model.Configuration) (*DriverContext, error)

type MessageCodec 

type MessageCodec struct {
	_default.DefaultCodec
	// contains filtered or unexported fields
}

func NewMessageCodec 

func NewMessageCodec(transportInstance transports.TransportInstance, _options ...options.WithOption) *MessageCodec

func (*MessageCodec) GetCodec 

func (m *MessageCodec) GetCodec() spi.MessageCodec

func (*MessageCodec) Receive 

func (m *MessageCodec) Receive() (spi.Message, error)

func (*MessageCodec) Send 

func (m *MessageCodec) Send(message spi.Message) error

func (*MessageCodec) Serialize 

func (d *MessageCodec) Serialize() ([]byte, error)

func (*MessageCodec) SerializeWithWriteBuffer 

func (d *MessageCodec) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error

func (*MessageCodec) String 

func (d *MessageCodec) String() string

type SymbolicPlcQuery 

type SymbolicPlcQuery interface {
	apiModel.PlcQuery

	GetSymbolicAddressPattern() string
}

type TagHandler 

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

func NewTagHandler 

func NewTagHandler() TagHandler

NewTagHandler this constructor creates a version of the TagHandler that's detached from a connection and can't provide context-sensitive feedback.

func NewTagHandlerWithDriverContext 

func NewTagHandlerWithDriverContext(driverContext *DriverContext) TagHandler

NewTagHandlerWithDriverContext this constructor creates a version of the TagHandler that is connected to a connection and can provide context-sensitive feedback.

func (TagHandler) ParseQuery 

func (m TagHandler) ParseQuery(query string) (apiModel.PlcQuery, error)

func (TagHandler) ParseTag 

func (m TagHandler) ParseTag(query string) (apiModel.PlcTag, error)

type ValueHandler 

type ValueHandler struct {
	spiValues.DefaultValueHandler
	// contains filtered or unexported fields
}

func NewValueHandler 

func NewValueHandler(_options ...options.WithOption) ValueHandler

func NewValueHandlerWithDriverContext 

func NewValueHandlerWithDriverContext(driverContext *DriverContext, tagHandler TagHandler, _options ...options.WithOption) ValueHandler

func (ValueHandler) AdsParseListType 

func (t ValueHandler) AdsParseListType(dataType readWriteModel.AdsDataTypeTableEntry, arrayInfo []readWriteModel.AdsDataTypeArrayInfo, value any) (apiValues.PlcValue, error)

func (ValueHandler) AdsParseSimpleType 

func (t ValueHandler) AdsParseSimpleType(dataType readWriteModel.AdsDataTypeTableEntry, value any) (apiValues.PlcValue, error)

func (ValueHandler) AdsParseStructType 

func (t ValueHandler) AdsParseStructType(dataType readWriteModel.AdsDataTypeTableEntry, value any) (apiValues.PlcValue, error)

func (ValueHandler) AdsParseType 

func (t ValueHandler) AdsParseType(datatype readWriteModel.AdsDataTypeTableEntry, arrayInfo []readWriteModel.AdsDataTypeArrayInfo, value any) (apiValues.PlcValue, error)

func (ValueHandler) NewPlcValue 

func (t ValueHandler) NewPlcValue(tag apiModel.PlcTag, value any) (apiValues.PlcValue, error)

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.