sl5api 0.0.2__py3-none-any.whl

sl5api/main.py

@@ -0,0 +1,128 @@
+import grpc
+from .rootcert import ROOT_CERTIFICATE
+from datetime import datetime, timezone
+from typing import Any
+from .pb import sl5_api_pb2
+from .pb import sl5_api_pb2_grpc
+
+class Config:
+  target: str = 'localhost:23505'
+  token: str
+
+  def __init__(self, target: str, token: str):
+    self.target = target
+    self.token = token
+
+class Client:
+  channel: grpc.aio.Channel
+  tag_stub: sl5_api_pb2_grpc.TagServiceStub
+
+  def __init__(self, config: Config):
+
+    call_credentials = grpc.access_token_call_credentials(config.token)
+
+    channel_credentials = grpc.ssl_channel_credentials(
+      root_certificates=ROOT_CERTIFICATE,
+    )
+
+    composite_credentials = grpc.composite_channel_credentials(
+      channel_credentials,
+      call_credentials,
+    )
+
+    self.channel = grpc.aio.secure_channel(config.target, composite_credentials)
+    self.tag_stub = sl5_api_pb2_grpc.TagServiceStub(self.channel)
+   
+  async def __aenter__(self):
+    return self
+  
+  async def __aexit__(self, exc_type, exc_val, exc_tb):
+    await self.close(None)
+   
+  async def close(self, grace: float | None):
+    await self.channel.close(grace)
+    
+  async def read_value(self, tag_name: str) -> Any:
+    """
+    Args:
+      tag_name (str): Название тега в вистеме
+
+    Returns:
+      Any: Значение тега
+
+    Raises:
+      grpc.aio._call.AioRpcError: Ошибка со стороны сервера
+    """
+
+    req = sl5_api_pb2.TagReadValueRequest(names=[tag_name])
+    res = await self.tag_stub.ReadValues(req)
+    pb_value = res.values[0]
+    any_value = pbvalue_to_any(pb_value)
+    return any_value
+  
+  async def write_value(self, tag_name: str, new_value: Any, new_quality: int) -> None:
+    pb_value = any_to_pbvalue(new_value)
+    wv = sl5_api_pb2.WriteValue(
+      tag_name=tag_name,
+      quality=new_quality,
+      value=pb_value,
+    )
+    req = sl5_api_pb2.TagWriteValueRequest(wvs=[wv])
+    await self.tag_stub.WriteValues(req)
+
+def pbvalue_to_any(src: sl5_api_pb2.SLValue) -> Any:
+  kind = src.WhichOneof("kind")
+  match kind:
+    case "double_value":
+      return src.double_value
+    
+    case "string_value":
+      return src.string_value
+    
+    case "bool_value":
+      return src.bool_value
+    
+    case "int32_value":
+      return src.int32_value
+    
+    case "int64_value":
+      return src.int64_value
+    
+    case "uint32_value":
+      return src.uint32_value
+    
+    case "uint64_value":
+      return src.uint64_value    
+    
+    case "time_value":
+      v = src.time_value.ToDatetime(tzinfo=timezone.utc)
+      # map v to localtime timezone
+      v = v.astimezone(tz=None)
+      return v
+    case _:
+      raise Exception(f"unsupported type {kind}")
+    
+def any_to_pbvalue(src: Any) -> sl5_api_pb2.SLValue:
+
+  if isinstance(src, bool):
+    return sl5_api_pb2.SLValue(bool_value=src)
+  
+  if isinstance(src, datetime):
+    v = src.astimezone(tz=timezone.utc)
+    return sl5_api_pb2.SLValue(time_value=v)
+
+  match src:
+    case int(v):
+      dst = sl5_api_pb2.SLValue(int64_value=v)
+
+    case float(v):
+      dst = sl5_api_pb2.SLValue(double_value=v)
+
+    case str(v):
+      dst = sl5_api_pb2.SLValue(string_value=v)
+
+    case _:
+      raise ValueError(f"cannot cast {type(src)} to SLValue")
+
+  return dst
+    

