Skip to main content

An interface that enables the use of SCPI commands for the tinySA

Project description

tinySCPI

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

See the Commands documentation for each command and a description.

Table of Contents

  1. Getting Started

  2. Dependencies

  3. Unit Testing

  4. Coverage

  5. Contact Us

Getting Started

  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.

from tinyscpi import tinySCPI



print(tinySCPI.user_input("*IDN?"))
  1. Connect the tinySA device to your computer via USB. Your device should have come with said cable.

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

  1. Now you're ready to execute any of the commands located in the Command Tree!
  • If you're looking for a taste of what you're capable of with tinySCPI, see this Example Script

  • To see what other functions are a part of our library see the Class Documentation

Dependency:

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

pip install pyserial

pip install pytest

pip install pytest-cov

Unit Test:

pytest

Coverage:

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

Contact Us:

Email: tinyscpi@vt.edu

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tinyscpi-0.0.4.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

tinyscpi-0.0.4-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file tinyscpi-0.0.4.tar.gz.

File metadata

  • Download URL: tinyscpi-0.0.4.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for tinyscpi-0.0.4.tar.gz
Algorithm Hash digest
SHA256 fee6e0930383c2754d82d6bad6d9b35fe16a27c49841d600f12d39c95df95697
MD5 d3bff794724607f743cea9804ae9844f
BLAKE2b-256 3b2d44ce44ad07b435bc42978ee481c106e7e73e34ee3163b5842efad4bdead2

See more details on using hashes here.

File details

Details for the file tinyscpi-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: tinyscpi-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 22.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for tinyscpi-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8800cec8481dd35fa5588845a8a48d14d43beee59a2d94022d181bdc3b8493a9
MD5 b55f2c7259da3c64e4ad624e5bd2ac59
BLAKE2b-256 00017c6895df932efcc11cb074d7bf2b419734af563e108668b3aa8a0675b663

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page