|
5 | 5 | #IN PROGRESS! The dev branch is not stable. refer to the main branch for the current stable version of the code |
6 | 6 |
|
7 | 7 |
|
| 8 | + |
8 | 9 | A Non-GUI Python API for the tinySA series of devices. This repository uses official resources and documentation but is NOT endorsed by the official tinySA product or company. See the[references](#references) section for further reading. See the[official tinySA resources](https://www.tinysa.org/wiki/) for device features. |
9 | 10 |
|
10 | | -This library covers most documented commands for the tinySA device series, and is planned to include device-specific commands and memory. The documentation (after the examples) is sorted based on the serial command for the device, with some provided usage examples. While some error checking exists in both the device and the library, it is not exhaustive. It is stronglysuggested to read the official documentation before attempting to script with your device. |
| 11 | +This library covers most documented commands for the tinySA device series, and is planned to includeconfigurable,device-specific commands and memory. The documentation (after the examples) is sorted based on the serial command for the device, with some provided usage examples. While some error checking exists in both the device and the library, it is not exhaustive. It is stronglyadvised to read the official documentation before attempting to script with yourtinySAdevice. Operating the device experimentally or without referencing the official documents runs the risk of**destroying your device**. See the[tinySA First use page](https://tinysa.org/wiki/pmwiki.php?n=Main.FirstUse) for some setup tips and warnings. |
11 | 12 |
|
12 | | -This README provides example code for connecting to the device, scanning and plotting data, saving to CSV, and creating real-time waterfall plots. Examples are not exhaustive. Refer to the[List of tinySA Commands and their Library Commands](#list-of-tinysa-commands-and-their-library-commands) for all of the tested commands for this library. |
| 13 | +This README provides example code for connecting to the device, scanning and plotting data, saving to CSV, and creating real-time waterfall plots. Examples are not exhaustive. Refer to the[List of tinySA Commands and their Library Commands](#list-of-tinysa-commands-and-their-library-commands) for all of the tested commands for this library.Alias functions have been provided for convenience, but are not exhaustive. |
13 | 14 |
|
14 | 15 | If you are interested in developing the PyPI package, or making a custom local version, see[Library Development](#library-development) towards the end of this README. |
15 | 16 |
|
16 | 17 |
|
| 18 | + |
17 | 19 | ##Table of Contents |
18 | 20 | *[The tinySA Series of Devices](#the-tinysa-series-of-devices) |
19 | 21 | *[Library Usage](#library-usage) |
|