sl5api/pb/sl5_api_pb2.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: sl5_api.proto
+# Protobuf Python Version: 6.31.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    6,
+    31,
+    1,
+    '',
+    'sl5_api.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import timestamp_pb2 as google_dot_protobuf_dot_timestamp__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rsl5_api.proto\x12\x0bsl5_grpc.pb\x1a\x1fgoogle/protobuf/timestamp.proto\"$\n\x13TagReadValueRequest\x12\r\n\x05names\x18\x01 \x03(\t\"9\n\x11TagReadValueReply\x12$\n\x06values\x18\x01 \x03(\x0b\x32\x14.sl5_grpc.pb.SLValue\"\xe7\x01\n\x07SLValue\x12\x16\n\x0c\x64ouble_value\x18\x01 \x01(\x01H\x00\x12\x16\n\x0cstring_value\x18\x02 \x01(\tH\x00\x12\x14\n\nbool_value\x18\x03 \x01(\x08H\x00\x12\x15\n\x0bint32_value\x18\x04 \x01(\x05H\x00\x12\x15\n\x0bint64_value\x18\x05 \x01(\x03H\x00\x12\x16\n\x0cuint32_value\x18\x06 \x01(\rH\x00\x12\x16\n\x0cuint64_value\x18\x07 \x01(\x04H\x00\x12\x30\n\ntime_value\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x06\n\x04kind\"<\n\x14TagWriteValueRequest\x12$\n\x03wvs\x18\x01 \x03(\x0b\x32\x17.sl5_grpc.pb.WriteValue\"T\n\nWriteValue\x12\x10\n\x08tag_name\x18\x01 \x01(\t\x12#\n\x05value\x18\x02 \x01(\x0b\x32\x14.sl5_grpc.pb.SLValue\x12\x0f\n\x07quality\x18\x03 \x01(\r\"\x14\n\x12TagWriteValueReply2\xb3\x01\n\nTagService\x12P\n\nReadValues\x12 .sl5_grpc.pb.TagReadValueRequest\x1a\x1e.sl5_grpc.pb.TagReadValueReply\"\x00\x12S\n\x0bWriteValues\x12!.sl5_grpc.pb.TagWriteValueRequest\x1a\x1f.sl5_grpc.pb.TagWriteValueReply\"\x00\x42\x1fZ\x1dserver/app/server/api/grpc/pbb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'sl5_api_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'Z\035server/app/server/api/grpc/pb'
+  _globals['_TAGREADVALUEREQUEST']._serialized_start=63
+  _globals['_TAGREADVALUEREQUEST']._serialized_end=99
+  _globals['_TAGREADVALUEREPLY']._serialized_start=101
+  _globals['_TAGREADVALUEREPLY']._serialized_end=158
+  _globals['_SLVALUE']._serialized_start=161
+  _globals['_SLVALUE']._serialized_end=392
+  _globals['_TAGWRITEVALUEREQUEST']._serialized_start=394
+  _globals['_TAGWRITEVALUEREQUEST']._serialized_end=454
+  _globals['_WRITEVALUE']._serialized_start=456
+  _globals['_WRITEVALUE']._serialized_end=540
+  _globals['_TAGWRITEVALUEREPLY']._serialized_start=542
+  _globals['_TAGWRITEVALUEREPLY']._serialized_end=562
+  _globals['_TAGSERVICE']._serialized_start=565
+  _globals['_TAGSERVICE']._serialized_end=744
+# @@protoc_insertion_point(module_scope)

sl5api/pb/sl5_api_pb2.pyi

