SECS I over TCP

module imports.

class secsgem.secsitcp.SecsITcpConnectMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]: Secs I over TCP connect mode (client or server).

class secsgem.secsitcp.SecsITcpSettings(**kwargs)[source]

Settings for Secs I over TCP connection.

These attributes can be initialized in the constructor and accessed as property.

Example

>>> import secsgem.secsitcp
>>>
>>> settings = secsgem.secsitcp.SecsITcpSettings(device_type=secsgem.common.DeviceType.EQUIPMENT)
>>> settings.device_type
Equipment
>>> settings.address
'127.0.0.1'

property connect_mode: SecsITcpConnectMode

Secs I over TCP connect mode.

Default: SecsITcpConnectMode.CLIENT

property address: str

Remote (client) or local (server) IP address.

Default: “127.0.0.1”

property port: int

TCP port of remote host.

Default: 5000

create_protocol()[source]

Protocol class for this configuration.

Return type:: Protocol

create_connection()[source]

Connection class for this configuration.

Return type:: Connection

property name: str: Name of this configuration.

generate_thread_name(functionality)[source]

Generate a unique thread name for this configuration and a provided functionality.

Parameters:: functionality (str) – name of the functionality to generate thread name for
Return type:: str
Returns:: generated thread name