Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add camera connection #17

Merged
merged 3 commits into from
Oct 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions pytrafikverket/__init__.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
"""Pytrafikverket module."""
# flake8: noqa
from pytrafikverket.trafikverket import (AndFilter, FieldFilter, FieldSort,
Filter, FilterOperation, NodeHelper,
OrFilter, SortOrder, Trafikverket)
from pytrafikverket.trafikverket_train import (StationInfo, TrafikverketTrain,
TrainStop, TrainStopStatus)
from pytrafikverket.trafikverket_weather import (TrafikverketWeather,
WeatherStationInfo)
from pytrafikverket.trafikverket_ferry import (TrafikverketFerry,
FerryStop, FerryStopStatus)
from pytrafikverket.trafikverket import (
AndFilter,
FieldFilter,
FieldSort,
Filter,
FilterOperation,
NodeHelper,
OrFilter,
SortOrder,
Trafikverket,
)
from pytrafikverket.trafikverket_train import (
StationInfo,
TrafikverketTrain,
TrainStop,
TrainStopStatus,
)
from pytrafikverket.trafikverket_weather import TrafikverketWeather, WeatherStationInfo
from pytrafikverket.trafikverket_ferry import (
TrafikverketFerry,
FerryStop,
FerryStopStatus,
)
from pytrafikverket.trafikverket_camera import TrafikverketCamera, CameraInfo
117 changes: 117 additions & 0 deletions pytrafikverket/trafikverket_camera.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
"""Retrieve camera data from Trafikverket API."""

from datetime import datetime
import aiohttp
from pytrafikverket.trafikverket import (
FieldFilter,
FilterOperation,
NodeHelper,
Trafikverket,
)


class CameraInfo:
"""Fetch Camera data."""

_required_fields = [
"Name",
"Id",
"Active",
"Deleted",
"Description",
"Direction",
"HasFullSizePhoto",
"Location",
"ModifiedTime",
"PhotoTime",
"PhotoUrl",
"Status",
"Type",
]

def __init__(
self,
camera_name: str,
camera_id: str,
active: bool,
deleted: bool,
description: str,
direction: str,
fullsizephoto: bool,
location: str,
modified: datetime,
phototime: datetime,
photourl: str,
status: str,
camera_type: str,
) -> None:
"""Initialize the class."""
self.camera_name = camera_name
self.camera_id = camera_id
self.active = active
self.deleted = deleted
self.description = description
self.direction = direction
self.fullsizephoto = fullsizephoto
self.location = location
self.modified = modified
self.phototime = phototime
self.photourl = photourl
self.status = status
self.camera_type = camera_type

@classmethod
def from_xml_node(cls, node):
"""Map XML path for values."""
node_helper = NodeHelper(node)
camera_name = node_helper.get_text("Name")
camera_id = node_helper.get_text("Id")
active = node_helper.get_bool("Active")
deleted = node_helper.get_bool("Deleted")
description = node_helper.get_text("Description")
direction = node_helper.get_text("Direction")
fullsizephoto = node_helper.get_bool("HasFullSizePhoto")
location = node_helper.get_text("Location")
modified = node_helper.get_datetime_for_modified("ModifiedTime")
phototime = node_helper.get_datetime("PhotoTime")
photourl = node_helper.get_text("PhotoUrl")
status = node_helper.get_text("Status")
camera_type = node_helper.get_text("Type")
return cls(
camera_name,
camera_id,
active,
deleted,
description,
direction,
fullsizephoto,
location,
modified,
phototime,
photourl,
status,
camera_type,
)


class TrafikverketCamera:
"""Class used to communicate with trafikverket's camera api."""

def __init__(self, client_session: aiohttp.ClientSession, api_key: str) -> None:
"""Initialize Camera object."""
self._api = Trafikverket(client_session, api_key)

async def async_get_camera(self, location_name: str) -> CameraInfo:
"""Retrieve camera from API."""
cameras = await self._api.async_make_request(
"Camera",
"1.0",
CameraInfo._required_fields, # pylint: disable=protected-access
[FieldFilter(FilterOperation.equal, "Name", location_name)],
)
if len(cameras) == 0:
raise ValueError("Could not find a camera with the specified name")
if len(cameras) > 1:
raise ValueError("Found multiple camera with the specified name")

return CameraInfo.from_xml_node(cameras[0])
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

setup(
name="pytrafikverket",
version="0.2.0.1",
version="0.2.1",
description="Retreive values from public API at the Swedish Transport Administration (Trafikverket).",
url="https://github.com/endor-force/pytrafikverket",
author="Peter Andersson, Jonas Karlsson",
Expand Down