aboutsummaryrefslogtreecommitdiff
path: root/man/aeroup.man.txt
blob: 7b938583295c7b98df874971cac8b0ad269b7580 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
man(1)                             AeroUp man page                             man(1)



NAME
       AeroUp


SYNOPSIS
       aeroup  [-t  serialPort]  [-o  serialPort]  [-c red,green,blue,serialPort] [-G
       serialPort] [-S serialNumber,serialPort] [-i gloFile] [-u  gloFile,serialPort]
       [-U glocFile,serialPort] [-P] [-v] [-h]



DESCRIPTION
       AeroUp  is  an open source command line tool to control Ultimate (programmable
       light sequencing juggling props) from Aerotech Projects.


OPTIONS
       -t, --test=serialPort
              Send a test command on dev serialPort.


       -o, --start=serialPort
              Send a start sequence command on dev serialPort.


       -c, --color=red,green,blue,serialPort
              Send a color command on dev serialPort.
              Colors red, green, blue can be hexadecimal or decimal value in range of [0-255]
              hex value have to begin with 0x.


       -G, --getSerial=serialPort
              get serial number on dev serialPort, and print it to standard output.



       -S, --setSerial=serialNumber,serialPort
              Set serialNumber on dev serialPort.
              32 bits value can be writen in hexadecimal (0x#) or decimal (#).


       -i, --verify=gloFile
              Verify that syntax glo file is valid


       -u, --uploadGlo=gloFile,serialPort
              Verify that syntax glo file is valid and if this is the case upload  it
              on dev serialPort



       -k --symlink
              return  the  serial  name  used as symlink of kernel name by udev (work
              with linux only). see the improved  management  driver  section  below.
              But  you can also use this command to retrieve an more readable id than
              serial number.


       Improved management driver (linux only)
              note: you may need to update to last   bootloader  (aeroup  was  tested
              with  Club_Ball_Poi_V2.3.hex).  you 'll find it on the Aerotech ltd web
              page.

              To use the system management driver, you first need to set the apropri‐
              ate  serial  number in your props with the --setSerial option. (See the
              address table belowx).  And put the file aeroup.rule to your udev rules
              directory  if  it  wasn't done during installation.  When you plug your
              props you should now have a corresponding symlink to your  /dev  direc‐
              tory.

              ================================================
                Props | Range adress  | id char | Symlinks
              ================================================
                Ball  | 0.0.98.0/24   | b       | /dev/Ball#
                Staff | 0.0.115.0/24  | s       | /dev/Staff#
                Club  | 0.0.99.0/24   | c       | /dev/Club#
                Poi   | 0:0:112:0/24  | p       | /Poi/Poi#
              ================================================



       -P, --thread
              Multithread mode, not implemented yet...


       -U, --uploadGloc=glocFile,serialPort
              not implemented yet...


       -v     Verbose mode


       -h, --help
              Print help


       --version
              Print version

       The last bootloader V2.3 from Aerotech needs to be installed first to use Serial number features.
       Each sub options have to be separate with a comma without blank.



EXAMPLES
       aeroup -t /dev/ttyACM0
       aeroup -o /dev/ttyACM0 -o /dev/ttyACM1 -t /dev/ttyACM3
       aeroup -c 255,69,255,/dev/ttyACM0 27,3,7,/dev/ttyACM1
       aeroup -S 0x0b01/dev/ttyACM0
       aeroup -G /dev/ttyACM0



SEE ALSO
       AeroUp project page : https://github.com/LaurentBa/AeroUp
       AeroWrite project page : https://github.com/LaurentBa/AeroWrite

AUTHOR
       Written by Laurent Barattero (laurent@larueluberlu.net.in)


COPYRIGHT
       Copyright © 2013 BARATTERO Laurent License GPLv3+: GNU GPL  version 3 or later
       <http://gnu.org/licenses/gpl.html>.
       This  is  free software: you are free to change and redistribute it.  There is
       NO WARRANTY, to the extent permitted by law.










0.8                                 December 2013                              man(1)