DriveBC Smart-Home-Integration, kostenlos und Open Source
Unofficial. Road events in British Columbia from DriveBC open data.
Veröffentlicht von LM1LC3N7
- Geräte
- Version 0.1.1
- Erfordert Gladys >=5.1.0
- ★ 0
Die Dokumentation dieser Integration wird von ihrem Autor geschrieben und ist bisher nur auf Englisch verfügbar.
Unofficial integration. It reads the road events that DriveBC (Province of British Columbia) publishes on its public Open511 API: closures, construction, incidents, weather and road conditions. No account, no API key.
This integration is not an official source. Before you drive, check DriveBC itself. The data may lag behind the road, and the integration may miss an event.
Contains information licensed under the Open Government Licence – British Columbia.
What you get
Up to three watch zones, each one a Gladys device. A zone is a circle around a point (1 to 300 km), optionally limited to some roads ("Highway 1, Highway 99").
Each zone device has:
| Feature | Type | Meaning |
|---|---|---|
| Events in effect | counter | Active events in effect now inside the zone |
| Road closures | counter | Those with a road marked closed |
| Major events | counter | Those of severity "major" |
| Summary | text | The events, closures first, then major ones, then by distance |
The summary is written in the language chosen in the configuration (English or French); the road names and the DriveBC texts stay in English, the only language of the API.
In effect means: an active event whose schedule interval covers the current time, as given by the DriveBC
server (Date header). An event planned for later is not counted until its interval starts. Daily hours written only
in the description ("7:00 AM to 7:00 PM, weekdays") are not read: such an event counts for its whole interval. An
event without a readable schedule, or an answer without a readable server time, counts as in effect. A server time
more than a day away from the clock of Gladys is not believed (taken as unreadable).
No event: DriveBC answers a box without any event with an HTTP 500 carrying the code 1008 ("Error processing OP5 event data"), never with an empty list (observed on the live API in October 2026). The integration reads that exact answer as "no event"; any other 500 is an outage. When a zone that had events falls to "no event" through that answer, 0 is published only if the next scheduled read says the same (no extra request): one interval later. A first read, or a zone already at 0, is published at once. A list where more than half of the events cannot be read is never 0: the status says that DriveBC sends events that cannot be read, nothing is published, and the reads go on at the interval (no pause).
Scene trigger: "New DriveBC event in a zone"
Fired when an event in effect appears in a zone for the first time and was created, updated or started within the last 2 hours (server time). Filters: zone, event types, severity. Variables: road, headline and description (English), type, severity, closed (yes/no), distance from the zone center (km), announced delay (minutes, empty when unknown), DriveBC event id.
It is not fired by the first read of a zone, nor after you move a zone (new center, radius or roads): that read only learns what is already there. It is not fired when the answer carries no readable server time. At most 20 events per zone and per read.
Configuration
- Language of the summary: English or French.
- Read interval: 3 to 60 minutes (5 by default).
- Zone 1 (required), zones 2 and 3 (optional, left empty to turn them off): a name, the latitude and longitude of the center (decimal degrees, inside British Columbia), the radius in km (25 by default), and optionally the roads to keep, separated by commas, as DriveBC writes them ("Highway 1", "Highway 99"; "Hwy 99" works too; the case is ignored). Local roads are named "Other Roads" by DriveBC.
A refused field is named in the status (the value you typed is not repeated there).
The button Show the last read tells what the last read of each zone gave and when the next comes. It does not read DriveBC.
Pace and courtesy toward DriveBC
DriveBC throttles its API and asks to space requests by 10 seconds or more. The integration:
- sends one request at a time, 12 seconds at least between the starts of two requests (one per zone and per round; a zone with more than 500 events takes one more request per 500, up to 2000);
- starts a round every interval, measured from the start of the previous round;
- does not read sooner after a restart, a reconnection to Gladys, a configuration saved unchanged, a Discovery or
the test button (the time of the last attempt is kept in
/data, and in memory); moving a zone reads at once, 12 seconds after the last request; - when
/datacannot tell the last attempt (unreadable file, a date in the future, a/datathat cannot be written or does not answer within 2 seconds), waits 3 minutes after the start before the first read, and says so in the status; a/datathat stops being writable later is said in the status too: a restart may then read sooner; - after a 429 ("too many requests"), pauses every read for 5 minutes, then 10, 20… up to 6 hours; after a
server error (5xx, the "no event" answer apart) or another unexpected status (400, 403, 404…), for 2 minutes,
then 4, 8… up to 6 hours; a
Retry-Afterlonger than that is honored, up to 6 hours. A refusal that arrives while the configuration is being saved, or Gladys reconnects, still starts the pause. The pause is kept in/dataacross restarts; the doubling starts over after a successful read; - identifies itself with the User-Agent
gladys-drivebc/<version> (+https://github.com/LM1LC3N7/gladys-drivebc); - cuts an answer after 30 seconds or 16 MB.
DriveBC does not offer ETag nor Last-Modified on its events: every round reads the events again.
Status
The Configuration screen shows, for each zone, the counts of the last read and its time (Pacific time), or why it failed and the time of the last data. Data older than 2 hours is said stale. When a read fails, nothing is published for that zone: the devices keep their last values and the status says since when. A fall to 0 waiting for its confirmation is said too. The integration is shown connected when the last read of at least one zone succeeded, less than 2 hours ago.
Privacy
The coordinates of your zones stay in the Gladys configuration. DriveBC receives, for each zone, the box around
the circle (its center is the middle of the box). The /data file holds the time of the last attempt, the pause,
and per zone the ids of the events already seen with a salted fingerprint of the zone, not its coordinates.
Limits
- British Columbia only (the zone center must be in BC; events near the borders are included).
- Tested against the real DriveBC API on 2026-10-29; not yet tested by a user in British Columbia.
- The texts of DriveBC are in English only.
- "No event" is the HTTP 500 with code 1008 of DriveBC: should DriveBC ever send that exact answer during an outage, a zone would show 0 after two such reads in a row (one interval apart).
Konfigurationseinstellungen
Diese Einstellungen fragt DriveBC in seinem Konfigurationsbildschirm in Gladys ab.
| Einstellung | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
| DriveBC road events | section | Nein | Closures, construction, incidents and road conditions published by DriveBC (Province of British Columbia), read from its public Open511 API: no account, no key. Up to three zones, each one a device. Data in English only, under the Open Government Licence – British Columbia. Check DriveBC before you drive: this integration is not an official source. |
| Language of the summary | select | Nein | Language of the device names and of the summary text (DriveBC road names stay in English). |
| Read interval (minutes) | number | Nein | From 3 to 60 minutes. DriveBC asks for at least 10 s between two requests: the zones are read one after the other, 12 s apart. |
| Zone 1 | section | Nein | A circle around a point: the events in effect inside it are counted. Required. |
| Name | string | Nein | Name of the device in Gladys (60 characters at most). |
| Latitude | number | Ja | Center of the zone, in British Columbia (decimal degrees). |
| Longitude | number | Ja | Center of the zone (decimal degrees, negative: west). |
| Radius (km) | number | Nein | From 1 to 300 km. |
| Only these roads | string | Nein | Optional: road names as DriveBC writes them, separated by commas ("Highway 1, Highway 99"; "Hwy 99" works too). Empty: every road of the zone. |
| Zone 2 (optional) | section | Nein | A circle around a point: the events in effect inside it are counted. Leave the latitude and longitude empty to turn it off. |
| Name | string | Nein | Name of the device in Gladys (60 characters at most). |
| Latitude | number | Nein | Center of the zone, in British Columbia (decimal degrees). |
| Longitude | number | Nein | Center of the zone (decimal degrees, negative: west). |
| Radius (km) | number | Nein | From 1 to 300 km. |
| Only these roads | string | Nein | Optional: road names as DriveBC writes them, separated by commas ("Highway 1, Highway 99"; "Hwy 99" works too). Empty: every road of the zone. |
| Zone 3 (optional) | section | Nein | A circle around a point: the events in effect inside it are counted. Leave the latitude and longitude empty to turn it off. |
| Name | string | Nein | Name of the device in Gladys (60 characters at most). |
| Latitude | number | Nein | Center of the zone, in British Columbia (decimal degrees). |
| Longitude | number | Nein | Center of the zone (decimal degrees, negative: west). |
| Radius (km) | number | Nein | From 1 to 300 km. |
| Only these roads | string | Nein | Optional: road names as DriveBC writes them, separated by commas ("Highway 1, Highway 99"; "Hwy 99" works too). Empty: every road of the zone. |
So installierst du DriveBC in Gladys
- Öffne in Gladys Integrationen: DriveBC erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
- Klicke auf Installieren. Gladys lädt das Docker-Image (
ghcr.io/lm1lc3n7/gladys-drivebc:0.1.1) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration). - Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
- Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/LM1LC3N7/gladys-drivebc.
DriveBC benötigt Gladys >=5.1.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.
Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.
Über externe Integrationen
DriveBC ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von LM1LC3N7 veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.
- Alle Integrationen durchsuchen, native und aus der Community
- Deine eigene externe Integration bauen und veröffentlichen
- Quellcode auf GitHub — Quelle dieser Dokumentation