Skip to main content

SDK to communicate with Baltech RFID readers.

Project description

Baltech SDK

Installation

pip install baltech-sdk

Usage

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.

Supported IO protocols

from baltech_sdk import Brp, UsbHid, RS232

# 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"))

Reader Update

from baltech_sdk import Brp, UsbHid, ReaderUpdater

with Brp(UsbHid(), open=True) as brp:
    updater = ReaderUpdater.from_path("firmware.bf3")

    # simple upload
    updater.run(brp)

    # upload with progress
    for progress in updater.iter(brp):
        print(f"{progress.progress:.0%} ({progress.transferred_bytes} bytes)")

Access Reader Configuration

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

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 and manually set the path to your binary.

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:

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)
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

baltech_sdk-5.2026.3.1.tar.gz (253.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

baltech_sdk-5.2026.3.1-py3-none-any.whl (258.5 kB view details)

Uploaded Python 3

File details

Details for the file baltech_sdk-5.2026.3.1.tar.gz.

File metadata

  • Download URL: baltech_sdk-5.2026.3.1.tar.gz
  • Upload date:
  • Size: 253.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for baltech_sdk-5.2026.3.1.tar.gz
Algorithm Hash digest
SHA256 3939d7c2374c557d3e4449b0286877e55c8ad10426f2688b5ceb0fe00504b3e1
MD5 48f51f04712a9fd5c8b30c2ad92d3bf9
BLAKE2b-256 e6255198d1d2fb6dc7760f5187c4567c581cb8878989c0f91d88814e859f1b9b

See more details on using hashes here.

File details

Details for the file baltech_sdk-5.2026.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for baltech_sdk-5.2026.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a06892604231031e0e5209371e7e0b8f3b4d926d469c8ff16c5e8bd772db168b
MD5 5e70f76c2d82f04586c7b2f86e436467
BLAKE2b-256 0ff94adc85573864bd33de44a099f443dcbd23dd366a4bc1bf828431f9ce54ab

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page