Skip to content

Commit 344d758

Browse files
Update README.md
1 parent aff20d6 commit 344d758

File tree

1 file changed

+10
-19
lines changed

1 file changed

+10
-19
lines changed

README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -62,44 +62,35 @@ Once you have your connected node bound, you can call its status, reset and logg
6262

6363

6464

65-
To create [Muscle](#muscle-commands)-class objects, start by calling tf.muscle(). This is where you need input your *idnum*, *resistance*, *length*, and *diameter* values if you have them.
65+
To create [Muscle](#muscle-commands)-class objects, start by calling tf.muscle(). Input the "idnum" which is the port on the Node controller that the muscle is plugged into.
6666

6767

6868
``` Python
69-
muscle1 = tf.muscle(idnum = 0, resist= 300, diam= 2, length= 150)
70-
muscle2 = tf.muscle(idnum = 1, resist= 290, diam= 2, length= 145)
69+
muscle1 = tf.muscle(idnum = 0)
70+
muscle2 = tf.muscle(idnum = 1)
7171
```
7272

73-
Note that the *idnum* field is the only field that is neccesary for creating the [Muscle](#muscle-commands)-object.
74-
75-
Next, assign the muscle objects to a node object by calling the .setMuscle() command. This command takes the identification number and the muscle object as arguments
73+
Next, assign the muscle objects to a node object by calling the .setMuscle() command. This command takes the port number and the muscle object as arguments
7674

7775
```Python
7876
node0.setMuscle(0, muscle1)
7977
node0.setMuscle(1, muscle2)
8078
```
8179

82-
Sessions are automatically created and create a filesystem that exports to a higher level folder. Sessions track the incoming and outgoing serial data and saves it to a .ses file and a .txt file. The .txt files are generated as plain messages, where as the .ses files have serialized messages.
83-
84-
```Python
85-
sessionl = tf.Session.sessionl
86-
session1 = session[0]
87-
```
88-
89-
From here, you can add commands to your command buffer. [Node Commands](#node-commands)
90-
91-
These commands should be in the format,
80+
These commands should be in the following format, either referencing a `Muscle` object or a `Node` object:
9281

9382
```Python
9483
node0.enable(muscle1)
84+
# or
85+
muscle1.enable()
9586
```
9687

97-
The muscle objects also have their own commands that are passed to their commanding node.[Muscle Commands](#muscle-commands)
88+
Full list of Muscle Commands: [Muscle Commands](#muscle-commands)
9889

9990

100-
## Program Commands
91+
## Library Functions
10192

102-
| **Program Commands** | **Function** |
93+
| **Program Function** | **Description** |
10394
| --------------------- | ----------------------------------------------------------------------- |
10495
| discover(*prodid*) | finds connected nodes from the product id (*prodid*) |
10596
| update() | updates all of the networks |

0 commit comments

Comments
 (0)