From 45ab288c8256f2787e7bf694c7a48888592be4cd Mon Sep 17 00:00:00 2001 From: Barattero Laurent Date: Sat, 18 Jan 2014 10:24:55 +0100 Subject: first commit release 0.2 --- man/aeroup.man | 123 ++++++++++++++++++++++++++++++++++++++++++++++++++++ man/aeroup.man.html | 72 ++++++++++++++++++++++++++++++ man/aeroup.man.txt | 95 ++++++++++++++++++++++++++++++++++++++++ man/man.html | 67 ++++++++++++++++++++++++++++ 4 files changed, 357 insertions(+) create mode 100644 man/aeroup.man create mode 100644 man/aeroup.man.html create mode 100644 man/aeroup.man.txt create mode 100644 man/man.html (limited to 'man') diff --git a/man/aeroup.man b/man/aeroup.man new file mode 100644 index 0000000..ab78499 --- /dev/null +++ b/man/aeroup.man @@ -0,0 +1,123 @@ +.\" Manpage for AeroUp. +.\" Contact laurentba@larueluberlu.net.in to correct errors or typos. +.TH man 1 "December 2013" "0.8" "AeroUp man page" + +.SH NAME +AeroUp + +.SH SYNOPSIS +.B aeroup +[-t \fIserialPort] +[-o \fIserialPort] +[-c \fIred,\fIgreen\fR,\fIblue\fR,\fIserialPort\fR] +[-G \fIserialPort\fR] +[-S \fIserialNumber\fR,\fIserialPort\fR] +[-i \fIgloFile\fR] +[-u \fIgloFile\fR,\fIserialPort\fR] +[-U \fIglocFile\fR,\fIserialPort\fR] +[-P] +[-v] +[-h] + + +.SH DESCRIPTION +AeroUp is an open source command line tool to control Ultimate (programmable light sequencing juggling props) from Aerotech Projects. + +.SH OPTIONS +.TP +\fB\-t\fR, \fB\-\-test\fR=\fIserialPort\fR +Send a test command on dev \fIserialPort\fR. + +.TP +\fB\-o\fR, \fB\-\-start=\fIserialPort\fR +Send a start sequence command on dev \fIserialPort\fR. + +.TP +\fB\-c\fR, \fB\-\-color\fR=\fIred\fR,\fIgreen\fR,\fIblue\fR,\fIserialPort\fR +.nf +Send a color command on dev \fIserialPort\fR. +Colors \fIred\fR, \fIgreen\fR, \fIblue\fR can be hexadecimal or decimal value in range of [0-255] +hex value have to begin with 0x. +.fi + +.TP +\fB\-G\fR, \fB\-\-getSerial=\fIserialPort\fR +get serial number on dev \fIserialPort\fR, and print it to standard output. + + +.TP +.nf +\fB\-S\fR, \fB\-\-setSerial\fR=\fIserialNumber\fR,\fIserialPort\fR +Set \fIserialNumber\fR on dev \fIserialPort\fR. +32 bits value can be writen in hexadecimal (0x#) or decimal (#). +.fi + +.TP +.nf +\fB\-i\fR, \fB\-\-verify\fR=\fIgloFile\fR +Verify that syntax glo file is valid + +.TP +.nf +\fB\-u\fR, \fB\-\-uploadGlo\fR=\fIgloFile\fR,\fIserialPort\fR +Verify that syntax glo file is valid and if this is the case upload it on dev \fIserialPort\fR + +.TP +.nf +\fB\-P\fR, \fB\-\-thread\fR +Multithread mode, not implemented yet... + +.TP +.nf +\fB\-U\fR, \fB\-\-uploadGloc\fR=\fIglocFile\fR,\fIserialPort\fR +not implemented yet... + +.TP +.nf +\fB\-v\fR +Verbose mode + +.TP +.nf +\fB\-h\fR, \fB\-\-help\fR +Print help + +.TP +.nf +\fB\-\-version\fR +Print version +.PP +The last bootloader V2.3 from Aerotech needs to be installed first to use Serial number features. +.br +Each sub options have to be separate with a comma without blank. + + +.SH EXAMPLES +aeroup -t /dev/ttyACM0 +.br +aeroup -o /dev/ttyACM0 -o /dev/ttyACM1 -t /dev/ttyACM3 +.br +aeroup -c 255,69,255,/dev/ttyACM0 27,3,7,/dev/ttyACM1 +.br +aeroup -S 0x0b01/dev/ttyACM0 +.br +aeroup -G /dev/ttyACM0 +.br + + +.SH SEE ALSO +AeroUp project page : https://github.com/LaurentBa/AeroUp +.br +AeroWrite project page : https://github.com/LaurentBa/AeroWrite +\#.SH BUGS +\#No known bugs. +.SH AUTHOR +Written by Laurent Barattero (laurent@larueluberlu.net.in) + +.SH COPYRIGHT +Copyright © 2013 BARATTERO Laurent +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + diff --git a/man/aeroup.man.html b/man/aeroup.man.html new file mode 100644 index 0000000..3a254f5 --- /dev/null +++ b/man/aeroup.man.html @@ -0,0 +1,72 @@ + + +AeroUp Man Page + + +

