tlkcore 2.3.0rc2

TmxLab Kit Core engine (TLKCore) Hardware Driver Python API

Introduction

TLKCore is a core service which inside the TMXLAB KIT(TLK/[WEB-TLK](https://web-tlk.tmytek.com/)), it integrates Python built libraries which developing mmWave( n257 / n258 / n260 / n261 ) beamforming and beam steering applications on BBox 5G Series(mmwave beamformer) and UDBox 5G Series(mmwave Up-down frequency converter) and other standard products developed by TMYTEK. It provides a simple and efficient way to interact with the hardware, allowing developers to focus on building applications without worrying about low-level details.

Installation Troubleshooting

• If you encounter any issues during tlkcore installation or usage, please check the following:

1. Ensure you have the required dependencies installed.

2. Check the compatibility of your Python version.

3. Review the documentation for any specific configuration steps.

• If you meet the error message likes: CERTIFICATE_VERIFY_FAILED,

  you can try the following steps:

1. Update your pip to the latest version:

   pip install --upgrade pip

2. You may need to configure your proxy settings if you are behind a corporate firewall.

3. You can also try to disable SSL verification (not recommended for production):

   pip install tlkcore --trusted-host pypi.org --trusted-host files.pythonhosted.org

4. Or download cacert.pem from https://curl.se/ca/cacert.pem , then set environment variable SSL_CERT_FILE to the path of the downloaded file.

   set SSL_CERT_FILE={$your_path}/cacert.pem

Hardware Prequisites

• Architecture:

  

• USB driver for scanning/connect device

  • Installation Guides for all platforms

  • Windows

    • Online-Host with external internet capability - Auto detect a new device and install driver

    • Offline-Host - Download setup executable driver from FTDI and install it.

  • Linux

    1. Follow steps to create or extend /etc/udev/rules.d/99-ftdi.rules includes:

       SUBSYSTEM=="usb", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="601c", GROUP="plugdev", MODE="0666"

    2. Try to reload udev rules or re-plugin USB devices:

       sudo udevadm control --reload-rules
       sudo udevadm trigger

Examples

This represents how to use the tlkcore API. Please refer to the example from github: https://github.com/tmytek/tlkcore-examples for more details.

Initialize & scanDevices

from tlkcore.TLKCoreService import TLKCoreService
service = TLKCoreService(".")
ret = service.scanDevices()
print(ret)