Public Member Functions | |
| def | __init__ (self, bus, schedule_file='schedule.json') |
| def | check_state (self) |
| def | clear_empty (self) |
| def | clear_repeating (self) |
| def | get_event_handler (self, message) |
| def | load (self) |
| def | remove_event (self, event) |
| def | remove_event_handler (self, message) |
| def | run (self) |
| def | schedule_event (self, event, sched_time, repeat=None, data=None) |
| def | schedule_event_handler (self, message) |
| def | shutdown (self) |
| def | store (self) |
| def | update_event (self, event, data) |
| def | update_event_handler (self, message) |
Public Attributes | |
| bus | |
| event_lock | |
| events | |
| isRunning | |
| schedule_file | |
Detailed Description
Definition at line 43 of file event_scheduler.py.
Constructor & Destructor Documentation
| def mycroft.skills.event_scheduler.EventScheduler.__init__ | ( | self, | |
| bus, | |||
schedule_file = 'schedule.json' |
|||
| ) |
Create an event scheduler thread. Will send messages at a
predetermined time to the registered targets.
Args:
bus: Mycroft messagebus (mycroft.messagebus)
schedule_file: File to store pending events to on shutdown
Definition at line 44 of file event_scheduler.py.
Member Function Documentation
| def mycroft.skills.event_scheduler.EventScheduler.check_state | ( | self | ) |
Check if an event should be triggered.
Definition at line 99 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.clear_empty | ( | self | ) |
Remove empty event entries from events dict
Definition at line 228 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.clear_repeating | ( | self | ) |
Remove repeating events from events dict.
Definition at line 220 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.get_event_handler | ( | self, | |
| message | |||
| ) |
Messagebus interface to get_event.
Emits another event sending event status
Definition at line 199 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.load | ( | self | ) |
Load json data with active events from json file.
Definition at line 75 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.remove_event | ( | self, | |
| event | |||
| ) |
Definition at line 176 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.remove_event_handler | ( | self, | |
| message | |||
| ) |
Messagebus interface to the remove_event method.
Definition at line 181 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.run | ( | self | ) |
Definition at line 94 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.schedule_event | ( | self, | |
| event, | |||
| sched_time, | |||
repeat = None, |
|||
data = None |
|||
| ) |
Add event to pending event schedule using thread safe queue.
Args:
event (str): Handler for the event
sched_time ([type]): [description]
repeat ([type], optional): Defaults to None. [description]
data ([type], optional): Defaults to None. [description]
Definition at line 130 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.schedule_event_handler | ( | self, | |
| message | |||
| ) |
Messagebus interface to the schedule_event method.
Required data in the message envelope is
event: event to emit
time: time to emit the event
optional data is
repeat: repeat interval
data: data to send along with the event
Definition at line 153 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.shutdown | ( | self | ) |
Stop the running thread.
Definition at line 236 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.store | ( | self | ) |
Write current schedule to disk.
Definition at line 212 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.update_event | ( | self, | |
| event, | |||
| data | |||
| ) |
Definition at line 186 of file event_scheduler.py.
| def mycroft.skills.event_scheduler.EventScheduler.update_event_handler | ( | self, | |
| message | |||
| ) |
Messagebus interface to the update_event method.
Definition at line 193 of file event_scheduler.py.
Member Data Documentation
| mycroft.skills.event_scheduler.EventScheduler.bus |
Definition at line 59 of file event_scheduler.py.
| mycroft.skills.event_scheduler.EventScheduler.event_lock |
Definition at line 57 of file event_scheduler.py.
| mycroft.skills.event_scheduler.EventScheduler.events |
Definition at line 56 of file event_scheduler.py.
| mycroft.skills.event_scheduler.EventScheduler.isRunning |
Definition at line 60 of file event_scheduler.py.
| mycroft.skills.event_scheduler.EventScheduler.schedule_file |
Definition at line 61 of file event_scheduler.py.
The documentation for this class was generated from the following file: