|
1 |
|
2 --**-- Quick reference guide for UCCS Commands (more for programmers) --**-- |
|
3 |
|
4 |
|
5 (2) UC_QUIT |
|
6 |
|
7 Stops the script thread. It sets a flag which prevents the remote control from |
|
8 waiting on the rendezvous semaphore again (since it will block forever) and |
|
9 signals the rendezvous semaphore to release it if that's where it is now. This |
|
10 does not stop the use-case -- it will keep running until the device side runs |
|
11 end use case. |
|
12 |
|
13 |
|
14 (3) UC_RUNCMD |
|
15 |
|
16 Runs the command. Does lots of stuff. |
|
17 |
|
18 |
|
19 (4) UC_ASSIGN |
|
20 |
|
21 Adds the specified elements to the environment object. This is then used by the |
|
22 parser in future commands. |
|
23 |
|
24 |
|
25 (5) UC_WAITFOR |
|
26 |
|
27 Waits for fields of the last reply to be at a certain value. It checks the value |
|
28 of the fields, and if they are not equal then it goes back to the last runcmd |
|
29 and runs all subsequent commands. |
|
30 |
|
31 FIXME: need to check what happens if there haven't been any runcmd's yet -- both |
|
32 in the case that this is the first command, and when this is not the first but |
|
33 the previous are all non-runcmd |
|
34 |
|
35 |
|
36 (6) UC_WAITFORSIGNAL |
|
37 |
|
38 Waits for a signal from the device |
|
39 |
|
40 |
|
41 (7) UC_RENDEZVOUS |
|
42 |
|
43 Rendezvous with the device |
|
44 |
|
45 |
|
46 (8) UC_REQUIRE |
|
47 |
|
48 Require a field to be a particular value. If the field is not correct then this is equivalent |
|
49 to a quit command. |
|
50 |
|
51 |
|
52 (9) UC_REQUIRENOT |
|
53 |
|
54 Same as above however the logical not |
|
55 |
|
56 |
|
57 (10) UC_CHECK |
|
58 |
|
59 Checks that a field is a particular value. It differs from require in that if the condition |
|
60 is not met, the script continues to run, however, a warning is output. |
|
61 |
|
62 |
|
63 (11) UC_CHECKNOT |
|
64 |
|
65 Logical not of the above operation. |
|
66 |
|
67 |
|
68 (12) UC_PRINTENVIRONMENT |
|
69 |
|
70 Prints out all the environment variables. |
|
71 |
|
72 |
|
73 (13) UC_WAITFORNOT |
|
74 |
|
75 Same as waitfor but not. |
|
76 |
|
77 |
|
78 (14) UC_SIGNAL |
|
79 |
|
80 Signal to device. |