Skip to content

Commit c78a42c

Browse files
committed
finalized file cleaning and documentation
1 parent 44b4093 commit c78a42c

File tree

6 files changed

+2
-49
lines changed

6 files changed

+2
-49
lines changed

README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,6 @@ node0.enable(muscle1)
9696

9797
The muscle objects also have their own commands that are passed to their commanding node.[Muscle Commands](#muscle-commands)
9898

99-
Developer install instructions
100-
101-
for testing purposes, use the command
102-
```
103-
pip install -e $SRC
104-
```
105-
with $SRC being the path to the [python-serial](python-serial/) folder. This will install the files as a test library.
10699

107100
## Program Commands
108101

Binary file not shown.
-20.9 KB
Binary file not shown.
Binary file not shown.
20.4 KB
Binary file not shown.
Lines changed: 2 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Metadata-Version: 2.1
1+
Metadata-Version: 2.2
22
Name: thermoflex
3-
Version: 0.0.1
3+
Version: 1.0.1
44
Summary: This is the library for controlling the ThermoFlex muscle system by Delta Robotics
55
Author-email: Marvin S <[email protected]>, Mark D <[email protected]>
66
Project-URL: Homepage, https://www.deltaroboticsinc.com/
@@ -13,43 +13,3 @@ License-File: LICENSE.txt
1313
Requires-Dist: pyserial==3.5
1414
Requires-Dist: protobuf==5.28.3
1515
Requires-Dist: pandas==2.2.3
16-
17-
#### System Requirements
18-
19-
- Python 3.12 or greater
20-
- Pyserial 3.5 or greater
21-
22-
## Introduction
23-
24-
###### 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.
25-
26-
## First steps
27-
28-
Ensure that you have a Node and Muscle device.
29-
30-
Install the thermoflex library. You can do this 3 different ways.
31-
32-
1. Type this command into Powershell
33-
34-
```
35-
pip install thermoflex
36-
```
37-
38-
2. From the thermoflex repository, download the python-serial folder,cd to the build folder, and type this command.
39-
40-
```bash
41-
pip install thermoflex-0.0.3.tar.gz
42-
```
43-
44-
3. After downloading the thermoflex repository, cd into the folder and type this command
45-
46-
```bash
47-
pip install python-serial/
48-
```
49-
50-
After installing the library, connect the Muscle to the Node and the Node to the computer.
51-
52-
There is an example python script muscle-simple.py in the getting started folder to help you understand the flow of the system.
53-
Simply run the file and the muscle should contract, update for 5 seconds, and then release. Then the program will end.
54-
55-
The README in the thermoflex repository has a glossary containing all of the working commands.

0 commit comments

Comments
 (0)