sascha_hemi/hacs_waste_collection_schedule
1
0
Fork 0
mirror of https://github.com/sascha-hemi/hacs_waste_collection_schedule.git synced 2026-03-21 04:06:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add Montreal service (#1654)

Browse Source 
* Add Montreal service

* refactoring + manifest.json add shapely dependency

---------

Co-authored-by: 5ila5 <5ila5@users.noreply.github.com>
Co-authored-by: 5ila5 <38183212+5ila5@users.noreply.github.com>
This commit is contained in:
Julien Boriasse
2024-01-11 08:49:37 -05:00
committed by GitHub
parent d7d52448a5
commit 338111556b
6 changed files with 333 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -476,6 +476,7 @@ Waste collection schedules in the following formats and countries are supported.
- [City of Peterborough, ON](/doc/ics/recollect.md) / peterborough.ca
- [City of Vancouver](/doc/ics/recollect.md) / vancouver.ca
- [London (ON)](/doc/source/recyclecoach_com.md) / london.ca
- [Montreal](/doc/source/montreal_ca.md) / montreal.ca/info-collectes
- [Ottawa, Canada](/doc/ics/recollect.md) / ottawa.ca
- [RM of Morris, MB](/doc/ics/recollect.md) / mwmenviro.ca
- [Strathcona County, ON](/doc/ics/recollect.md) / strathcona.ca

2
custom_components/waste_collection_schedule/manifest.json
View File

@@ -6,6 +6,6 @@
"documentation": "https://github.com/mampfes/hacs_waste_collection_schedule#readme",
"integration_type": "hub",
"iot_class": "cloud_polling",
"requirements": ["icalendar", "recurring_ical_events", "icalevents", "beautifulsoup4", "lxml"],
"requirements": ["icalendar", "recurring_ical_events", "icalevents", "beautifulsoup4", "lxml", "shapely"],
"version": "1.44.0"
}

301
custom_components/waste_collection_schedule/waste_collection_schedule/source/montreal_ca.py Normal file
View File

