Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitf5b3ee5

Browse files
committed
README org update
1 parent1e577a6 commitf5b3ee5

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

‎README.md‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@
55
#IN PROGRESS! The dev branch is not stable. refer to the main branch for the current stable version of the code
66

77

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.
99

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.
1011

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.
1215

1316

1417
##Table of Contents
1518
*[The tinySA Series of Devices](#the-tinysa-series-of-devices)
1619
*[Library Usage](#library-usage)
1720
*[Requirements](#requirements)
18-
*[Library Development](#library-development)
1921
*[Error Handling](#error-handling)
2022
*[Example Implementations](#example-implementations)
2123
*[Finding the Serial Port](#finding-the-serial-port)
@@ -39,6 +41,7 @@ This library covers most documented commands for the tinySA device series. The d
3941
*[List of tinySA Commands and their Library Commands](#list-of-tinysa-commands-and-their-library-commands)
4042
*[List of Commands Removed from Library](#list-of-commands-removed-from-library)
4143
*[Additional Library Functions for Advanced Use](#additional-library-functions-for-advanced-use)
44+
*[Library Development](#library-development)
4245
*[Notes for Beginners](#notes-for-beginners)
4346
*[Vocab Check](#vocab-check)
4447
*[Calibration Setup](#calibration-setup)
@@ -150,7 +153,6 @@ pip install pyserial numpy pandas matplotlib pillow pyQt5
150153

151154

152155

153-
##Library Development
154156

155157

156158

@@ -2546,6 +2548,13 @@ Other commands: version reset data frequencies scan hop scanraw test touchcal to
25462548
***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.
25472549

25482550

2551+
2552+
##Library Development
2553+
2554+
2555+
2556+
2557+
25492558
##Notes for Beginners
25502559

25512560
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_.

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp