An async GeoJSON client library for NSW Transport Service Incidents.
pip install aio-geojson-nsw-transport-incidents
See below for examples of how this library can be used. After instantiating a
particular class - feed or feed manager - and supply the required parameters,
you can call
update to retrieve the feed data. The return value
will be a tuple of a status code and the actual data in the form of a list of
feed entries specific to the selected feed.
- OK: Update went fine and data was retrieved. The library may still return empty data, for example because no entries fulfilled the filter criteria.
- OK_NO_DATA: Update went fine but no data was retrieved, for example because the server indicated that there was not update since the last request.
- ERROR: Something went wrong during the update
||Coordinates (tuple of latitude/longitude)|
||Type of Hazard to retreive|
Traffic Hazards are divided into six basic types:
- Incidents (
- Fire (
- Flood (
- Alpine conditions (
- Major Events (
- Roadworks (
Hazards can be open, closed (or both can be retreived). Refer to the Live Traffic Data Developer Guide
||Radius in kilometers around the home coordinates in which events from feed are included.|
||Array of category names. Only events with a category matching any of these is included.|
import asyncio from aiohttp import ClientSession from aio_geojson_nsw_transport_incidents import NswTransportServiceIncidentsFeed async def main() -> None: async with ClientSession() as websession: # Home Coordinates: Latitude: -33.0, Longitude: 150.0 # Filter radius: 50 km # Filter categories: 'Scheduled roadwork' # Hazard type : 'roadworks-open' feed = NswTransportServiceIncidentsFeed(websession, (-33.0, 150.0), filter_radius=50, filter_categories=['Scheduled roadwork'], hazard="roadwork-open") status, entries = await feed.update() print(status) print(entries) asyncio.get_event_loop().run_until_complete(main())
Feed entry properties
Each feed entry is populated with the following properties:
|geometry||All geometry details of this entry.||
|coordinates||Best coordinates (latitude, longitude) of this entry.||
|external_id||The unique public identifier for this incident.||
|title||Title of this entry.||
|attribution||Attribution of the feed.||n/a|
|distance_to_home||Distance in km of this entry to the home coordinates.||n/a|
|category||The broad hazard category description assigned to the hazard by TMC Communications. Used internally by TMCCommunications for reporting hazard statistics.Please note the values used by this property are subject to change and should not be relied upon.||
|publication_date||The publication date of the incidents.||
|description||The description of the incident.||
|council_area||Council are this incident falls into.||
|road||Council are this incident falls into.||
|type||Type of the incident (e.g. Bush Fire, Grass Fire, Hazard Reduction).||
|publicTransport||The publication date of this entry||
|adviceA||The first advice of this entry. The first standard piece of advice to motorists. At the present time||
|adviceB||Turn the second advice of this entry||
|adviceOther||The other advice of this entry||
|isMajor||True is the incident is major for this entry||
|isEnded||True if the hazard has ended, otherwise false. Once ended, the hazard’s record in our internal tracking system is closed and further modification becomes impossible unless the record is later re-opened. This property is a counterpart to the createdproperty. When true, the lastUpdatedproperty of the hazard will be the date/time when the hazard’s record in the tracking system was closed.||
|isNew||True if the incident is new for this entry.||
|isImpactNetwork||True if the hazard is currently having some impact on traffic on the road network.||
|diversions||The Summary of any traffic diversions in place. The text may contain HTML markup..||
|subCategory||The sub-category of incident of this entry.||
|duration||The Planned duration of the hazard. This property is rarely used.||
The Feed Manager helps managing feed updates over time, by notifying the consumer of the feed about new feed entries, updates and removed entries compared to the last feed update.
- If the current feed update is the first one, then all feed entries will be reported as new. The feed manager will keep track of all feed entries' external IDs that it has successfully processed.
- If the current feed update is not the first one, then the feed manager will
produce three sets:
- Feed entries that were not in the previous feed update but are in the current feed update will be reported as new.
- Feed entries that were in the previous feed update and are still in the current feed update will be reported as to be updated.
- Feed entries that were in the previous feed update but are not in the current feed update will be reported to be removed.
- If the current update fails, then all feed entries processed in the previous feed update will be reported to be removed.
After a successful update from the feed, the feed manager provides two different dates:
last_updatewill be the timestamp of the last update from the feed irrespective of whether it was successful or not.
last_update_successfulwill be the timestamp of the last successful update from the feed. This date may be useful if the consumer of this library wants to treat intermittent errors from feed updates differently.
last_timestamp(optional, depends on the feed data) will be the latest timestamp extracted from the feed data. This requires that the underlying feed data actually contains a suitable date. This date may be useful if the consumer of this library wants to process feed entries differently if they haven't actually been updated.
Attribution and motivation
This is a fork of exxamalte/python-aio-geojson-nsw-rfs-incidents.
It deferes mainly as the geoJSON feeds generated by NSW Transport using QGis. QGis generates files that don't match exactly geojson format (geometry types :
POINT instead of
This library has been created for Home Assistant component.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size aio_geojson_nsw_transport_incidents-0.1-py3-none-any.whl (14.9 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size aio_geojson_nsw_transport_incidents-0.1.tar.gz (11.4 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for aio_geojson_nsw_transport_incidents-0.1-py3-none-any.whl
Hashes for aio_geojson_nsw_transport_incidents-0.1.tar.gz