#####################################################################
# settings.py
#
# (c) Copyright 2023-2024, Benjamin Parzella. All rights reserved.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This software is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#####################################################################
"""SECS-I settings class."""
from __future__ import annotations
import secsgem.common
[docs]
class SecsISettings(secsgem.common.Settings):
"""Settings for SECS-I connection.
These attributes can be initialized in the constructor and accessed as property.
Example:
>>> import secsgem.secsi
>>>
>>> settings = secsgem.secsi.SecsISettings(port="COM1")
>>> settings.port
'COM1'
>>> settings.speed
9600
"""
def __init__(self, **kwargs) -> None:
"""Initialize settings."""
super().__init__(**kwargs)
self._port = kwargs.get("port", "")
self._speed = kwargs.get("speed", 9600)
self._validate_args(kwargs)
@classmethod
def _args(cls) -> list[str]:
return [*super()._args(), "port", "speed"]
@property
def port(self) -> str:
"""Serial port.
Default: ""
"""
return self._port
@property
def speed(self) -> int:
"""Serial port baud rate.
Default: 9600
"""
return self._speed
[docs]
def create_protocol(self) -> secsgem.common.Protocol:
"""Protocol class for this configuration."""
from .protocol import SecsIProtocol # pylint: disable=import-outside-toplevel
return SecsIProtocol(self)
[docs]
def create_connection(self) -> secsgem.common.Connection:
"""Connection class for this configuration."""
return secsgem.common.SerialConnection(self)
@property
def name(self) -> str:
"""Name of this configuration."""
return f"SECSI-{self.port}"
[docs]
def generate_thread_name(self, functionality: str) -> str:
"""Generate a unique thread name for this configuration and a provided functionality.
Args:
functionality: name of the functionality to generate thread name for
Returns:
generated thread name
"""
return f"secsgem_SecsI_{functionality}_{self.port}@{self.speed}"