Metadata-Version: 2.1
Name: tinyscpi
Version: 0.0.4
Summary: An interface that enables the use of SCPI commands for the tinySA
Author: tinySCPI Team
Author-email: <rndonovan1@gmail.com>
Keywords: python,scpi,interface,commands
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: pillow
Requires-Dist: wheel
Requires-Dist: setuptools
Requires-Dist: pyserial


# tinySCPI

A Python library that enables the use of SCPI commands on the tinySA.



See the [Commands](https://github.com/noldono/tinySCPI/blob/main/docs/Commands.md) documentation for each command and a description.



# Table of Contents



1. [**Getting Started**](#getting-started)

2. [**Dependencies**](#dependencies)

3. [**Unit Testing**](#unit-test)

4. [**Coverage**](#coverage)

5. [**Contact Us**](#contact)



## Getting Started <a name="getting-started"></a>

1. Create a new Python file.

2. In your terminal/command line, install the tinySCPI library by typing `pip install tinyscpi`

3. Copy and paste the below code into your Python file.

```python

from tinyscpi import tinySCPI



print(tinySCPI.user_input("*IDN?"))

```

4. Connect the tinySA device to your computer via USB. Your device should have come with said cable.

5. Run the file using the line below. Ensure your command-line/terminal is in the same path as your Python file!

```

python3 <name_of_your_file>.py

```

This should return something similar to this, it will usually be specific to your device but in a similar format:

```

Running info 

tinySA v0.3

2019-2022 Copyright @Erik Kaashoek

2016-2020 Copyright @edy555

SW licensed under GPL. See: https://github.com/erikkaashoek/tinySA

Version: tinySA_v1.3-506-g8291e1e

Build Time: Nov 28 2022 - 14:01:16

Kernel: 4.0.0

Compiler: GCC 7.2.1 20170904 (release) [ARM/embedded-7-branch revision 255204]

Architecture: ARMv6-M Core Variant: Cortex-M0

Port Info: Preemption through NMI

Platform: STM32F072xB Entry Level Medium Density devices

ESD protected

```

6. Now you're ready to execute any of the commands located in the [Command Tree](https://github.com/noldono/tinySCPI/blob/main/docs/Commands.md)!



- If you're looking for a taste of what you're capable of with tinySCPI, see this [Example Script](https://github.com/noldono/tinySCPI/blob/main/examples/example_script.txt)

- To see what other functions are a part of our library see the [Class Documentation](https://github.com/noldono/tinySCPI/blob/main/docs/Class_Documentation.md)



## Dependency: <a name="dependencies"></a>

tinySCPI requires python >= 3.6, pyserial, pytest, and pytest-cov



```pip install pyserial```

```pip install pytest```

```pip install pytest-cov```



## Unit Test: <a name="unit-test"></a>

```pytest```



## Coverage: <a name="coverage"></a>

```pytest --cov-config=.coveragerc --cov=tinyscpi tinyscpi/tests/ --cov-report html ```



## Contact Us: <a name="contact"></a>

Email: tinyscpi@vt.edu