@@ -0,0 +1,301 @@
import logging
import re
import time
from datetime import datetime, timedelta
import requests
from shapely.geometry import Point, shape
from waste_collection_schedule import Collection # type: ignore[attr-defined]
# Currently, Montreal does not offer an iCal/Webcal subscription method.
# The GeoJSON file provides sector-specific details.
# The waste collection schedule is then interpreted from English natural language. Not every sector follows the same structure.
# This method is not highly reliable but serves as an acceptable workaround until a better solution is provided by the city.
TITLE = "Montreal"
DESCRIPTION = "Source script for montreal.ca/info-collectes"
URL = "https://montreal.ca/info-collectes"
TEST_CASES = {
"6280 Chambord": {"address": "6280 rue Chambord"},
"2358 Monsabre": {"address": "2358 rue Monsabre"},
"10785 Clark": {"address": "10785 rue Clark"},
}
API_URL = [
{
"type": "Waste",
"url": "https://donnees.montreal.ca/dataset/2df0fa28-7a7b-46c6-912f-93b215bd201e/resource/5f3fb372-64e8-45f2-a406-f1614930305c/download/collecte-des-ordures-menageres.geojson",
},
{
"type": "Recycling",
"url": "https://donnees.montreal.ca/dataset/2df0fa28-7a7b-46c6-912f-93b215bd201e/resource/d02dac7d-a114-4113-8e52-266001447591/download/collecte-des-matieres-recyclables.geojson",
},
{
"type": "Food",
"url": "https://donnees.montreal.ca/dataset/2df0fa28-7a7b-46c6-912f-93b215bd201e/resource/61e8c7e6-9bf1-45d9-8ebe-d7c0d50cfdbb/download/collecte-des-residus-alimentaires.geojson",
},
{
"type": "Green",
"url": "https://donnees.montreal.ca/dataset/2df0fa28-7a7b-46c6-912f-93b215bd201e/resource/d0882022-c74d-4fe2-813d-1aa37f6427c9/download/collecte-des-residus-verts-incluant-feuilles-mortes.geojson",
},
{
"type": "Bulky",
"url": "https://donnees.montreal.ca/dataset/2df0fa28-7a7b-46c6-912f-93b215bd201e/resource/2345d55a-5325-488c-b4fc-a885fae458e2/download/collecte-des-residus-de-construction-de-renovation-et-de-demolition-crd-et-encombrants.geojson",
},
]
ICON_MAP = {
"Waste": "mdi:trash-can",
"Recycling": "mdi:recycle",
"Food": "mdi:food-apple",
"Green": "mdi:leaf",
"Bulky": "mdi:sofa",
}
WEEKDAYS = {
"Monday": 0,
"Tuesday": 1,
"Tuesay": 1, # Typo in message "Collections take place on TUESAYS" (instead of TUESDAYS).
"Wednesday": 2,
"Thursday": 3,
"Friday": 4,
"Saturday": 5,
"Sunday": 6,
}
MONTHS = {
"January": 1,
"February": 2,
"March": 3,
"April": 4,
"May": 5,
"June": 6,
"July": 7,
"August": 8,
"September": 9,
"October": 10,
"November": 11,
"December": 12,
}
MONTH_PATTERN = r"\b(?:January|February|March|April|May|June|July|August|September|October|November|December) 20[0-9][0-9]\b"
LOGGER = logging.getLogger(__name__)
class Source:
def __init__(self, address):
self._address = address
def get_collections(self, collection_day, weeks, start_date):
collection_day = time.strptime(collection_day, "%A").tm_wday
days = (collection_day - datetime.now().date().weekday() + 7) % 7
next_collect = datetime.now().date() + timedelta(days=days)
days = abs(next_collect - datetime.strptime(start_date, "%Y-%m-%d").date()).days
if (days // 7) % weeks:
next_collect = next_collect + timedelta(days=7)
next_dates = []
next_dates.append(next_collect)
for i in range(1, int(4 / weeks)):
next_collect = next_collect + timedelta(days=(weeks * 7))
next_dates.append(next_collect)
return next_dates
def get_latitude_longitude_point(self):
# Get latitude & longitude of address
url = "https://geocoder.cit.api.here.com/6.2/search.json"
params = {
"gen": "9",
"app_id": "pYZXmzEqjmR2DG66DRIr",
"app_code": "T-Z-VT6e6I7IXGuqBfF_vQ",
"country": "CAN",
"state": "QC",
"searchtext": self._address,
"bbox": "45.39,-73.37;45.72,-74.00",
}
r = requests.get(url, params=params)
r.raise_for_status()
lat_long = r.json()["Response"]["View"][0]["Result"][0]["Location"][
"DisplayPosition"
]
# construct point based on lon/lat returned by geocoder
return Point(lat_long["Longitude"], lat_long["Latitude"])
def parse_green(self, schedule_message):
SOURCE_TYPE = "Green"
days = []
# Searching for the weekday in the sentence
collection_day = None
for day in WEEKDAYS:
if re.search(day, schedule_message, re.IGNORECASE):
collection_day = WEEKDAYS[day]
break # Stop searching if the day is found
split_green_schedule_message = schedule_message.split("-")
for month in MONTHS:
for line in split_green_schedule_message:
line = line.split("\n")[0]
line = line.split(".")[0]
line = line.replace("*", "")
if not re.search(month, line):
continue
if re.search("weekly", line):
for day in range(1, 32):
try:
date = datetime(2024, MONTHS[month], day)
if date.weekday() == collection_day: # Tuesday has index 1
days.append(date.date())
except ValueError:
pass # Skip if the day is out of range for the month
continue
# Splitting the string by ',' and 'and' to extract individual numbers
line = line.replace(";", "")
line = line.replace(".", "")
# Constructing the regex pattern using the variable
month_to_remove = rf"\b{re.escape(month)}\b"
line = re.sub(month_to_remove, "", line)
line = re.split(r", | and ", line)
line = [part.lstrip().split(" ")[0] for part in line]
# Converting the extracted strings to integers
days_numbers = [int(num) for num in line if num.isnumeric()]
for day in days_numbers:
date = datetime(2024, MONTHS[month], day)
days.append(date.date())
break
entries = []
for d in days:
entries.append(
Collection(
date=d,
t=SOURCE_TYPE,
icon=ICON_MAP.get(SOURCE_TYPE),
)
)
return entries
def parse_waste(self, schedule_message):
SOURCE_TYPE = "Waste"
split_waste_schedule_message = schedule_message.split("\n")
entries = []
for MONTHS in split_waste_schedule_message:
if re.search(MONTH_PATTERN, MONTHS):
split_months = MONTHS.split(":")
month_year = split_months[0].split(" ")
month_name = month_year[1]
year = int(month_year[2])
# remove * character
split_months[1] = split_months[1].replace("*", "")
# Splitting the string by ',' and 'and' to extract individual numbers
days = re.split(r", | and ", split_months[1])
# Converting the extracted strings to integers
days = [int(num) for num in days]
for d in days:
datetime_obj = datetime(
year, datetime.strptime(month_name, "%B").month, d
)
date_obj = datetime_obj.date()
entries.append(
Collection(
date=date_obj,
t=SOURCE_TYPE,
icon=ICON_MAP.get(SOURCE_TYPE),
)
)
return entries
def parse_recycling_food(self, schedule_message, source_type):
entries = []
# Searching for the weekday in the sentence
collection_day = None
for day in WEEKDAYS:
if re.search(day, schedule_message, re.IGNORECASE):
collection_day = WEEKDAYS[day]
break # Stop searching if the day is found
# Iterate through each month and day, and handle the "out of range" error
for month in range(1, 13):
for day in range(1, 32):
try:
date = datetime(2024, month, day)
if date.weekday() != collection_day: # Tuesday has index 1
continue
entries.append(
Collection(
date=date.date(),
t=source_type,
icon=ICON_MAP.get(source_type),
)
)
except ValueError:
pass # Skip if the day is out of range for the month
return entries
def get_data_by_source(self, source_type, url, point):
# Get waste collection zone by longitude and latitude
r = requests.get(url)
r.raise_for_status()
schedule = r.json()
entries = []
# check each polygon to see if it contains the point
for feature in schedule["features"]:
sector_shape = shape(feature["geometry"])
if not sector_shape.contains(point):
continue
schedule_message = feature["properties"]["MESSAGE_EN"]
# HOUSEHOLD WASTE
if source_type == "Waste":
entries += self.parse_waste(schedule_message)
# GREEN WASTE
if source_type == "Green":
entries += self.parse_green(schedule_message)
# RECYCLING OR FOOD
elif source_type == "Recycling" or source_type == "Food":
entries += self.parse_recycling_food(schedule_message, source_type)
else:
# source_type == "Bulky" not implemented
pass
return entries
def fetch(self):
point = self.get_latitude_longitude_point()
entries = []
for source in API_URL:
try:
entries += self.get_data_by_source(source["type"], source["url"], point)
except Exception:
# Probably because the natural language format does not match known formats.
LOGGER.warning(
f"Error while parsing {source['type']} schedule. Ignored."
)
return entries

28
doc/source/montreal_ca.md Normal file
View File

@@ -0,0 +1,28 @@
# Montreal
Waste collection schedules provided by [Info Collecte Montreal](https://montreal.ca/info-collectes/).
## Configuration via configuration.yaml
```yaml
waste_collection_schedule:
sources:
- name: montreal_ca
args:
address: ADDRESS
```
### Configuration Variables
**address**
*(string) (required)*
## Example
```yaml
waste_collection_schedule:
sources:
- name: montreal_ca
args:
address: 2812, rue Monsabre
```

2
info.md
View File

File diff suppressed because one or more lines are too long

1
requirements.txt
View File

@@ -10,3 +10,4 @@ requests>=2.31.0
urllib3>=2.0.7
jinja2>=3.1.2
lxml>=4.9.4
shapely>=2.0.2