kld7


Namekld7 JSON
Version 0.2.1 PyPI version JSON
download
home_pagehttps://github.com/nickovs/kld7
SummaryK-LD7 Doppler radar sensor driver
upload_time2023-06-21 08:48:22
maintainer
docs_urlNone
authorNicko van Someren
requires_python>=3.6
license
keywords radar doppler
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            A Python driver for the K-LD7 radar module
==========================================

This is a simple, high-level interface to the K-LD7_ radar module. It
lets the user read and set the various radar parameters as described
in the datasheet_ and fetch the various sorts of raw or processed data
frames from the sensor, either individually or as a stream. 

Tracking the distance, speed, angle and magnitude of the most
promenant moving object in range is as simple as:

.. code-block:: python

    from kld7 import KLD7
    with KLD7("/dev/tty.usbserial") as radar:
        for target_info in radar.stream_TDAT():
            print(target_info)

Documentation
-------------

The API for this module is documented on ReadTheDocs_.
            
Overview
--------

According the the datasheet:

    "The K-LD7 is a fully digital low cost Doppler radar that can
    measure speed, direction, distance and angle of moving objects in
    front of the sensor. The digital structure and wide power supply
    range make it very easy to use this sensor in any stand-alone or
    MCU based application."

The module can detect and measure multiple moving objects and provide
filtered tracking information about the most prominent one. Various
detection criteria can be stored and a set of programmable output pins
on the module can be configured to indicate detection status, allowing
for stand-alone operation once the coniguration paramters have been
set.

The K-LD7 module includes an integrated signal processor and allows
access to the radar signal at a number of levels including raw ADC
samples, FFT output, candidate targets, most significant tracked
target and flags for the tracked target relative to detection
thresholds. Each level of processing provides higher-level information
and thus reduces the volume of data that needs to be sent to the host.
This driver allows users to access each of these levels of data to be
fetched, either as a single snamshot or as a stream of data frames.

Configuration paramters
-----------------------

The K-LD7 module has 22 configurable radar paramters that can be used
to control the sensitivity, distance and speed range and detection
thresholds used during filtering, as well as for configuring the
programmable output pins. These paramters can be read and set though
a ``RadarParamProxy`` object accessible as the ``params``
attribute of the driver object.

            
.. _K-LD7: https://www.rfbeam.ch/product?id=40

.. _datasheet: https://www.rfbeam.ch/files/products/40/downloads/Datasheet_K-LD7.pdf

.. _ReadTheDocs: https://kld7.readthedocs.io/en/latest/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nickovs/kld7",
    "name": "kld7",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "radar,Doppler",
    "author": "Nicko van Someren",
    "author_email": "nicko@nicko.org",
    "download_url": "https://files.pythonhosted.org/packages/32/63/518c774d10152e895b07f14cbce0c1c0fc3e9de34760dbd7dc9a244801dd/kld7-0.2.1.tar.gz",
    "platform": null,
    "description": "A Python driver for the K-LD7 radar module\n==========================================\n\nThis is a simple, high-level interface to the K-LD7_ radar module. It\nlets the user read and set the various radar parameters as described\nin the datasheet_ and fetch the various sorts of raw or processed data\nframes from the sensor, either individually or as a stream. \n\nTracking the distance, speed, angle and magnitude of the most\npromenant moving object in range is as simple as:\n\n.. code-block:: python\n\n    from kld7 import KLD7\n    with KLD7(\"/dev/tty.usbserial\") as radar:\n        for target_info in radar.stream_TDAT():\n            print(target_info)\n\nDocumentation\n-------------\n\nThe API for this module is documented on ReadTheDocs_.\n            \nOverview\n--------\n\nAccording the the datasheet:\n\n    \"The K-LD7 is a fully digital low cost Doppler radar that can\n    measure speed, direction, distance and angle of moving objects in\n    front of the sensor. The digital structure and wide power supply\n    range make it very easy to use this sensor in any stand-alone or\n    MCU based application.\"\n\nThe module can detect and measure multiple moving objects and provide\nfiltered tracking information about the most prominent one. Various\ndetection criteria can be stored and a set of programmable output pins\non the module can be configured to indicate detection status, allowing\nfor stand-alone operation once the coniguration paramters have been\nset.\n\nThe K-LD7 module includes an integrated signal processor and allows\naccess to the radar signal at a number of levels including raw ADC\nsamples, FFT output, candidate targets, most significant tracked\ntarget and flags for the tracked target relative to detection\nthresholds. Each level of processing provides higher-level information\nand thus reduces the volume of data that needs to be sent to the host.\nThis driver allows users to access each of these levels of data to be\nfetched, either as a single snamshot or as a stream of data frames.\n\nConfiguration paramters\n-----------------------\n\nThe K-LD7 module has 22 configurable radar paramters that can be used\nto control the sensitivity, distance and speed range and detection\nthresholds used during filtering, as well as for configuring the\nprogrammable output pins. These paramters can be read and set though\na ``RadarParamProxy`` object accessible as the ``params``\nattribute of the driver object.\n\n            \n.. _K-LD7: https://www.rfbeam.ch/product?id=40\n\n.. _datasheet: https://www.rfbeam.ch/files/products/40/downloads/Datasheet_K-LD7.pdf\n\n.. _ReadTheDocs: https://kld7.readthedocs.io/en/latest/\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "K-LD7 Doppler radar sensor driver",
    "version": "0.2.1",
    "project_urls": {
        "Homepage": "https://github.com/nickovs/kld7"
    },
    "split_keywords": [
        "radar",
        "doppler"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fc5f4dab5f09952c82595fd3f43b69606ba28aa8305bf5515e5b5cd6f92cd19a",
                "md5": "1873ada4a4669580750c0685b288cb33",
                "sha256": "cf8f39e85cece9a6ca793d2c292c3684762ee82a26f0381d71bd378c94b58a73"
            },
            "downloads": -1,
            "filename": "kld7-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1873ada4a4669580750c0685b288cb33",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 7676,
            "upload_time": "2023-06-21T08:47:40",
            "upload_time_iso_8601": "2023-06-21T08:47:40.854931Z",
            "url": "https://files.pythonhosted.org/packages/fc/5f/4dab5f09952c82595fd3f43b69606ba28aa8305bf5515e5b5cd6f92cd19a/kld7-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3263518c774d10152e895b07f14cbce0c1c0fc3e9de34760dbd7dc9a244801dd",
                "md5": "27c5141dd334240776cc882852bb3a7a",
                "sha256": "6db9b52258c346ee1867b2fc220603dc611865ee6709d554c3f6325262181755"
            },
            "downloads": -1,
            "filename": "kld7-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "27c5141dd334240776cc882852bb3a7a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 7686,
            "upload_time": "2023-06-21T08:48:22",
            "upload_time_iso_8601": "2023-06-21T08:48:22.521200Z",
            "url": "https://files.pythonhosted.org/packages/32/63/518c774d10152e895b07f14cbce0c1c0fc3e9de34760dbd7dc9a244801dd/kld7-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-21 08:48:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nickovs",
    "github_project": "kld7",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "kld7"
}
        
Elapsed time: 2.07843s