-
-
Notifications
You must be signed in to change notification settings - Fork 10
/
NationalRailPy3.py
999 lines (859 loc) · 46.7 KB
/
NationalRailPy3.py
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
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
# This software was produced by Jonathan Foot (c) 2023, all rights reserved.
# Project Website : https://departureboard.jonathanfoot.com
# Documentation : https://jonathanfoot.com/Projects/DepartureBoard
# Description : This program allows you to display a live train departure board for any UK station nationally, excluding the London Underground.
# Python 3 Required.
import time
import inspect, os
import sys
import inflect
import re
import argparse
from PIL import ImageFont, Image, ImageDraw
from luma.core.render import canvas
from luma.core import cmdline
from datetime import datetime
from luma.core.image_composition import ImageComposition, ComposableImage
from nredarwin.webservice import DarwinLdbSession
###
# Below Declares all the program optional and compulsory settings/ start up paramters.
###
## Start Up Paramarter Checks
# Checks value is greater than Zero.
def check_positive(value):
try:
ivalue = int(value)
if ivalue <= 0:
raise argparse.ArgumentTypeError("%s is invalid, value must be an integer value greater than 0." % value)
return ivalue
except:
raise argparse.ArgumentTypeError("%s is invalid, value must be an integer value greater than 0." % value)
# Checks string is a valid time range, in the format of "00:00-24:00"
def check_time(value):
try:
datetime.strptime(value.split("-")[0], '%H:%M').time()
datetime.strptime(value.split("-")[1], '%H:%M').time()
except:
raise argparse.ArgumentTypeError(
"%s is invalid, value must be in the form of XX:XX-YY:YY, where the values are in 24hr format." % value)
return [datetime.strptime(value.split("-")[0], '%H:%M').time(),
datetime.strptime(value.split("-")[1], '%H:%M').time()]
## Defines all optional paramaters
parser = argparse.ArgumentParser(
description='National Rail Live Departure Board, to run the program you will need to pass it all of the required paramters and you may wish to pass any optional paramters.')
parser.add_argument("-t", "--TimeFormat", help="Do you wish to use 24hr or 12hr time format; default is 24hr.",
type=int, choices=[12, 24], default=24)
parser.add_argument("-v", "--Speed",
help="What speed do you want the text to scroll at on the display; default is 3, must be greater than 0.",
type=check_positive, default=3)
parser.add_argument("-d", "--Delay",
help="How long the display will pause before starting the next animation; default is 30, must be greater than 0.",
type=check_positive, default=30)
parser.add_argument("-r", "--RecoveryTime",
help="How long the display will wait before attempting to get new data again after previously failing; default is 100, must be greater than 0.",
type=check_positive, default=100)
parser.add_argument("-n", "--NumberOfCards",
help="The maximum number of cards you will see before forcing a new data retrieval, a limit is recommend to prevent cycling through data which may become out of data or going too far into scheduled trains; default is 9, must be greater than 0.",
type=check_positive, default=9)
parser.add_argument("-y", "--Rotation", help="Defines which way up the screen is rendered; default is 0", type=int,
default=0, choices=[0, 2])
parser.add_argument("-l", "--RequestLimit",
help="Defines the minium amount of time the display must wait before making a new data request; default is 55(seconds)",
type=check_positive, default=55)
parser.add_argument("-z", "--StaticUpdateLimit",
help="Defines the amount of time the display will wait before updating the expected arrival time (based upon it's last known predicted arrival time); default is 15(seconds), this should be lower than your 'RequestLimit'",
type=check_positive, default=15)
parser.add_argument("-e", "--EnergySaverMode",
help="To save screen from burn in and prolong it's life it is recommend to have energy saving mode enabled. 'off' is default, between the hours set the screen will turn off. 'dim' will turn the screen brightness down, but not completely off. 'none' will do nothing and leave the screen on; this is not recommend, you can change your active hours instead.",
type=str, choices=["none", "dim", "off"], default="off")
parser.add_argument("-i", "--InactiveHours",
help="The period of time for which the display will go into 'Energy Saving Mode' if turned on; default is '23:00-07:00'",
type=check_time, default="23:00-07:00")
parser.add_argument("-u", "--UpdateDays",
help="The number of days for which the Pi will wait before rebooting and checking for a new update again during your energy saving period; default 1 day (every day check).",
type=check_positive, default=1)
parser.add_argument("-x", "--ExcludedPlatforms", default="",
help="List any platforms you do not wish to view. Make sure to capitalise correctly and simply put a single space between each; default is nothing, ie show every platform.",
nargs='*')
parser.add_argument("-q", "--Header", default="desc", choices=['desc', 'loc', 'date', 'none'],
help="Defines the design for the top row/ header of the display. desc- List the purpose of each column. loc- Names the location of the station above. date- List the date at the top. none-Keeps the header blank. default is desc.")
parser.add_argument("-c", "--HeaderAlignment", default="center", choices=['right', 'center'],
help="If you use the 'loc' or 'date' header you can choose to either center or right align this text. By default it will center align.")
parser.add_argument("-m", "--Design", default='full',
help="Alters the design of the display, full- shows both scheduled and expected arrival time. compact- shows only the expected time (like a bus display); default is 'full'",
choices=['full', 'compact'])
parser.add_argument('--ShowCallingAtForDirect', dest='ShowDirect', action='store_true', default=False,
help="For trains that are a direct route, ie they will only be calling at their terminating destination by default have their calling at animation skipped. Using this tag will show the animation again.")
parser.add_argument('--HidePlatform', dest='HidePlatform', action='store_true',
help="Do you wish to hide the platform number for each service due to arrive.")
parser.add_argument('--ShowIndex', dest='ShowIndex', action='store_true',
help="Do you wish to see index position for each service due to arrive.")
parser.add_argument("--ReducedAnimations",
help="If you wish to stop the Via animation and cycle faster through the services use this tag to turn the animation off.",
dest='ReducedAnimations', action='store_true')
parser.add_argument("--FixNextToArrive", dest='FixToArrive', action='store_true', default=False,
help="Keep the train next arrive at the very top of the display until it has left; by default false")
parser.add_argument('--no-splashscreen', dest='SplashScreen', action='store_false',
help="Do you wish to see the splash screen at start up; recommended and on by default.")
parser.add_argument("--Display", default="ssd1322", choices=['ssd1322', 'pygame', 'capture', 'gifanim'],
help="Used for development purposes, allows you to switch from a physical display to a virtual emulated one; default 'ssd1322'")
parser.add_argument("--max-frames", default=60, dest='maxframes', type=check_positive,
help="Used only when using gifanim emulator, sets how long the gif should be.")
parser.add_argument("--no-console-output", dest='NoConsole', action='store_true',
help="Used to stop the program outputting anything to console that isn't an error message, you might want to do this if your logging the program output into a file to record crashes.")
parser.add_argument("--filename", dest='filename', default="output.gif",
help="Used mainly for development, if using a gifanim display, this can be used to set the output gif file name, this should always end in .gif.")
parser.add_argument("--PartialAnimations",
help="Only show the Via animation for the top service and cycle faster through the services",
dest='PartialAnimations', action='store_true')
parser.add_argument("--SortByActual",
help="By default services will be displayed in the order of their scheduled departure time. Use this flag to sort by their Actual/Expected departure time if this is known.",
dest='SortByActual', action='store_true')
# Defines the required paramaters
requiredNamed = parser.add_argument_group('required named arguments')
requiredNamed.add_argument("-k", "--APIToken",
help="Your OpenLDBWS National Rail Token, you can get your own from: http://realtime.nationalrail.co.uk/OpenLDBWSRegistration/",
type=str, required=True)
requiredNamed.add_argument("-s", "--StationID",
help="The Station Code for the specific station you wish to display. View all codes here: https://www.nationalrail.co.uk/stations_destinations/48541.aspx",
type=str, required=True)
Args = parser.parse_args()
# Calculates the size of the font based upon the settings the users used; to best maximise screen space.
FontSize = 11
TimeSize = 14
if Args.Design == 'full':
if Args.ShowIndex:
if Args.HidePlatform:
FontSize = 12
else:
FontSize = 11
else:
FontSize = 12
Offset = FontSize
elif Args.Design == 'compact':
if Args.ShowIndex:
if Args.HidePlatform:
FontSize = 13
else:
FontSize = 12
else:
FontSize = 13
Offset = FontSize
if Args.Header == 'none':
if Args.HidePlatform:
FontSize += 2
else:
FontSize += 1
TimeSize = 16
Offset = FontSize / 4
## Defines all the programs "global" variables
# Defines the fonts used throughout most the program
BasicFont = ImageFont.truetype(
"%s/resources/lower.ttf" % (os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))),
FontSize - 1)
# Stores the name of the station being displayed.
StationName = ""
###
# Below contains the class which is used to reperesent one instance of a service record. It is also responsible for getting the information from the Transport API.
###
# Used to create a blank object, needed in start-up or when there are less than 3 services currently scheduled.
class LiveTimeStud():
def __init__(self):
self.Index = " "
self.Destination = " "
self.SchArrival = " "
self.ExptArrival = " "
self.DisplayTime = " "
self.CallingAt = " "
self.Platfrom = " "
self.ID = " "
self.Operator = " "
self.IsCancelled = " "
self.DisruptionReason = " "
self.DisplayText = " "
self.ID = "0"
def TimePassedStatic(self):
return False
# Used to get live data from the National Rail API and represent a specific services and it's details.
class LiveTime(object):
# The last time an API call was made to get new data.
LastUpdate = datetime.now()
# * Change this method to implement your own API *
def __init__(self, Data, Index, serviceC):
self.Index = str(inflect.engine().ordinal(Index))
self.Destination = str(serviceC.destination_text).split("via")[0]
self.SchArrival = self.GetArrivalTime(Data)
# The text displayed showing the status of the train, ie, "On time", "Canceled" or "XX:XX"
self.ExptArrival = self.GetExpectedArrivalTime(Data)
self.DisplayTime = self.GetExptTime()
# The text displayed showing where the train will be stopping at along the way.
self.CallingAt = str([cp.location_name for cp in Data.subsequent_calling_points]).replace(']', '').replace('[',
'').replace(
'\'', '')
self.Platform = str(serviceC.platform) if serviceC.platform != None else ""
self.ID = str(serviceC.service_id)
self.Operator = str(Data.operator_name)
# The main text displayed on the screen.
self.DisplayText = self.GetDisplayMessage()
## Currently not used in the program
#self.IsCancelled = str(Data.is_cancelled)
#self.DisruptionReason = str(Data.disruption_reason)
# Gets the expected arrival time - if not known get departure time instead, else get scheduled.
def GetExpectedArrivalTime(self, Data):
if (Data.eta == None):
if (Data.etd == None):
return self.GetArrivalTime(Data)
else:
return str(Data.etd)
else:
return str(Data.eta)
# Gets the expected arrival time, if not known get departure time instead.
def GetArrivalTime(self, Data):
if (Data.sta == None):
return str(Data.std)
else:
return str(Data.sta)
# Returns the string which will be shown on the display.
def GetDisplayMessage(self):
msg = ''
if Args.ShowIndex:
msg += self.Index + ' '
if Args.Design == 'full':
msg += datetime.strptime(str(datetime.now().date()) + " " + self.SchArrival,
'%Y-%m-%d %H:%M').time().strftime(
"%H:%M" if (Args.TimeFormat == 24) else "%I:%M") + ' '
if not Args.HidePlatform:
msg += self.Platform
msg += ' ' * (4 - len(self.Platform))
return msg
# Returns the string to display for the predicted arrival text box
def GetExptTime(self):
self.LastStaticUpdate = datetime.now()
if Args.Design == 'full':
if re.search('[a-zA-Z]', self.ExptArrival):
return self.ExptArrival
else:
return datetime.strptime(str(datetime.now().date()) + " " + self.ExptArrival,
'%Y-%m-%d %H:%M').time().strftime(
"%H:%M" if (Args.TimeFormat == 24) else "%I:%M")
else:
if re.search('[a-zA-Z]', self.ExptArrival) and self.ExptArrival != 'On time':
return self.ExptArrival
ExpTime = self.ExptArrival
if self.ExptArrival == 'On time':
ExpTime = self.SchArrival
try:
Diff = (datetime.strptime(ExpTime, "%H:%M").replace(year=datetime.now().year,
month=datetime.now().month,
day=datetime.now().day) - datetime.now()).total_seconds() / 60
if Diff <= 1:
return ' Arriving'
if Diff >= 15:
return ExpTime
return ' %d min' % Diff
except Exception as e:
print("GetExptTime() ERROR")
print(str(e))
return ExpTime
# Returns true or false dependent upon if the last time an API data call was made was over the request limit; to prevent spamming the API feed.
@staticmethod
def TimePassed():
return (datetime.now() - LiveTime.LastUpdate).total_seconds() > Args.RequestLimit
# Return true or false dependent upon if the last time the display was updated was over the static update limit. This prevents updating the display to frequently to increase performance.
def TimePassedStatic(self):
return ("min" in self.ExptArrival) and (
datetime.now() - self.LastStaticUpdate).total_seconds() > Args.StaticUpdateLimit
@staticmethod
def sort_key(train):
def convert_to_datetime(time_str):
try:
return datetime.strptime(time_str, "%H:%M")
except (ValueError, TypeError):
return None
real_departure = convert_to_datetime(train.etd) if train.etd is not None else convert_to_datetime(train.eta)
scheduled_departure = convert_to_datetime(train.std) if train.std is not None else convert_to_datetime(
train.sta)
return (real_departure if real_departure is not None else scheduled_departure)
# Calls the API and gets the data from it, returning a list of LiveTime objects to be used in the program.
# * Change this method to implement your own API *
@staticmethod
def GetData():
LiveTime.LastUpdate = datetime.now()
services = []
try:
darwin_sesh = DarwinLdbSession(wsdl="https://lite.realtime.nationalrail.co.uk/OpenLDBWS/wsdl.aspx",
api_key=Args.APIToken)
board = darwin_sesh.get_station_board(Args.StationID)
global StationName
StationName = board.location_name
# Sort by the actual expected departure time, instead of the scheduled.
if Args.SortByActual:
sorted_train_list = sorted(board.train_services, key=LiveTime.sort_key)
else:
sorted_train_list = board.train_services
for serviceC in sorted_train_list:
if len(services) >= Args.NumberOfCards:
break
service = darwin_sesh.get_service_details(serviceC.service_id)
if (service.sta != None or service.std != None) and str(service.platform) not in Args.ExcludedPlatforms:
services.append(LiveTime(service, len(services) + 1, serviceC))
return services
except Exception as e:
print("GetData() ERROR")
print(str(e))
return []
###
# Below contains everything for the drawing on the board.
# All text must be converted into Images, for the image to be displayed on the display.
###
# Used to create the time on the board or any other basic text box.
class TextImage():
def __init__(self, device, text):
self.image = Image.new(device.mode, (device.width, FontSize))
draw = ImageDraw.Draw(self.image)
draw.text((0, 0), text, font=BasicFont, fill="white")
self.width = int(draw.textlength(text, BasicFont))
self.height = 4 + TimeSize
del draw
# Used to create the time on the board or any other basic text box.
class VariableTextImage():
def __init__(self, device, text, sizeAllowed):
# Add 5 onto the size to allow for padding
self.image = Image.new(device.mode, (sizeAllowed + 5, FontSize))
draw = ImageDraw.Draw(self.image)
draw.text((0, 0), text, font=self.generateFont(text, sizeAllowed), fill="white")
self.width = 5 + int(draw.textlength(text, BasicFont))
self.height = 4 + TimeSize
del draw
@staticmethod
def generateFont(text, sizeAllowed):
tempFontSize = 3
font = ImageFont.truetype(
"%s/resources/lower.ttf" % (os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))),
tempFontSize)
while font.getlength(text) < sizeAllowed and tempFontSize <= FontSize - 1:
# iterate until the text size is just larger than the criteria
tempFontSize += 1
font = ImageFont.truetype(
"%s/resources/lower.ttf" % (os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))),
tempFontSize)
# optionally de-increment to be sure it is less than criteria
tempFontSize -= 1
return ImageFont.truetype(
"%s/resources/lower.ttf" % (os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))),
tempFontSize)
# Used to create the Calling At text box due to the length needed.
class LongTextImage():
def __init__(self, device, text):
self.image = Image.new(device.mode, (device.width * 5, FontSize))
draw = ImageDraw.Draw(self.image)
draw.text((0, 0), text, font=BasicFont, fill="white")
self.width = 5 + int(draw.textlength(text, BasicFont))
self.height = 4 + TimeSize
del draw
#Used for the opening animation, creates a static two lines of the new and previous service.
class StaticTextImage():
def __init__(self, device, service, previous_service):
self.image = Image.new(device.mode, (device.width, FontSize * 2))
draw = ImageDraw.Draw(self.image)
displayTimeTemp = TextImage(device, service.DisplayTime)
displayInfoTemp = TextImage(device, service.DisplayText)
sizeRemaining = device.width - (displayTimeTemp.width + displayInfoTemp.width)
draw.text((0, FontSize), service.DisplayText, font=BasicFont, fill="white")
draw.text((device.width - displayTimeTemp.width, FontSize), service.DisplayTime, font=BasicFont, fill="white")
draw.text((displayInfoTemp.width, FontSize), service.Destination,
font=VariableTextImage.generateFont(service.Destination, sizeRemaining), fill="white")
displayTimeTempPrev = TextImage(device, previous_service.DisplayTime)
displayInfoTempPrev = TextImage(device, previous_service.DisplayText)
sizeRemainingPrev = device.width - (displayTimeTempPrev.width + displayInfoTempPrev.width)
draw.text((0, 0), previous_service.DisplayText, font=BasicFont, fill="white")
draw.text((device.width - displayTimeTempPrev.width, 0), previous_service.DisplayTime, font=BasicFont,
fill="white")
draw.text((displayInfoTempPrev.width, 0), previous_service.Destination,
font=VariableTextImage.generateFont(previous_service.Destination, sizeRemainingPrev), fill="white")
self.width = device.width
self.height = FontSize * 2
del draw
#Used to draw a black cover over hidden stuff.
class RectangleCover():
def __init__(self, device):
w = device.width
h = FontSize
self.image = Image.new(device.mode, (w, h))
draw = ImageDraw.Draw(self.image)
draw.rectangle((0, 0, device.width, FontSize), outline="black", fill="black")
del draw
self.width = w
self.height = h
#Error message displayed when no data can be found.
class NoService():
def __init__(self, device):
w = device.width
h = FontSize
msg = "No Scheduled Services Found"
self.image = Image.new(device.mode, (w, h))
draw = ImageDraw.Draw(self.image)
draw.text((0, 0), msg, font=BasicFont, fill="white")
self.width = draw.textlength(msg, font=BasicFont)
self.height = h
del draw
###
## Synchronizer, used to keep track what is busy doing work and what is ready to do more work.
###
# Used to ensure that only 1 animation is playing at any given time, apart from at the start; where all three can animate in.
class Synchroniser():
def __init__(self):
self.synchronised = {}
def busy(self, task):
self.synchronised[id(task)] = False
def ready(self, task):
self.synchronised[id(task)] = True
def is_synchronised(self):
for task in self.synchronised.items():
if task[1] == False:
return False
return True
###
## Below contains the class which represents a single row on the train display, a LiveTime object contains all the information on a service and is then wrapped up in a ScrollTime Object
## This object contains the state of the object, such as if it is in an animation and what should be displayed to the display.
###
class ScrollTime():
WAIT_OPENING = 0
OPENING_SCROLL = 1
OPENING_END = 2
SCROLL_DECIDER = 3
SCROLLING_WAIT = 4
SCROLLING_PAUSE = 5
SCROLLING = 6
WAIT_SYNC = 7
WAIT_STUD = 8
STUD_SCROLL = 9
STUD_END = 10
STUD = -1
def __init__(self, image_composition, service, previous_service, scroll_delay, synchroniser, device, position,
controller):
self.speed = Args.Speed
self.position = position
self.Controller = controller
self.max_pos = 0 #Place holder until set in generateCards()
self.image_composition = image_composition
self.rectangle = ComposableImage(RectangleCover(device).image,
position=(0, (FontSize * position) + FontSize + Offset))
self.CurrentService = service
self.DirectService = False
self.generateCard(service)
self.IStaticOld = ComposableImage(StaticTextImage(device, service, previous_service).image,
position=(0, Offset + (FontSize * position)))
self.image_composition.add_image(self.IStaticOld)
self.image_composition.add_image(self.rectangle)
self.image_y_posA = 0
self.image_x_pos = 0
self.device = device
self.partner = None
self.delay = scroll_delay
self.ticks = 0
self.state = self.OPENING_SCROLL if service.ID != 0 else self.STUD
self.synchroniser = synchroniser
self.render()
self.synchroniser.ready(self)
# Generates all the Images (Text boxes) to be drawn on the display.
def generateCard(self, service):
displayTimeTemp = TextImage(device, service.DisplayTime)
displayInfoTemp = TextImage(device, service.DisplayText)
sizeRemaining = device.width - (displayTimeTemp.width + displayInfoTemp.width)
displayDestinationTemp = VariableTextImage(device, service.Destination, sizeRemaining)
self.IDisplayText = ComposableImage(displayInfoTemp.image, position=(0, Offset + (FontSize * self.position)))
self.IDestintion = ComposableImage(displayDestinationTemp.image,
position=(displayInfoTemp.width, Offset + (FontSize * self.position)))
self.IDisplayTime = ComposableImage(displayTimeTemp.image, position=(
device.width - displayTimeTemp.width, Offset + (FontSize * self.position)))
TempSCallingAt = TextImage(device, "Calling at:")
TempICallingAt = LongTextImage(device, service.CallingAt)
self.DirectService = ',' not in service.CallingAt
self.ICallingAt = ComposableImage(
TempICallingAt.image.crop((0, 0, max(TempICallingAt.width + 3, 256), FontSize)),
position=(TempSCallingAt.width + 3, Offset + (FontSize * self.position)))
self.SCallingAt = ComposableImage(TempSCallingAt.image.crop((0, 0, TempSCallingAt.width, FontSize)),
position=(0, Offset + (FontSize * self.position)))
self.max_pos = TempICallingAt.width + 3
# Called when you have new/updated information from an API call and want to update the objects predicted arrival time.
def updateCard(self, newService, device):
self.state = self.SCROLL_DECIDER
self.synchroniser.ready(self)
self.image_composition.remove_image(self.IDisplayTime)
self.image_composition.remove_image(self.IDestintion)
displayTimeTemp = TextImage(device, newService.DisplayTime)
self.IDisplayTime = ComposableImage(displayTimeTemp.image, position=(
device.width - displayTimeTemp.width, Offset + (FontSize * self.position)))
tempDisplayText = TextImage(device, newService.DisplayText)
sizeRemaining = device.width - (displayTimeTemp.width + tempDisplayText.width)
displayDestinationTemp = VariableTextImage(device, newService.Destination, sizeRemaining)
self.IDestintion = ComposableImage(displayDestinationTemp.image,
position=(tempDisplayText.width, Offset + (FontSize * self.position)))
self.image_composition.add_image(self.IDestintion)
self.image_composition.add_image(self.IDisplayTime)
self.image_composition.refresh()
# Called when you want to change the row from one service to another.
def changeCard(self, newService, device):
if newService.ID == "0" and self.CurrentService.ID == "0":
self.state = self.STUD
self.synchroniser.ready(self)
return
self.synchroniser.busy(self)
self.IStaticOld = ComposableImage(StaticTextImage(device, newService, self.CurrentService).image,
position=(0, Offset + (FontSize * self.position)))
self.image_composition.add_image(self.IStaticOld)
self.image_composition.add_image(self.rectangle)
if self.CurrentService.ID != "0":
self.image_composition.remove_image(self.IDisplayText)
self.image_composition.remove_image(self.IDestintion)
self.image_composition.remove_image(self.IDisplayTime)
del self.IDisplayText
del self.IDisplayTime
del self.IDestintion
if self.partner != None and self.partner.CurrentService.ID != "0":
self.partner.refresh()
self.image_composition.refresh()
self.generateCard(newService)
self.CurrentService = newService
self.state = self.WAIT_STUD if (newService.ID == "0") else self.WAIT_OPENING
# Used when you want to delete the row/object.
def delete(self):
try:
self.image_composition.remove_image(self.IStaticOld)
self.image_composition.remove_image(self.rectangle)
except:
pass
try:
self.image_composition.remove_image(self.IDisplayText)
self.image_composition.remove_image(self.IDestintion)
self.image_composition.remove_image(self.IDisplayTime)
except:
pass
try:
self.image_composition.remove_image(self.ICallingAt)
self.image_composition.remove_image(self.SCallingAt)
except:
pass
self.image_composition.refresh()
# Called upon each time you want to get the next frame for the display.
def tick(self):
#Update X min till arrival.
if self.CurrentService.TimePassedStatic() and (
self.state == self.SCROLL_DECIDER or self.state == self.SCROLLING_WAIT or self.state == self.SCROLLING or self.state == self.WAIT_SYNC):
self.image_composition.remove_image(self.IDisplayTime)
self.CurrentService.DisplayTime = self.CurrentService.GetExptTime()
displayTimeTemp = TextImage(device, self.CurrentService.DisplayTime)
self.IDisplayTime = ComposableImage(displayTimeTemp.image, position=(
device.width - displayTimeTemp.width, Offset + (FontSize * self.position)))
self.image_composition.add_image(self.IDisplayTime)
self.image_composition.refresh()
if self.state == self.WAIT_OPENING:
if not self.is_waiting():
self.state = self.OPENING_SCROLL
elif self.state == self.OPENING_SCROLL:
if self.image_y_posA < FontSize:
self.render()
self.image_y_posA += self.speed
else:
self.state = self.OPENING_END
elif self.state == self.OPENING_END:
self.image_x_pos = 0
self.image_y_posA = 0
self.image_composition.remove_image(self.IStaticOld)
self.image_composition.remove_image(self.rectangle)
del self.IStaticOld
self.image_composition.add_image(self.IDisplayText)
self.image_composition.add_image(self.IDestintion)
self.image_composition.add_image(self.IDisplayTime)
self.render()
self.synchroniser.ready(self)
self.state = self.SCROLL_DECIDER
elif self.state == self.SCROLL_DECIDER:
if self.synchroniser.is_synchronised():
if not self.is_waiting():
if self.synchroniser.is_synchronised():
self.synchroniser.busy(self)
if Args.ReducedAnimations or (self.DirectService and not Args.ShowDirect):
self.state = self.WAIT_SYNC
elif Args.PartialAnimations and self.position != 0:
self.state = self.WAIT_SYNC
elif self.CurrentService.ID == "0":
self.synchroniser.ready(self)
self.state = self.STUD
else:
self.state = self.SCROLLING_WAIT
elif self.state == self.SCROLLING_WAIT:
if not self.is_waiting():
self.image_composition.remove_image(self.IDisplayText)
self.image_composition.remove_image(self.IDestintion)
self.image_composition.remove_image(self.IDisplayTime)
self.image_composition.add_image(self.ICallingAt)
self.image_composition.add_image(self.SCallingAt)
self.state = self.SCROLLING_PAUSE
elif self.state == self.SCROLLING_PAUSE:
if not self.is_waiting():
self.state = self.SCROLLING
elif self.state == self.SCROLLING:
if self.image_x_pos < self.max_pos:
self.render()
self.image_x_pos += self.speed
else:
self.image_composition.remove_image(self.SCallingAt)
self.image_composition.remove_image(self.ICallingAt)
self.image_composition.add_image(self.IDisplayText)
self.image_composition.add_image(self.IDestintion)
self.image_composition.add_image(self.IDisplayTime)
self.state = self.WAIT_SYNC
elif self.state == self.WAIT_SYNC:
if self.image_x_pos != 0:
self.image_x_pos = 0
self.render()
else:
if not self.is_waiting():
self.Controller.requestCardChange(self, self.position + 1)
elif self.state == self.WAIT_STUD:
if not self.is_waiting():
self.state = self.STUD_SCROLL
elif self.state == self.STUD_SCROLL:
if self.image_y_posA < FontSize:
self.render()
self.image_y_posA += self.speed
else:
self.state = self.STUD_END
elif self.state == self.STUD_END:
self.image_x_pos = 0
self.image_y_posA = 0
self.image_composition.remove_image(self.IStaticOld)
self.image_composition.remove_image(self.rectangle)
del self.IStaticOld
self.render()
self.synchroniser.ready(self)
self.state = self.STUD
elif self.state == self.STUD:
if not self.is_waiting():
self.Controller.requestCardChange(self, self.position + 1)
# Sets the image offest for the animation, telling it how to render.
def render(self):
if (self.state == self.SCROLLING or self.state == self.WAIT_SYNC):
self.ICallingAt.offset = (self.image_x_pos, 0)
if (self.state == self.OPENING_SCROLL or self.state == self.STUD_SCROLL):
self.IStaticOld.offset = (0, self.image_y_posA)
# Used to reset the image on the display.
def refresh(self):
if hasattr(self, 'IDisplayText') and hasattr(self, 'IDisplayTime') and hasattr(self, 'IDestintion'):
self.image_composition.remove_image(self.IDisplayText)
self.image_composition.remove_image(self.IDestintion)
self.image_composition.remove_image(self.IDisplayTime)
self.image_composition.add_image(self.IDisplayText)
self.image_composition.add_image(self.IDestintion)
self.image_composition.add_image(self.IDisplayTime)
# Used to add a partner; this is the row below it self. Used when needed to tell partner to redraw itself
# on top of the row above it (layering the text boxes correctly)
def addPartner(self, partner):
self.partner = partner
# Used to add a time delay between animations.
def is_waiting(self):
self.ticks += 1
if self.ticks > self.delay:
self.ticks = 0
return False
return True
###
## Board Controller
## Defines the board which controls what each off the rows in the display will show at any time.
###
class boardFixed():
def __init__(self, image_composition, scroll_delay, device):
self.Services = LiveTime.GetData()
self.synchroniser = Synchroniser()
self.scroll_delay = scroll_delay
self.image_composition = image_composition
self.device = device
self.ticks = 0
self.setInitalCards()
self.State = "alive"
NoServiceTemp = NoService(device)
self.NoServices = ComposableImage(NoServiceTemp.image, position=(
int(device.width / 2 - NoServiceTemp.width / 2), int(device.height / 2 - NoServiceTemp.height / 2)))
self.top.addPartner(self.middel)
self.middel.addPartner(self.bottom)
# Set up the cards for the initial starting animation.
def setInitalCards(self):
self.top = ScrollTime(image_composition, len(self.Services) >= 1 and self.Services[0] or LiveTimeStud(),
LiveTimeStud(), self.scroll_delay, self.synchroniser, device, 0, self)
self.middel = ScrollTime(image_composition, len(self.Services) >= 2 and self.Services[1] or LiveTimeStud(),
LiveTimeStud(), self.scroll_delay, self.synchroniser, device, 1, self)
self.bottom = ScrollTime(image_composition, len(self.Services) >= 3 and self.Services[2] or LiveTimeStud(),
LiveTimeStud(), self.scroll_delay, self.synchroniser, device, 2, self)
self.x = len(self.Services) < 3 and len(self.Services) or 3
# Called upon every time a new frame is needed.
def tick(self):
#If no data can be found.
if len(self.Services) == 0:
if self.ticks == 0:
self.image_composition.add_image(self.NoServices)
#Wait a period of time then try getting new data again.
if not self.is_waiting():
self.top.delete()
del self.top
self.middel.delete()
del self.middel
self.bottom.delete()
del self.bottom
self.image_composition.remove_image(self.NoServices)
self.State = "dead"
else:
# Tell all rows of the display next frame is wantted.
self.top.tick()
self.middel.tick()
self.bottom.tick()
# Called when a row has completed one cycle of it's states and requests to change card, here the program decides what to do.
def requestCardChange(self, card, row):
# If it has cycled through all cards, cycle from start again, unless enough time has passed for a new API request.
if (self.x > Args.NumberOfCards or self.x > len(self.Services) - 1):
self.x = 1 if Args.FixToArrive else 0
if LiveTime.TimePassed():
self.Services = LiveTime.GetData()
print_safe("New Data Retrieved %s" % datetime.now().time())
# If there are more rows (3) than there is services scheduled show nothing.
if row > len(self.Services):
card.changeCard(LiveTimeStud(), device)
return
# If there is exactly 3 or less services the order in which they appear on the display is fixed to the order they will arrive in.
if len(self.Services) <= 3:
if self.Services[row - 1].ID == card.CurrentService.ID:
card.updateCard(self.Services[row - 1], device)
else:
card.changeCard(self.Services[row - 1], device)
else:
# If not they will cycled around showing whatever card is next.
if Args.FixToArrive and row == 1:
if self.Services[0].ID == card.CurrentService.ID:
card.updateCard(self.Services[0], device)
else:
card.changeCard(self.Services[0], device)
else:
if self.Services[self.x % len(self.Services)].ID == card.CurrentService.ID:
card.updateCard(self.Services[self.x % len(self.Services)], device)
else:
card.changeCard(self.Services[self.x % len(self.Services)], device)
if not (Args.FixToArrive and row == 1):
self.x = self.x + 1
# Used to add a time delay if there was an error with the last API request (providing a back off and wait mechanism)
def is_waiting(self):
self.ticks += 1
if self.ticks > Args.RecoveryTime:
self.ticks = 0
return False
return True
# Returns the string for the header at the top of the display.
def GetHeader(self):
msg = ''
if Args.Header == 'desc':
if Args.ShowIndex:
msg += 'Idx '
if Args.Design == 'full':
msg += 'Time '
if not Args.HidePlatform:
msg += 'Plt '
msg += 'Destination'
elif Args.Header == 'loc':
msg += StationName
elif Args.Header == 'date':
msg += datetime.today().strftime('%Y-%m-%d')
return msg
# Used to work out if the current time is between the inactive hours.
def is_time_between():
# If check time is not given, default to current UTC time
check_time = datetime.now().time()
if Args.InactiveHours[0] < Args.InactiveHours[1]:
return check_time >= Args.InactiveHours[0] and check_time <= Args.InactiveHours[1]
else: # crosses midnight
return check_time >= Args.InactiveHours[0] or check_time <= Args.InactiveHours[1]
# Checks that the user has allowed outputting to console.
def print_safe(msg):
if not Args.NoConsole:
print(msg)
###
## Main
## Connects to the display and makes it update forever until ended by the user with a ctrl-c
###
DisplayParser = cmdline.create_parser(description='Dynamically connect to either a virtual or physical display.')
device = cmdline.create_device(DisplayParser.parse_args(
['--display', str(Args.Display), '--interface', 'spi', '--width', '256', '--rotate', str(Args.Rotation)]))
if Args.Display == 'gifanim':
device._filename = str(Args.filename)
device._max_frames = int(Args.maxframes)
image_composition = ImageComposition(device)
board = boardFixed(image_composition, Args.Delay, device)
FontTime = ImageFont.truetype(
"%s/resources/time.otf" % (os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))), TimeSize)
device.contrast(255)
energyMode = "normal"
StartUpDate = datetime.now().date()
HeaderStr = board.GetHeader()
HeaderPos = 0
if (Args.Header == 'date' or Args.Header == 'loc') and Args.HeaderAlignment == 'center':
draw = ImageDraw.Draw(Image.new(device.mode, (device.width, FontSize)))
headerWidth = int(draw.textlength(HeaderStr, BasicFont))
HeaderPos = device.width / 2 - headerWidth / 2
# Draws the clock and tells the rest of the display next frame wanted.
def display():
board.tick()
msgTime = str(datetime.now().strftime("%H:%M:%S" if (Args.TimeFormat == 24) else "%I:%M:%S"))
with canvas(device, background=image_composition()) as draw:
image_composition.refresh()
draw.multiline_text((HeaderPos, 0), HeaderStr, font=BasicFont)
draw.multiline_text(
((device.width - int(draw.textlength(msgTime, FontTime))) / 2, device.height - (TimeSize + 1)), msgTime,
font=FontTime, align="center")
# Draws the splash screen on start up
def Splash():
if Args.SplashScreen:
with canvas(device) as draw:
draw.multiline_text((64, 10), "Departure Board", font=ImageFont.truetype(
"%s/resources/Bold.ttf" % (os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))),
20), align="center")
draw.multiline_text((45, 35), "Version : 2.12.NR - By Jonathan Foot", font=ImageFont.truetype(
"%s/resources/Skinny.ttf" % (os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))),
15), align="center")
time.sleep(30) # Wait such a long time to allow the device to startup and connect to a WIFI source first.
try:
Splash()
# Run the program forever
while True:
time.sleep(0.02)
if 'board' in globals() and board.State == "dead":
del board
board = boardFixed(image_composition, Args.Delay, device)
device.clear()
# Turns the display into one of the energy saving modes if in the correct time and enabled.
if (Args.EnergySaverMode != "none" and is_time_between()):
# Check for program updates and restart the pi every 'UpdateDays' Days.
# if (datetime.now().date() - StartUpDate).days >= Args.UpdateDays:
# print_safe("Checking for updates and then restarting Pi.")
# os.system("sudo git -C %s pull; sudo reboot" % (os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))))
# sys.exit()
if Args.EnergySaverMode == "dim":
if energyMode == "normal":
device.contrast(15)
energyMode = "dim"
display()
elif Args.EnergySaverMode == "off":
if energyMode == "normal":
del board
device.clear()
device.hide()
energyMode = "off"
else:
if energyMode != "normal":
device.contrast(255)
if energyMode == "off":
device.show()
Splash()
board = boardFixed(image_composition, Args.Delay, device)
energyMode = "normal"
display()
except KeyboardInterrupt:
pass