The highest tagged major version is v2.

binaryIoTypeA

package

v0.1.6 Latest Latest Go to latest Published: Jan 19, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ci4rail/io4edge-client-go

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	DefaultChannelFilterMask uint32 = 0xFFFFFFFF
	DefaultKeepaliveInterval uint32 = 10
	DefaultBufferSize        uint32 = 50
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

Client represents a client for the binaryIoTypeA function

func NewClient ¶

func NewClient(c *client.Client) *Client

func NewClientFromService ¶

func NewClientFromService(serviceAddr string, timeout time.Duration) (*Client, error)

NewClientFromService creates a new core function client from a socket with a address, which was acquired from the specified service. The timeout specifies the maximal time waiting for a service to show up.

func NewClientFromSocketAddress ¶

func NewClientFromSocketAddress(address string) (*Client, error)

NewClientFromSocketAddress creates a new binaryIoTypeA function client from a socket with the specified address.

func (*Client) Command ¶ added in v0.1.4

func (c *Client) Command(cmd *fbv1.Command, timeout time.Duration) (*fbv1.Response, error)

Command issues a command cmd to a channel, waits for the devices response and returns it in res

func (*Client) Describe ¶

func (c *Client) Describe() (*binio.ConfigurationControlDescribeResponse, error)

func (*Client) GetAll ¶

func (c *Client) GetAll(mask uint32) (uint32, error)

func (*Client) GetConfiguration ¶

func (c *Client) GetConfiguration() (*Configuration, error)

func (*Client) GetResponse ¶ added in v0.1.4

func (c *Client) GetResponse(context string) *functionblockV1.Response

func (*Client) GetSingle ¶

func (c *Client) GetSingle(channel uint) (bool, error)

func (*Client) ReadResponses ¶ added in v0.1.4

func (c *Client) ReadResponses()

func (*Client) SetAll ¶

func (c *Client) SetAll(values uint32, mask uint32) error

func (*Client) SetAllBinaryChannels ¶

func (c *Client) SetAllBinaryChannels(output uint32) error

SetAllBinaryChannels sets all binary channels to the given value from the bitmask LSB is channel 0. True: output is on, False, output is off For iou01 there are only four output channels. All other bits are ignored

func (*Client) SetBinaryChannel ¶

func (c *Client) SetBinaryChannel(channel int, state bool) error

SetBinaryChannel sets the binary channel to the given value

func (*Client) SetConfiguration ¶

func (c *Client) SetConfiguration(config Configuration) error

func (*Client) SetRecover ¶ added in v0.1.4

func (c *Client) SetRecover(customRecover func())

SetRecover sets a function to inform the client about a panic event like timeout.

func (*Client) SetSingle ¶

func (c *Client) SetSingle(channel uint, state bool) error

func (*Client) StartStream ¶ added in v0.1.4

func (c *Client) StartStream(config *StreamConfiguration, callback func(*binio.Sample, uint32)) error

func (*Client) StopStream ¶ added in v0.1.4

func (c *Client) StopStream() error

func (*Client) StreamDefaultConfiguration ¶ added in v0.1.4

func (c *Client) StreamDefaultConfiguration() *StreamConfiguration

func (*Client) StreamStatus ¶ added in v0.1.4

func (c *Client) StreamStatus() bool

func (*Client) WaitForResponse ¶ added in v0.1.4

func (c *Client) WaitForResponse(context string, timeout time.Duration) (*functionblockV1.Response, error)

type ClientInterface ¶

type ClientInterface interface {
	NewClientFromSocketAddress(address string) (*Client, error)
	NewClientFromService(serviceAddr string, timeout time.Duration) (*Client, error)
}

type Configuration ¶

type Configuration struct {
	OutputFritting        int32
	OutputWatchdog        int32
	OutputWatchdogTimeout int32
}

type StreamConfiguration ¶ added in v0.1.4

type StreamConfiguration struct {
	ChannelFilterMask uint32
	KeepaliveInterval uint32
	BufferSize        uint32
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
v1alpha1

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