| Name | tinyscpi JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | |
| Summary | An interface that enables the use of SCPI commands for the tinySA |
| upload_time | 2023-11-13 20:30:55 |
| maintainer | |
| docs_url | None |
| author | tinySCPI Team |
| requires_python | |
| license | |
| keywords |
python
scpi
interface
commands
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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)
6. [**Safety**](#safety)
7. [**Output**](#output)
## 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``` is required to execute unit tests.
You can install pytest library by typing `pip install pytest` in your terminal/command line
You can execute unit tests by typing `pytest` in your terminal/command line root directoryscpi`
## Coverage: <a name="coverage"></a>
`pytest` and `pytest-cov` are required to execute code coverage analysis.
You can install pytest andn pytest-ocv library by typing `pip install pytest pytest-cov` in your temrinal/command line.
You can execute unit tests by typing `pytest --cov-config=.coveragerc --cov=tinyscpi tinyscpi/tests/ --cov-report html`
After the execution you will be able to find the coverage report at `./htmlcov/index.html`
## Contact Us: <a name="contact"></a>
Email: tinyscpi@vt.edu
## Safety: <a name="safety"></a>
Like with all RF devices, there involves some risk in operation. For more information, please refer to [Safety](https://github.com/noldono/tinySCPI/blob/main/SAFETY.md).
## Output: <a name="output"></a>
On older firmware, output mode control over serial may not be stable and can return the "FATAL ERROR" message on screen. [Updating to a newer firmware](https://github.com/noldono/tinySCPI/blob/main/docs/tinySA_Firmware_Update_Manual.pdf) seems to resolve this issue.
Raw data
{
"_id": null,
"home_page": "",
"name": "tinyscpi",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,scpi,interface,commands",
"author": "tinySCPI Team",
"author_email": "<rndonovan1@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/de/78/ada436e499970f54ac731908581a340b196e1d15490987af6534b8e55838/tinyscpi-1.0.1.tar.gz",
"platform": null,
"description": "# tinySCPI\nA Python library that enables the use of SCPI commands on the tinySA.\n\nSee the [Commands](https://github.com/noldono/tinySCPI/blob/main/docs/Commands.md) documentation for each command and a description.\n\n# Table of Contents\n\n1. [**Getting Started**](#getting-started)\n2. [**Dependencies**](#dependencies)\n3. [**Unit Testing**](#unit-test)\n4. [**Coverage**](#coverage)\n5. [**Contact Us**](#contact)\n6. [**Safety**](#safety)\n7. [**Output**](#output) \n\n## Getting Started <a name=\"getting-started\"></a>\n1. Create a new Python file.\n2. In your terminal/command line, install the tinySCPI library by typing `pip install tinyscpi`\n3. Copy and paste the below code into your Python file.\n```python\nfrom tinyscpi import tinySCPI\n\nprint(tinySCPI.user_input(\"*IDN?\"))\n```\n4. Connect the tinySA device to your computer via USB. Your device should have come with said cable.\n5. Run the file using the line below. Ensure your command-line/terminal is in the same path as your Python file!\n```\npython3 <name_of_your_file>.py\n```\nThis should return something similar to this, it will usually be specific to your device but in a similar format:\n```\nRunning info \ntinySA v0.3\n2019-2022 Copyright @Erik Kaashoek\n2016-2020 Copyright @edy555\nSW licensed under GPL. See: https://github.com/erikkaashoek/tinySA\nVersion: tinySA_v1.3-506-g8291e1e\nBuild Time: Nov 28 2022 - 14:01:16\nKernel: 4.0.0\nCompiler: GCC 7.2.1 20170904 (release) [ARM/embedded-7-branch revision 255204]\nArchitecture: ARMv6-M Core Variant: Cortex-M0\nPort Info: Preemption through NMI\nPlatform: STM32F072xB Entry Level Medium Density devices\nESD protected\n```\n6. 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)!\n\n- 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)\n- 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)\n\n## Dependency: <a name=\"dependencies\"></a>\ntinySCPI requires python >= 3.6, pyserial, pytest, and pytest-cov\n\n```pip install pyserial```\n```pip install pytest```\n```pip install pytest-cov```\n\n## Unit Test: <a name=\"unit-test\"></a>\n```pytest``` is required to execute unit tests.\n\nYou can install pytest library by typing `pip install pytest` in your terminal/command line\n\nYou can execute unit tests by typing `pytest` in your terminal/command line root directoryscpi`\n\n## Coverage: <a name=\"coverage\"></a>\n`pytest` and `pytest-cov` are required to execute code coverage analysis. \n\nYou can install pytest andn pytest-ocv library by typing `pip install pytest pytest-cov` in your temrinal/command line.\n\nYou can execute unit tests by typing `pytest --cov-config=.coveragerc --cov=tinyscpi tinyscpi/tests/ --cov-report html`\n\nAfter the execution you will be able to find the coverage report at `./htmlcov/index.html`\n\n## Contact Us: <a name=\"contact\"></a>\nEmail: tinyscpi@vt.edu\n\n## Safety: <a name=\"safety\"></a>\nLike with all RF devices, there involves some risk in operation. For more information, please refer to [Safety](https://github.com/noldono/tinySCPI/blob/main/SAFETY.md).\n\n## Output: <a name=\"output\"></a>\nOn older firmware, output mode control over serial may not be stable and can return the \"FATAL ERROR\" message on screen. [Updating to a newer firmware](https://github.com/noldono/tinySCPI/blob/main/docs/tinySA_Firmware_Update_Manual.pdf) seems to resolve this issue.\n",
"bugtrack_url": null,
"license": "",
"summary": "An interface that enables the use of SCPI commands for the tinySA",
"version": "1.0.1",
"project_urls": null,
"split_keywords": [
"python",
"scpi",
"interface",
"commands"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "64a0e57776e0a86f5e784dac97cfb49077e8d5c3bee8f1ab1a13c6798bbc7225",
"md5": "3116e358d6578824cc152c863efec18c",
"sha256": "9529b126b9280b105a6532aa741934be28a126d40fe2f6e3ef362af2e864f737"
},
"downloads": -1,
"filename": "tinyscpi-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3116e358d6578824cc152c863efec18c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22865,
"upload_time": "2023-11-13T20:30:51",
"upload_time_iso_8601": "2023-11-13T20:30:51.011969Z",
"url": "https://files.pythonhosted.org/packages/64/a0/e57776e0a86f5e784dac97cfb49077e8d5c3bee8f1ab1a13c6798bbc7225/tinyscpi-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de78ada436e499970f54ac731908581a340b196e1d15490987af6534b8e55838",
"md5": "8d752f371252517d97113ca92d0fce06",
"sha256": "5299e049732bbba7053d46a009d2c220403436695926b3b3a24d198861b0f352"
},
"downloads": -1,
"filename": "tinyscpi-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8d752f371252517d97113ca92d0fce06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22451,
"upload_time": "2023-11-13T20:30:55",
"upload_time_iso_8601": "2023-11-13T20:30:55.110441Z",
"url": "https://files.pythonhosted.org/packages/de/78/ada436e499970f54ac731908581a340b196e1d15490987af6534b8e55838/tinyscpi-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 20:30:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tinyscpi"
}