@@ -0,0 +1,62 @@
+import datetime
+
+from google.protobuf import timestamp_pb2 as _timestamp_pb2
+from google.protobuf.internal import containers as _containers
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from collections.abc import Iterable as _Iterable, Mapping as _Mapping
+from typing import ClassVar as _ClassVar, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class TagReadValueRequest(_message.Message):
+    __slots__ = ("names",)
+    NAMES_FIELD_NUMBER: _ClassVar[int]
+    names: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, names: _Optional[_Iterable[str]] = ...) -> None: ...
+
+class TagReadValueReply(_message.Message):
+    __slots__ = ("values",)
+    VALUES_FIELD_NUMBER: _ClassVar[int]
+    values: _containers.RepeatedCompositeFieldContainer[SLValue]
+    def __init__(self, values: _Optional[_Iterable[_Union[SLValue, _Mapping]]] = ...) -> None: ...
+
+class SLValue(_message.Message):
+    __slots__ = ("double_value", "string_value", "bool_value", "int32_value", "int64_value", "uint32_value", "uint64_value", "time_value")
+    DOUBLE_VALUE_FIELD_NUMBER: _ClassVar[int]
+    STRING_VALUE_FIELD_NUMBER: _ClassVar[int]
+    BOOL_VALUE_FIELD_NUMBER: _ClassVar[int]
+    INT32_VALUE_FIELD_NUMBER: _ClassVar[int]
+    INT64_VALUE_FIELD_NUMBER: _ClassVar[int]
+    UINT32_VALUE_FIELD_NUMBER: _ClassVar[int]
+    UINT64_VALUE_FIELD_NUMBER: _ClassVar[int]
+    TIME_VALUE_FIELD_NUMBER: _ClassVar[int]
+    double_value: float
+    string_value: str
+    bool_value: bool
+    int32_value: int
+    int64_value: int
+    uint32_value: int
+    uint64_value: int
+    time_value: _timestamp_pb2.Timestamp
+    def __init__(self, double_value: _Optional[float] = ..., string_value: _Optional[str] = ..., bool_value: bool = ..., int32_value: _Optional[int] = ..., int64_value: _Optional[int] = ..., uint32_value: _Optional[int] = ..., uint64_value: _Optional[int] = ..., time_value: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ...) -> None: ...
+
+class TagWriteValueRequest(_message.Message):
+    __slots__ = ("wvs",)
+    WVS_FIELD_NUMBER: _ClassVar[int]
+    wvs: _containers.RepeatedCompositeFieldContainer[WriteValue]
+    def __init__(self, wvs: _Optional[_Iterable[_Union[WriteValue, _Mapping]]] = ...) -> None: ...
+
+class WriteValue(_message.Message):
+    __slots__ = ("tag_name", "value", "quality")
+    TAG_NAME_FIELD_NUMBER: _ClassVar[int]
+    VALUE_FIELD_NUMBER: _ClassVar[int]
+    QUALITY_FIELD_NUMBER: _ClassVar[int]
+    tag_name: str
+    value: SLValue
+    quality: int
+    def __init__(self, tag_name: _Optional[str] = ..., value: _Optional[_Union[SLValue, _Mapping]] = ..., quality: _Optional[int] = ...) -> None: ...
+
+class TagWriteValueReply(_message.Message):
+    __slots__ = ()
+    def __init__(self) -> None: ...

sl5api/pb/sl5_api_pb2_grpc.py

