Example Scripts#
Some great examples to get started with the Python API are:
If you followed Source Installation in Exploration Tool Installation, you can
view, edit, and run the examples under the examples/ folder.
If you followed Python Package (PyPi) you can download each example directly from
examples/ on GitHub or each examples’ page here.
Some examples are meant to be edited directly and does not support command line arguments, but most examples do. The majority of the examples can be run against our modules via a common set of command line arguments:
Tip
If an example supports command line arguments, you can see them by running:
python <some_example.py> --help
A121 Examples’ Command Line Arguments#
The examples in the examples/a121/ folder support the common command line arguments:
python <some_example.py> --serial-port COMX
python <some_example.py> --ip-address <ip-address of, for example, a Raspberry Pi>
python <some_example.py> --usb-device
Complete list of example scripts
- App Example Scripts
- Bilateration Example Scripts
- Breathing Example Scripts
- Distance Example Scripts
- Hand Motion Example Scripts
- Obstacle Example Scripts
- Phase Tracking Example Scripts
- Presence Example Scripts
- Python API Example Scripts
- examples/a121/basic.py
- examples/a121/extended_config.py
- examples/a121/load_record.py
- examples/a121/plot.py
- examples/a121/post_process_sparse_iq.py
- examples/a121/record_data/barebones.py
- examples/a121/record_data/with_cli.py
- examples/a121/reuse_calibration.py
- examples/a121/stress.py
- examples/a121/subsweeps.py
- Smart Presence Example Scripts
- Speed Example Scripts
- Surface Velocity Example Scripts
- Tank Level Example Scripts
- Touchless Button Example Scripts
- Vibration Example Scripts
- Waste Level Example Scripts