You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,19 @@
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
-
A Non-GUI Python APIclassfor 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.
8
+
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
9
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 strongly suggested to read the official documentation before attempting to script with your device.
10
11
11
-
This library covers most documented commands for the tinySA device series. The documentation is sorted based on the serial command, with some provided usage examples. While some error checking exists in both the device and the library, it is not exhaustive. It is strongly suggested to read the official documentation before attempting to script with your device.
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
+
14
+
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.
12
15
13
16
14
17
##Table of Contents
15
18
*[The tinySA Series of Devices](#the-tinysa-series-of-devices)
@@ -2546,6 +2548,13 @@ Other commands: version reset data frequencies scan hop scanraw test touchcal to
2546
2548
***Notes:** If unfamiliar with device and operation, DO NOT USE THIS. There is no error checking and you will be interfacing with the tinySA device directly.
2547
2549
2548
2550
2551
+
2552
+
##Library Development
2553
+
2554
+
2555
+
2556
+
2557
+
2549
2558
##Notes for Beginners
2550
2559
2551
2560
This is a brief section for anyone that might have jumped in with a bit too much ambition. It is highly suggested to_read the manual_.