@@ -0,0 +1,145 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+import sl5_api_pb2 as sl5__api__pb2
+
+GRPC_GENERATED_VERSION = '1.76.0'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + ' but the generated code in sl5_api_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class TagServiceStub(object):
+    """TagService
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.ReadValues = channel.unary_unary(
+                '/sl5_grpc.pb.TagService/ReadValues',
+                request_serializer=sl5__api__pb2.TagReadValueRequest.SerializeToString,
+                response_deserializer=sl5__api__pb2.TagReadValueReply.FromString,
+                _registered_method=True)
+        self.WriteValues = channel.unary_unary(
+                '/sl5_grpc.pb.TagService/WriteValues',
+                request_serializer=sl5__api__pb2.TagWriteValueRequest.SerializeToString,
+                response_deserializer=sl5__api__pb2.TagWriteValueReply.FromString,
+                _registered_method=True)
+
+
+class TagServiceServicer(object):
+    """TagService
+    """
+
+    def ReadValues(self, request, context):
+        """Позволяет прочитать указанные теги
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def WriteValues(self, request, context):
+        """Позволяет записать значения и качество в теги
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_TagServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'ReadValues': grpc.unary_unary_rpc_method_handler(
+                    servicer.ReadValues,
+                    request_deserializer=sl5__api__pb2.TagReadValueRequest.FromString,
+                    response_serializer=sl5__api__pb2.TagReadValueReply.SerializeToString,
+            ),
+            'WriteValues': grpc.unary_unary_rpc_method_handler(
+                    servicer.WriteValues,
+                    request_deserializer=sl5__api__pb2.TagWriteValueRequest.FromString,
+                    response_serializer=sl5__api__pb2.TagWriteValueReply.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'sl5_grpc.pb.TagService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('sl5_grpc.pb.TagService', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class TagService(object):
+    """TagService
+    """
+
+    @staticmethod
+    def ReadValues(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/sl5_grpc.pb.TagService/ReadValues',
+            sl5__api__pb2.TagReadValueRequest.SerializeToString,
+            sl5__api__pb2.TagReadValueReply.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def WriteValues(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/sl5_grpc.pb.TagService/WriteValues',
+            sl5__api__pb2.TagWriteValueRequest.SerializeToString,
+            sl5__api__pb2.TagWriteValueReply.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

sl5api/rootcert.py

@@ -0,0 +1,25 @@
+
+ROOT_CERTIFICATE = """
+-----BEGIN CERTIFICATE-----
+MIIDkzCCAnugAwIBAgIUSJFCdUz+HRePK/JoxrZPSA0RbIgwDQYJKoZIhvcNAQEL
+BQAwWTELMAkGA1UEBhMCUlUxGjAYBgNVBAcMEVN2ZXJkbG92c2sgcmVnaW9uMRYw
+FAYDVQQDDA1TaW1wTGlnaHQgTExDMRYwFAYDVQQKDA1TaW1wTGlnaHQgTExDMB4X
+DTI0MTEwNDA4MjAzNFoXDTQ0MDEwNDA4MjAzNFowWTELMAkGA1UEBhMCUlUxGjAY
+BgNVBAcMEVN2ZXJkbG92c2sgcmVnaW9uMRYwFAYDVQQDDA1TaW1wTGlnaHQgTExD
+MRYwFAYDVQQKDA1TaW1wTGlnaHQgTExDMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
+MIIBCgKCAQEAq6P0dlBPBUJ+zF6zt9PnSTv9TNgm7zceweDq+Yien8itNgTZI79D
+KpkGFHKOaUSBUlXHQuvALBcr+BOguQb/Lc6oJp+vLZm8PqLMIl3PDzzj3dbMwTzR
+5P+od+WtmQeZxIN7KPD1yMl/ZgeXpN/py77gLAgB8MGLNsBnSDpe9mlhkBShNr1K
+2+2TPvJhfH+UcjFNHd+qkm3tYv+Qo8D2rmKj5dPAfZs0I4snDD5JcmMvc045n/eF
+sy8joqZlHV6BZm522Epgt9oQFHj6bIP4XsENpBhWK8Rx2HLu5uksXATcHDHkMBT4
+bGvjgoGHHG+PLZMSMuv7jhzOE3Tvog8NUQIDAQABo1MwUTAdBgNVHQ4EFgQUMeog
+t4jvLGOG+nTy1LI0Sowo30UwHwYDVR0jBBgwFoAUMeogt4jvLGOG+nTy1LI0Sowo
+30UwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAMHZm/vIUVV+w
+oq7oQGjN+WKoIgY8hUIwVKZsjjg+aPJwAuyMhY36DHdQRVZyQPBCgyQOs39ivDrL
+HgjSmfTSl8rOai5LEoFfSssnkufuRi6Kj7uzXpEhzaMDtOnE/oPXSINdeEGJXc5U
+mxKw9rDxtKsVIdbOJWDIiT9A5Owt5Y2cEnOWLQ4xWMJpP+2nTjl0qgEWJvJo7eJw
+TknawKxpy0eFCqCy9sSalnVk/4FYpiXHyAHlWVsKBcVm1vlnAZAERuNP5oszWqaF
+n6cUcTPW/NL7E9HGZuAyzI5DcUmEPpmq/SlTVo8fZzpD2tGloRi12gJvn3Hk00hs
+KnXlTxGZSA==
+-----END CERTIFICATE-----
+""".encode("utf-8")

sl5api-0.0.2.dist-info/METADATA

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: sl5api
+Version: 0.0.2
+Summary: SimpLight SCADA v5 gRPC api
+Author-email: SimpLight <simp@simplight.ru>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: grpcio>=1.76.0
+Requires-Dist: protobuf>=6.33.2
+Description-Content-Type: text/markdown
+
+# SimpLight SCADA v5 gRPC API
+
+Use this package to work with SimpLight SCADA v5. The package implements a scripting API that is available in system scripts in Lua language.

sl5api-0.0.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+sl5api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sl5api/main.py,sha256=broFV3RB6SfJTMf1QieRB-rXapfuqYIdUcyUEfnPhPE,3388
+sl5api/rootcert.py,sha256=gIyd7PIe5JMO5Sy1Tzf4uGNzAE5bzyUwuhTPljfGKZs,1369
+sl5api/pb/sl5_api_pb2.py,sha256=7cFgzo0xck0CewjTMEdZcR5rg6IUeCmqzUUJaJAi4z8,3207
+sl5api/pb/sl5_api_pb2.pyi,sha256=XJpDOluReMqhWvgq0UqzQZN_yuhcFk2NIFfErikMV2w,2837
+sl5api/pb/sl5_api_pb2_grpc.py,sha256=G7Y_vk2AaVyEERGARY89CY2asyslo2DnDg45KRSTEhs,5095
+sl5api-0.0.2.dist-info/METADATA,sha256=2Ac45u7nk7NwELqGYSCCId1o8SZlDRwMQt2Mai-kCH8,571
+sl5api-0.0.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+sl5api-0.0.2.dist-info/licenses/LICENSE,sha256=jYDva2lqwCgTP62vFTi_4vdvvlpZqIOk1SEw-xNq-Ac,1068
+sl5api-0.0.2.dist-info/RECORD,,

sl5api-0.0.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sl5api-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 SimpLight LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.