class Manager_Pocket(Base_Manager):
"""
The subclass that uses the main Manager class and initializes the
pocket geiger sensor.
"""
def __init__(self,
counts_LED_pin=None,
network_LED_pin=None,
noise_pin=NOISE_PIN,
signal_pin=SIGNAL_PIN,
**kwargs):
super(Manager_Pocket, self).__init__(sensor_type=1, **kwargs)
self.quit_after_interval = False
if RPI:
if counts_LED_pin == None:
if self.new_setup:
self.counts_LED = LED(NEW_COUNTS_LED_PIN)
else:
self.counts_LED = LED(OLD_COUNTS_LED_PIN)
else:
self.counts_LED = LED(counts_LED_pin)
if network_LED_pin == None:
if self.new_setup:
self.network_LED = LED(NEW_NETWORK_LED_PIN)
else:
self.network_LED = LED(OLD_NETWORK_LED_PIN)
else:
self.network_LED = LED(network_LED_pin)
else:
self.counts_LED = None
self.network_LED = None
self.sensor = Sensor(
counts_LED=self.counts_LED,
verbosity=self.v,
logfile=self.logfile)
self.data_handler = Data_Handler_Pocket(
manager=self,
verbosity=self.v,
logfile=self.logfile,
network_led=self.network_LED)
self.sender = ServerSender(
manager=self,
mode=self.sender_mode,
port=self.port,
verbosity=self.v,
logfile=self.logfile)
self.init_log()
self.branch = ''
self.data_handler.backlog_to_queue()
def init_log(self):
"""
Post log message to server regarding Manager startup.
"""
# set working directory
cwd = os.getcwd()
os.chdir(GIT_DIRECTORY)
branch = subprocess.check_output(
['git', 'rev-parse', '--abbrev-ref', 'HEAD']).rstrip()
self.vprint(3, 'Found git branch: {}'.format(branch))
commit = subprocess.check_output(
['git', 'rev-parse', '--short', 'HEAD']).rstrip()
self.vprint(3, 'Found commit: {}'.format(commit))
os.chdir(cwd)
msg_code = BOOT_LOG_CODE
msg_text = 'Booting on {} at {}'.format(branch, commit)
self.vprint(1, 'Sending log message: [{}] {}'.format(
msg_code, msg_text))
try:
self.sender.send_log(msg_code, msg_text)
except (socket.gaierror, socket.error, socket.timeout):
self.vprint(1, 'Failed to send log message, network error')
if self.network_LED:
self.network_LED.start_blink(
interval=NETWORK_LED_BLINK_PERIOD_S)
else:
self.vprint(2, 'Success sending log message')
if self.network_LED:
if self.network_LED.blinker:
self.network_LED.stop_blink()
self.network_LED.on()
def sleep_until(self, end_time, retry=True):
"""
Sleep until the given timestamp.
Input:
end_time: number of seconds since epoch, e.g. time.time()
"""
catching_up_flag = False
sleeptime = end_time - time.time()
self.vprint(3, 'Sleeping for {} seconds'.format(sleeptime))
if sleeptime < 0:
# can happen if flushing queue to server takes longer than interval
sleeptime = 0
catching_up_flag = True
time.sleep(sleeptime)
if self.quit_after_interval and retry:
# SIGQUIT signal somehow interrupts time.sleep
# which makes the retry argument needed
self.sleep_until(end_time, retry=False)
now = time.time()
self.vprint(
2, 'sleep_until offset is {} seconds'.format(now - end_time))
# normally this offset is < 0.1 s
# although a reboot normally produces an offset of 9.5 s
# on the first cycle
if not catching_up_flag and (now - end_time > 10 or now < end_time):
# raspberry pi clock reset during this interval
# normally the first half of the condition triggers it.
raise SleepError
class Manager_D3S(Base_Manager):
"""
The subclass that uses the main Manager class and initializes the D3S.
"""
def __init__(self,
calibrationlog=None,
calibrationlogflag=False,
calibrationlogtime=None,
count=0,
d3s_LED_pin=None,
d3s_LED_blink=True,
d3s_LED_blink_period_1=D3S_LED_BLINK_PERIOD_INITIAL,
d3s_LED_blink_period_2=D3S_LED_BLINK_PERIOD_DEVICE_FOUND,
d3s_light_switch=False,
device='all',
log_bytes=False,
running=False,
signal_test_time=DEFAULT_D3STEST_TIME,
transport='usb',
d3s_presence=None,
d3s_data_attempts=1,
d3s_data_lim=3,
**kwargs):
super(Manager_D3S, self).__init__(sensor_type=2, **kwargs)
self.running = running
self.total = None
self.lst = None
self.create_structures = True
self.count = count
self.transport = transport
self.device = device
self.log_bytes = log_bytes
self.calibrationlog = calibrationlog
self.calibrationlogflag = calibrationlogflag
self.c_timer = 0
self.calibrationlogtime = calibrationlogtime
self.z_flag()
self.j_flag()
self.x_flag()
self.make_calibration_log(self.calibrationlog)
self.signal_test_time = signal_test_time
self.d3s_presence = d3s_presence
self.d3s_data_attempts = d3s_data_attempts
self.d3s_data_lim = d3s_data_lim
if d3s_LED_pin == None:
if self.new_setup:
self.d3s_LED = LED(NEW_D3S_LED_PIN)
else:
self.d3s_LED = LED(OLD_D3S_LED_PIN)
else:
self.d3s_LED = LED(d3s_LED_pin)
self.d3s_light_switch = d3s_light_switch
self.d3s_LED_blink_period_1 = d3s_LED_blink_period_1
self.d3s_LED_blink_period_2 = d3s_LED_blink_period_2
self.d3s_LED_blink = d3s_LED_blink
if d3s_LED_blink:
self.d3s_LED.start_blink(interval=self.d3s_LED_blink_period_1)
if d3s_light_switch:
self.d3s_LED.on()
self.data_handler = Data_Handler_D3S(
manager=self,
verbosity=self.v,
logfile=self.logfile,)
self.sender = ServerSender(
manager=self,
mode=self.sender_mode,
port=self.port,
verbosity=self.v,
logfile=self.logfile,)
self.data_handler.backlog_to_queue()
def z_flag(self):
"""
Checks if the -z from_argparse is called.
If it is called, sets the path of the calibration-log to
DEFAULT_CALIBRATIONLOG_D3S.
"""
if self.calibrationlogflag:
self.calibrationlog = DEFAULT_CALIBRATIONLOG_D3S
def j_flag(self):
"""
Checks if the -j from_argparse is called.
If it is called, sets calibrationlogflag to True.
Also sets calibrationlogtime to DEFAULT_CALIBRATIONLOG_TIME.
"""
if self.calibrationlog:
self.calibrationlogflag = True
self.calibrationlogtime = DEFAULT_CALIBRATIONLOG_TIME
def x_flag(self):
"""
Checks if -x is called.
If it is called, sets calibrationlogflag to True.
Also sets calibrationlog to DEFAULT_CALIBRATIONLOG_D3S.
"""
if self.calibrationlogtime and (
self.calibrationlogtime != DEFAULT_CALIBRATIONLOG_TIME):
self.calibrationlog = DEFAULT_CALIBRATIONLOG_D3S
self.calibrationlogflag = True
def make_calibration_log(self, file):
if self.calibrationlogflag:
with open(file, 'a') as f:
pass
def calibration_log(self, file, spectra):
"""
Writes spectra to calibration-log.
"""
if self.calibrationlogflag:
with open(file, 'a') as f:
f.write('{0}, '.format(spectra))
self.vprint(
2, 'Writing spectra to calibration log at {}'.format(file))
self.c_timer += self.interval
if self.c_timer >= self.calibrationlogtime:
self.vprint(1, 'Calibration Complete')
self.takedown()
class Manager(object):
"""
Master object for dosimeter operation.
Initializes other classes, tracks time intervals, and converts the counts
from Sensor into a CPM to give to the server.
time_interval is the interval (in seconds) over for which CPM is
calculated.
"""
# Note: keep the __init__() keywords identical to the keywords in argparse,
# in order to avoid unpacking them individually.
# The None's are handled differently, depending on whether test mode.
def __init__(self,
network_LED_pin=NETWORK_LED_PIN,
counts_LED_pin=COUNTS_LED_PIN,
signal_pin=SIGNAL_PIN,
noise_pin=NOISE_PIN,
sender_mode=DEFAULT_SENDER_MODE,
interval=None,
config=None,
publickey=None,
hostname=DEFAULT_HOSTNAME,
port=None,
verbosity=None,
log=False,
logfile=None,
datalog=None,
datalogflag=False,
protocol=DEFAULT_PROTOCOL,
test=None,
):
self.quit_after_interval = False
self.protocol = protocol
self.datalog = datalog
self.datalogflag = datalogflag
self.a_flag()
self.d_flag()
self.make_data_log(self.datalog)
self.handle_input(log, logfile, verbosity,
test, interval, config, publickey)
self.test = test
# LEDs
if RPI:
self.network_LED = LED(network_LED_pin)
self.counts_LED = LED(counts_LED_pin)
else:
self.network_LED = None
self.counts_LED = None
# other objects
self.sensor = Sensor(
counts_LED=self.counts_LED,
verbosity=self.v,
logfile=self.logfile)
self.data_handler = Data_Handler(
manager=self,
verbosity=self.v,
logfile=self.logfile,
network_led=self.network_LED)
self.sender = ServerSender(
manager=self,
mode=sender_mode,
port=port,
verbosity=self.v,
logfile=self.logfile)
self.init_log()
# DEFAULT_UDP_PORT and DEFAULT_TCP_PORT are assigned in sender
self.branch = ''
self.data_handler.backlog_to_queue()
def init_log(self):
"""
Post log message to server regarding Manager startup.
"""
# set working directory
cwd = os.getcwd()
os.chdir(GIT_DIRECTORY)
branch = subprocess.check_output(
['git', 'rev-parse', '--abbrev-ref', 'HEAD']).rstrip()
self.vprint(3, 'Found git branch: {}'.format(branch))
commit = subprocess.check_output(
['git', 'rev-parse', '--short', 'HEAD']).rstrip()
self.vprint(3, 'Found commit: {}'.format(commit))
os.chdir(cwd)
msg_code = BOOT_LOG_CODE
msg_text = 'Booting on {} at {}'.format(branch, commit)
self.vprint(1, 'Sending log message: [{}] {}'.format(
msg_code, msg_text))
try:
self.sender.send_log(msg_code, msg_text)
except (socket.gaierror, socket.error, socket.timeout):
self.vprint(1, 'Failed to send log message, network error')
if self.network_LED:
self.network_LED.start_blink(
interval=NETWORK_LED_BLINK_PERIOD_S)
else:
self.vprint(2, 'Success sending log message')
if self.network_LED:
if self.network_LED.blinker:
self.network_LED.stop_blink()
self.network_LED.on()
def a_flag(self):
"""
Checks if the -a from_argparse is called.
If it is called, sets the path of the data-log to
DEFAULT_DATALOG.
"""
if self.datalogflag:
self.datalog = DEFAULT_DATALOG
def d_flag(self):
"""
Checks if the -d from_argparse is called.
If it is called, sets datalogflag to True.
"""
if self.datalog:
self.datalogflag = True
def make_data_log(self, file):
if self.datalogflag:
with open(file, 'a') as f:
pass
def handle_input(self,
log, logfile, verbosity,
test, interval, config, publickey):
# resolve logging defaults
if log and logfile is None:
# use default file if logging is enabled
logfile = DEFAULT_LOGFILE
if logfile and not log:
# enable logging if logfile is specified
# (this overrides a log=False input which wouldn't make sense)
log = True
if log:
self.logfile = logfile
else:
self.logfile = None
# set up verbosity
if verbosity is None:
if test:
verbosity = 2
else:
verbosity = 1
self.v = verbosity
set_verbosity(self, logfile=logfile)
if log:
self.vprint(1, '')
self.vprint(1, 'Writing to logfile at {}'.format(self.logfile))
self.test = test
self.running = False
# resolve defaults that depend on test mode
if self.test:
if interval is None:
self.vprint(
2, "No interval given, using default for TEST MODE")
interval = DEFAULT_INTERVAL_TEST
else:
if interval is None:
self.vprint(
2, "No interval given, using default for NORMAL MODE")
interval = DEFAULT_INTERVAL_NORMAL
if config is None:
self.vprint(2, "No config file given, " +
"attempting to use default config path")
config = DEFAULT_CONFIG
if publickey is None:
self.vprint(2, "No publickey file given, " +
"attempting to use default publickey path")
publickey = DEFAULT_PUBLICKEY
self.interval = interval
if self.datalogflag:
self.vprint(
1, 'Writing CPM to data log at {}'.format(self.datalog))
if config:
try:
self.config = Config(config,
verbosity=self.v, logfile=self.logfile)
except IOError:
raise IOError(
'Unable to open config file {}!'.format(config))
else:
self.vprint(
1, 'WARNING: no config file given. Not posting to server')
self.config = None
if publickey:
try:
self.publickey = PublicKey(
publickey, verbosity=self.v, logfile=self.logfile)
except IOError:
raise IOError(
'Unable to load publickey file {}!'.format(publickey))
else:
self.vprint(
1, 'WARNING: no public key given. Not posting to server')
self.publickey = None
self.aes = None # gets checked in sender. feature in manager_d3s
def run(self):
"""
Start counting time.
This method does NOT return, so run in a subprocess if you
want to keep control.
However, setting self.running = False will stop, as will a
KeyboardInterrupt.
"""
this_start, this_end = self.get_interval(time.time())
self.vprint(
1, ('Manager is starting to run at {}' +
' with intervals of {}s').format(
datetime_from_epoch(this_start), self.interval))
self.running = True
try:
while self.running:
self.vprint(3, 'Sleeping at {} until {}'.format(
datetime_from_epoch(time.time()),
datetime_from_epoch(this_end)))
try:
self.sleep_until(this_end)
except SleepError:
self.vprint(1, 'SleepError: system clock skipped ahead!')
# the previous start/end times are meaningless.
# There are a couple ways this could be handled.
# 1. keep the same start time, but go until time.time()
# - but if there was actually an execution delay,
# the CPM will be too high.
# 2. set start time to be time.time() - interval,
# and end time is time.time().
# - but if the system clock was adjusted halfway through
# the interval, the CPM will be too low.
# The second one is more acceptable.
self.vprint(
3, 'former this_start = {}, this_end = {}'.format(
datetime_from_epoch(this_start),
datetime_from_epoch(this_end)))
this_start, this_end = self.get_interval(
time.time() - self.interval)
self.handle_cpm(this_start, this_end)
if self.quit_after_interval:
self.vprint(1, 'Reboot: taking down Manager')
self.stop()
self.takedown()
os.system('sudo {0} {1}'.format(
REBOOT_SCRIPT, self.branch))
this_start, this_end = self.get_interval(this_end)
except KeyboardInterrupt:
self.vprint(1, '\nKeyboardInterrupt: stopping Manager run')
self.stop()
self.takedown()
except SystemExit:
self.vprint(1, '\nSystemExit: taking down Manager')
self.stop()
self.takedown()
def stop(self):
"""Stop counting time."""
self.running = False
def sleep_until(self, end_time, retry=True):
"""
Sleep until the given timestamp.
Input:
end_time: number of seconds since epoch, e.g. time.time()
"""
catching_up_flag = False
sleeptime = end_time - time.time()
self.vprint(3, 'Sleeping for {} seconds'.format(sleeptime))
if sleeptime < 0:
# can happen if flushing queue to server takes longer than interval
sleeptime = 0
catching_up_flag = True
time.sleep(sleeptime)
if self.quit_after_interval and retry:
# SIGQUIT signal somehow interrupts time.sleep
# which makes the retry argument needed
self.sleep_until(end_time, retry=False)
now = time.time()
self.vprint(
2, 'sleep_until offset is {} seconds'.format(now - end_time))
# normally this offset is < 0.1 s
# although a reboot normally produces an offset of 9.5 s
# on the first cycle
if not catching_up_flag and (now - end_time > 10 or now < end_time):
# raspberry pi clock reset during this interval
# normally the first half of the condition triggers it.
raise SleepError
def get_interval(self, start_time):
"""
Return start and end time for interval, based on given start_time.
"""
end_time = start_time + self.interval
return start_time, end_time
def data_log(self, file, **kwargs):
"""
Writes cpm to data-log.
"""
time_string = time.strftime("%Y-%m-%d %H:%M:%S")
cpm, cpm_err = kwargs.get('cpm'), kwargs.get('cpm_err')
if self.datalogflag:
with open(file, 'a') as f:
f.write('{0}, {1}, {2}'.format(time_string, cpm, cpm_err))
f.write('\n')
self.vprint(2, 'Writing CPM to data log at {}'.format(file))
def handle_cpm(self, this_start, this_end):
"""
Get CPM from sensor, display text, send to server.
"""
cpm, cpm_err = self.sensor.get_cpm(this_start, this_end)
counts = int(round(cpm * self.interval / 60))
self.data_handler.main(
self.datalog, cpm, cpm_err, this_start, this_end, counts)
def takedown(self):
"""Delete self and child objects and clean up GPIO nicely."""
# sensor
self.sensor.cleanup()
del(self.sensor)
try:
GPIO.cleanup()
except NameError:
# not on a Raspberry Pi so no GPIO
pass
# send the rest of the queue object to DEFAULT_DATA_BACKLOG_FILE upon
# shutdown
self.data_handler.send_all_to_backlog()
# self. can I even do this?
del(self)
@classmethod
def from_argparse(cls):
"""
Initialize a Manager instance using arguments from the command line.
For usage:
python manager.py -h
"""
# Note: keep the keywords identical to the keywords in __init__(),
# to avoid individual handling of arguments.
# The arguments with default=None depend on test state.
# They are handled in __init__()
# Also, LED pin numbers could be added here if you want.
parser = argparse.ArgumentParser(
description="Manager for the DoseNet radiation detector")
# test mode
parser.add_argument(
'--test', '-t', action='store_true', default=False,
help='Start in test mode (no config, 30s intervals)')
# interval: default depends on whether test mode is enabled
parser.add_argument(
'--interval', '-i', type=int, default=None,
help=('Interval of CPM measurement, in seconds' +
' (default 300 for normal mode)'))
# verbosity
parser.add_argument(
'--verbosity', '-v', type=int, default=None,
help='Verbosity level (0 to 3) (default 1)')
parser.add_argument(
'--log', '-l', action='store_true', default=False,
help='Enable file logging of all verbose text (default off)')
parser.add_argument(
'--logfile', '-f', type=str, default=None,
help='Specify file for logging (default {})'.format(
DEFAULT_LOGFILE))
# config file and public key
parser.add_argument(
'--config', '-c', default=None,
help='Specify a config file (default {})'.format(DEFAULT_CONFIG))
parser.add_argument(
'--publickey', '-k', default=None,
help='Specify a publickey file (default {})'.format(
DEFAULT_PUBLICKEY))
# server address and port
parser.add_argument(
'--hostname', '-s', default=DEFAULT_HOSTNAME,
help='Specify a server hostname (default {})'.format(
DEFAULT_HOSTNAME))
parser.add_argument(
'--port', '-p', type=int, default=None,
help='Specify a port for the server ' +
'(default {} for UDP, {} for TCP)'.format(
DEFAULT_UDP_PORT, DEFAULT_TCP_PORT))
parser.add_argument(
'--sender-mode', '-m', type=str, default=DEFAULT_SENDER_MODE,
choices=['udp', 'tcp', 'UDP', 'TCP'],
help='The network protocol used in sending data ' +
'(default {})'.format(DEFAULT_SENDER_MODE))
# datalog
parser.add_argument(
'--datalog', '-d', default=None,
help='Specify a path for the datalog (default {})'.format(
DEFAULT_DATALOG))
parser.add_argument(
'--datalogflag', '-a', action='store_true', default=False,
help='Enable logging local data (default off)')
# communication protocal
parser.add_argument(
'--protocol', '-r', default=DEFAULT_PROTOCOL,
help='Specify what communication protocol is to be used ' +
'(default {})'.format(DEFAULT_PROTOCOL))
args = parser.parse_args()
arg_dict = vars(args)
mgr = Manager(**arg_dict)
return mgr
class Manager_D3S(object):
"""
Master object for D3S device operation.
Prints out spectra for every interval, stores each spectra, and sums the spectra together.
Interval is in seconds with the default being 30 seconds.
"""
def __init__(
self,
interval=None,
count=0,
transport='any',
device='all',
log_bytes=False,
verbosity=None,
datalog=None,
datalogflag=False,
test=None,
config=None,
publickey=None,
hostname=DEFAULT_HOSTNAME,
port=None,
sender_mode=DEFAULT_SENDER_MODE,
logfile=None,
log=False,
running=False,
network_LED_pin=NETWORK_LED_PIN,
power_LED_pin=POWER_LED_PIN,
):
self.running = running
self.total = None
self.lst = None
self.create_structures = True
self.interval = interval
self.count = count
self.transport = transport
self.device = device
self.log_bytes = log_bytes
self.datalog = datalog
self.datalogflag = datalogflag
self.a_flag()
self.d_flag()
self.make_data_log(self.datalog)
self.test = test
self.handle_input(log, logfile, verbosity, interval, config, publickey)
if RPI:
self.power_LED = LED(power_LED_pin)
self.network_LED = LED(network_LED_pin)
self.power_LED.on()
else:
self.power_LED = None
self.network_LED = None
self.data_handler = Data_Handler_D3S(manager=self,
verbosity=self.v,
logfile=self.logfile,
network_led=self.network_LED)
self.sender = ServerSender(
manager=self,
mode=sender_mode,
port=port,
verbosity=self.v,
logfile=self.logfile,
)
# DEFAULT_UDP_PORT and DEFAULT_TCP_PORT are assigned in sender
self.data_handler.backlog_to_queue()
def a_flag(self):
"""
Checks if the -a from_argparse is called.
If it is called, sets the path of the data-log to
DEFAULT_DATALOG.
"""
if self.datalogflag:
self.datalog = DEFAULT_DATALOG_D3S
def d_flag(self):
"""
Checks if the -d from_argparse is called.
If it is called, sets datalogflag to True.
"""
if self.datalog:
self.datalogflag = True
def make_data_log(self, file):
if self.datalogflag:
with open(file, 'a') as f:
pass
def handle_input(self, log, logfile, verbosity, interval, config,
publickey):
"""
Sets up logging, verbosity, interval, config, and publickey
"""
# resolve logging defaults
if log and logfile is None:
# use default file if logging is enabled
logfile = DEFAULT_LOGFILE_D3S
if logfile and not log:
# enable logging if logfile is specified
# (this overrides a log=False input which wouldn't make sense)
log = True
if log:
self.logfile = logfile
else:
self.logfile = None
if verbosity is None:
verbosity = 1
self.v = verbosity
set_verbosity(self, logfile=logfile)
if log:
self.vprint(1, '')
self.vprint(1, 'Writing to logfile at {}'.format(self.logfile))
self.running = True
if interval is None:
self.vprint(2, "No interval given, using interval at 30 seconds")
interval = DEFAULT_INTERVAL_NORMAL_D3S
if config is None:
self.vprint(
2, "No config file given, " +
"attempting to use default config path")
config = DEFAULT_CONFIG
if publickey is None:
self.vprint(
2, "No publickey file given, " +
"attempting to use default publickey path")
publickey = DEFAULT_PUBLICKEY
self.interval = interval
if config:
try:
self.config = Config(config,
verbosity=self.v,
logfile=self.logfile)
except IOError:
raise IOError('Unable to open config file {}!'.format(config))
else:
self.vprint(
1, 'WARNING: no config file given. Not posting to server')
self.config = None
if publickey:
try:
self.publickey = PublicKey(publickey,
verbosity=self.v,
logfile=self.logfile)
except IOError:
raise IOError(
'Unable to load publickey file {}!'.format(publickey))
else:
self.vprint(1,
'WARNING: no public key given. Not posting to server')
self.publickey = None
def run(self):
"""
Main method. Currently also stores and sum the spectra as well.
Current way to stop is only using a keyboard interrupt.
"""
if self.transport == 'any':
devs = kromek.discover()
else:
devs = kromek.discover(self.transport)
print 'Discovered %s' % devs
if len(devs) <= 0:
return
filtered = []
for dev in devs:
if self.device == 'all' or dev[0] in self.device:
filtered.append(dev)
devs = filtered
if len(devs) <= 0:
return
done_devices = set()
try:
while self.running:
with kromek.Controller(devs, self.interval) as controller:
for reading in controller.read():
if self.create_structures:
self.total = np.array(reading[4])
self.lst = np.array([reading[4]])
self.create_structures = False
else:
self.total += np.array(reading[4])
self.lst = np.concatenate(
(self.lst, [np.array(reading[4])]))
serial = reading[0]
dev_count = reading[1]
if serial not in done_devices:
this_start, this_end = self.get_interval(
time.time() - self.interval)
self.handle_spectra(this_start, this_end,
reading[4])
if dev_count >= self.count > 0:
done_devices.add(serial)
controller.stop_collector(serial)
if len(done_devices) >= len(devs):
break
except KeyboardInterrupt:
self.vprint(1, '\nKeyboardInterrupt: stopping Manager run')
self.takedown()
except SystemExit:
self.vprint(1, '\nSystemExit: taking down Manager')
self.takedown()
def get_interval(self, start_time):
"""
Return start and end time for interval, based on given start_time.
"""
end_time = start_time + self.interval
return start_time, end_time
def data_log(self, file, spectra):
"""
Writes spectra to data-log.
"""
if self.datalogflag:
with open(file, 'a') as f:
f.write('{0}, '.format(spectra))
self.vprint(2,
'Writing spectra to data log at {}'.format(file))
def handle_spectra(self, this_start, this_end, spectra):
"""
Get spectra from sensor, display text, send to server.
"""
self.data_handler.main(self.datalog, spectra, this_start, this_end)
def takedown(self):
"""
Sets self.running to False and deletes self. Also turns off LEDs
"""
self.power_LED.off()
GPIO.cleanup()
self.running = False
self.data_handler.send_all_to_backlog()
del (self)
@classmethod
def from_argparse(cls):
parser = argparse.ArgumentParser()
parser.add_argument('--hostname', '-s', default=DEFAULT_HOSTNAME)
parser.add_argument('--port', '-p', type=int, default=None)
parser.add_argument('--sender-mode',
'-m',
type=str,
default=DEFAULT_SENDER_MODE,
choices=['udp', 'tcp', 'UDP', 'TCP'])
parser.add_argument('--config', '-c', default=None)
parser.add_argument('--datalog', '-d', default=None)
parser.add_argument('--datalogflag',
'-a',
action='store_true',
default=False)
parser.add_argument('--publickey', '-k', default=None)
parser.add_argument('--verbosity', '-v', type=int, default=None)
parser.add_argument('--test', '-t', action='store_true', default=False)
parser.add_argument('--transport', '-n', default='any')
parser.add_argument('--interval', '-i', type=int, default=None)
parser.add_argument('--count', '-0', dest='count', default=0)
parser.add_argument('--device', '-e', dest='device', default='all')
parser.add_argument('--log-bytes',
'-b',
dest='log_bytes',
default=False,
action='store_true')
parser.add_argument('--log', '-l', action='store_true', default=False)
parser.add_argument('--logfile', '-f', type=str, default=None)
args = parser.parse_args()
arg_dict = vars(args)
mgr = Manager_D3S(**arg_dict)
return mgr
class Manager_D3S(object):
"""
Master object for D3S device operation.
Prints out spectra for every interval, stores each spectra, and
sums the spectra together.
Interval is in seconds with the default being 30 seconds.
"""
def __init__(self,
interval=None,
count=0,
transport='any',
device='all',
log_bytes=False,
verbosity=None,
datalog=None,
datalogflag=False,
calibrationlog=None,
calibrationlogflag=False,
calibrationlogtime=None,
test=None,
config=None,
publickey=None,
hostname=DEFAULT_HOSTNAME,
port=None,
sender_mode=DEFAULT_SENDER_MODE,
logfile=None,
log=False,
running=False,
network_LED_pin=NETWORK_LED_PIN,
power_LED_pin=POWER_LED_PIN,
):
self.running = running
self.total = None
self.lst = None
self.create_structures = True
self.interval = interval
self.count = count
self.transport = transport
self.device = device
self.log_bytes = log_bytes
self.calibrationlog = calibrationlog
self.calibrationlogflag = calibrationlogflag
self.c_timer = 0
self.calibrationlogtime = calibrationlogtime
self.z_flag()
self.y_flag()
self.x_flag()
self.make_calibration_log(self.calibrationlog)
self.datalog = datalog
self.datalogflag = datalogflag
self.a_flag()
self.d_flag()
self.make_data_log(self.datalog)
self.test = test
self.handle_input(log, logfile, verbosity, interval, config, publickey)
if RPI:
self.power_LED = LED(power_LED_pin)
self.network_LED = LED(network_LED_pin)
self.power_LED.on()
else:
self.power_LED = None
self.network_LED = None
self.data_handler = Data_Handler_D3S(
manager=self,
verbosity=self.v,
logfile=self.logfile,
network_led=self.network_LED)
self.sender = ServerSender(
manager=self,
mode=sender_mode,
port=port,
verbosity=self.v,
logfile=self.logfile,)
# DEFAULT_UDP_PORT and DEFAULT_TCP_PORT are assigned in sender
self.data_handler.backlog_to_queue()
def z_flag(self):
"""
Checks if the -z from_argparse is called.
If it is called, sets the path of the calibration-log to
DEFAULT_CALIBRATIONLOG_D3S.
"""
if self.calibrationlogflag:
self.calibrationlog = DEFAULT_CALIBRATIONLOG_D3S
def y_flag(self):
"""
Checks if the -y from_argparse is called.
If it is called, sets calibrationlogflag to True.
Also sets calibrationlogtime to DEFAULT_CALIBRATIONLOG_TIME.
"""
if self.calibrationlog:
self.calibrationlogflag = True
self.calibrationlogtime = DEFAULT_CALIBRATIONLOG_TIME
def x_flag(self):
"""
Checks if -x is called.
If it is called, sets calibrationlogflag to True.
Also sets calibrationlog to DEFAULT_CALIBRATIONLOG_D3S.
"""
if self.calibrationlogtime and (
self.calibrationlogtime != DEFAULT_CALIBRATIONLOG_TIME):
self.calibrationlog = DEFAULT_CALIBRATIONLOG_D3S
self.calibrationlogflag = True
def make_calibration_log(self, file):
if self.calibrationlogflag:
with open(file, 'a') as f:
pass
def a_flag(self):
"""
Checks if the -a from_argparse is called.
If it is called, sets the path of the data-log to
DEFAULT_DATALOG_D3S.
"""
if self.datalogflag:
self.datalog = DEFAULT_DATALOG_D3S
def d_flag(self):
"""
Checks if the -d from_argparse is called.
If it is called, sets datalogflag to True.
"""
if self.datalog:
self.datalogflag = True
def make_data_log(self, file):
if self.datalogflag:
with open(file, 'a') as f:
pass
def handle_input(self, log, logfile, verbosity, interval,
config, publickey):
"""
Sets up logging, verbosity, interval, config, and publickey
"""
# resolve logging defaults
if log and logfile is None:
# use default file if logging is enabled
logfile = DEFAULT_LOGFILE_D3S
if logfile and not log:
# enable logging if logfile is specified
# (this overrides a log=False input which wouldn't make sense)
log = True
if log:
self.logfile = logfile
else:
self.logfile = None
if verbosity is None:
verbosity = 1
self.v = verbosity
set_verbosity(self, logfile=logfile)
if log:
self.vprint(1, '')
self.vprint(1, 'Writing to logfile at {}'.format(self.logfile))
self.running = True
if interval is None:
self.vprint(
2, "No interval given, using interval at 30 seconds")
interval = DEFAULT_INTERVAL_NORMAL_D3S
if config is None:
self.vprint(2, "No config file given, " +
"attempting to use default config path")
config = DEFAULT_CONFIG
if publickey is None:
self.vprint(2, "No publickey file given, " +
"attempting to use default publickey path")
publickey = DEFAULT_PUBLICKEY
self.interval = interval
if config:
try:
self.config = Config(config,
verbosity=self.v, logfile=self.logfile)
except IOError:
raise IOError(
'Unable to open config file {}!'.format(config))
else:
self.vprint(
1, 'WARNING: no config file given. Not posting to server')
self.config = None
if publickey:
try:
self.publickey = PublicKey(
publickey, verbosity=self.v, logfile=self.logfile)
except IOError:
raise IOError(
'Unable to load publickey file {}!'.format(publickey))
else:
self.vprint(
1, 'WARNING: no public key given. Not posting to server')
self.publickey = None
def run(self):
"""
Main method. Currently also stores and sum the spectra as well.
Current way to stop is only using a keyboard interrupt.
"""
if self.transport == 'any':
devs = kromek.discover()
else:
devs = kromek.discover(self.transport)
print 'Discovered %s' % devs
if len(devs) <= 0:
return
filtered = []
for dev in devs:
if self.device == 'all' or dev[0] in self.device:
filtered.append(dev)
devs = filtered
if len(devs) <= 0:
return
done_devices = set()
try:
while self.running:
with kromek.Controller(devs, self.interval) as controller:
for reading in controller.read():
if self.create_structures:
self.total = np.array(reading[4])
self.lst = np.array([reading[4]])
self.create_structures = False
else:
self.total += np.array(reading[4])
self.lst = np.concatenate(
(self.lst, [np.array(reading[4])]))
serial = reading[0]
dev_count = reading[1]
if serial not in done_devices:
this_start, this_end = self.get_interval(
time.time() - self.interval)
self.handle_spectra(
this_start, this_end, reading[4])
if dev_count >= self.count > 0:
done_devices.add(serial)
controller.stop_collector(serial)
if len(done_devices) >= len(devs):
break
except KeyboardInterrupt:
self.vprint(1, '\nKeyboardInterrupt: stopping Manager run')
self.takedown()
except SystemExit:
self.vprint(1, '\nSystemExit: taking down Manager')
self.takedown()
def get_interval(self, start_time):
"""
Return start and end time for interval, based on given start_time.
"""
end_time = start_time + self.interval
return start_time, end_time
def data_log(self, file, spectra):
"""
Writes spectra to data-log.
"""
if self.datalogflag:
with open(file, 'a') as f:
f.write('{0}, '.format(spectra))
self.vprint(
2, 'Writing spectra to data log at {}'.format(file))
def calibration_log(self, file, spectra):
"""
Writes spectra to calibration-log.
"""
if self.calibrationlogflag:
with open(file, 'a') as f:
f.write('{0}, '.format(spectra))
self.vprint(
2, 'Writing spectra to calibration log at {}'.format(file))
self.c_timer += self.interval
if self.c_timer >= self.calibrationlogtime:
self.vprint(1, 'Calibration Complete')
self.takedown()
def handle_spectra(self, this_start, this_end, spectra):
"""
Get spectra from sensor, display text, send to server.
"""
self.data_handler.main(
self.datalog, self.calibrationlog, spectra, this_start, this_end)
def takedown(self):
"""
Sets self.running to False and deletes self. Also turns off LEDs
"""
self.power_LED.off()
GPIO.cleanup()
self.running = False
self.data_handler.send_all_to_backlog()
del(self)
@classmethod
def from_argparse(cls):
parser = argparse.ArgumentParser()
parser.add_argument('--hostname', '-s', default=DEFAULT_HOSTNAME)
parser.add_argument('--port', '-p', type=int, default=None)
parser.add_argument(
'--sender-mode', '-m', type=str, default=DEFAULT_SENDER_MODE,
choices=['udp', 'tcp', 'UDP', 'TCP'])
parser.add_argument('--config', '-c', default=None)
parser.add_argument('--datalog', '-d', default=None)
parser.add_argument(
'--datalogflag', '-a', action='store_true', default=False)
parser.add_argument('--publickey', '-k', default=None)
parser.add_argument('--verbosity', '-v', type=int, default=None)
parser.add_argument('--test', '-t', action='store_true', default=False)
parser.add_argument('--transport', '-n', default='any')
parser.add_argument('--interval', '-i', type=int, default=None)
parser.add_argument('--count', '-0', dest='count', default=0)
parser.add_argument('--device', '-e', dest='device', default='all')
parser.add_argument(
'--log-bytes', '-b', dest='log_bytes', default=False,
action='store_true')
parser.add_argument('--log', '-l', action='store_true', default=False)
parser.add_argument('--logfile', '-f', type=str, default=None)
parser.add_argument('--calibrationlogtime', '-x', type=int, default=None)
parser.add_argument('--calibrationlog', '-y', default=None)
parser.add_argument(
'--calibrationlogflag', '-z', action='store_true', default=False)
args = parser.parse_args()
arg_dict = vars(args)
mgr = Manager_D3S(**arg_dict)
return mgr
class Manager_D3S(object):
"""
Master object for D3S device operation.
Prints out spectra for every interval, stores each spectra, and
sums the spectra together.
Interval is in seconds with the default being 30 seconds.
"""
def __init__(
self,
interval=None,
count=0,
transport='usb',
device='all',
log_bytes=False,
verbosity=None,
datalog=None,
datalogflag=False,
calibrationlog=None,
calibrationlogflag=False,
calibrationlogtime=None,
test=None,
config=None,
publickey=None,
aeskey=None,
hostname=DEFAULT_HOSTNAME,
port=None,
sender_mode=DEFAULT_SENDER_MODE,
logfile=None,
log=False,
running=False,
d3s_LED_pin=D3S_LED_PIN,
d3s_light_switch=False,
d3s_LED_blink_period_1=D3S_LED_BLINK_PERIOD_INITIAL,
d3s_LED_blink_period_2=D3S_LED_BLINK_PERIOD_DEVICE_FOUND,
d3s_LED_blink=True,
signal_test_time=DEFAULT_D3STEST_TIME,
signal_test_loop=True,
signal_test_connection=False,
signal_test_attempts=0,
):
self.running = running
self.total = None
self.lst = None
self.create_structures = True
self.interval = interval
self.count = count
self.transport = transport
self.device = device
self.log_bytes = log_bytes
self.calibrationlog = calibrationlog
self.calibrationlogflag = calibrationlogflag
self.c_timer = 0
self.calibrationlogtime = calibrationlogtime
self.z_flag()
self.y_flag()
self.x_flag()
self.make_calibration_log(self.calibrationlog)
self.datalog = datalog
self.datalogflag = datalogflag
self.a_flag()
self.d_flag()
self.make_data_log(self.datalog)
self.test = test
self.signal_test_time = signal_test_time
self.signal_test_loop = signal_test_loop
self.signal_test_connection = signal_test_connection
self.signal_test_attempts = signal_test_attempts
self.d3s_LED = LED(d3s_LED_pin)
self.d3s_light_switch = d3s_light_switch
self.d3s_LED_blink_period_1 = d3s_LED_blink_period_1
self.d3s_LED_blink_period_2 = d3s_LED_blink_period_2
self.d3s_LED_blink = d3s_LED_blink
if d3s_LED_blink:
print("Attempting to connect to D3S now")
self.d3s_LED.start_blink(interval=self.d3s_LED_blink_period_1)
else:
self.d3s_LED.on()
self.handle_input(log, logfile, verbosity, interval, config, publickey,
aeskey)
self.data_handler = Data_Handler_D3S(
manager=self,
verbosity=self.v,
logfile=self.logfile,
)
self.sender = ServerSender(
manager=self,
mode=sender_mode,
port=port,
verbosity=self.v,
logfile=self.logfile,
)
# DEFAULT_UDP_PORT and DEFAULT_TCP_PORT are assigned in sender
self.data_handler.backlog_to_queue()
def z_flag(self):
"""
Checks if the -z from_argparse is called.
If it is called, sets the path of the calibration-log to
DEFAULT_CALIBRATIONLOG_D3S.
"""
if self.calibrationlogflag:
self.calibrationlog = DEFAULT_CALIBRATIONLOG_D3S
def y_flag(self):
"""
Checks if the -y from_argparse is called.
If it is called, sets calibrationlogflag to True.
Also sets calibrationlogtime to DEFAULT_CALIBRATIONLOG_TIME.
"""
if self.calibrationlog:
self.calibrationlogflag = True
self.calibrationlogtime = DEFAULT_CALIBRATIONLOG_TIME
def x_flag(self):
"""
Checks if -x is called.
If it is called, sets calibrationlogflag to True.
Also sets calibrationlog to DEFAULT_CALIBRATIONLOG_D3S.
"""
if self.calibrationlogtime and (self.calibrationlogtime !=
DEFAULT_CALIBRATIONLOG_TIME):
self.calibrationlog = DEFAULT_CALIBRATIONLOG_D3S
self.calibrationlogflag = True
def make_calibration_log(self, file):
if self.calibrationlogflag:
with open(file, 'a') as f:
pass
def a_flag(self):
"""
Checks if the -a from_argparse is called.
If it is called, sets the path of the data-log to
DEFAULT_DATALOG_D3S.
"""
if self.datalogflag:
self.datalog = DEFAULT_DATALOG_D3S
def d_flag(self):
"""
Checks if the -d from_argparse is called.
If it is called, sets datalogflag to True.
"""
if self.datalog:
self.datalogflag = True
def make_data_log(self, file):
if self.datalogflag:
with open(file, 'a') as f:
pass
def handle_input(self, log, logfile, verbosity, interval, config,
publickey, aeskey):
"""
Sets up logging, verbosity, interval, config, and publickey
"""
# resolve logging defaults
if log and logfile is None:
# use default file if logging is enabled
logfile = DEFAULT_LOGFILE_D3S
if logfile and not log:
# enable logging if logfile is specified
# (this overrides a log=False input which wouldn't make sense)
log = True
if log:
self.logfile = logfile
else:
self.logfile = None
if verbosity is None:
verbosity = 1
self.v = verbosity
set_verbosity(self, logfile=logfile)
if log:
self.vprint(1, '')
self.vprint(1, 'Writing to logfile at {}'.format(self.logfile))
self.running = True
if interval is None:
self.vprint(2, "No interval given, using interval at 30 seconds")
interval = DEFAULT_INTERVAL_NORMAL_D3S
if config is None:
self.vprint(
2, "No config file given, " +
"attempting to use default config path")
config = DEFAULT_CONFIG
if publickey is None:
self.vprint(
2, "No publickey file given, " +
"attempting to use default publickey path")
publickey = DEFAULT_PUBLICKEY
if aeskey is None:
self.vprint(
2, "No AES key file given, " +
"attempting to use default AES key path")
aeskey = DEFAULT_AESKEY
self.interval = interval
if config:
try:
self.config = Config(config,
verbosity=self.v,
logfile=self.logfile)
except IOError:
raise IOError('Unable to open config file {}!'.format(config))
else:
self.vprint(
1, 'WARNING: no config file given. Not posting to server')
self.config = None
if publickey:
try:
self.publickey = PublicKey(publickey,
verbosity=self.v,
logfile=self.logfile)
except IOError:
raise IOError(
'Unable to load publickey file {}!'.format(publickey))
else:
self.vprint(1,
'WARNING: no public key given. Not posting to server')
self.publickey = None
if aeskey:
try:
with open(aeskey, 'r') as aesfile:
key = aesfile.read()
self.aes = AES.new(key, mode=AES.MODE_ECB)
except IOError:
raise IOError('Unable to load AES key file {}!'.format(aeskey))
else:
self.vprint(1, 'WARNING: no AES key given. Not posting to server')
self.aes = None
def run(self):
"""
Main method. Currently also stores and sum the spectra as well.
Current way to stop is only using a keyboard interrupt.
"""
if self.transport == 'any':
devs = kromek.discover()
else:
devs = kromek.discover(self.transport)
if len(devs) <= 0:
print("No D3S connected, exiting manager now")
self.d3s_LED.stop_blink()
GPIO.cleanup()
return
else:
print 'Discovered %s' % devs
print("D3S device found, checking for data now")
self.d3s_LED.start_blink(interval=self.d3s_LED_blink_period_2)
filtered = []
for dev in devs:
if self.device == 'all' or dev[0] in self.device:
filtered.append(dev)
devs = filtered
if len(devs) <= 0:
print("No D3S connected, exiting manager now")
self.d3s_LED.stop_blink()
GPIO.cleanup()
return
# Checks if the RaspberryPi is getting data from the D3S and turns on
# the red LED if it is. If a D3S is connected but no data is being recieved,
# it tries a couple times then reboots the RaspberryPi.
try:
while self.signal_test_attempts < 3 and self.signal_test_connection == False:
test_time = time.time() + self.signal_test_time + 5
while time.time() < test_time and self.signal_test_loop:
with kromek.Controller(
devs, self.signal_test_time) as controller:
for reading in controller.read():
if sum(reading[4]) != 0:
self.d3s_light_switch = True
self.signal_test_loop = False
break
else:
self.signal_test_loop = False
break
if self.d3s_light_switch:
self.signal_test_connection = True
else:
self.signal_test_attempts += 1
self.signal_test_loop = True
print(
"Connection to D3S not found, trying another {} times".
format(3 - self.signal_test_attempts))
if not self.signal_test_connection:
print("No data from D3S found, restarting now")
os.system('sudo reboot')
except KeyboardInterrupt:
self.vprint(1, '\nKeyboardInterrupt: stopping Manager run')
self.takedown()
except SystemExit:
self.vprint(1, '\nSystemExit: taking down Manager')
self.takedown()
if self.d3s_light_switch:
self.d3s_LED.stop_blink()
print(
"D3S data connection found, continuing with normal data collection"
)
self.d3s_LED.on()
done_devices = set()
try:
while self.running:
with kromek.Controller(devs, self.interval) as controller:
for reading in controller.read():
if self.create_structures:
self.total = np.array(reading[4])
self.lst = np.array([reading[4]])
self.create_structures = False
else:
self.total += np.array(reading[4])
self.lst = np.concatenate(
(self.lst, [np.array(reading[4])]))
serial = reading[0]
dev_count = reading[1]
if serial not in done_devices:
this_start, this_end = self.get_interval(
time.time() - self.interval)
self.handle_spectra(this_start, this_end,
reading[4])
if dev_count >= self.count > 0:
done_devices.add(serial)
controller.stop_collector(serial)
if len(done_devices) >= len(devs):
break
except KeyboardInterrupt:
self.vprint(1, '\nKeyboardInterrupt: stopping Manager run')
self.takedown()
except SystemExit:
self.vprint(1, '\nSystemExit: taking down Manager')
self.takedown()
def get_interval(self, start_time):
"""
Return start and end time for interval, based on given start_time.
"""
end_time = start_time + self.interval
return start_time, end_time
def data_log(self, file, **kwargs):
"""
Writes spectra to data-log.
"""
spectra = kwargs.get('spectra')
if self.datalogflag:
with open(file, 'a') as f:
f.write('{0}, '.format(spectra))
self.vprint(2,
'Writing spectra to data log at {}'.format(file))
def calibration_log(self, file, spectra):
"""
Writes spectra to calibration-log.
"""
if self.calibrationlogflag:
with open(file, 'a') as f:
f.write('{0}, '.format(spectra))
self.vprint(
2, 'Writing spectra to calibration log at {}'.format(file))
self.c_timer += self.interval
if self.c_timer >= self.calibrationlogtime:
self.vprint(1, 'Calibration Complete')
self.takedown()
def handle_spectra(self, this_start, this_end, spectra):
"""
Get spectra from sensor, display text, send to server.
"""
self.data_handler.main(self.datalog, self.calibrationlog, spectra,
this_start, this_end)
def takedown(self):
"""
Sets self.running to False and deletes self. Also turns off LED
"""
self.running = False
self.data_handler.send_all_to_backlog()
try:
self.d3s_LED.off()
except AttributeError:
pass
try:
GPIO.cleanup()
except NameError:
pass
del (self)
@classmethod
def from_argparse(cls):
parser = argparse.ArgumentParser()
parser.add_argument('--hostname', '-s', default=DEFAULT_HOSTNAME)
parser.add_argument('--port', '-p', type=int, default=None)
parser.add_argument('--sender-mode',
'-m',
type=str,
default=DEFAULT_SENDER_MODE,
choices=['udp', 'tcp', 'UDP', 'TCP'])
parser.add_argument('--config', '-c', default=None)
parser.add_argument('--datalog', '-d', default=None)
parser.add_argument('--datalogflag',
'-a',
action='store_true',
default=False)
parser.add_argument('--publickey', '-k', default=None)
parser.add_argument('--verbosity', '-v', type=int, default=None)
parser.add_argument('--test', '-t', action='store_true', default=False)
parser.add_argument('--transport', '-n', default='usb')
parser.add_argument('--interval', '-i', type=int, default=None)
parser.add_argument('--count', '-0', dest='count', default=0)
parser.add_argument('--device', '-e', dest='device', default='all')
parser.add_argument('--log-bytes',
'-b',
dest='log_bytes',
default=False,
action='store_true')
parser.add_argument('--log', '-l', action='store_true', default=False)
parser.add_argument('--logfile', '-f', type=str, default=None)
parser.add_argument('--calibrationlogtime',
'-x',
type=int,
default=None)
parser.add_argument('--calibrationlog', '-y', default=None)
parser.add_argument('--calibrationlogflag',
'-z',
action='store_true',
default=False)
args = parser.parse_args()
arg_dict = vars(args)
mgr = Manager_D3S(**arg_dict)
return mgr
class Manager(object):
"""
Master object for dosimeter operation.
Initializes other classes, tracks time intervals, and converts the counts
from Sensor into a CPM to give to the server.
time_interval is the interval (in seconds) over for which CPM is
calculated.
"""
# Note: keep the __init__() keywords identical to the keywords in argparse,
# in order to avoid unpacking them individually.
# The None's are handled differently, depending on whether test mode.
def __init__(self,
network_LED_pin=NETWORK_LED_PIN,
power_LED_pin=POWER_LED_PIN,
counts_LED_pin=COUNTS_LED_PIN,
signal_pin=SIGNAL_PIN,
noise_pin=NOISE_PIN,
sender_mode=DEFAULT_SENDER_MODE,
interval=None,
config=None,
publickey=None,
hostname=DEFAULT_HOSTNAME,
port=None,
verbosity=None,
log=False,
logfile=None,
datalog=None,
datalogflag=False,
protocol=DEFAULT_PROTOCOL,
test=None,
):
self.quit_after_interval = False
self.protocol = protocol
self.datalog = datalog
self.datalogflag = datalogflag
self.a_flag()
self.d_flag()
self.make_data_log(self.datalog)
self.handle_input(log, logfile, verbosity,
test, interval, config, publickey)
self.test = test
# LEDs
if RPI:
self.power_LED = LED(power_LED_pin)
self.network_LED = LED(network_LED_pin)
self.counts_LED = LED(counts_LED_pin)
self.power_LED.on()
else:
self.power_LED = None
self.network_LED = None
self.counts_LED = None
# other objects
self.sensor = Sensor(
counts_LED=self.counts_LED,
verbosity=self.v,
logfile=self.logfile)
self.data_handler = Data_Handler(
manager=self,
verbosity=self.v,
logfile=self.logfile,
network_led=self.network_LED)
self.sender = ServerSender(
manager=self,
mode=sender_mode,
port=port,
verbosity=self.v,
logfile=self.logfile)
self.init_log()
# DEFAULT_UDP_PORT and DEFAULT_TCP_PORT are assigned in sender
self.branch = ''
self.data_handler.backlog_to_queue()
def init_log(self):
"""
Post log message to server regarding Manager startup.
"""
# set working directory
cwd = os.getcwd()
os.chdir(GIT_DIRECTORY)
branch = subprocess.check_output(
['git', 'rev-parse', '--abbrev-ref', 'HEAD']).rstrip()
self.vprint(3, 'Found git branch: {}'.format(branch))
commit = subprocess.check_output(
['git', 'rev-parse', '--short', 'HEAD']).rstrip()
self.vprint(3, 'Found commit: {}'.format(commit))
os.chdir(cwd)
msg_code = BOOT_LOG_CODE
msg_text = 'Booting on {} at {}'.format(branch, commit)
self.vprint(1, 'Sending log message: [{}] {}'.format(
msg_code, msg_text))
try:
self.sender.send_log(msg_code, msg_text)
except (socket.gaierror, socket.error, socket.timeout):
self.vprint(1, 'Failed to send log message, network error')
if self.network_LED:
self.network_LED.start_blink(
interval=NETWORK_LED_BLINK_PERIOD_S)
else:
self.vprint(2, 'Success sending log message')
if self.network_LED:
if self.network_LED.blinker:
self.network_LED.stop_blink()
self.network_LED.on()
def a_flag(self):
"""
Checks if the -a from_argparse is called.
If it is called, sets the path of the data-log to
DEFAULT_DATALOG.
"""
if self.datalogflag:
self.datalog = DEFAULT_DATALOG
def d_flag(self):
"""
Checks if the -d from_argparse is called.
If it is called, sets datalogflag to True.
"""
if self.datalog:
self.datalogflag = True
def make_data_log(self, file):
if self.datalogflag:
with open(file, 'a') as f:
pass
def handle_input(self,
log, logfile, verbosity,
test, interval, config, publickey):
# resolve logging defaults
if log and logfile is None:
# use default file if logging is enabled
logfile = DEFAULT_LOGFILE
if logfile and not log:
# enable logging if logfile is specified
# (this overrides a log=False input which wouldn't make sense)
log = True
if log:
self.logfile = logfile
else:
self.logfile = None
# set up verbosity
if verbosity is None:
if test:
verbosity = 2
else:
verbosity = 1
self.v = verbosity
set_verbosity(self, logfile=logfile)
if log:
self.vprint(1, '')
self.vprint(1, 'Writing to logfile at {}'.format(self.logfile))
self.test = test
self.running = False
# resolve defaults that depend on test mode
if self.test:
if interval is None:
self.vprint(
2, "No interval given, using default for TEST MODE")
interval = DEFAULT_INTERVAL_TEST
else:
if interval is None:
self.vprint(
2, "No interval given, using default for NORMAL MODE")
interval = DEFAULT_INTERVAL_NORMAL
if config is None:
self.vprint(2, "No config file given, " +
"attempting to use default config path")
config = DEFAULT_CONFIG
if publickey is None:
self.vprint(2, "No publickey file given, " +
"attempting to use default publickey path")
publickey = DEFAULT_PUBLICKEY
self.interval = interval
if self.datalogflag:
self.vprint(
1, 'Writing CPM to data log at {}'.format(self.datalog))
if config:
try:
self.config = Config(config,
verbosity=self.v, logfile=self.logfile)
except IOError:
raise IOError(
'Unable to open config file {}!'.format(config))
else:
self.vprint(
1, 'WARNING: no config file given. Not posting to server')
self.config = None
if publickey:
try:
self.publickey = PublicKey(
publickey, verbosity=self.v, logfile=self.logfile)
except IOError:
raise IOError(
'Unable to load publickey file {}!'.format(publickey))
else:
self.vprint(
1, 'WARNING: no public key given. Not posting to server')
self.publickey = None
self.aes = None # gets checked in sender. feature in manager_d3s
def run(self):
"""
Start counting time.
This method does NOT return, so run in a subprocess if you
want to keep control.
However, setting self.running = False will stop, as will a
KeyboardInterrupt.
"""
this_start, this_end = self.get_interval(time.time())
self.vprint(
1, ('Manager is starting to run at {}' +
' with intervals of {}s').format(
datetime_from_epoch(this_start), self.interval))
self.running = True
try:
while self.running:
self.vprint(3, 'Sleeping at {} until {}'.format(
datetime_from_epoch(time.time()),
datetime_from_epoch(this_end)))
try:
self.sleep_until(this_end)
except SleepError:
self.vprint(1, 'SleepError: system clock skipped ahead!')
# the previous start/end times are meaningless.
# There are a couple ways this could be handled.
# 1. keep the same start time, but go until time.time()
# - but if there was actually an execution delay,
# the CPM will be too high.
# 2. set start time to be time.time() - interval,
# and end time is time.time().
# - but if the system clock was adjusted halfway through
# the interval, the CPM will be too low.
# The second one is more acceptable.
self.vprint(
3, 'former this_start = {}, this_end = {}'.format(
datetime_from_epoch(this_start),
datetime_from_epoch(this_end)))
this_start, this_end = self.get_interval(
time.time() - self.interval)
self.handle_cpm(this_start, this_end)
if self.quit_after_interval:
self.vprint(1, 'Reboot: taking down Manager')
self.stop()
self.takedown()
os.system('sudo {0} {1}'.format(
REBOOT_SCRIPT, self.branch))
this_start, this_end = self.get_interval(this_end)
except KeyboardInterrupt:
self.vprint(1, '\nKeyboardInterrupt: stopping Manager run')
self.stop()
self.takedown()
except SystemExit:
self.vprint(1, '\nSystemExit: taking down Manager')
self.stop()
self.takedown()
def stop(self):
"""Stop counting time."""
self.running = False
def sleep_until(self, end_time, retry=True):
"""
Sleep until the given timestamp.
Input:
end_time: number of seconds since epoch, e.g. time.time()
"""
catching_up_flag = False
sleeptime = end_time - time.time()
self.vprint(3, 'Sleeping for {} seconds'.format(sleeptime))
if sleeptime < 0:
# can happen if flushing queue to server takes longer than interval
sleeptime = 0
catching_up_flag = True
time.sleep(sleeptime)
if self.quit_after_interval and retry:
# SIGQUIT signal somehow interrupts time.sleep
# which makes the retry argument needed
self.sleep_until(end_time, retry=False)
now = time.time()
self.vprint(
2, 'sleep_until offset is {} seconds'.format(now - end_time))
# normally this offset is < 0.1 s
# although a reboot normally produces an offset of 9.5 s
# on the first cycle
if not catching_up_flag and (now - end_time > 10 or now < end_time):
# raspberry pi clock reset during this interval
# normally the first half of the condition triggers it.
raise SleepError
def get_interval(self, start_time):
"""
Return start and end time for interval, based on given start_time.
"""
end_time = start_time + self.interval
return start_time, end_time
def data_log(self, file, cpm, cpm_err):
"""
Writes cpm to data-log.
"""
time_string = time.strftime("%Y-%m-%d %H:%M:%S")
if self.datalogflag:
with open(file, 'a') as f:
f.write('{0}, {1}, {2}'.format(time_string, cpm, cpm_err))
f.write('\n')
self.vprint(2, 'Writing CPM to data log at {}'.format(file))
def handle_cpm(self, this_start, this_end):
"""
Get CPM from sensor, display text, send to server.
"""
cpm, cpm_err = self.sensor.get_cpm(this_start, this_end)
counts = int(round(cpm * self.interval / 60))
self.data_handler.main(
self.datalog, cpm, cpm_err, this_start, this_end, counts)
def takedown(self):
"""Delete self and child objects and clean up GPIO nicely."""
# sensor
self.sensor.cleanup()
del(self.sensor)
# power LED
try:
self.power_LED.off()
except AttributeError:
# no LED
pass
try:
GPIO.cleanup()
except NameError:
# not on a Raspberry Pi so no GPIO
pass
# send the rest of the queue object to DEFAULT_DATA_BACKLOG_FILE upon
# shutdown
self.data_handler.send_all_to_backlog()
# self. can I even do this?
del(self)
@classmethod
def from_argparse(cls):
"""
Initialize a Manager instance using arguments from the command line.
For usage:
python manager.py -h
"""
# Note: keep the keywords identical to the keywords in __init__(),
# to avoid individual handling of arguments.
# The arguments with default=None depend on test state.
# They are handled in __init__()
# Also, LED pin numbers could be added here if you want.
parser = argparse.ArgumentParser(
description="Manager for the DoseNet radiation detector")
# test mode
parser.add_argument(
'--test', '-t', action='store_true', default=False,
help='Start in test mode (no config, 30s intervals)')
# interval: default depends on whether test mode is enabled
parser.add_argument(
'--interval', '-i', type=int, default=None,
help=('Interval of CPM measurement, in seconds' +
' (default 300 for normal mode)'))
# verbosity
parser.add_argument(
'--verbosity', '-v', type=int, default=None,
help='Verbosity level (0 to 3) (default 1)')
parser.add_argument(
'--log', '-l', action='store_true', default=False,
help='Enable file logging of all verbose text (default off)')
parser.add_argument(
'--logfile', '-f', type=str, default=None,
help='Specify file for logging (default {})'.format(
DEFAULT_LOGFILE))
# config file and public key
parser.add_argument(
'--config', '-c', default=None,
help='Specify a config file (default {})'.format(DEFAULT_CONFIG))
parser.add_argument(
'--publickey', '-k', default=None,
help='Specify a publickey file (default {})'.format(
DEFAULT_PUBLICKEY))
# server address and port
parser.add_argument(
'--hostname', '-s', default=DEFAULT_HOSTNAME,
help='Specify a server hostname (default {})'.format(
DEFAULT_HOSTNAME))
parser.add_argument(
'--port', '-p', type=int, default=None,
help='Specify a port for the server ' +
'(default {} for UDP, {} for TCP)'.format(
DEFAULT_UDP_PORT, DEFAULT_TCP_PORT))
parser.add_argument(
'--sender-mode', '-m', type=str, default=DEFAULT_SENDER_MODE,
choices=['udp', 'tcp', 'UDP', 'TCP'],
help='The network protocol used in sending data ' +
'(default {})'.format(DEFAULT_SENDER_MODE))
# datalog
parser.add_argument(
'--datalog', '-d', default=None,
help='Specify a path for the datalog (default {})'.format(
DEFAULT_DATALOG))
parser.add_argument(
'--datalogflag', '-a', action='store_true', default=False,
help='Enable logging local data (default off)')
# communication protocal
parser.add_argument(
'--protocol', '-r', default=DEFAULT_PROTOCOL,
help='Specify what communication protocol is to be used ' +
'(default {})'.format(DEFAULT_PROTOCOL))
args = parser.parse_args()
arg_dict = vars(args)
mgr = Manager(**arg_dict)
return mgr