f69bb15343ebdeb1965773840daa1b17a4bfcef9
[SaveMySugar/python3-savemysugar.git] / src / measure_call_setup_time.py
1 #!/usr/bin/env python3
2 #
3 # measure_call_setup_time - measure time between dialing out and ringing in
4 #
5 # Copyright (C) 2015  Antonio Ospite <ao2@ao2.it>
6 #
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20 from savemysugar.cumulative_average import cumulative_average
21 from savemysugar.Modem import Modem
22 import time
23
24
25 class Ring(object):
26     time = -1
27
28
29 def on_ring():
30     if Ring.time == -1:
31         Ring.time = time.time()
32         raise StopIteration("Got the ring we were waiting for")
33
34
35 def measure_call_setup_time(ingoing_port, outgoing_port, destination_number):
36     ingoing_modem = Modem(ingoing_port)
37     ingoing_modem.register_callback("RING", on_ring)
38
39     outgoing_modem = Modem(outgoing_port)
40
41     min_call_time = 10000
42     max_call_time = -1
43     min_call_setup_time = 10000
44     max_call_setup_time = -1
45
46     avg_call_setup_time = 0
47
48     for i in range(5):
49         print()
50         print("Attempt: %s" % (i + 1))
51         outgoing_modem.send_command("ATDT" + destination_number + ";")
52         dial_time = time.time()
53
54         # Wait for the receiver to get a ring before terminating the call
55         try:
56             ingoing_modem.get_response_loop()
57         except (StopIteration, KeyboardInterrupt):
58             outgoing_modem.send_command("ATH")
59             outgoing_modem.get_response()
60
61         hangup_time = time.time()
62
63         call_setup_time = Ring.time - dial_time
64         min_call_setup_time = min(min_call_setup_time, call_setup_time)
65         max_call_setup_time = max(max_call_setup_time, call_setup_time)
66         avg_call_setup_time = cumulative_average(avg_call_setup_time,
67                                                  i + 1,
68                                                  call_setup_time)
69         uncertainty = (max_call_setup_time - min_call_setup_time) / 2.
70         print("Call setup time: %f" % call_setup_time)
71         print("Min call setup time: %f" % min_call_setup_time)
72         print("Max call setup time: %f" % max_call_setup_time)
73         print("Average call setup time: %f" % avg_call_setup_time)
74         print("Call setup time uncertainty: %f" % uncertainty)
75         print()
76
77         call_time = hangup_time - dial_time
78         min_call_time = min(min_call_time, call_time)
79         max_call_time = max(max_call_time, call_time)
80         print("Total call time: %f" % call_time)
81         print("Min call time: %f" % min_call_time)
82         print("Max call time: %f" % max_call_time)
83         print()
84
85         Ring.time = -1
86
87         # When dialing with an analog modem I noticed that if calls are
88         # separated one from another they take less time to set up, this
89         # may be due to how an analog modem works: getting it on-hook and
90         # off-hook takes quite some time.
91         inter_call_sleep = 5.2
92         print("Sleeping %.2f sec before the next call..." % inter_call_sleep)
93         time.sleep(inter_call_sleep)
94
95
96 def main():
97     import sys
98     if len(sys.argv) != 4:
99         print("usage: %s" % sys.argv[0],
100               "<ingoing serial port> <outgoing serial port>",
101               "<destination number>")
102         sys.exit(1)
103
104     measure_call_setup_time(sys.argv[1], sys.argv[2], sys.argv[3])
105
106
107 if __name__ == "__main__":
108     main()