tasks.py
25.6 KB
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
from __future__ import absolute_import
from celery.task import Task
from django.core.exceptions import ObjectDoesNotExist
from django.db.models import Q
import observation_manager
import observation_manager.tasks
import scheduler
import scheduler.tasks as sched_task
import utils.Logger as L
import monitoring.tasks
import alert_manager.tasks
from common.models import *
from devices.CameraNIR import NIRCameraController
from devices.CameraVIS import VISCameraController
from devices.Dome import DomeController
from devices.PLC import PLCController
from devices.Telescope import TelescopeController
from majordome.MajordomeDecorators import *
from utils.JDManipulator import *
DEBUG_FILE = False
log = L.setupLogger("MajordomeTaskLogger", "Majordome")
'''
Task to handle the execution of the program
check the environment status in database
check the devices status (telescope / cameras)
check if the last schedule made has to be planned
launch schedule's sequences
'''
class Majordome(Task):
loop_speed = 1
julian_div = 86400
executing_sequence = None
next_sequence = None
status_tel = ""
status_nir = ""
status_vis = ""
status_dom = ""
site_status = "OK"
weather_status = "OK"
timers = {}
functions = {}
schedule = None
available_status = []
current_status = "RUNNING"
alarm_list = []
'''
Check if the instrument status is valid
'''
def isValidStatus(self, status):
# TODO REMOVE COMMENT AND CHANGE WHEN DEFINED
# if (status == "" or status == "ERROR" or status == "FAILED" or status == "NOT_SET"):
# return (False)
return (True)
def setContext(self):
self.tel = TelescopeController()
self.vis_camera = VISCameraController()
self.nir_camera = NIRCameraController()
self.plc = PLCController()
self.dom = DomeController()
return (0)
def createTask(self):
try:
# (EP) NO find() method available from Django ORM !!!!
#TaskId.objects.find(task="majordome").delete()
TaskId.objects.filter(task="majordome").delete()
except Exception as e:
log.info(str(e))
return 1
TaskId.objects.create(task_id=self.request.id, task="majordome")
return 0
def setTasks(self):
try:
self.monitoring_task = TaskId.objects.get(task="monitoring")
self.alert_task = TaskId.objects.get(task="alert_manager")
except Exception as e:
self.monitoring_task = None
self.alert_task = None
return 0
'''
Function called by celery task
Behavior:
Init telescope / cameras
set night limits
check the software version
launch the majordome loop
'''
def run(self):
self.createTask()
self.updateSoftware()
self.setContext()
self.setTime()
self.setTasks()
self.loop()
'''
Reads the softwares versions in the settings.py, store them in the DB and send them to the IC.
'''
def updateSoftware(self):
versions = settings.MODULES_VERSIONS
for module, version in versions.items():
same_module_versions = Version.objects.filter(module_name=module)
if same_module_versions.count() == 0:
Version.objects.create(module_name=module, version=version)
elif same_module_versions.order_by("-created")[0].version != version:
Version.objects.create(module_name=module, version=version)
return (0)
'''
Loop to wait for the device to be idle with the starting configurations.
'''
def waitDevices(self):
while self.status_vis == "" and self.status_tel == "" and self.status_nir == "" and self.status_dom == "":
self.status_vis = self.vis_camera.getStatus()
self.status_nir = self.nir_camera.getStatus()
self.status_tel = self.tel.getStatus()
self.status_dom = self.dom.getStatus()
return (0)
'''
Computes the beginning and the end of the following (or current) night
set the timers -> maybe put timers in a config file ?
'''
def setTime(self):
self.night_start = getNightStart()
self.night_end = getNightEnd()
self.night_start_jd = secondsToJulianDate(getNightStart())
self.night_end_jd = secondsToJulianDate(getNightEnd())
self.timer_night_start = self.night_start - getCurrentTime()
self.timer_night_end = self.night_end - getCurrentTime()
self.timer_status = 5
self.tasks_timer = 5
self.timer_plc = 2
self.alert_timer = 1
self.timer_schedule = 1
self.timer_sequence = 1
if (self.night_start - 120 > getCurrentTime()):
self.timer_night_start = self.night_start - 120 - getCurrentTime()
self.timer_night_end = self.night_end - getCurrentTime()
if (getCurrentTime() > self.night_start):
self.adaptTimers()
self.timers = {
"status": self.timer_status,
"environment": self.timer_plc,
"night_start": self.timer_night_start,
"night_end": self.timer_night_end,
"schedule": self.timer_schedule,
"sequence": self.timer_sequence,
"tasks": self.tasks_timer
}
if (settings.DEBUG and DEBUG_FILE):
log.info("Majordome started with timers : " + str(self.timers))
# Functions called during the loop
self.functions = {
"status": self.handleStatusTimer,
"environment": self.handleEnvironmentTimer,
"night_start": self.handleNightStartTimer,
"night_end": self.handleNightEndTimer,
"schedule": self.handleScheduleTimer,
"sequence": self.handleSequenceTimer,
"tasks": self.handleTasks
}
return (0)
'''
Function called by the main loop to handle the task event (check monitoring and alert_manager)
'''
def handleTasks(self):
if not settings.USE_CELERY: return 0
self.timers["tasks"] = self.tasks_timer
if self.monitoring_task is None:
try:
self.monitoring_task = TaskId.objects.get(task="monitoring")
except Exception as e:
monitoring.tasks.Monitoring.apply_async()
if settings.DEBUG and DEBUG_FILE:
log.info(str(e))
if self.alert_task is None:
try:
self.alert_task = TaskId.objects.get(task="alert_manager")
except Exception as e:
alert_manager.tasks.AlertListener.apply_async()
if settings.DEBUG and DEBUG_FILE:
log.info(str(e))
return 0
# TODO adapt timers if the majordome is started during the night or not ?
def adaptTimers(self):
pass
def logDB(self, message: str):
Log.objects.create(agent="Majordome", message=message)
'''
Infinite loop according to the majordome behavior
'''
def loop(self):
while (self.current_status != "SHUTDOWN"):
print("(MAJOR): start new iteration")
minimal_timer = min(self.timers, key=self.timers.get)
if (self.timers[minimal_timer] > 0):
time.sleep(self.timers[minimal_timer])
self.timers = {key: value - self.timers[minimal_timer] for key, value in self.timers.items()}
for timer_name, timer_value in self.timers.items():
if (timer_value <= 0):
if timer_name in self.functions:
self.logDB("Executing timer " + str(timer_name))
self.functions[timer_name]()
else:
if (settings.DEBUG and DEBUG_FILE):
log.info("Timer : " + str(timer_name) + "is not known by the Majordome")
self.logDB("Timer " + str(timer_name) + " unknown")
if (settings.DEBUG and DEBUG_FILE):
log.info("Timer : " + str(timer_name) + " executed")
# EP added because loop is too quick (without CELERY)
if not settings.USE_CELERY: time.sleep(2)
return (0)
'''
Function called by the main loop to handle environment event (PLC info)
'''
def handleEnvironmentTimer(self):
self.timers["environment"] = self.timer_plc
self.handlePLC()
return (0)
'''
Function called by the main loop to handle the devices status
'''
def handleStatusTimer(self):
self.timers["status"] = self.timer_status
self.status_tel = self.tel.getStatus()
self.status_nir = self.nir_camera.getStatus()
self.status_vis = self.vis_camera.getStatus()
self.status_dom = self.dom.getStatus()
self.handleStatus()
return 0
'''
Function called by the main loop to check if the executing sequence is finished
'''
def handleSequenceTimer(self):
self.timers["sequence"] = self.timer_sequence
if (self.executing_sequence):
self.handleSequence(self.executing_sequence[0],
self.executing_sequence[1], self.executing_sequence[2])
return (0)
'''
Function called by the main loop to check if there is a new schedule and to execute its sequences
'''
def handleScheduleTimer(self):
self.timers["schedule"] = self.timer_schedule
if (self.isValidStatus(self.status_tel)):
if (self.schedule is None):
try:
self.schedule = Schedule.objects.latest('created')
except ObjectDoesNotExist:
if (settings.DEBUG and DEBUG_FILE):
log.info("No schedule found in database")
return (1)
else:
try:
schedule = Schedule.objects.latest('created')
except ObjectDoesNotExist:
if (settings.DEBUG and DEBUG_FILE):
log.info("No schedule found in database")
return (1)
if (schedule.created != self.schedule.created):
self.next_sequence = None
self.schedule = schedule
self.firstSequenceIsAlert()
if (self.schedule):
shs_list = self.schedule.shs.filter(Q(status=Sequence.PLANNED) |
Q(status=Sequence.PENDING)).order_by('tsp')
self.executeSchedule(shs_list)
else:
self.notifyTelescopeStatus("scheduler")
return (0)
'''
Function called by handleScheduleTimer, the purpose is to kill the executing sequence if the
first sequence in the new planning is from an alert
'''
@executingSequenceExist
def firstSequenceIsAlert(self):
shs_list = self.schedule.shs.filter(Q(status=Sequence.PLANNED) |
Q(status=Sequence.PENDING)).order_by('tsp')
if shs_list and shs_list[0].sequence.is_alert:
if shs_list[0].sequence.created.date() >= (datetime.datetime.now() - datetime.timedelta(seconds=10)).date():
self.killExecutingSequence()
return 1
return 0
'''
Function called by the main loop to handle the end of a night
'''
def handleNightEndTimer(self):
self.timers["night_end"] = getNightEnd()
if (self.isValidStatus(self.status_tel)):
#observation_manager.tasks.night_calibrations.apply_async()
if settings.USE_CELERY:
print("MJ: call observation_manager WITH CELERY")
observation_manager.tasks.night_calibrations.apply_async()
else:
print("MJ: call observation_manager WITHOUT CELERY")
observation_manager.tasks.night_calibrations().run()
else:
self.notifyTelescopeStatus("night_end")
return (0)
'''
Function called by the main loop to handle the beginning of a night
'''
def handleNightStartTimer(self):
self.timers["night_start"] = getNextNightStart()
if self.isOutsideOk():
self.dom.open()
self.vis_camera.open_shutter()
self.nir_camera.open_shutter()
#scheduler.tasks.scheduling.apply_async((False, False))
if settings.USE_CELERY:
print("MJ: call schedule WITH CELERY")
scheduler.tasks.scheduling.apply_async((False, False))
else:
print("MJ: call schedule WITHOUT CELERY")
scheduler.tasks.scheduling().run((False, False))
return (0)
def notifyTelescopeStatus(self, timer_name):
return (self.notifyDeviceStatus("telescope", timer_name, self.status_tel))
def notifyDeviceStatus(self, device_name, timer_name, status):
Log.objects.create(agent=device_name, created=datetime.datetime.now(),
message="The action : " + str(timer_name) + " has been canceled : Telescope status : " + str(status))
# TODO MAYBE reset some variables and do a scheduling
return (0)
'''
Execute a schedule
'''
def executeSchedule(self, shs_list):
for shs in shs_list: # shs_list is sorted by tsp
if (self.executableSequence(shs.sequence.status) and self.observable(shs.sequence)):
if self.next_sequence is None:
self.setNextSequence(shs, shs.sequence)
if self.isExecutable() and self.executing_sequence is None:
if self.isValidTimer(self.next_sequence[0]):
if self.executeSequence(self.next_sequence[0], self.next_sequence[1]) == -1:
return -1
if self.next_sequence[0] != shs and self.next_sequence[1] != shs.sequence:
self.setNextSequence(shs, shs.sequence)
else:
self.next_sequence = None
else:
return 0
else:
if (settings.DEBUG and DEBUG_FILE):
log.info("Sequence cannot be executed : Not observable")
self.logDB("Sequence "+shs.sequence.name+" cannot be executed : Not observable")
return 0
def observable(self, sequence):
if (sequence.jd2 - sequence.duration - secondsToPreciseJulianDate(getPreciseCurrentTime()) <= 0):
return 0
return 1
def executableSequence(self, status):
if status == Sequence.PLANNED or status == Sequence.PENDING:
return 1
return 0
'''
Kill the executing sequence and set its state to cancelled
'''
@executingSequenceExist
def killExecutingSequence(self):
shs = self.executing_sequence[0]
sequence = self.executing_sequence[1]
executing_plans = self.executing_sequence[2]
shs.status = Sequence.CANCELLED
sequence.status = Sequence.CANCELLED
shs.save()
sequence.save()
for rev in executing_plans:
if (not rev.failed() and not rev.successful()):
rev.revoke(terminate=True)
self.executing_sequence = None
return 0
def reset(self, type):
if type == "WEATHER":
self.dom.open()
#scheduler.tasks.scheduling.delay((False, False))
if settings.USE_CELERY:
print("MJ: call schedule WITH CELERY")
scheduler.tasks.scheduling.delay((False, False))
else:
print("MJ: call schedule WITHOUT CELERY")
scheduler.tasks.scheduling().run((False, False))
elif type == "INSIDE":
#scheduler.tasks.scheduling.delay((False, False))
if settings.USE_CELERY:
print("MJ: call schedule WITH CELERY")
scheduler.tasks.scheduling.delay((False, False))
else:
print("MJ: call schedule WITHOUT CELERY")
scheduler.tasks.scheduling().run((False, False))
'''
Handle a new alarm (called by isInsideOk or isWeatherOk)
'''
@SameAlarmCheck
def handleAlarm(self, type, pos=-1):
if type == "WEATHER":
#TODO send email
self.dom.close()
self.killExecutingSequence()
self.vis_camera.park()
self.nir_camera.park()
elif type == "INSIDE":
#TODO send email
self.killExecutingSequence()
self.vis_camera.park()
self.nir_camera.park()
elif type == "ENDED":
if len(self.alarm_list) > 0 and pos != -1:
ended = self.alarm_list[pos]
del self.alarm_list[pos]
self.reset(ended)
return 0
else:
return 1
self.alarm_list.append(type)
return 0
'''
for now weather_status and site_status contains something different than OK if the status is critical
Later we may have other states to handle
'''
def isOutsideOk(self) -> bool:
self.handlePLC()
if self.weather_status == "OK":
if "WEATHER" in self.alarm_list:
self.handleAlarm("ENDED", self.alarm_list.index("WEATHER"))
return True
self.handleAlarm("WEATHER")
return False
'''
Check the telescope inside status
'''
def isInsideOk(self) -> bool:
self.handlePLC()
if self.site_status == "OK":
if "INSIDE" in self.alarm_list:
self.handleAlarm("ENDED", self.alarm_list.index("INSIDE"))
return True
self.handleAlarm("INSIDE")
return False
def isDevicesOk(self) -> bool:
if self.isValidStatus(self.status_tel) and self.isValidStatus(self.status_dom)\
and self.isValidStatus(self.status_vis) and self.isValidStatus(self.status_nir):
return True
return False
def isExecutable(self) -> bool:
if self.isValidStatus(self.status_tel) and self.isValidStatus(self.status_dom)\
and self.isOutsideOk() and self.isInsideOk():
return True
return False
'''
check if the sequence timer is valid for execution, also check if there is a scheduling task running
'''
def isValidTimer(self, shs) -> bool:
current_countdown = self.getCountdown(shs)
if (current_countdown <= JulianSeconds(5)):
try:
task = TaskId.objects.filter(task="scheduling")
if not task:
return True
return False
except:
return True
return False
'''
Launch the observation tasks NIR and VIS associated to a sequence
'''
def executeSequence(self, shs, sequence):
shs.status = Sequence.EXECUTING
sequence.status = Sequence.EXECUTING
shs.save()
sequence.save()
log.info("Executing sequence id = " + str(sequence.pk))
self.logDB("Executing sequence")
plans_results = []
if sequence.albums.filter(detector__name="Cagire").exists():
if (self.isValidStatus(self.status_nir)):
for plan in sequence.albums.get(detector__name="Cagire").plans.all():
#res = observation_manager.tasks.execute_plan_nir.apply_async((plan.id, float(self.getCountdown(shs))))
if settings.USE_CELERY:
print("MJ: call observation_manager WITH CELERY")
res = observation_manager.tasks.execute_plan_nir.apply_async(
(plan.id, float(self.getCountdown(shs))))
else:
print("MJ: call observation_manager WITHOUT CELERY")
res = observation_manager.tasks.execute_plan_nir().run(
(plan.id, float(self.getCountdown(shs))))
# JB TODO : is it still usefull ?
# TaskId.objects.create(task_id=res.id, task="execute_plan")
plans_results.append(res)
else:
self.notifyDeviceStatus("Cagire", "Sequence execution", self.status_nir)
sequence.status = Sequence.CANCELLED
shs.status = Sequence.CANCELLED
shs.save()
sequence.save()
return (1)
if sequence.albums.filter(detector__name="Visible camera").exists():
if (self.isValidStatus(self.status_vis)):
for plan in sequence.albums.get(detector__name="Visible camera").plans.all():
#res = observation_manager.tasks.execute_plan_vis.apply_async((plan.id, float(self.getCountdown(shs))))
if settings.USE_CELERY:
print("MJ: call observation_manager WITH CELERY")
res = observation_manager.tasks.execute_plan_vis.apply_async((plan.id, float(self.getCountdown(shs))))
else:
print("MJ: call observation_manager WITHOUT CELERY")
res = observation_manager.tasks.execute_plan_vis().run((plan.id, float(self.getCountdown(shs))))
plans_results.append(res)
else:
self.notifyDeviceStatus("Camera visible", "Sequence execution", self.status_vis)
sequence.status = Sequence.CANCELLED
shs.status = Sequence.CANCELLED
shs.save()
sequence.save()
return (1)
self.executing_sequence = [shs, sequence, plans_results]
return (0)
'''
Set the next sequence
'''
def setNextSequence(self, shs, sequence):
sequence.status = Sequence.PENDING
shs.status = Sequence.PENDING
self.next_sequence = [shs, sequence]
sequence.save()
shs.save()
return (0)
'''
Check if the current sequence is finished
'''
def handleSequence(self, shs, sequence, executing_plans):
count = 0
for res in executing_plans:
try:
if res.successful() or res.failed():
count += 1
except Exception as e:
if DEBUG_FILE and settings.DEBUG:
log.info(str(e))
shs.status = Sequence.CANCELLED
sequence.status = Sequence.CANCELLED
shs.save()
sequence.save()
for rev in executing_plans:
if (not rev.failed() and not rev.successful()):
rev.revoke(terminate=True)
self.executing_sequence = None
return (-1)
if count >= len(executing_plans):
sequence.status = Sequence.EXECUTED
shs.status = Sequence.EXECUTED
sequence.save()
shs.save()
message = "Finished sequence " + str(sequence.pk) + " execution"
Log.objects.create(agent="Majordome", message=message)
self.executing_sequence = None
return (0)
'''
Function called to do an action with the devices status
'''
def handleStatus(self):
telescope = Telescope.objects.first()
camera_nir = Detector.objects.get(name="Cagire")
camera_vis = Detector.objects.get(name="Visible camera")
dome = Dome.objects.get(name="Dome")
dome.status = self.status_dom
telescope.status = self.status_tel
camera_nir.status = self.status_nir
camera_vis.status = self.status_vis
dome.save()
telescope.save()
camera_nir.save()
camera_vis.save()
self.logDB("Instrument status : dome = " + str(self.status_dom) + ", telescope = " + str(self.status_tel)
+ ", camera_nir = " + str(self.status_nir) + ", camera_vis" + str(self.status_vis))
return (0)
'''
Put the majordome in pause
'''
def systemPause(self, duration, cause: str):
self.logDB("System in pause for " + str(duration))
time.sleep(duration)
#scheduler.tasks.scheduling.apply_async(first_schedule=False, alert=False)
if settings.USE_CELERY:
print("MJ: call schedule WITH CELERY")
scheduler.tasks.scheduling.apply_async(first_schedule=False, alert=False)
else:
print("MJ: call schedule WITHOUT CELERY")
scheduler.tasks.scheduling().run(first_schedule=False, alert=False)
self.setTime()
print("system has been paused. Cause : " + cause)
return (0)
'''
Function called to do an action with the site status and the wheather status
'''
def handlePLC(self):
try:
site_status = SiteWatch.objects.latest('updated')
weather_status = WeatherWatch.objects.latest('updated')
self.weather_status = weather_status.global_status
self.site_status = site_status.global_status
except ObjectDoesNotExist as e:
if (settings.DEBUG and DEBUG_FILE):
log.info("No site_status or weather_status found in database : " + str(e))
# TODO shutdown everything
return 1
return 0
'''
Gets the time before the expected start of the execution.
'''
def getCountdown(self, shs):
# TODO start sequence as soon as possible (a lot of verifications must be done there)
current_time = secondsToPreciseJulianDate(getPreciseCurrentTime())
countdown = shs.tsp - current_time
return countdown
'''
Change observation conditions
'''
def changeObsConditions(self):
print("change_obs_conditions")
pass