Skip to main content

Python SDK for the RadarIQ sensor

Project description

================================= Python SDK |docs|

Overview

This module provides an easy to use Python wrapper for the RadarIQ-M1_ sensor which works for both Python 2 & 3. This SDK has been tested with Windows, OSX, Raspberry Pi and Linux.

The RadarIQ-M1 sensor is an easy-to-use radar sensor for detecting objects and measuring distance and speed. All the difficult parts of working with radar are done by the sensor and a simple API and SDK provide an easy path to integration.

The RadarIQ Python SDK is released under the MIT software license, see LICENSE_ for more details.

.. _LICENSE: https://github.com/radariq/python-sdk/LICENCE

Documentation

See https://radariq-python.readthedocs.io

Requirements

  • Python_ 2 or 3
  • A RadarIQ-M1_ module

Installation

Install the RadarIQ SDK using pip

.. code-block:: bash

pip install radariq

The SDK can be used from Python scripts

.. code-block:: python

from radariq import RadarIQ

Usage

.. code-block:: python

from radariq import RadarIQ, MODE_POINT_CLOUD

riq = RadarIQ()
riq.set_mode(MODE_POINT_CLOUD)
riq.set_units('m', 'm/s')
riq.set_frame_rate(5)
riq.set_distance_filter(0, 10)
riq.set_angle_filter(-45, 45)
riq.start()

for row in riq.get_data():
    print(row)

Examples

Examples are in the directory examples_.

Other pages

  • Home page_
  • Downloads_
  • GitHub_
  • Forum_
  • Youtube channel_
  • Facebook page_

.. _GitHub: https://github.com/radariq .. _Home Page: https://radariq.io .. _Downloads: https://radariq.io .. _Forum: https://forum.radariq.io .. _Youtube channel: https://youtube.com/radariq .. _Facebook page: https://facebook.com/radarIQsensing .. _Python: https://www.python.org .. _RadarIQ-M1: https://radariq.io/products/radariq-m1 .. _radariq.io: https://radariq.io .. _examples: https://github.com/radariq/python-sdk/blob/master/examples

.. |docs| image:: https://readthedocs.org/projects/pip/badge/?version=stable :target: https://pip.pypa.io/en/stable/?badge=stable :alt: Documentation Status

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

radariq-1.0.0.tar.gz (16.8 kB view hashes)

Uploaded source

Built Distribution

radariq-1.0.0-py3-none-any.whl (16.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page