Explore the Next Sense with Acconeer's Python Exploration Kit! Use one of our evaluation kits together with our Python examples and start exploring the world of Acconeer's radar sensor technology. The Python scripts and GUI in this repository will help you to easily stream the radar sensor's data to your local machine to start radar sensor evaluation and/or algorithm development for your application.
To run the Python exploration scripts, you will need an evaluation kit running the included Streaming or Module server, which are supplied with the Acconeer SDK and Module SW image.
This release is developed for Acconeer SDK and Module SW version 1.10.0. Running this version is strongly recommended, as we continuously fix bugs and add features.
There is a portable version of the Exploration Kit for Windows:
- Download the zip file and extract
- Double click the
update.batfile and wait for the installation to finish, which takes a couple of minutes - Double click the
run_gui.bat
For an in-depth evaluation we recommend a full installation of the Exploartion Kit as described below.
Additional documentation is available on Read the Docs.
For general help on getting started head over to the Acconeer developer page. There you will find both a getting started guide and a video showing you how to set up your evaluation kit. There you will also find the SDK download.
Python 3.6 or newer. Older versions have limited or no support.
Tested on:
- Python 3 (developed and tested on 3.6 and 3.7)
- Windows 10
- Ubuntu 18.04
- WSL (Windows Subsystem for Linux)
Setuptools, wheel, NumPy, SciPy, PySerial, matplotlib, PyQtGraph, PyQt5, h5py, Flask.
If you have PyQt4 installed, it might conflict with PyQt5. If this is the case for you, we recommend using virtual environments to separate the two installations.
Install all Python dependencies using pip:
python -m pip install --user setuptools wheel
python -m pip install --user -r requirements.txt
Depending on your environment, you might have to replace python with python3 or py.
Install the supplied Acconeer utilities module acconeer_utils:
python setup.py install --user
Note: The utilities module has to be reinstalled after any change in acconeer_utils, and therefore it is recommended to reinstall after each update of the Exploration Kit.
If you are running Linux together with the XM112, you probably need permission to access the serial port. Access is obtained by adding yourself to the dialout group:
sudo usermod -a -G dialout your-user-name
For the changes to take effect, you will need to log out and in again.
Note: If you have ModemManager installed and running it might try to connect to the XM112, which has proven to cause problems. If you are having issues, try disabling the ModemManager service.
If you are using Linux together with the XM112+XB112, you probably need permission to access the SPI bridge USB device. Either run the scripts with sudo, or create an udev rule as follows. Create and edit:
sudo nano /etc/udev/rules.d/50-ft4222.rules
with the following content:
SUBSYSTEM=="usb", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="601c", MODE:="0666"
This method is confirmed to work for Ubuntu 18.04.
Note: SPI is not supported under WSL.
Using the GUI is the easiest way to start exploring Acconeer's radar sensor and our application examples:
python gui/main.py
In the top right box of the GUI, named "Connection Settings", select the interface you wish to use
- SPI: the GUI will try to autodetect a sensor connected via USB
- Socket: specify the IP address of your RaspberryPi, running the streaming server
- Serial: specify the COM port that is assigned to the sensor (press "scan ports" to detect available ports)
After pressing "Connect", a connection should be established. In the box below, labeled "Scan Controls", select the service you want to test and configure the sensor and service settings to your specific setup. Once you press "Start", the GUI will start fetching data from the sensor and plotting the results. You cannot change "Sensor" or "Processing" settings while scanning. After pressing "Stop", you can save (and later load data) or just replay the data stored in the sweep buffer. For basic examples you can also test background cancelation methods using the "Scan Background" or "Load Background" buttons.
Note that except for Power bins, Envelope and IQ, the GUI is loading examples from the examples/processing folder. If you modify code in those files, the changes will trickle down to the GUI once you reload it.
Large values for "Image history" (IQ and Envelope service) may slow down plotting severely.
EXPERIMENTAL deep learning:
If you want to test our new deep learning interface please install additional requirements
python -m pip install --user -r requirements_ml.txt
This will install Keras, TensorFlow and Scikit-learn. You can then start the machine learning GUI with
python gui/main.py -ml
Please keep in mind that the deep learning interface is WIP and documentation is not available at this point.
If you prefer using the command line for testing and evaluation of our examples you can use the following instructions.
XC111+XR111 or XC112+XR112 (mounted on a Raspberry Pi):
python examples/basic.py -s <your Raspberry Pi IP address>
XM112+XB112 via SPI over USB:
python examples/basic.py -spi
XM112+XB112 via UART over USB, autodetecting the serial port:
python examples/basic.py -u
XM112+XB112 via UART over USB, using a specific serial port:
python examples/basic.py -u <your XM112 COM port e.g. COM3>
Again, depending on your environment, you might have to replace python with python3 or py.
Choosing which sensor(s) to be used can be done by adding the argument --sensor <id 1> [id 2] .... The default is the sensor on port 1. This is not applicable for XM112.
Scripts can be terminated by pressing Ctrl-C in the terminal.
The basic scripts contains a lot of comments guiding you through the steps taken in most example scripts. We recommend taking a look at these scripts before working with the others.
basic.py
Basic script for getting data from the radar. Start here!basic_continuous.py
Basic script for getting data continuously that serves as the base for most other examples.
power_bin.py(doc)
Demonstrates the power bin service.envelope.py(doc)
Demonstrates the envelope service.iq.py(doc)
Demonstrates the IQ service.sparse.py(doc)
Demonstrates the Sparse service. Currently this is an experimental service, see more in the disclaimer.
presence_detection_sparse.py(doc)
An example of a presence/motion detection algorithm based on the sparse service.sparse_speed.py
An example of a speed detection algorithm estimating speeds of an approaching object based on the sparse service.sparse_fft.py
An example of a frequency analyzer to get an idea of the frequency content in the sparse service data.button_press.py(doc)
An example of a "button press" detection algorithm detecting a motion at short distances (~3-5 cm) based on the envelope service, which could be used as "hidden" touch buttons.obstacle_detection.py(doc)
An example of an obstacle detection algorithm estimating the distance and angle to an approaching obstacle.breathing.py
An example breathing detection algorithm.sleep_breathing.py(doc)
An example of a "sleep breathing" detection algorithm assuming that the person is still (as when in sleep) where only the motion from breathing is to be detected.phase_tracking.py(doc)
An example of a relative movements tracking algorithm using phase information.
plot_with_matplotlib.py
Example of how to use matplotlib for plotting.plot_with_mpl_process.py
Example of how to use the mpl_process (matplotlib process) module for plotting.plot_with_pyqtgraph.py
Example of how to use PyQtGraph for plotting.
The radar viewer visualizes the output from Acconeer's service API:s in your default browser.
Run the radar viewer using:
python radar_viewer/radar_viewer.py -u
The usage of arguments is the same as for the examples.
Here you find the disclaimer.
We've moved the FAQ to Read the Docs.