baltech-sdk 3.19.4__tar.gz

baltech_sdk-3.19.4/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.1
+Name: baltech-sdk
+Version: 3.19.4
+Summary: SDK to communicate with Baltech RFID readers.
+License: MIT
+Author: Baltech AG
+Author-email: info@baltech.de
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: typing-extensions
+Description-Content-Type: text/markdown
+
+# Baltech SDK
+
+***Warning: While the underlying SDK is stable, the Python API is not stable yet, and future releases are not guaranteed to be backwards compatible. Pinning this project to a specific version in your dependency management is recommended.***
+
+## Installation
+```bash
+pip install baltech-sdk
+```
+
+## Usage
+
+```python
+from baltech_sdk import Brp, UsbHid
+
+# Sample code for GetInfo
+with Brp(UsbHid()) as brp:
+    print(brp.Sys_GetInfo())
+
+# This is a shortcut for:
+io = UsbHid()
+brp = Brp(io, open=False)
+brp.open()
+print(brp.Sys_GetInfo())
+brp.close()
+```
+A complete reference of the supported commands can be found [here](https://docs.baltech.de/refman/cmds/index.html).
+
+### Supported IO protocols
+```python
+from baltech_sdk import Brp, UsbHid, RS232, Tcp
+
+# USB HID autodetect connected reader
+brp = Brp(UsbHid())
+
+# USB HID by serialnumber
+brp = Brp(UsbHid(serialnumber=99999999))
+
+# Serial with (optional) custom settings
+brp = Brp(RS232("COM1", baudrate=115200, parity=b"N"))
+
+# TCP by ip address
+brp = Brp(Tcp(ipaddr="192.168.0.1"))
+```
+
+### Access Reader Configuration
+```python
+from baltech_sdk import Config
+
+cfg_src = {(0x0201, 0x02): b'\x01'}   # instead of a confDict also a brp object 
+                                     # can be passed to modify reader's 
+                                     # configuration directly
+cfg = Config(cfg_src)
+
+# set value
+cfg.Device_Boot_StartAutoreadAtPowerup("EnableOnce")
+
+# get value
+print(cfg.Device_Boot_StartAutoreadAtPowerup.get())
+
+# delete value
+cfg.Device_Boot_StartAutoreadAtPowerup.delete()
+```
+
+### Templates and BaltechScripts
+```python
+from baltech_sdk import Config, Template, BaltechScript, TemplateFilter
+
+confdict = {}
+cfg = Config(confdict)
+
+cfg.Scripts_Events_OnAccepted(
+    BaltechScript()
+        .ToggleInverted("RedLed", RepeatCount=3, Delay=20)
+        .Toggle("GreenLed", RepeatCount=1, Delay=20)
+        .DefaultAction()
+)
+cfg.Autoread_Rule_Template(
+    0, 
+    Template()
+        .Static(b"SNR:")
+        .Serialnr(TemplateFilter(BinToAscii=True, Unpack=True, BinToBcd=True))
+)
+print(confdict)
+```
+
+### Linux or macOS
+To use ``baltech-sdk`` under Linux or macOS you need to build your own binary of the [BaltechSDK](https://docs.baltech.de/developers/sdk.html) and manually set the path to your binary.
+```python
+from pathlib import Path
+from baltech_sdk import set_brp_lib_path
+
+set_brp_lib_path(Path("path/to/brp_lib"))
+```
+
+
+### Further parameters on connections fors sensible data 
+
+Additional Options: 
+ * [AES based Encryption](https://docs.baltech.de/developers/add-aes-auth-and-encryption.html) can be activated
+ * [Enabled monitoring](https://docs.baltech.de/developers/analyze-communication.html#enable-monitoring) can be suppressed or extended to plaintext
+
+```python
+from baltech_sdk import Brp, UsbHid, SecureChannel
+
+KEY = b'abcdefghijklmnuk'
+brp = Brp(UsbHid(), 
+          crypto=SecureChannel(security_level=1, key=KEY),  # encrypt communication
+          monitor="plaintext"                               # log unencrypted data (if activated by user)
+)
+```
+

baltech_sdk-3.19.4/README.md

@@ -0,0 +1,110 @@
+# Baltech SDK
+
+***Warning: While the underlying SDK is stable, the Python API is not stable yet, and future releases are not guaranteed to be backwards compatible. Pinning this project to a specific version in your dependency management is recommended.***
+
+## Installation
+```bash
+pip install baltech-sdk
+```
+
+## Usage
+
+```python
+from baltech_sdk import Brp, UsbHid
+
+# Sample code for GetInfo
+with Brp(UsbHid()) as brp:
+    print(brp.Sys_GetInfo())
+
+# This is a shortcut for:
+io = UsbHid()
+brp = Brp(io, open=False)
+brp.open()
+print(brp.Sys_GetInfo())
+brp.close()
+```
+A complete reference of the supported commands can be found [here](https://docs.baltech.de/refman/cmds/index.html).
+
+### Supported IO protocols
+```python
+from baltech_sdk import Brp, UsbHid, RS232, Tcp
+
+# USB HID autodetect connected reader
+brp = Brp(UsbHid())
+
+# USB HID by serialnumber
+brp = Brp(UsbHid(serialnumber=99999999))
+
+# Serial with (optional) custom settings
+brp = Brp(RS232("COM1", baudrate=115200, parity=b"N"))
+
+# TCP by ip address
+brp = Brp(Tcp(ipaddr="192.168.0.1"))
+```
+
+### Access Reader Configuration
+```python
+from baltech_sdk import Config
+
+cfg_src = {(0x0201, 0x02): b'\x01'}   # instead of a confDict also a brp object 
+                                     # can be passed to modify reader's 
+                                     # configuration directly
+cfg = Config(cfg_src)
+
+# set value
+cfg.Device_Boot_StartAutoreadAtPowerup("EnableOnce")
+
+# get value
+print(cfg.Device_Boot_StartAutoreadAtPowerup.get())
+
+# delete value
+cfg.Device_Boot_StartAutoreadAtPowerup.delete()
+```
+
+### Templates and BaltechScripts
+```python
+from baltech_sdk import Config, Template, BaltechScript, TemplateFilter
+
+confdict = {}
+cfg = Config(confdict)
+
+cfg.Scripts_Events_OnAccepted(
+    BaltechScript()
+        .ToggleInverted("RedLed", RepeatCount=3, Delay=20)
+        .Toggle("GreenLed", RepeatCount=1, Delay=20)
+        .DefaultAction()
+)
+cfg.Autoread_Rule_Template(
+    0, 
+    Template()
+        .Static(b"SNR:")
+        .Serialnr(TemplateFilter(BinToAscii=True, Unpack=True, BinToBcd=True))
+)
+print(confdict)
+```
+
+### Linux or macOS
+To use ``baltech-sdk`` under Linux or macOS you need to build your own binary of the [BaltechSDK](https://docs.baltech.de/developers/sdk.html) and manually set the path to your binary.
+```python
+from pathlib import Path
+from baltech_sdk import set_brp_lib_path
+
+set_brp_lib_path(Path("path/to/brp_lib"))
+```
+
+
+### Further parameters on connections fors sensible data 
+
+Additional Options: 
+ * [AES based Encryption](https://docs.baltech.de/developers/add-aes-auth-and-encryption.html) can be activated
+ * [Enabled monitoring](https://docs.baltech.de/developers/analyze-communication.html#enable-monitoring) can be suppressed or extended to plaintext
+
+```python
+from baltech_sdk import Brp, UsbHid, SecureChannel
+
+KEY = b'abcdefghijklmnuk'
+brp = Brp(UsbHid(), 
+          crypto=SecureChannel(security_level=1, key=KEY),  # encrypt communication
+          monitor="plaintext"                               # log unencrypted data (if activated by user)
+)
+```

baltech_sdk-3.19.4/baltech_sdk/__init__.py

@@ -0,0 +1,103 @@
+import sys
+import importlib.resources
+from pathlib import Path
+from typing import Protocol, Tuple, Optional, Union
+
+from .baltech_api import Commands, ConfigAccessor
+from .baltech_api.typedefs import Sys_ErrCfgNotFound
+from .brp_lib.protocols import BrpStack, UsbHid, RS232, SecureChannel, PKI, Tcp
+from .brp_lib.dll_wrapper import c_brp_lib
+
+from .baltech_api.typedefs import *
+from .baltech_api.template import *
+from .baltech_api.baltech_script import *
+
+
+class Brp(BrpStack, Commands):
+    pass
+
+
+class ConfDict(Protocol):
+    def __getitem__(self, item: Tuple[int, Optional[int]]) -> bytes: ...
+    def __setitem__(self, key: Tuple[int, Optional[int]], content: Optional[bytes]) -> None: ...
+
+
+class _CommandsConfDictWrapper(ConfDict):
+    def __init__(self, cmds: Commands) -> None:
+        self.cmds = cmds
+
+    def __getitem__(self, item: Tuple[int, Optional[int]]) -> bytes:
+        key, value = item
+        if value is None:
+            raise KeyError(item)
+        try:
+            return self.cmds.Sys_CfgGetValue(Key=key, Value=value)
+        except Sys_ErrCfgNotFound:
+            raise KeyError(item)
+
+    def __setitem__(self, item: Tuple[int, Optional[int]], content: Optional[bytes]) -> None:
+        key, value = item
+        if content is None:
+            try:
+                self.cmds.Sys_CfgDelValues(Key=key, Value=value if value is not None else 0xFF)
+            except Sys_ErrCfgNotFound:
+                raise KeyError(item)
+        else:
+            if value is None:
+                raise KeyError(item)
+            try:
+                self.cmds.Sys_CfgSetValue(Key=key, Value=value, Content=content)
+            except Sys_ErrCfgNotFound:
+                raise KeyError(item)
+
+
+class Config(ConfigAccessor):
+    def __init__(self, cfg_src: Union[ConfDict, Commands]) -> None:
+        self.confdict = _CommandsConfDictWrapper(cfg_src) if isinstance(cfg_src, Commands) else cfg_src
+
+    def execute(self, frame: bytes) -> bytes:
+        mode = frame[0]
+        masterkey = frame[1]
+        subkey = frame[2] if len(frame) > 2 else 0xFF
+        value = frame[3] if len(frame) > 3 else None
+        content = frame[4:] if len(frame) > 4 else b""
+        key = (masterkey << 8) | subkey
+
+        if mode == 0:  # get
+            return self.confdict[(key, value)]
+
+        if mode == 1:  # set
+            self.confdict[(key, value)] = content
+            return b""
+
+        if mode == 2:
+            self.confdict[(key, value)] = None
+            return b""
+
+        raise ValueError(f"unknown mode '{mode}' in configuration frame {frame!r}")
+
+
+def get_brp_lib_path() -> Optional[Path]:
+    return c_brp_lib.dll_path
+
+
+def set_brp_lib_path(path: Union[Path, str]) -> None:
+    c_brp_lib.dll_path = Path(path)
+
+
+def _autodetect_brp_lib() -> None:
+    arch = 64 if sys.maxsize > 2 ** 32 else 32
+    platform = sys.platform.replace("win32", "win")
+    extension = {
+        "win": "dll"
+    }.get(platform, "unknown")
+    dll_name = f"brp_lib.{platform}{arch}.{extension}"
+
+    root_resource = importlib.resources.files("baltech_sdk")
+    dll_resource = root_resource / "brp_lib" / dll_name
+    dll_path = Path(str(dll_resource))
+    if dll_path.exists():
+        set_brp_lib_path(dll_path)
+
+
+_autodetect_brp_lib()