[doc] Cosmetic improvements
"Options" comes right after "Description", quotes, etc.
This commit is contained in:
Matteo Cypriani
parent
c10b9de1b4
commit
f10f99634c
|
|
@ -41,7 +41,7 @@ June 2013
|
|||
|
||||
= Description =
|
||||
|
||||
OwlPS Aggregator receives captured requests from the capture points
|
||||
**OwlPS Aggregator** receives captured requests from the capture points
|
||||
(OwlPS Listener, see owlps-listenerd.t2t), and assembles the different
|
||||
packets corresponding to the same request. The requests received are
|
||||
stored in a list in memory, which is checked periodically (cf. the
|
||||
|
|
@ -84,37 +84,6 @@ the **-K** option).
|
|||
|
||||
|
||||
|
||||
= CSV format =
|
||||
|
||||
The text output is constituted of fields separated by semicolons (;).
|
||||
(We call it CSV format even though semicolons are used instead of
|
||||
commas.) The format can evolve from one version of OwlPS to another,
|
||||
this is why the first field of each line is the version of the format
|
||||
used. In the current version of the format, each line contains the
|
||||
following fields:
|
||||
|
||||
- CSV format version = 1
|
||||
- MAC address of the transmitter
|
||||
- request type
|
||||
- number of packets sent by the transmitter
|
||||
- timestamp (transmission time at the transmitter), under the form
|
||||
“seconds.nanoseconds”
|
||||
- X coordinate
|
||||
- Y coordinate
|
||||
- Z coordinate
|
||||
- direction (orientation) of the transmitter
|
||||
- one or more per-packet information made of the following fields:
|
||||
- MAC address of the capture point
|
||||
- packet ID
|
||||
- signal strength
|
||||
|
||||
|
||||
If unknown, the coordinates are set to “0.00” and the orientation to
|
||||
“0”.
|
||||
|
||||
|
||||
|
||||
|
||||
= Options =
|
||||
|
||||
== Main options ==
|
||||
|
|
@ -199,6 +168,37 @@ If unknown, the coordinates are set to “0.00” and the orientation to
|
|||
|
||||
|
||||
|
||||
= CSV format =
|
||||
|
||||
The text output is constituted of fields separated by semicolons (;).
|
||||
(We call it CSV format even though semicolons are used instead of
|
||||
commas.) The format can evolve from one version of OwlPS to another,
|
||||
this is why the first field of each line is the version of the format
|
||||
used. In the current version of the format, each line contains the
|
||||
following fields:
|
||||
|
||||
- CSV format version = 1
|
||||
- MAC address of the transmitter
|
||||
- request type
|
||||
- number of packets sent by the transmitter
|
||||
- timestamp (transmission time at the transmitter), under the form
|
||||
“seconds.nanoseconds”
|
||||
- X coordinate
|
||||
- Y coordinate
|
||||
- Z coordinate
|
||||
- direction (orientation) of the transmitter
|
||||
- one or more per-packet information made of the following fields:
|
||||
- MAC address of the capture point
|
||||
- packet ID
|
||||
- signal strength
|
||||
|
||||
|
||||
If unknown, the coordinates are set to “0.00” and the orientation to
|
||||
“0”.
|
||||
|
||||
|
||||
|
||||
|
||||
= Files =
|
||||
|
||||
: //{{INSTALL_PREFIX}}/etc/owlps/owlps-aggregator.conf//
|
||||
|
|
|
|||
|
|
@ -45,6 +45,53 @@ owlps-aggregatord.t2t) to create a manual calibration database.
|
|||
|
||||
|
||||
|
||||
= Options =
|
||||
|
||||
: **-h**
|
||||
Print help message and exit.
|
||||
: **-V**
|
||||
Print version information and exit.
|
||||
: **-v**
|
||||
Turn on verbose mode (default).
|
||||
: **-q**
|
||||
Do not print informational messages and some (less important)
|
||||
warnings.
|
||||
: **-i** //dest_ip//
|
||||
Destination IP address of the localisation request.
|
||||
: **-p** //dest_port//
|
||||
Destination port of the localisation request (default: 9900).
|
||||
: **-t** //delay//
|
||||
Time between two packet transmissions in milliseconds. The default is
|
||||
25 ms for normal requests and 50 ms for calibration requests.
|
||||
: **-n** //nb_packets//
|
||||
Number of packet transmitted for the request (default: 10 for a normal
|
||||
request, 20 for a calibration request).
|
||||
: **-s** //packet_size//
|
||||
Data size of the transmitted packets. The minimal value is the size of
|
||||
the request's data fields; if //packet_size// is less than this size,
|
||||
it is ignored. Note that this size does not take into account the
|
||||
headers, so the whole 802.11 frame will be bigger.
|
||||
: **-I** //iface//
|
||||
Name of the network interface used to transmit the request (e.g.
|
||||
“eth2”). If this option is absent, the interface is selected
|
||||
automatically. You must be root to use this option.
|
||||
: **-F** [ //delay// ]
|
||||
“Flood mode”: loop indefinitely, sending a new request every //delay//
|
||||
milliseconds (default: 1000 ms).
|
||||
: **-N** //nb_requests//
|
||||
With -F, stop after //nb_requests// requests transmitted instead of
|
||||
looping indefinitely.
|
||||
: **-D**
|
||||
Daemon mode (fork to the background). Useful only in flood mode.
|
||||
: **-l** [ //port// ]
|
||||
Wait for the computed position and display it. The optional argument
|
||||
//port// allows to specify the listening port (default: 9910).
|
||||
Available only if the program was compiled with the compilation-time
|
||||
option ENABLE_RECEIVE_POSITION.
|
||||
|
||||
|
||||
|
||||
|
||||
= Positioning request =
|
||||
|
||||
The positioning request sent by OwlPS Client is a simple buffer
|
||||
|
|
@ -97,53 +144,6 @@ Where:
|
|||
|
||||
|
||||
|
||||
= Options =
|
||||
|
||||
: **-h**
|
||||
Print help message and exit.
|
||||
: **-V**
|
||||
Print version information and exit.
|
||||
: **-v**
|
||||
Turn on verbose mode (default).
|
||||
: **-q**
|
||||
Do not print informational messages and some (less important)
|
||||
warnings.
|
||||
: **-i** //dest_ip//
|
||||
Destination IP address of the localisation request.
|
||||
: **-p** //dest_port//
|
||||
Destination port of the localisation request (default: 9900).
|
||||
: **-t** //delay//
|
||||
Time between two packet transmissions in milliseconds. The default is
|
||||
25 ms for normal requests and 50 ms for calibration requests.
|
||||
: **-n** //nb_packets//
|
||||
Number of packet transmitted for the request (default: 10 for a normal
|
||||
request, 20 for a calibration request).
|
||||
: **-s** //packet_size//
|
||||
Data size of the transmitted packets. The minimal value is the size of
|
||||
the request's data fields; if //packet_size// is less than this size,
|
||||
it is ignored. Note that this size does not take into account the
|
||||
headers, so the whole 802.11 frame will be bigger.
|
||||
: **-I** //iface//
|
||||
Name of the network interface used to transmit the request (e.g.
|
||||
"eth2"). If this option is absent, the interface is selected
|
||||
automatically. You must be root to use this option.
|
||||
: **-F** [ //delay// ]
|
||||
"Flood mode": loop indefinitely, sending a new request every //delay//
|
||||
milliseconds (default: 1000 ms).
|
||||
: **-N** //nb_requests//
|
||||
With -F, stop after //nb_requests// requests transmitted instead of
|
||||
looping indefinitely.
|
||||
: **-D**
|
||||
Daemon mode (fork to the background). Useful only in flood mode.
|
||||
: **-l** [ //port// ]
|
||||
Wait for the computed position and display it. The optional argument
|
||||
//port// allows to specify the listening port (default: 9910).
|
||||
Available only if the program was compiled with the compilation-time
|
||||
option ENABLE_RECEIVE_POSITION.
|
||||
|
||||
|
||||
|
||||
|
||||
= Copying =
|
||||
|
||||
This documentation is part of the Owl Positioning System (OwlPS)
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ June 2013
|
|||
|
||||
= Description =
|
||||
|
||||
OwlPS Listener is the program that captures the positioning requests
|
||||
**OwlPS Listener** is the program that captures the positioning requests
|
||||
sent by the mobile terminals (with OwlPS Client, see owlps-client.t2t).
|
||||
It extracts the signal strength from the captured requests, and forwards
|
||||
them to the aggregation server (OwlPS Aggregator, see
|
||||
|
|
|
|||
|
|
@ -41,9 +41,32 @@ matter). For example, a correct request is detected if you load
|
|||
http://localhost:8080/?request=ReadSimpleResults (assuming the host
|
||||
running this program is localhost).
|
||||
|
||||
The HTTP requests currently implemented are listed bellow.
|
||||
The HTTP requests currently implemented are listed in the “Request
|
||||
types” section below.
|
||||
|
||||
|
||||
|
||||
|
||||
= Options =
|
||||
|
||||
: **-h**
|
||||
Print help message and exit.
|
||||
: **-V**
|
||||
Print version information and exit.
|
||||
: **-v**
|
||||
Turn on verbose mode (default).
|
||||
: **-q**
|
||||
Do not print informational messages.
|
||||
: **-l** //result_port//
|
||||
Port on which the results are received (default: 9910).
|
||||
: **-t** //http_port//
|
||||
Port on which the HTTP server listens (default: 8080).
|
||||
|
||||
|
||||
|
||||
|
||||
= Request types =
|
||||
|
||||
== “ReadResults” request ==
|
||||
|
||||
Answer in case of error:
|
||||
|
|
@ -94,24 +117,6 @@ If a unknown request is received, the answer format is:
|
|||
|
||||
|
||||
|
||||
= Options =
|
||||
|
||||
: **-h**
|
||||
Print help message and exit.
|
||||
: **-V**
|
||||
Print version information and exit.
|
||||
: **-v**
|
||||
Turn on verbose mode (default).
|
||||
: **-q**
|
||||
Do not print informational messages.
|
||||
: **-l** //result_port//
|
||||
Port on which the results are received (default: 9910).
|
||||
: **-t** //http_port//
|
||||
Port on which the HTTP server listens (default: 8080).
|
||||
|
||||
|
||||
|
||||
|
||||
= Copying =
|
||||
|
||||
This documentation is part of the Owl Positioning System (OwlPS)
|
||||
|
|
|
|||
Loading…
Reference in New Issue