AeroUp Man Page

+
+
+SYNOPSIS
+       aeroup  [-t  serialPort]  [-o  serialPort]  [-c red,green,blue,serialPort] [-G serialPort] [-S serialNumber,serialPort] [-i gloFile] [-u gloFile,serialPort] [-U gloc‐
+       File,serialPort] [-v] [-P]
+
+DESCRIPTION
+       AeroUp is an open source tool to use with 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.
+              Each sub options have to be separate with a comma without blank.
+              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#) binary (0b#) or decimal (#).
+
+       -i, --verify=gloFile
+              Verify that syntax glo file is valid
+
+       -u, --verify=gloFile,serialPort
+              Verify that syntax glo file is valid and if this is the case upload it on dev serialPort
+
+       -P, --thread
+              Multithread mode, not implemented yet...
+
+       -u, --verify=glocFile,serialPort
+              not implemented yet...
+
+       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
+
+BUGS
+       No known bugs.
+
+AUTHOR
+       Laurent Barattero (laurent@larueluberlu.net.in)
+
+0.8                                                                             December 2013                                                                          man(1)
+

+Man(1) output converted with +man2html +

+ + diff --git a/man/aeroup.man.txt b/man/aeroup.man.txt new file mode 100644 index 0000000..9e88efc --- /dev/null +++ b/man/aeroup.man.txt @@ -0,0 +1,95 @@ +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 gloc‐ + File,serialPort] [-P] [-v] [-h] + + + +DESCRIPTION + AeroUp is an open source command line tool to use with 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. + Each sub options have to be separate with a comma without blank. + 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#) binary (0b#) or decimal (#). + + + -i, --verify=gloFile + Verify that syntax glo file is valid + + + -u, --verify=gloFile,serialPort + Verify that syntax glo file is valid and if this is the case upload it on dev serialPort + + + -P, --thread + Multithread mode, not implemented yet... + + + -u, --verify=glocFile,serialPort + not implemented yet... + + + -v Verbose mode + + + -h, --help + Print help + + + --version + Print version + + +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 + + + +BUGS + No known bugs. + + +AUTHOR + Laurent Barattero (laurent@larueluberlu.net.in) + + + +0.8 December 2013 man(1) diff --git a/man/man.html b/man/man.html new file mode 100644 index 0000000..b12e09e --- /dev/null +++ b/man/man.html @@ -0,0 +1,67 @@ + + +

+
+
+SYNOPSIS
+       aeroup  [-t  serialPort]  [-o  serialPort]  [-c red,green,blue,serialPort] [-G serialPort] [-S serialNumber,serialPort] [-i gloFile] [-u gloFile,serialPort] [-U gloc‐
+       File,serialPort] [-v] [-P]
+
+DESCRIPTION
+       AeroUp is an open source tool to use with 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.
+              Each sub options have to be separate with a comma without blank.
+              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#) binary (0b#) or decimal (#).
+
+       -i, --verify=gloFile
+              Verify that syntax glo file is valid
+
+       -u, --verify=gloFile,serialPort
+              Verify that syntax glo file is valid and if this is the case upload it on dev serialPort
+
+       -P, --thread
+              Multithread mode, not implemented yet...
+
+       -u, --verify=glocFile,serialPort
+              not implemented yet...
+
+       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
+
+BUGS
+       No known bugs.
+
+AUTHOR
+       Laurent Barattero (laurent@larueluberlu.net.in)
+
+0.8                                                                             December 2013                                                                          man(1)
+

+Man(1) output converted with +man2html +

+ + -- cgit v1.2.3