aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArturs Artamonovs <dos21h@gmail.com>2023-10-17 10:04:27 +0100
committerArturs Artamonovs <dos21h@gmail.com>2023-10-17 10:04:27 +0100
commitf6b6bf250ab979f6d9d1fffb95c3fa503aad44df (patch)
tree2b6ff08fc920aff0229cd1611b8e597f79f861a4
parent66483334eb744413dd70eedc3ce41c4547ee6ca0 (diff)
downloadpyairspyhf-f6b6bf250ab979f6d9d1fffb95c3fa503aad44df.tar.gz
pyairspyhf-f6b6bf250ab979f6d9d1fffb95c3fa503aad44df.zip
Update README
-rw-r--r--README.md40
1 files changed, 38 insertions, 2 deletions
diff --git a/README.md b/README.md
index f6c9a89..99941e8 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,8 @@ Checked supported and tested version list
To build the libairspyhf follow: https://github.com/airspy/airspyhf
-Workes localy
+Works with airspyhf master branch install. Master airspyhf version is 1.7.1,
+most distribution have tagged version of 1.6.8 beware when building master branch.
```
git clone https://github.com/airspy/airspyhf.git
cd airspyhf
@@ -47,6 +48,39 @@ udevadm control --reload-rules
# API
## libairspyhf
+Imported functions from libairspyhf library
+
+| Function declaration | Version |
+| --- | --- |
+| airspyhf_lib_version | |
+| airspyhf_list_devices | |
+| airspyhf_open | |
+| airspyhf_open_sn | |
+| airspyhf_open_fd | >= 1.7.1 |
+| airspyhf_close | |
+| airspyhf_get_output_size | |
+| airspyhf_start | |
+| airspyhf_stop | |
+| airspyhf_is_streaming | |
+| airspyhf_is_low_if | |
+| airspyhf_set_freq | |
+| airspyhf_set_freq_double | >= 1.7.1 |
+| airspyhf_set_lib_dsp | |
+| airspyhf_get_samplerates | |
+| airspyhf_set_samplerate | |
+| airspyhf_get_calibration | |
+| airspyhf_set_calibration | |
+| airspyhf_get_vctcxo_calibration | >= 1.7.1 |
+| airspyhf_set_vctcxo_calibration | >= 1.7.1 |
+| airspyhf_set_optimal_iq_correction_point | |
+| airspyhf_iq_balancer_configure | |
+| airspyhf_flash_calibration | |
+| airspyhf_version_string_read | |
+| airspyhf_set_hf_agc | |
+| airspyhf_set_hf_agc_threshold | |
+| airspyhf_set_hf_att | |
+| airspyhf_set_hf_lna | |
+
## AirSpyHF
# Examples
@@ -58,10 +92,12 @@ udevadm control --reload-rules
| Python | libairspyhf | OS | Status |
| --- |--- | --- | --- |
| 3.9, 3.10 | 1.7.1 | ArchLinux, Ubuntu 20.04 | Supported and tested |
-
+| 3.9, 3.10 | 1.6.8 | MacOS | Supported and tested |
## Install
+
+
## Links
https://docs.python.org/3/library/ctypes.html \ No newline at end of file