Skip to content

to staging #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 13 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .github/workflows/testpypublish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
uses: actions/upload-artifact@v4
with:
name: release-dists
path: dist/
path: python-serial/dist/

testpypi-publish:
runs-on: ubuntu-latest
Expand All @@ -52,7 +52,7 @@ jobs:
environment:
name: pypi
# OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
url: https://pypi.org/p/thermo/
url: https://test.pypi.org/p/thermo/
#
# ALTERNATIVE: if your GitHub Release name is the PyPI project version string
# ALTERNATIVE: exactly, uncomment the following line instead:
Expand All @@ -64,8 +64,9 @@ jobs:
with:
name: release-dists
path: python-serial/dist/

- name: Publish release distributions to PyPI
- name: Publish distribution 📦 to TestPyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
repository-url: https://test.pypi.org/legacy/
packages-dir: python-serial/dist/
280 changes: 151 additions & 129 deletions README.md

Large diffs are not rendered by default.

182 changes: 96 additions & 86 deletions docs/Thermoflex Glossary.md

Large diffs are not rendered by default.

82 changes: 41 additions & 41 deletions python-serial/Getting Started.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
# Getting Started

#### System Requirements

- Python 3.12 or greater
- Pyserial 3.5 or greater

## Introduction

###### The Thermoflex muscle is a current activated artificial muscle that is designed to have a low profile usage and simple activation and deactivation sequence. The purpose of this library is 2-fold; to become the working backend of the Delta hardware application and to allow for open-source development of the Nitinol muscle.

## First steps

Ensure that you have a Node and Muscle device.

Install the thermoflex library. You can do this 3 different ways.
1. Type this command into Powershell

```
pip install thermoflex
```
2. From the thermoflex repository, download the python-serial folder,cd to the build folder, and type this command.

```bash
pip install thermoflex-0.0.3.tar.gz
```
3. After downloading the thermoflex repository, cd into the folder and type this command

```bash
pip install python-serial/
```

After installing the library, connect the Muscle to the Node and the Node to the computer.

There is an example python script muscle-simple.py in the getting started folder to help you understand the flow of the system.
Simply run the file and the muscle should contract, update for 5 seconds, and then release. Then the program will end.

The README in the thermoflex repository has a glossary containing all of the working commands.
### System Requirements
- Python 3.12 or greater
- Pyserial 3.5 or greater
## Introduction
The Thermoflex muscle is a current activated artificial muscle that is designed to have a low profile usage and simple activation and deactivation sequence. The purpose of this library is 2-fold; to become the working backend of the Delta hardware application and to allow for open-source development of the Nitinol muscle.
## First steps
Ensure that you have a Node and Muscle device.
Install the thermoflex library. You can do this 3 different ways.
1. Type this command into Powershell
```
pip install thermoflex
```
2. From the thermoflex repository, download the [python-serial](https://github.com/Delta-Robotics-Inc/ThermoFlex-Python-API/tree/main/python-serial) folder,cd to the build folder, and type this command.
```bash
pip install python-serial/
```
3. Download the latest release from [Github Releases](https://github.com/Delta-Robotics-Inc/ThermoFlex-Python-API/releases), cd into the folder and type this command
```bash
pip install thermoflex-1.0.1.tar.gz
```
*The version number is subject to change*
After installing the library, connect the Muscle to the Node and the Node to the computer.
There is an example python script [muscle-simple.py](https://github.com/Delta-Robotics-Inc/ThermoFlex-Python-API/blob/main/getting-started/muscle-simple.py) in the getting started folder to help you understand the flow of the system.
Simply run the file and the muscle should contract, update for 5 seconds, and then release. Then the program will end.
There is a [Glossary](https://github.com/Delta-Robotics-Inc/ThermoFlex-Python-API/blob/main/docs/Thermoflex%20Glossary.md) of the working commands and features in the library.
2 changes: 2 additions & 0 deletions python-serial/INSTALL INSTRUCTIONS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
copy the path to the .tar file from the staging/build/dist directory. This is the $SRC
From powershell, Type 'pip install $SRC/thermoflex-0.0.3.tar'
41 changes: 0 additions & 41 deletions python-serial/README.md

This file was deleted.

5 changes: 3 additions & 2 deletions python-serial/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "thermoflex"
name = "thermo"
version = "1.0.0"
authors = [{name = "Marvin S", email = "[email protected]"}, {name = "Mark D", email = "[email protected]"} ]
authors = [{name = "Marvin Stephens", email = "[email protected]"}, {name = "Mark D", email = "[email protected]"}]

readme = "README.md"
dependencies = ['pyserial == 3.5','protobuf == 5.28.3', 'pandas == 2.2.3']
description = "This is the library for controlling the ThermoFlex muscle system by Delta Robotics"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
```
pip install $filepath\dist\thermoflex-0.0.1.tar.gz
```

use this command in powershell or python terminal.
$filepath is the path to the dist\ folder in python-serial
Binary file not shown.
Binary file not shown.
6 changes: 6 additions & 0 deletions python-serial/staging/src/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

from .sessions import *

#my library is the brains of the operation. Everything happens here.
#make Markdown file
#Getting Started, Markdown with commands, Basic tutorial
Loading
Loading