Optimized API usage, added departures filtering

Author: PiotrMachowski

README.md

@@ -20,6 +20,8 @@ This sensor uses unofficial API to get data from [*Rozkładzik.pl*](https://www.
 | `id` | ID of stop |
 | `name` | Name of stop |
 | `stops_group_mode` | Enables stops group mode. Possible values: `true`, `false`. |
+| `lines` | `list` | `False` | all available | List of monitored lines. |
+| `directions` | `list` | `False` | all available | List of monitored directions. |
 
 ## Example usage
 
@@ -30,9 +32,13 @@ sensor:
     stops:
       - id: 1281
         name: 'Plac Grunwaldzki'
+        directions:
+          - "Reja"
       - id: 94
         name: 'Rynek'
         stops_group_mode: true
+        lines:
+          - "33"
 ```
 
 ## Installation

custom_components/rozkladzik/sensor.py

@@ -13,6 +13,8 @@
 CONF_STOP_ID = 'id'
 CONF_STOP_NAME = 'name'
 CONF_GROUP_MODE = 'stops_group_mode'
+CONF_LINES = 'lines'
+CONF_DIRECTIONS = 'directions'
 CONF_CITY = 'city'
 
 DEFAULT_NAME = 'Rozkładzik'
@@ -25,6 +27,8 @@
             vol.Required(CONF_STOP_ID): cv.positive_int,
             vol.Required(CONF_STOP_NAME): cv.string,
             vol.Optional(CONF_GROUP_MODE, default=False): cv.boolean,
+            vol.Optional(CONF_LINES, default=[]): cv.ensure_list,
+            vol.Optional(CONF_DIRECTIONS, default=[]): cv.ensure_list
         })])
 })
 
@@ -38,22 +42,27 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
         stop_id = stop.get(CONF_STOP_ID)
         stop_name = stop.get(CONF_STOP_NAME)
         group_mode = stop.get(CONF_GROUP_MODE)
+        lines = stop.get(CONF_LINES)
+        directions = stop.get(CONF_DIRECTIONS)
         uid = '{}_{}_{}'.format(name, city, stop_id)
         entity_id = async_generate_entity_id(ENTITY_ID_FORMAT, uid, hass=hass)
-        dev.append(RozkladzikSensor(entity_id, name, city, stop_id, stop_name, group_mode))
+        dev.append(RozkladzikSensor(entity_id, name, city, stop_id, stop_name, group_mode, lines, directions))
     add_entities(dev, True)
 
 
 class RozkladzikSensor(Entity):
-    def __init__(self, entity_id, name, city, stop_id, stop_name, group_mode):
+    def __init__(self, entity_id, name, city, stop_id, stop_name, group_mode, watched_lines, watched_directions):
         self.entity_id = entity_id
         self._name = name
         self._stop_id = stop_id
         self._stop_name = stop_name
         self._city = city
         self._city_data = self.get_city_data()
         self._group_mode = group_mode
-        self._departures_number = None
+        self._watched_lines = watched_lines
+        self._watched_directions = watched_directions
+        self._last_response = None
+        self._departures_number = 0
         self._departures_ordered = []
         self._departures_by_line = dict()
         self._state = None
@@ -90,35 +99,47 @@ def device_state_attributes(self):
     def update(self):
         now = datetime.datetime.now()
         r_time = now.hour * 60 + now.minute
-        url_template = 'https://www.rozkladzik.pl/{}/timetable.txt?c=tsa&t={}&day={}&time={}'
-        if self._group_mode:
-            url_template = 'https://www.rozkladzik.pl/{}/timetable.txt?c=bsa&b={}&day={}&time={}'
-        response = requests.get(url_template.format(self._city, self._stop_id, now.weekday(), r_time))
-        if response.status_code == 200 and response.content.__len__() > 0:
-            raw_array = response.text.split("|")
-            self._departures_ordered = []
-            self._departures_by_line = dict()
-            departures_by_line = dict()
-            lines_directions = dict()
-            for r in raw_array:
-                line, direction_number, departures = self.process_raw(r, r_time)
-                direction = self.get_direction(line, direction_number)
-                if not line in lines_directions:
-                    lines_directions[line] = []
-                lines_directions[line].append(direction)
-                departures_by_line[(line, direction)] = []
-                for departure_time, departure_diff in departures:
-                    self._departures_ordered.append((line, direction, departure_time, departure_diff))
-                    departures_by_line[(line, direction)].append((departure_time, departure_diff))
-                departures_by_line[(line, direction)].sort(key=lambda e: e[1])
-            for line in lines_directions:
-                self._departures_by_line[line] = dict()
-                for direction in lines_directions[line]:
-                    self._departures_by_line[line][direction] = []
-                    for departure in departures_by_line[(line, direction)]:
-                        self._departures_by_line[line][direction].append(departure)
-            self._departures_ordered.sort(key=lambda e: e[3])
-            self._departures_number = len(self._departures_ordered)
+        if self._should_update(now):
+            url_template = 'https://www.rozkladzik.pl/{}/timetable.txt?c=tsa&t={}&day={}&time={}'
+            if self._group_mode:
+                url_template = 'https://www.rozkladzik.pl/{}/timetable.txt?c=bsa&b={}&day={}&time={}'
+            response = requests.get(url_template.format(self._city, self._stop_id, now.weekday(), r_time))
+            if response.status_code == 200 and response.content.__len__() > 0:
+                self._last_response = response.text
+        if self._last_response is not None:
+            self.update_values_for_time(r_time)
+
+    def _should_update(self, now):
+        return self._last_response is None or self._departures_ordered is None or len(self._departures_ordered) == 0 or self._departures_ordered[0][4] < now
+
+    def update_values_for_time(self, r_time):
+        raw_array = self._last_response.split("|")
+        self._departures_ordered = []
+        self._departures_by_line = dict()
+        departures_by_line = dict()
+        lines_directions = dict()
+        for r in raw_array:
+            line, direction_number, departures = self.process_raw(r, r_time)
+            direction = self.get_direction(line, direction_number)
+            if len(self._watched_lines) > 0 and line not in self._watched_lines \
+                    or len(self._watched_directions) > 0 and direction not in self._watched_directions:
+                continue
+            if not line in lines_directions:
+                lines_directions[line] = []
+            lines_directions[line].append(direction)
+            departures_by_line[(line, direction)] = []
+            for departure_time, departure_diff, departure_timestamp in departures:
+                self._departures_ordered.append((line, direction, departure_time, departure_diff, departure_timestamp))
+                departures_by_line[(line, direction)].append((departure_time, departure_diff))
+            departures_by_line[(line, direction)].sort(key=lambda e: e[1])
+        for line in lines_directions:
+            self._departures_by_line[line] = dict()
+            for direction in lines_directions[line]:
+                self._departures_by_line[line][direction] = []
+                for departure in departures_by_line[(line, direction)]:
+                    self._departures_by_line[line][direction].append(departure)
+        self._departures_ordered.sort(key=lambda e: e[3])
+        self._departures_number = len(self._departures_ordered)
 
     def get_html(self):
         html = '<table width="100%" border=1 style="border: 1px black solid; border-collapse: collapse;">\n'
@@ -178,5 +199,5 @@ def process_raw(raw, now):
             hour = time // 60
             minute = time % 60
             t = "{:02}:{:02}".format(hour, minute)
-            times.append((t, diff))
+            times.append((t, diff, time))
         return line, direction_number, times

info.md

@@ -13,6 +13,8 @@
 | `id` | ID of stop |
 | `name` | Name of stop |
 | `stops_group_mode` | Enables stops group mode. Possible values: `true`, `false`. |
+| `lines` | `list` | `False` | all available | List of monitored lines. |
+| `directions` | `list` | `False` | all available | List of monitored directions. |
 
 ## Example usage
 
@@ -23,9 +25,13 @@ sensor:
     stops:
       - id: 1281
         name: 'Plac Grunwaldzki'
+        directions:
+          - "Reja"
       - id: 94
         name: 'Rynek'
         stops_group_mode: true
+        lines:
+          - "33"
 ```
 
 ## Hints