45 Commits

Author SHA1 Message Date
a7d7c2864c Shipping v1.0.0 2023-05-24 12:34:47 +02:00
b32c84e3db Migrate to new hosts for GeoRide 2023-05-24 12:34:18 +02:00
8b3cf944dd Shipping v0.9.6 2023-03-24 23:13:01 +01:00
c1497f0b00 Fix None unsted of null 2023-03-24 23:12:41 +01:00
ef926fd983 Shipping v0.9.5 2023-03-24 23:08:04 +01:00
61af626207 Change version to 0.9.5 2023-03-24 23:07:32 +01:00
72fb58fa12 Add a more tracker fields as optional 2023-03-24 23:03:35 +01:00
23d8fa5624 Shipping v0.9.4 2023-02-28 19:17:57 +01:00
Matthieu DUVAL
5c977e3732 Fix: georide tracker property method 2023-02-28 19:16:52 +01:00
1c541fa4d6 Shipping v0.9.3 2023-02-27 20:24:39 +01:00
cb5b85e9d4 Fix missig fileds 2023-02-27 20:20:26 +01:00
ec399c8b0a Shipping v0.9.2 2023-02-27 20:06:34 +01:00
40c0c9aa69 Fixgitemail mispell 2023-02-27 20:05:16 +01:00
736182b200 Shipping v0.9.1 2023-02-27 19:31:35 +01:00
5b1bf8c1c4 Fixes mis configuraiton in tracker 2023-02-27 19:31:03 +01:00
39b2c3c776 Shipping v0.9.0 2023-02-27 18:54:17 +01:00
Matthieu DUVAL
7e399cf982 Rework of GeoRide objects and add missing fields on Traker 2023-02-27 18:06:19 +01:00
733ef83127 Shipping v0.8.4 2022-03-20 14:02:00 +01:00
edf209272d Fix missign field 'cardInformation' on some client 2022-03-20 14:01:22 +01:00
b53fdc07f8 Shipping v0.8.3 2022-03-19 21:43:23 +01:00
9c7d2890da Add support of missing fileds on GeoRide Subscription, remove deprectaed class 2022-03-19 21:39:49 +01:00
d93bab0fcf Imporve example 2022-03-06 12:25:50 +01:00
eb260b7a7e Shipping v0.8.2 2022-03-04 18:36:24 +01:00
e29e530d42 Fix tracher beacon reponse set to an array unsed of a unique object 2022-03-04 18:35:44 +01:00
6db3afcd28 Shipping v0.8.1 2022-03-04 16:07:48 +01:00
841740ec4c Fix miss import GeoRideTrackerBeacon 2022-03-04 16:07:02 +01:00
00c66320b5 Shipping v0.8.0 2022-03-04 15:44:43 +01:00
a01bb7bb7f Update gitignore 2022-03-04 15:38:54 +01:00
e85903bf8b Add better GeoRide3 management, remove deprecated classe 2022-03-04 15:32:25 +01:00
5823012259 Shipping v0.7.1 2022-03-04 10:30:13 +01:00
a62ae48001 Fix subscription info for Georide 2022-03-04 10:29:45 +01:00
7dec38109a Shipping v0.7.0 2022-03-03 20:13:36 +01:00
e6e471deae Update to add better support of GeoRide 3 and more fields protection 2022-03-03 19:57:19 +01:00
b6ede1af3b Shipping 0.6.1 2021-05-05 22:43:49 +02:00
6f02f0b925 Fix socketio client to prevent update to 5.0 2021-05-05 22:42:42 +02:00
e38a402d44 Shipping v0.6.0 2021-04-11 17:41:10 +02:00
a05b5bdaa6 Add new tracker fields 2021-04-11 12:42:16 +02:00
3053f2db69 Fix small mistakes 2021-04-10 22:49:21 +02:00
859d962cae Update wording and add new method for tracker 2021-04-10 20:02:44 +02:00
60254999df Small wording fix 2020-12-01 19:49:40 +01:00
93f089c431 Update GeoRide trademark wording 2020-05-26 23:50:03 +02:00
e59cd77908 Shipping v0.4.4 2019-11-03 20:26:49 +01:00
1275ffa882 Fix socket init error 2019-11-03 20:26:00 +01:00
6ab8749f11 Shipping v0.4.3 2019-11-02 17:51:48 +01:00
9923f45a95 Add pypi badge 2019-11-02 17:51:25 +01:00
21 changed files with 1446 additions and 730 deletions

4
.gitignore vendored
View File

@@ -2,4 +2,6 @@ examples/__main__.py
__pycache__
**/__pycache__
dist/
*.egg-info/
*.egg-info/
build/
ressources/

View File

@@ -1,16 +1,18 @@
# Georideapilib
![Logo Georide](georide-logo.png)
# georideapilib
![Logo GeoRide](georide-logo.png)
⚠️ this is not an official implementation
[![pypi_badge](https://img.shields.io/pypi/v/georideapilib?style=for-the-badge)](https://pypi.org/project/georideapilib/)
Official georide website: https://georide.fr/
This library can control your georide tracker tracker
This library can control your georide tracker
Some code have been taken from @alexmohr https://github.com/alexmohr/sonyapilib
This library is used as communication interface in a home assistant component to control media players, which can be found here:(Not ready yet ;))
This library is used as communication interface in a home assistant component to control media players, which can be found here: https://github.com/ptimatth/GeorideHA
At the moment not all functions offered by the api are implemented. If you miss a function feel free to create a pull request or open a feature request.
@@ -25,8 +27,7 @@ This library has been tested with python 3.7 and above, functionality for older
## Main repo:
- https://git.tontontux.fr/mduval/pyGeoride
## Github repo:
- https://github.com/ptimatth/pyGeoride
- https://github.com/ptimatth/georide-api
## Todo
- [ ] Add support of SocketIO connection
- [ ] Add support of "Get a shared trip" endpoint

View File

@@ -1,92 +1,125 @@
""" Example georideapilib code """
import logging.config
import time
import datetime
logging.config.fileConfig('logging.conf')
from georideapilib.objects import GeorideAccount
import georideapilib.api as GeorideApi
from georideapilib.socket import GeorideSocket
from georideapilib.objects import GeoRideAccount
import georideapilib.api as GeoRideApi
from georideapilib.socket import GeoRideSocket
from threading import Thread
_LOGGER = logging.getLogger('example')
DATE_START="2019-10-10"
DATE_END="2019-10-24"
def example():
""" simple example function """
# token = "<your_token>"# pylint: disable=C0301
# account = GeorideAccount(0, "<your_email>", False, token)
# account = GeoRideAccount(0, "<your_email>", False, token)
account = GeorideApi.get_authorisation_token("<your_email>", "<your_password>")
account = GeoRideApi.get_authorisation_token("<your_email>", "<your_password>")
print("token 1: ", account.auth_token)
_LOGGER.info("token 1: %s", account.auth_token)
# pylint: disable=W0105
def locked_locked(data):
_LOGGER.info("Locke received")
_LOGGER.info("Lock received")
def refresh_tracker():
_LOGGER.info("Refresh tracker recieved")
def connect_socket(account):
socket = GeorideSocket()
socket = GeoRideSocket()
socket.subscribe_locked(locked_locked)
socket.subscribe_refresh_tracker(refresh_tracker)
socket.init()
socket.connect(account.auth_token)
time.sleep(10)
socket.disconnect()
thread = Thread(target=connect_socket, args=(account))
thread = Thread(target=connect_socket, args=[account])
thread.start()
"""
account.auth_token = GeorideApi.renewToken(account.auth_token)
account.auth_token = GeoRideApi.renewToken(account.auth_token)
print("token 2: ", account.auth_token)
""" # pylint: disable=W0105
user = GeorideApi.get_user(account.auth_token)
user = GeoRideApi.get_user(account.auth_token)
_LOGGER.info("User: %s", user.first_name)
trackers = GeorideApi.get_trackers(account.auth_token)
trackers = GeoRideApi.get_trackers(account.auth_token)
tracker = trackers[0]
_LOGGER.info("Tracker name: %s", tracker.tracker_name)
trips = GeorideApi.get_trips(account.auth_token, tracker.tracker_id, "2019-10-10", "2019-10-24")
trip = trips[0]
trip_date = datetime.datetime.strptime("2019-10-10T06:45:34.000Z", '%Y-%m-%dT%H:%M:%S.%fZ')
_LOGGER.info("Trip date: %s, from: %s, to: %s", trip_date, trip.nice_start_address,
trip.nice_end_address)
trips = GeoRideApi.get_trips(account.auth_token, tracker.tracker_id, DATE_START, DATE_END)
if len(trips) < 1:
_LOGGER.info("No trip found for tracker name: %s between: %s and %s", tracker.tracker_name, DATE_START, DATE_END)
else:
trip = trips[0]
trip_date = datetime.datetime.strptime("2019-10-10T06:45:34.000Z", '%Y-%m-%dT%H:%M:%S.%fZ')
_LOGGER.info("Trip date: %s, from: %s, to: %s", trip_date, trip.nice_start_address,
trip.nice_end_address)
positions = GeorideApi.get_positions(account.auth_token, tracker.tracker_id,
"2019-10-10", "2019-10-24")
position = positions[0]
_LOGGER.info("Position speed: %s, lon: %s, lat: %s", position.speed, position.longitude,
position.latitude)
positions = GeoRideApi.get_positions(account.auth_token, tracker.tracker_id,
DATE_START, DATE_END)
if len(positions) < 1:
_LOGGER.info("No positions found for tracker name: %s between: %s and %s", tracker.tracker_name, DATE_START, DATE_END)
else:
position = positions[0]
_LOGGER.info("Position speed: %s, lon: %s, lat: %s", position.speed, position.longitude,
position.latitude)
trip_shared = GeorideApi.share_a_trip_by_date(account.auth_token, tracker.tracker_id,
"2019-10-10", "2019-10-24")
trip_shared = GeoRideApi.share_a_trip_by_date(account.auth_token, tracker.tracker_id,
DATE_START, DATE_END)
_LOGGER.info("tripShared url: %s, id: %s", trip_shared.url, trip_shared.share_id)
time.sleep(10)
have_been_locked = GeorideApi.lock_tracker(account.auth_token, tracker.tracker_id)
have_been_locked = GeoRideApi.lock_tracker(account.auth_token, tracker.tracker_id)
_LOGGER.info("Tracker have been locked: %s", have_been_locked)
time.sleep(10)
have_been_unlocked = GeorideApi.unlock_tracker(account.auth_token, tracker.tracker_id)
have_been_unlocked = GeoRideApi.unlock_tracker(account.auth_token, tracker.tracker_id)
_LOGGER.info("Tracker have been unlocked: %s", have_been_unlocked)
time.sleep(10)
is_locked = GeorideApi.toogle_lock_tracker(account.auth_token, tracker.tracker_id)
is_locked = GeoRideApi.toogle_lock_tracker(account.auth_token, tracker.tracker_id)
_LOGGER.info("Tracker is locked: %s", is_locked)
time.sleep(10)
trackers = GeorideApi.get_trackers(account.auth_token)
trackers = GeoRideApi.get_trackers(account.auth_token)
tracker = trackers[0]
_LOGGER.info("Tracker name: %s is locked: %s", tracker.tracker_name, tracker.is_locked)
if tracker.version >= 3:
_LOGGER.info("Congrat for your new gen GeoRide \o/")
# Have been commented for your neighbor ;)
# time.sleep(10)
# have_been_siren_turned_on = GeoRideApi.change_tracker_siren_state(account.auth_token, tracker.tracker_id, True)
# _LOGGER.info("Tracker siren is on: %s", have_been_siren_turned_on)
# time.sleep(5)
# have_been_siren_turned_off = GeoRideApi.change_tracker_siren_state(account.auth_token, tracker.tracker_id, False)
# _LOGGER.info("Tracker siren is off: %s", have_been_siren_turned_off)
time.sleep(10)
changed_to_eco_mode = GeoRideApi.change_tracker_eco_mode_state(account.auth_token, tracker.tracker_id, True)
_LOGGER.info("Tracker eco mode is on: %s", changed_to_eco_mode)
time.sleep(5)
changed_to_normal_mode = GeoRideApi.change_tracker_eco_mode_state(account.auth_token, tracker.tracker_id, False)
_LOGGER.info("Tracker eco mode is off: %s", changed_to_normal_mode)
tracker_beacon = GeoRideApi.get_tracker_beacon(account.auth_token, tracker.tracker_id)
_LOGGER.info("Your tracker beacon state: %s", tracker_beacon)
#you can also shutdown your tracker with shutdown_tracker(<token>, tracker_id) but i d'on give you an example.
else:
_LOGGER.info("You are from the first wave ;)")
"""

View File

@@ -6,14 +6,14 @@ Georide api lib
import json
import logging
import requests
from georideapilib.objects import (
GeorideTracker,
GeorideAccount,
GeorideUser,
GeorideTrackerTrip,
GeorideTrackerPosition,
GeorideSharedTrip
GeoRideTracker,
GeoRideAccount,
GeoRideUser,
GeoRideTrackerTrip,
GeoRideTrackerPosition,
GeoRideSharedTrip,
GeoRideTrackerBeacon
)
from georideapilib.exception import (
@@ -22,18 +22,25 @@ from georideapilib.exception import (
UnauthorizedException
)
GEORIDE_API_HOST = "https://api.georide.fr"
GEORIDE_API_HOST = "https://api.georide.com"
GEORIDE_SOCKET_HOST = "https://socket.georide.com"
GEORIDE_API_ENDPOINT_LOGIN = "/user/login"
GEORIDE_API_ENDPOINT_NEW_TOKEN = "/user/new-token"
GEORIDE_API_ENDPOINT_LOGOUT = "/user/logout"
GEORIDE_API_ENDPOINT_USER = "/user"
GEORIDE_API_ENDPOINT_TRAKERS = "/user/trackers"
GEORIDE_API_ENDPOINT_TRIPS = "/tracker/:trackerId/trips"
GEORIDE_API_ENDPOINT_LOCK = "/tracker/:trackerId/lock"
GEORIDE_API_ENDPOINT_UNLOCK = "/tracker/:trackerId/unlock"
GEORIDE_API_ENDPOINT_TOGGLE_LOCK = "/tracker/:trackerId/toggleLock"
GEORIDE_API_ENDPOINT_POSITIONS = "/tracker/:trackerId/trips/positions"
GEORIDE_API_ENDPOINT_TRIP_SHARE = "/tracker/:trackerId/share/trip"
GEORIDE_API_ENDPOINT_TRACKERS = "/user/trackers"
GEORIDE_API_ENDPOINT_TRIPS = "/tracker/{trackerId}/trips"
GEORIDE_API_ENDPOINT_LOCK = "/tracker/{trackerId}/lock"
GEORIDE_API_ENDPOINT_TRACKER_BEACON = "/tracker/{trackerId}/beacon"
GEORIDE_API_ENDPOINT_UNLOCK = "/tracker/{trackerId}/unlock"
GEORIDE_API_ENDPOINT_TOGGLE_LOCK = "/tracker/{trackerId}/toggleLock"
GEORIDE_API_ENDPOINT_POSITIONS = "/tracker/{trackerId}/trips/positions"
GEORIDE_API_ENDPOINT_TRIP_SHARE = "/tracker/{trackerId}/share/trip"
GEORIDE_API_ENDPOINT_SHUTDOWN_TRACKER = "/tracker/{trackerId}/shutdown"
GEORIDE_API_ENDPOINT_TRACKER_ALARM_OFF = "/tracker/{trackerId}/sonor-alarm/off"
GEORIDE_API_ENDPOINT_TRACKER_ALARM_ON = "/tracker/{trackerId}/sonor-alarm/on"
GEORIDE_API_ENDPOINT_TRACKER_ECO_MODE_OFF = "/tracker/{trackerId}/eco-mode/off"
GEORIDE_API_ENDPOINT_TRACKER_ECO_MODE_ON = "/tracker/{trackerId}/eco-mode/on"
_SESSION = requests.Session()
_LOGGER = logging.getLogger(__name__)
@@ -51,7 +58,7 @@ def get_authorisation_token(email, password):
if response.status_code == 200:
_LOGGER.debug("Login success")
response_data = response.json()
account = GeorideAccount.from_json(response_data)
account = GeoRideAccount.from_json(response_data)
elif response.status_code == 403:
_LOGGER.warning("Login failed")
raise LoginException(get_authorisation_token, "Login failed")
@@ -90,7 +97,7 @@ def revoke_token(token):
if response.status_code == 401:
_LOGGER.warnning("Token allready revoked")
raise UnauthorizedException(revoke_token, "Token allready revoked")
if response.status_code == 401:
if response.status_code == 403:
_LOGGER.warnning("Token allready revoked")
return False
return True
@@ -104,49 +111,69 @@ def get_user(token):
headers=headers)
response_data = response.json()
_LOGGER.debug(response_data)
account = GeorideUser.from_json(response_data)
account = GeoRideUser.from_json(response_data)
return account
def get_trackers(token):
""" get user trackers """
headers = {"Authorization": "Bearer " + token}
response = _SESSION.get(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRAKERS,
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRACKERS,
headers=headers)
response_data = response.json()
trackers = []
for json_tracker in response_data:
trackers.append(GeorideTracker.from_json(json_tracker))
_LOGGER.debug(json_tracker)
trackers.append(GeoRideTracker.from_json(json_tracker))
return trackers
def get_tracker_beacons(token, tracker_id):
""" get user trackers """
headers = {"Authorization": "Bearer " + token}
response = _SESSION.get(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRACKER_BEACON.format(trackerId=str(tracker_id)),
headers=headers)
response_data = response.json()
trackers_beacons = []
if response.status_code == 200:
for json_tracker_beacon in response_data:
_LOGGER.debug(json_tracker_beacon)
json_tracker_beacon['linked_tracker_id'] = tracker_id
trackers_beacons.append(GeoRideTrackerBeacon.from_json(json_tracker_beacon))
return trackers_beacons
def get_trips(token, tracker_id, from_date, to_date):
""" return all trips between two dates """
headers = {"Authorization": "Bearer " + token}
response = _SESSION.get(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRIPS.replace(':trackerId', str(tracker_id)),
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRIPS.format(trackerId=str(tracker_id)),
params={'from': from_date, 'to': to_date},
headers=headers)
response_data = response.json()
trips = []
for json_trip in response_data:
trips.append(GeorideTrackerTrip.from_json(json_trip))
if response.status_code == 200:
for json_trip in response_data:
trips.append(GeoRideTrackerTrip.from_json(json_trip))
return trips
def get_positions(token, tracker_id, from_date, to_date):
""" return all trips between two dates """
headers = {"Authorization": "Bearer " + token}
response = _SESSION.get(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_POSITIONS.replace(':trackerId', str(tracker_id)),
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_POSITIONS.format(trackerId=str(tracker_id)),
params={'from': from_date, 'to': to_date},
headers=headers)
response_data = response.json()
positions = []
for json_position in response_data:
positions.append(GeorideTrackerPosition.from_json(json_position))
if response.status_code == 200:
for json_position in response_data:
positions.append(GeoRideTrackerPosition.from_json(json_position))
return positions
def share_a_trip_by_trip_id(token, tracker_id, trip_id):
@@ -179,18 +206,20 @@ def _share_a_trip(token, tracker_id, trip_id=None, from_date=None, # pylint: dis
'Content-Type': 'application/json'
}
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRIP_SHARE.replace(':trackerId', str(tracker_id)),
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRIP_SHARE.format(trackerId=str(tracker_id)),
data=encoded_data,
headers=headers)
response_data = response.json()
return GeorideSharedTrip.from_json(response_data)
if response.status_code == 200:
return GeoRideSharedTrip.from_json(response_data)
return None
def lock_tracker(token, tracker_id):
""" used to lock a tracker """
headers = {"Authorization": "Bearer " + token}
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_LOCK.replace(':trackerId', str(tracker_id)),
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_LOCK.format(trackerId=str(tracker_id)),
headers=headers)
if response.status_code != 204:
return False
@@ -200,7 +229,7 @@ def unlock_tracker(token, tracker_id):
""" used to unlock a tracker """
headers = {"Authorization": "Bearer " + token}
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_UNLOCK.replace(':trackerId', str(tracker_id)),
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_UNLOCK.format(trackerId=str(tracker_id)),
headers=headers)
if response.status_code != 204:
return False
@@ -210,10 +239,53 @@ def toogle_lock_tracker(token, tracker_id):
""" used to toggle lock a tracker """
headers = {"Authorization": "Bearer " + token}
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TOGGLE_LOCK.replace(':trackerId', str(tracker_id)),
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TOGGLE_LOCK.format(trackerId=str(tracker_id)),
headers=headers)
response_data = response.json()
return response_data['locked']
def change_tracker_siren_state(token, tracker_id, state: bool):
""" used to toggle lock a tracker """
headers = {"Authorization": "Bearer " + token}
response = None
if state == True:
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRACKER_ALARM_ON.format(trackerId=str(tracker_id)),
headers=headers)
else:
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRACKER_ALARM_OFF.format(trackerId=str(tracker_id)),
headers=headers)
if response.status_code != 204:
return False
return True
def change_tracker_eco_mode_state(token, tracker_id, state: bool):
""" used to toggle lock a tracker """
headers = {"Authorization": "Bearer " + token}
response = None
if state == True:
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRACKER_ECO_MODE_ON.format(trackerId=str(tracker_id)),
headers=headers)
else:
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_TRACKER_ECO_MODE_OFF.format(trackerId=str(tracker_id)),
headers=headers)
if response.status_code != 204:
return False
return True
def shutdown_tracker(token, tracker_id):
""" used to toggle lock a tracker """
headers = {"Authorization": "Bearer " + token}
response = _SESSION.post(
GEORIDE_API_HOST + GEORIDE_API_ENDPOINT_SHUTDOWN_TRACKER.format(trackerId=str(tracker_id)),
headers=headers)
response_data = response.json()
if response.status_code == 200:
return response_data['locked']
return None
if __name__ == '__main__':
print("Not a main module")

View File

@@ -1,4 +1,4 @@
""" all geroide exception """
""" all GeoRide exception """
class Error(Exception):
"""Base class for exceptions in this module."""

View File

@@ -1,643 +0,0 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
class GeorideSharedTrip:
""" Shared trip object representation """
def __init__(self, url, shareId):
self._url = url
self._share_id = shareId
@property
def url(self):
""" shared trip url """
return self._url
@property
def share_id(self):
""" shared trip id """
return self._share_id
@staticmethod
def from_json(json):
"""return new object fromjson"""
return GeorideSharedTrip(
json['url'],
json['shareId']
)
class GeorideTrackerTrip: # pylint: disable=too-many-instance-attributes
""" Trip object representation """
def __init__(self, trip_id, tracker_id, average_speed, max_speed, distance, duration, # pylint: disable=R0914, R0913
start_address, nice_start_address, start_lat, start_lon, end_address,
nice_end_address, end_lat, end_lon, start_time, end_time):
self._trip_id = trip_id
self._tracker_id = tracker_id
self._average_speed = average_speed
self._max_speed = max_speed
self._distance = distance
self._duration = duration
self._start_address = start_address
self._nice_start_address = nice_start_address
self._start_lat = start_lat
self._start_lon = start_lon
self._end_address = end_address
self._nice_end_address = nice_end_address
self._end_lat = end_lat
self._end_lon = end_lon
self._start_time = start_time
self._end_time = end_time
@property
def trip_id(self):
"""trip_id """
return self._trip_id
@property
def tracker_id(self):
""" tracker_id """
return self._tracker_id
@property
def average_speed(self):
""" average_speed """
return self._average_speed
@property
def max_speed(self):
""" max_speed """
return self._max_speed
@property
def distance(self):
""" distance """
return self._distance
@property
def duration(self):
""" duration """
return self._duration
@property
def start_address(self):
""" start_address """
return self._start_address
@property
def nice_start_address(self):
""" nice_start_address """
return self._nice_start_address
@property
def start_lat(self):
""" start_lat """
return self._start_lat
@property
def start_lon(self):
""" start_lon """
return self._start_lon
@property
def end_address(self):
""" end_address """
return self._end_address
@property
def nice_end_address(self):
""" nice_end_address """
return self._nice_end_address
@property
def end_lat(self):
"""end_lat """
return self._end_lat
@property
def end_lon(self):
"""end_lon """
return self._end_lon
@property
def start_time(self):
""" start_time """
return self._start_time
@property
def end_time(self):
""" end_time """
return self._end_time
@staticmethod
def from_json(json):
"""return new object from json"""
return GeorideTrackerTrip(
json['id'],
json['trackerId'],
json['averageSpeed'],
json['maxSpeed'],
json['distance'],
json['duration'],
json['startAddress'],
json['niceStartAddress'],
json['startLat'],
json['startLon'],
json['endAddress'],
json['niceEndAddress'],
json['endLat'],
json['endLon'],
json['startTime'],
json['endTime']
)
class GeorideTrackerPosition:
""" Tracker position object representation """
def __init__(self, fixtime, latitude, longitude, altitude, speed, address): # pylint: disable= R0913
self._fixtime = fixtime
self._latitude = latitude
self._longitude = longitude
self._altitude = altitude
self._speed = speed
self._address = address
@property
def fixtime(self):
""" fixtime """
return self._fixtime
@property
def latitude(self):
""" latitude """
return self._latitude
@property
def longitude(self):
""" longitude """
return self._longitude
@property
def altitude(self):
""" altitude """
return self._altitude
@property
def speed(self):
""" speed (m/s) """
return self._speed
@property
def address(self):
""" address """
return self._address
@staticmethod
def from_json(json):
"""return new object fromjson"""
return GeorideTrackerPosition(
json['fixtime'],
json['latitude'],
json['longitude'],
json['altitude'],
json['speed'],
json['address']
)
class GeorideTracker: # pylint: disable=R0904,R0902
""" Tracker position object representation """
def __init__(self, tracker_id, tracker_name, device_button_action, device_button_delay, # pylint: disable= R0913, R0914, R0915
vibration_level, is_old_tracker, auto_lock_freezed_to, fixtime, role,
last_payment_date, gift_card_id, expires, activation_date, odometer, is_stolen,
is_crashed, crash_detection_disabled, speed, moving, position_id, latitude,
longitude, altitude, locked_position_id, locked_latitude, locked_longitude,
is_locked, can_see_position, can_lock, can_unlock, can_share, can_unshare,
can_check_speed, can_see_statistics, can_send_broken_down_signal,
can_send_stolen_signal, status):
self._tracker_id = tracker_id
self._tracker_name = tracker_name
self._device_button_action = device_button_action
self._device_button_delay = device_button_delay
self._vibration_level = vibration_level
self._is_old_tracker = is_old_tracker
self._auto_lock_freezed_to = auto_lock_freezed_to
self._fixtime = fixtime
self._role = role
self._last_payment_date = last_payment_date
self._gift_card_id = gift_card_id
self._expires = expires
self._activation_date = activation_date
self._odometer = odometer
self._is_stolen = is_stolen
self._is_crashed = is_crashed
self._crash_detection_disabled = crash_detection_disabled
self._speed = speed
self._moving = moving
self._position_id = position_id
self._latitude = latitude
self._longitude = longitude
self._altitude = altitude
self._locked_position_id = locked_position_id
self._locked_latitude = locked_latitude
self._locked_longitude = locked_longitude
self._is_locked = is_locked
self._can_see_position = can_see_position
self._can_lock = can_lock
self._can_unlock = can_unlock
self._can_share = can_share
self._can_unshare = can_unshare
self._can_check_speed = can_check_speed
self._can_see_statistics = can_see_statistics
self._can_send_broken_down_signal = can_send_broken_down_signal
self._can_send_stolen_signal = can_send_stolen_signal
self._status = status
@property
def tracker_id(self):
""" tracker_id """
return self._tracker_id
@property
def tracker_name(self):
""" tracker_name """
return self._tracker_name
@property
def device_button_action(self):
""" device_button_action """
return self._device_button_action
@property
def device_button_delay(self):
""" device_button_delay """
return self._device_button_delay
@property
def vibration_level(self):
""" vibration_level """
return self._vibration_level
@property
def is_old_tracker(self):
""" is_old_tracker """
return self._is_old_tracker
@property
def auto_lock_freezed_to(self):
""" auto_lock_freezed_to """
return self._auto_lock_freezed_to
@property
def fixtime(self):
""" fixtime """
return self._fixtime
@fixtime.setter
def fixtime(self, fixtime):
""" fixtime """
self._fixtime = fixtime
@property
def role(self):
""" role """
return self._role
@property
def last_payment_date(self):
""" last_payment_date """
return self._last_payment_date
@property
def gift_card_id(self):
""" gift_card_id """
return self._gift_card_id
@property
def expires(self):
""" expires """
return self._expires
@property
def activation_date(self):
""" activation_date """
return self._activation_date
@property
def odometer(self):
""" odometer """
return self._odometer
@property
def is_stolen(self):
""" is_stolen """
return self._is_stolen
@property
def is_crashed(self):
""" is_crashed """
return self._is_crashed
@property
def crash_detection_disabled(self):
""" crash_detection_disabled """
return self._crash_detection_disabled
@property
def speed(self):
""" speed """
return self._speed
@speed.setter
def speed(self, speed):
""" speed """
self._speed = speed
@property
def moving(self):
""" moving """
return self._moving
@moving.setter
def moving(self, moving):
""" moving """
self._moving = moving
@property
def position_id(self):
""" position_id """
return self._position_id
@property
def latitude(self):
""" latitude """
return self._latitude
@latitude.setter
def latitude(self, latitude):
""" latitude """
self._latitude = latitude
@property
def longitude(self):
""" longitude """
return self._longitude
@longitude.setter
def longitude(self, longitude):
""" longitude """
self._longitude = longitude
@property
def altitude(self):
""" altitude """
return self._altitude
@property
def locked_position_id(self):
""" locked_position_id """
return self._locked_position_id
@property
def locked_latitude(self):
""" locked_latitude """
return self._locked_latitude
@locked_latitude.setter
def locked_latitude(self, locked_latitude):
""" locked_latitude """
self._locked_latitude = locked_latitude
@property
def locked_longitude(self):
""" locked_longitude """
return self._locked_longitude
@locked_longitude.setter
def locked_longitude(self, locked_longitude):
""" locked_longitude """
self._locked_longitude = locked_longitude
@property
def is_locked(self):
""" is_locked """
return self._is_locked
@is_locked.setter
def is_locked(self, is_locked):
""" is_locked """
self._is_locked = is_locked
@property
def can_see_position(self):
""" can_see_position """
return self._can_see_position
@property
def can_lock(self):
""" can_lock """
return self._can_lock
@property
def can_unlock(self):
""" can_unlock """
return self._can_unlock
@property
def can_share(self):
""" can_share """
return self._can_share
@property
def can_unshare(self):
""" can_unshare """
return self._can_unshare
@property
def can_check_speed(self):
""" can_check_speed """
return self._can_check_speed
@property
def can_see_statistics(self):
""" can_see_statistics """
return self._can_see_statistics
@property
def can_send_broken_down_signal(self):
""" can_send_broken_down_signal """
return self._can_send_broken_down_signal
@property
def can_send_stolen_signal(self):
""" can_send_stolen_signal """
return self._can_send_stolen_signal
@property
def status(self):
""" status """
return self._status
@status.setter
def status(self, status):
""" status """
self._status = status
@staticmethod
def from_json(json):
"""return new object fromjson"""
return GeorideTracker(
json['trackerId'],
json['trackerName'],
json['deviceButtonAction'],
json['deviceButtonDelay'],
json['vibrationLevel'],
json['isOldTracker'],
json['autoLockFreezedTo'],
json['fixtime'],
json['role'],
json['lastPaymentDate'],
json['giftCardId'],
json['expires'],
json['activationDate'],
json['odometer'],
json['isStolen'],
json['isCrashed'],
json['crashDetectionDisabled'],
json['speed'],
json['moving'],
json['positionId'],
json['latitude'],
json['longitude'],
json['altitude'],
json['lockedPositionId'],
json['lockedLatitude'],
json['lockedLongitude'],
json['isLocked'],
json['canSeePosition'],
json['canLock'],
json['canUnlock'],
json['canShare'],
json['canUnshare'],
json['canCheckSpeed'],
json['canSeeStatistics'],
json['canSendBrokenDownSignal'],
json['canSendStolenSignal'],
json['status']
)
class GeorideAccount:
""" Account object representation """
def __init__(self, account_id, email, is_admin, auth_token):
self._account_id = account_id
self._email = email
self._is_admin = is_admin
self._auth_token = auth_token
@property
def account_id(self):
""" account_id """
return self._account_id
@property
def email(self):
""" email """
return self._email
@property
def is_admin(self):
""" is_admin """
return self._is_admin
@property
def auth_token(self):
""" auth_token """
return self._auth_token
@auth_token.setter
def auth_token(self, new_token):
""" change auth_token """
self._auth_token = new_token
@staticmethod
def from_json(json):
"""return new object from_json"""
return GeorideAccount(
json['id'],
json['email'],
json['isAdmin'],
json['authToken']
)
class GeorideUser: # pylint: disable= R0902
""" User object representation """
def __init__(self, user_id, email, first_name, created_at, phone_number, # pylint: disable= R0913
push_user_token, legal, date_of_birth):
self._user_id = user_id
self._email = email
self._first_name = first_name
self._created_at = created_at
self._phone_number = phone_number
self._push_user_token = push_user_token
self._legal = legal
self._date_of_birth = date_of_birth
@property
def user_id(self):
""" user_id """
return self._user_id
@property
def email(self):
""" email """
return self._email
@property
def first_name(self):
""" first_name """
return self._first_name
@property
def created_at(self):
""" created_at """
return self._created_at
@property
def phone_number(self):
""" phone_number """
return self._phone_number
@property
def push_user_token(self):
""" push_user_token """
return self._push_user_token
@property
def legal(self):
""" legal """
return self._legal
@property
def date_of_birth(self):
""" date_ofo_birth """
return self._date_of_birth
@staticmethod
def from_json(json):
"""return new object fromjson"""
return GeorideUser(
json['id'],
json['email'],
json['firstName'],
json['createdAt'],
json['phoneNumber'],
json['pushUserToken'],
json['legal'],
json['dateOfBirth']
)

View File

@@ -0,0 +1,51 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
_LOGGER = logging.getLogger(__name__)
class GeoRideAccount:
""" Account object representation """
def __init__(self, account_id, email, is_admin, auth_token):
self._account_id = account_id
self._email = email
self._is_admin = is_admin
self._auth_token = auth_token
@property
def account_id(self):
""" account_id """
return self._account_id
@property
def email(self):
""" email """
return self._email
@property
def is_admin(self):
""" is_admin """
return self._is_admin
@property
def auth_token(self):
""" auth_token """
return self._auth_token
@auth_token.setter
def auth_token(self, new_token):
""" change auth_token """
self._auth_token = new_token
@staticmethod
def from_json(json):
"""return new object from_json"""
return GeoRideAccount(
json['id'],
json['email'],
json['isAdmin'],
json['authToken']
)

View File

@@ -0,0 +1,33 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
_LOGGER = logging.getLogger(__name__)
class GeoRideSharedTrip:
""" Shared trip object representation """
def __init__(self, url, shareId):
self._url = url
self._share_id = shareId
@property
def url(self):
""" shared trip url """
return self._url
@property
def share_id(self):
""" shared trip id """
return self._share_id
@staticmethod
def from_json(json):
"""return new object fromjson"""
return GeoRideSharedTrip(
json['url'],
json['shareId']
)

View File

@@ -0,0 +1,98 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
from . import JsonMgtMetaClass, GeoRideSubscription_CardInfo
_LOGGER = logging.getLogger(__name__)
class GeoRideSubscription(metaclass=JsonMgtMetaClass):
""" Account object representation """
def __init__(self, subscription_id, subscription_type, initial_date, next_payment_date,
status, paused_since, cancel_requested, price, first_name, last_name, card_information):
self._subscription_id = subscription_id
self._subscription_type = subscription_type
self._initial_date = initial_date
self._next_payment_date = next_payment_date
self._status = status
self._paused_since = paused_since
self._cancel_requested = cancel_requested
self._price = price
self._first_name = first_name
self._last_name = last_name
self._card_information = card_information
@property
def subscription_id(self):
"""subscription_id property"""
return self._subscription_id
@property
def subscription_type(self):
"""subscription_type property"""
return self._subscription_type
@property
def initial_date(self):
"""initial_date property"""
return self._initial_date
@property
def next_payment_date(self):
"""next_payment_date property"""
return self._next_payment_date
@property
def status(self):
"""status property"""
return self._status
@property
def paused_since(self):
"""paused_since property"""
return self._paused_since
@property
def cancel_requested(self):
"""cancel_requested property"""
return self._cancel_requested
@property
def price(self):
"""price property"""
return self._price
@property
def first_name(self):
"""first_name property"""
return self._first_name
@property
def last_name(self):
"""last_name property"""
return self._last_name
@property
def card_information(self):
"""card_information property"""
return self._card_information
@classmethod
def from_json(cls, json):
"""return new object from_json"""
card_info = GeoRideSubscription_CardInfo.from_json(json['cardInformation']) if cls.json_field_protect(json, 'cardInformation', None) is not None else {}
return GeoRideSubscription(
cls.json_field_protect(json, 'id', -1),
json['type'],
cls.json_field_protect(json, 'initialDate'),
cls.json_field_protect(json, 'nextPaymentDate'),
cls.json_field_protect(json, 'status'),
cls.json_field_protect(json, 'pausedSince'),
cls.json_field_protect(json, 'cancelRequested'),
cls.json_field_protect(json, 'price'),
cls.json_field_protect(json, 'firstName'),
cls.json_field_protect(json, 'lastName'),
card_info
)

View File

@@ -0,0 +1,41 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
from . import JsonMgtMetaClass
_LOGGER = logging.getLogger(__name__)
class GeoRideSubscription_CardInfo(metaclass=JsonMgtMetaClass):
""" Account object representation """
def __init__(self, last_digits, expiry, brand):
self._last_digits = last_digits
self._expiry = expiry
self._brand = brand
@property
def last_digits(self):
"""last_digits property"""
return self._last_digits
@property
def expiry(self):
"""expiry property"""
return self._expiry
@property
def brand(self):
"""brand property"""
return self._brand
@classmethod
def from_json(cls, json):
"""return new object from_json"""
return GeoRideSubscription_CardInfo(
cls.json_field_protect(json, 'lastDigits'),
cls.json_field_protect(json, 'expiry'),
cls.json_field_protect(json, 'brand')
)

View File

@@ -0,0 +1,616 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
from . import JsonMgtMetaClass, GeoRideSubscription
_LOGGER = logging.getLogger(__name__)
class GeoRideTracker(metaclass=JsonMgtMetaClass): # pylint: disable=R0904,R0902
""" Tracker position object representation """
def __init__(self, tracker_id, tracker_name, device_button_action, device_button_delay, # pylint: disable= R0913, R0914, R0915
vibration_level, is_old_tracker, auto_lock_freezed_to, fixtime, role,
last_payment_date, gift_card_id, expires, activation_date, odometer, is_stolen,
is_crashed, crash_detection_disabled, speed, moving, position_id, latitude,
longitude, altitude, locked_position_id, locked_latitude, locked_longitude,
is_locked, can_see_position, can_lock, can_unlock, can_share, can_unshare,
can_check_speed, can_see_statistics, can_send_broken_down_signal,
can_send_stolen_signal, status, subscription_id, external_battery_voltage,
internal_battery_voltage, timezone, is_second_gen, is_up_to_date,
subscription, version, gift_card_expires, gift_card_months, odometer_updated_at,
maintenance_mode_until, battery_updated_at, is_in_eco, is_calibrated,
is_oldsubscription, software_version, has_beacon, has_outdated_beacons, ecall_activated,
ecall_crash_mode, assistance_theft_activated,model, business_model, has_theft_case_opened):
self._tracker_id = tracker_id
self._tracker_name = tracker_name
self._device_button_action = device_button_action
self._device_button_delay = device_button_delay
self._vibration_level = vibration_level
self._is_old_tracker = is_old_tracker
self._position_id = position_id
self._fixtime = fixtime
self._latitude = latitude
self._longitude = longitude
self._altitude = altitude
self._locked_position_id = locked_position_id
self._locked_latitude = locked_latitude
self._locked_longitude = locked_longitude
self._role = role
self._last_payment_date = last_payment_date
self._gift_card_id = gift_card_id
self._expires = expires
self._activation_date = activation_date
self._odometer = odometer
self._is_locked = is_locked
self._is_stolen = is_stolen
self._is_crashed = is_crashed
self._crash_detection_disabled = crash_detection_disabled
self._speed = speed
self._moving = moving
self._can_see_position = can_see_position
self._can_lock = can_lock
self._can_unlock = can_unlock
self._can_share = can_share
self._can_unshare = can_unshare
self._can_check_speed = can_check_speed
self._can_see_statistics = can_see_statistics
self._can_send_broken_down_signal = can_send_broken_down_signal
self._can_send_stolen_signal = can_send_stolen_signal
self._status = status
self._auto_lock_freezed_to = auto_lock_freezed_to
self._subscription_id = subscription_id
self._external_battery_voltage = external_battery_voltage
self._internal_battery_voltage = internal_battery_voltage
self._timezone = timezone
self._is_second_gen = is_second_gen
self._is_up_to_date = is_up_to_date
self._subscription = subscription
self._version = version
self._gift_card_expires = gift_card_expires
self._gift_card_months = gift_card_months
self._odometer_updated_at = odometer_updated_at
self._maintenance_mode_until = maintenance_mode_until
self._battery_updated_at = battery_updated_at
self._is_in_eco = is_in_eco
self._is_calibrated = is_calibrated
self._is_oldsubscription = is_oldsubscription
self._software_version = software_version
self._has_beacon = has_beacon
self._has_outdated_beacons = has_outdated_beacons
self._ecall_activated = ecall_activated
self._ecall_crash_mode = ecall_crash_mode
self._assistance_theft_activated = assistance_theft_activated
self._model = model
self._business_model = business_model
self._has_theft_case_opened = has_theft_case_opened
self._is_siren_on = False
self._siren_last_on_date = time.time()
@property
def tracker_id(self):
""" tracker_id """
return self._tracker_id
@property
def tracker_name(self):
""" tracker_name """
return self._tracker_name
@property
def device_button_action(self):
""" device_button_action """
return self._device_button_action
@property
def device_button_delay(self):
""" device_button_delay """
return self._device_button_delay
@property
def vibration_level(self):
""" vibration_level """
return self._vibration_level
@property
def is_old_tracker(self):
""" is_old_tracker """
return self._is_old_tracker
@property
def auto_lock_freezed_to(self):
""" auto_lock_freezed_to """
return self._auto_lock_freezed_to
@property
def fixtime(self):
""" fixtime """
return self._fixtime
@fixtime.setter
def fixtime(self, fixtime):
""" fixtime """
self._fixtime = fixtime
@property
def role(self):
""" role """
return self._role
@property
def last_payment_date(self):
""" last_payment_date """
return self._last_payment_date
@property
def gift_card_id(self):
""" gift_card_id """
return self._gift_card_id
@property
def expires(self):
""" expires """
return self._expires
@property
def activation_date(self):
""" activation_date """
return self._activation_date
@property
def odometer(self):
""" odometer """
return self._odometer
@property
def is_stolen(self):
""" is_stolen """
return self._is_stolen
@is_stolen.setter
def is_stolen(self, is_stolen):
""" is_stolen setter"""
self._is_stolen = is_stolen
@property
def is_crashed(self):
""" is_crashed """
return self._is_crashed
@is_crashed.setter
def is_crashed(self, is_crashed):
""" is_crashed setter"""
self._is_crashed = is_crashed
@property
def crash_detection_disabled(self):
""" crash_detection_disabled """
return self._crash_detection_disabled
@property
def speed(self):
""" speed """
return self._speed
@speed.setter
def speed(self, speed):
""" speed """
self._speed = speed
@property
def moving(self):
""" moving """
return self._moving
@moving.setter
def moving(self, moving):
""" moving """
self._moving = moving
@property
def position_id(self):
""" position_id """
return self._position_id
@property
def latitude(self):
""" latitude """
return self._latitude
@latitude.setter
def latitude(self, latitude):
""" latitude """
self._latitude = latitude
@property
def longitude(self):
""" longitude """
return self._longitude
@longitude.setter
def longitude(self, longitude):
""" longitude """
self._longitude = longitude
@property
def altitude(self):
""" altitude """
return self._altitude
@property
def locked_position_id(self):
""" locked_position_id """
return self._locked_position_id
@property
def locked_latitude(self):
""" locked_latitude """
return self._locked_latitude
@locked_latitude.setter
def locked_latitude(self, locked_latitude):
""" locked_latitude """
self._locked_latitude = locked_latitude
@property
def locked_longitude(self):
""" locked_longitude """
return self._locked_longitude
@locked_longitude.setter
def locked_longitude(self, locked_longitude):
""" locked_longitude """
self._locked_longitude = locked_longitude
@property
def is_locked(self):
""" is_locked """
return self._is_locked
@is_locked.setter
def is_locked(self, is_locked):
""" is_locked """
self._is_locked = is_locked
@property
def can_see_position(self):
""" can_see_position """
return self._can_see_position
@property
def can_lock(self):
""" can_lock """
return self._can_lock
@property
def can_unlock(self):
""" can_unlock """
return self._can_unlock
@property
def can_share(self):
""" can_share """
return self._can_share
@property
def can_unshare(self):
""" can_unshare """
return self._can_unshare
@property
def can_check_speed(self):
""" can_check_speed """
return self._can_check_speed
@property
def can_see_statistics(self):
""" can_see_statistics """
return self._can_see_statistics
@property
def can_send_broken_down_signal(self):
""" can_send_broken_down_signal """
return self._can_send_broken_down_signal
@property
def can_send_stolen_signal(self):
""" can_send_stolen_signal """
return self._can_send_stolen_signal
@property
def status(self):
""" status """
return self._status
@status.setter
def status(self, status):
""" status """
self._status = status
@property
def subscription_id(self):
"""subscription_id property"""
return self._subscription_id
@property
def external_battery_voltage(self):
"""_external_battery_voltage property"""
return self._external_battery_voltage
@property
def internal_battery_voltage(self):
"""internal_battery_voltage property"""
return self._internal_battery_voltage
@property
def timezone(self):
"""timezone property"""
return self._timezone
@property
def is_second_gen(self):
"""is_second_gen property"""
return self._is_second_gen
@property
def is_up_to_date(self):
"""is_up_to_date property"""
return self._is_up_to_date
@property
def subscription(self):
""" subscription property """
return self._subscription
@property
def version(self):
""" version property """
return self._version
@property
def gift_card_expires(self):
""" gift_card_expires property """
return self._gift_card_expires
@property
def gift_card_months(self):
""" gift_card_months property """
return self._gift_card_months
@property
def odometer_updated_at(self):
""" odometer_updated_at property """
return self._odometer_updated_at
@property
def maintenance_mode_until(self):
""" maintenance_mode_until property """
return self._maintenance_mode_until
@property
def battery_updated_at(self):
""" battery_updated_at property """
return self._battery_updated_at
@property
def is_in_eco(self):
""" is_in_eco property """
return self._is_in_eco
@is_in_eco.setter
def is_in_eco(self, is_in_eco):
""" is_in_eco setter """
self._is_in_eco = is_in_eco
@property
def is_siren_on(self):
""" is_siren_on property """
return self._is_siren_on
@is_siren_on.setter
def is_siren_on(self, is_siren_on):
""" is_siren_on setter """
if is_siren_on:
self._siren_last_on_date = time.time()
self._is_siren_on = is_siren_on
@property
def siren_last_on_date(self):
""" siren_last_on_date property """
return self._siren_last_on_date
@property
def is_calibrated(self):
""" is_calibrated property """
return self._is_calibrated
@property
def is_oldsubscription(self):
""" is_oldsubscription property """
return self._is_oldsubscription
@property
def software_version(self):
""" software_version property """
return self._software_version
@property
def has_beacon(self):
""" has_beacon property """
return self._has_beacon
@property
def has_outdated_beacons(self):
""" has_outdated_beacons property """
return self._has_outdated_beacons
@property
def ecall_activated(self):
""" ecall_activated property """
return self._ecall_activated
@property
def version(self):
""" version property """
return self._version
@property
def ecall_crash_mode(self):
""" eCallCrashMode property """
return self._ecall_crash_mode
@property
def assistance_theft_activated(self):
""" assistanceTheftActivated property """
return self._assistance_theft_activated
@property
def model(self):
""" model property """
return self._model
@property
def business_model(self):
""" businessModel property """
return self._business_model
@property
def has_theft_case_opened(self):
""" hasTheftCaseOpened property """
return self._has_theft_case_opened
@classmethod
def from_json(cls, json):
"""return new object fromjson"""
return GeoRideTracker(
json['trackerId'], # Mandatory
json['trackerName'], # Mandatory
cls.json_field_protect(json,'deviceButtonAction'),
cls.json_field_protect(json,'deviceButtonDelay'),
cls.json_field_protect(json,'vibrationLevel'),
cls.json_field_protect(json,'isOldTracker', False),
cls.json_field_protect(json,'autoLockFreezedTo'),
cls.json_field_protect(json,'fixtime'),
cls.json_field_protect(json,'role', "owner"),
cls.json_field_protect(json,'lastPaymentDate', None),
cls.json_field_protect(json,'giftCardId'),
cls.json_field_protect(json,'expires'),
cls.json_field_protect(json,'activationDate'),
cls.json_field_protect(json,'odometer', False),
cls.json_field_protect(json,'isStolen', False),
cls.json_field_protect(json,'isCrashed', False),
cls.json_field_protect(json,'crashDetectionDisabled'),
cls.json_field_protect(json,'speed', 0), # Mandatory
cls.json_field_protect(json,'moving', False),
cls.json_field_protect(json,'positionId', -1),
cls.json_field_protect(json,'latitude', 47.0),
cls.json_field_protect(json,'longitude', -1.0),
cls.json_field_protect(json,'altitude', 0),
cls.json_field_protect(json,'lockedPositionId'),
cls.json_field_protect(json,'lockedLatitude'),
cls.json_field_protect(json,'lockedLongitude'),
cls.json_field_protect(json,'isLocked', False),
cls.json_field_protect(json,'canSeePosition', False),
cls.json_field_protect(json,'canLock', False),
cls.json_field_protect(json,'canUnlock', False),
cls.json_field_protect(json,'canShare', False),
cls.json_field_protect(json,'canUnshare', False),
cls.json_field_protect(json,'canCheckSpeed', False),
cls.json_field_protect(json,'canSeeStatistics', False),
cls.json_field_protect(json,'canSendBrokenDownSignal', False),
cls.json_field_protect(json,'canSendStolenSignal', False),
cls.json_field_protect(json,'status', 'unknown'),
cls.json_field_protect(json,'subscriptionId', -1),
cls.json_field_protect(json,'externalBatteryVoltage', -1.0),
cls.json_field_protect(json,'internalBatteryVoltage', -1.0),
cls.json_field_protect(json,'timezone', "Europe/Paris"),
cls.json_field_protect(json,'isSecondGen', False),
cls.json_field_protect(json,'isUpToDate', False),
GeoRideSubscription.from_json(json['subscription']) if cls.json_field_protect(json,'subscription') is not None else None,
cls.json_field_protect(json,'version', 1),
cls.json_field_protect(json,'giftCardExpires'),
cls.json_field_protect(json,'giftCardMonths'),
cls.json_field_protect(json,'odometerUpdatedAt'),
cls.json_field_protect(json,'maintenanceModeUntil'),
cls.json_field_protect(json,'batteryUpdatedAt'),
cls.json_field_protect(json,'isInEco', False),
cls.json_field_protect(json,'isCalibrated', True),
cls.json_field_protect(json,'isOldSubscription', True),
cls.json_field_protect(json,'softwareVersion', 1),
cls.json_field_protect(json,'hasBeacon', False),
cls.json_field_protect(json,'hasOutdatedBeacons', False),
cls.json_field_protect(json,'eCallActivated', False),
cls.json_field_protect(json,'eCallCrashMode'),
cls.json_field_protect(json,'assistanceTheftActivated'),
cls.json_field_protect(json,'model'),
cls.json_field_protect(json,'businessModel'),
cls.json_field_protect(json,'hasTheftCaseOpened'),
)
def update_all_data(self, tracker):
"""update all data of th tracker from anew object"""
self._tracker_name = tracker.tracker_name
self._device_button_action = tracker.device_button_action
self._device_button_delay = tracker.device_button_delay
self._vibration_level = tracker.vibration_level
self._is_old_tracker = tracker.is_old_tracker
self._position_id = tracker.position_id
self._fixtime = tracker.fixtime
self._latitude = tracker.latitude
self._longitude = tracker.longitude
self._altitude = tracker.altitude
self._locked_position_id = tracker.locked_position_id
self._locked_latitude = tracker.locked_latitude
self._locked_longitude = tracker.locked_longitude
self._role = tracker.role
self._last_payment_date = tracker.last_payment_date
self._gift_card_id = tracker.gift_card_id
self._expires = tracker.expires
self._activation_date = tracker.activation_date
self._odometer = tracker.odometer
self._is_locked = tracker.is_locked
self._is_stolen = tracker.is_stolen
self._is_crashed = tracker.is_crashed
self._crash_detection_disabled = tracker.crash_detection_disabled
self._speed = tracker.speed
self._moving = tracker.moving
self._can_see_position = tracker.can_see_position
self._can_lock = tracker.can_lock
self._can_unlock = tracker.can_unlock
self._can_share = tracker.can_share
self._can_unshare = tracker.can_unshare
self._can_check_speed = tracker.can_check_speed
self._can_see_statistics = tracker.can_see_statistics
self._can_send_broken_down_signal = tracker.can_send_broken_down_signal
self._can_send_stolen_signal = tracker.can_send_stolen_signal
self._status = tracker.status
self._auto_lock_freezed_to = tracker.auto_lock_freezed_to
self._subscription_id = tracker.subscription_id
self._external_battery_voltage = tracker.external_battery_voltage
self._internal_battery_voltage = tracker.internal_battery_voltage
self._timezone = tracker.timezone
self._is_second_gen = tracker.is_second_gen
self._is_up_to_date = tracker.is_up_to_date
self._subscription = tracker.subscription
self._version = tracker.version
self._gift_card_expires = tracker.gift_card_expires
self._gift_card_months = tracker.gift_card_months
self._odometer_updated_at = tracker.odometer_updated_at
self._maintenance_mode_until = tracker.maintenance_mode_until
self._battery_updated_at = tracker.battery_updated_at
self._is_in_eco = tracker.is_in_eco
self._is_calibrated = tracker.is_calibrated
self._is_oldsubscription = tracker.is_oldsubscription
self._software_version = tracker.software_version
self._has_beacon = tracker.has_beacon
self._has_outdated_beacons = tracker.has_outdated_beacons
self._ecall_activated = tracker.ecall_activated
self._ecall_crash_mode = tracker.ecall_crash_mode
self._assistance_theft_activated = tracker.assistance_theft_activated
self._model = tracker.model
self._business_model = tracker.business_model
self._has_theft_case_opened = tracker.has_theft_case_opened

View File

@@ -0,0 +1,115 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
from . import JsonMgtMetaClass
_LOGGER = logging.getLogger(__name__)
class GeoRideTrackerBeacon:
""" GeoRideTrackerBeacon representation """
def __init__(self, beacon_id, linked_tracker_id, name, created_at, updated_at,
mac_address, battery_level, last_battery_level_update, sleep_delay,
is_updated, power):
self._beacon_id = beacon_id
self._linked_tracker_id = linked_tracker_id
self._name = name
self._created_at = created_at
self._updated_at = updated_at
self._mac_address = mac_address
self._battery_level = battery_level
self._last_battery_level_update = last_battery_level_update
self._sleep_delay = sleep_delay
self._is_updated = is_updated
self._power = power
@property
def linked_tracker_id(self):
""" linked_tracker_id property """
return self._linked_tracker_id
@linked_tracker_id.setter
def linked_tracker_id(self, linked_tracker_id):
""" linked_tracker_id setter """
self._linked_tracker_id = linked_tracker_id
@property
def beacon_id(self):
"""beacon_id property"""
return self._beacon_id
@property
def name(self):
"""name property"""
return self._name
@property
def created_at(self):
"""created_at property"""
return self._created_at
@property
def updated_at(self):
"""updated_at property"""
return self._updated_at
@property
def mac_address(self):
"""mac_address property"""
return self._mac_address
@property
def battery_level(self):
"""battery_level property"""
return self._battery_level
@property
def last_battery_level_update(self):
"""last_battery_level_update property"""
return self._last_battery_level_update
@property
def sleep_delay(self):
"""sleep_delay property"""
return self._sleep_delay
@property
def is_updated(self):
"""is_updated property"""
return self._is_updated
@property
def power(self):
"""power property"""
return self._power
@classmethod
def from_json(cls, json):
"""return new object from_json"""
return GeoRideTrackerBeacon(
json['id'],
json['linked_tracker_id'],
json['name'],
json['createdAt'],
json['updatedAt'],
json['macAddress'],
json['batteryLevel'],
json['lastBatteryLevelUpdate'],
json['sleepDelay'],
json['isUpdated'],
json['power'])
def update_all_data(self, tracker_beacon):
"""update all data of the tracker beacon from a new object"""
self._name = tracker_beacon.name
self._created_at = tracker_beacon.created_at
self._updated_at = tracker_beacon.updated_at
self._mac_address = tracker_beacon.mac_address
self._battery_level = tracker_beacon.battery_level
self._last_battery_level_update = tracker_beacon.last_battery_level_update
self._sleep_delay = tracker_beacon.sleep_delay
self._is_updated = tracker_beacon.is_updated
self._power = tracker_beacon.power

View File

@@ -0,0 +1,60 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
_LOGGER = logging.getLogger(__name__)
class GeoRideTrackerPosition:
""" Tracker position object representation """
def __init__(self, fixtime, latitude, longitude, altitude, speed, address): # pylint: disable= R0913
self._fixtime = fixtime
self._latitude = latitude
self._longitude = longitude
self._altitude = altitude
self._speed = speed
self._address = address
@property
def fixtime(self):
""" fixtime """
return self._fixtime
@property
def latitude(self):
""" latitude """
return self._latitude
@property
def longitude(self):
""" longitude """
return self._longitude
@property
def altitude(self):
""" altitude """
return self._altitude
@property
def speed(self):
""" speed (m/s) """
return self._speed
@property
def address(self):
""" address """
return self._address
@staticmethod
def from_json(json):
"""return new object fromjson"""
return GeoRideTrackerPosition(
json['fixtime'],
json['latitude'],
json['longitude'],
json['altitude'],
json['speed'],
json['address']
)

View File

@@ -0,0 +1,134 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
_LOGGER = logging.getLogger(__name__)
class GeoRideTrackerTrip: # pylint: disable=too-many-instance-attributes
""" Trip object representation """
def __init__(self, trip_id, tracker_id, average_speed, max_speed, distance, duration, # pylint: disable=R0914, R0913
start_address, nice_start_address, start_lat, start_lon, end_address,
nice_end_address, end_lat, end_lon, start_time, end_time):
self._trip_id = trip_id
self._tracker_id = tracker_id
self._average_speed = average_speed
self._max_speed = max_speed
self._distance = distance
self._duration = duration
self._start_address = start_address
self._nice_start_address = nice_start_address
self._start_lat = start_lat
self._start_lon = start_lon
self._end_address = end_address
self._nice_end_address = nice_end_address
self._end_lat = end_lat
self._end_lon = end_lon
self._start_time = start_time
self._end_time = end_time
@property
def trip_id(self):
"""trip_id """
return self._trip_id
@property
def tracker_id(self):
""" tracker_id """
return self._tracker_id
@property
def average_speed(self):
""" average_speed """
return self._average_speed
@property
def max_speed(self):
""" max_speed """
return self._max_speed
@property
def distance(self):
""" distance """
return self._distance
@property
def duration(self):
""" duration """
return self._duration
@property
def start_address(self):
""" start_address """
return self._start_address
@property
def nice_start_address(self):
""" nice_start_address """
return self._nice_start_address
@property
def start_lat(self):
""" start_lat """
return self._start_lat
@property
def start_lon(self):
""" start_lon """
return self._start_lon
@property
def end_address(self):
""" end_address """
return self._end_address
@property
def nice_end_address(self):
""" nice_end_address """
return self._nice_end_address
@property
def end_lat(self):
"""end_lat """
return self._end_lat
@property
def end_lon(self):
"""end_lon """
return self._end_lon
@property
def start_time(self):
""" start_time """
return self._start_time
@property
def end_time(self):
""" end_time """
return self._end_time
@staticmethod
def from_json(json):
"""return new object from json"""
return GeoRideTrackerTrip(
json['id'],
json['trackerId'],
json['averageSpeed'],
json['maxSpeed'],
json['distance'],
json['duration'],
json['startAddress'],
json['niceStartAddress'],
json['startLat'],
json['startLon'],
json['endAddress'],
json['niceEndAddress'],
json['endLat'],
json['endLon'],
json['startTime'],
json['endTime']
)

View File

@@ -0,0 +1,75 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
_LOGGER = logging.getLogger(__name__)
class GeoRideUser: # pylint: disable= R0902
""" User object representation """
def __init__(self, user_id, email, first_name, created_at, phone_number, # pylint: disable= R0913
push_user_token, legal, date_of_birth):
self._user_id = user_id
self._email = email
self._first_name = first_name
self._created_at = created_at
self._phone_number = phone_number
self._push_user_token = push_user_token
self._legal = legal
self._date_of_birth = date_of_birth
@property
def user_id(self):
""" user_id """
return self._user_id
@property
def email(self):
""" email """
return self._email
@property
def first_name(self):
""" first_name """
return self._first_name
@property
def created_at(self):
""" created_at """
return self._created_at
@property
def phone_number(self):
""" phone_number """
return self._phone_number
@property
def push_user_token(self):
""" push_user_token """
return self._push_user_token
@property
def legal(self):
""" legal """
return self._legal
@property
def date_of_birth(self):
""" date_ofo_birth """
return self._date_of_birth
@staticmethod
def from_json(json):
"""return new object fromjson"""
return GeoRideUser(
json['id'],
json['email'],
json['firstName'],
json['createdAt'],
json['phoneNumber'],
json['pushUserToken'],
json['legal'],
json['dateOfBirth']
)

View File

@@ -0,0 +1,13 @@
"""
Georide objects implementation
@author Matthieu DUVAL <matthieu@duval-dev.fr>
"""
import time
import logging
_LOGGER = logging.getLogger(__name__)
class JsonMgtMetaClass(type):
@staticmethod
def json_field_protect(json, field_name, default_value = None):
return json[field_name] if field_name in json.keys() else default_value

View File

@@ -0,0 +1,11 @@
from .JsonMgtMetaClass import *
from .GeoRideAccount import *
from .GeoRideSharedTrip import *
from .GeoRideSubscription_CardInfo import *
from .GeoRideSubscription import *
from .GeoRideTracker import *
from .GeoRideTrackerBeacon import *
from .GeoRideTrackerPosition import *
from .GeoRideTrackerTrip import *
from .GeoRideUser import *

View File

@@ -1,8 +1,8 @@
""" Georide socket-io implementation """
""" GeoRide socket-io implementation """
import logging
import socketio
from georideapilib.api import GEORIDE_API_HOST
from georideapilib.api import GEORIDE_SOCKET_HOST
_LOGGER = logging.getLogger(__name__)
@@ -19,8 +19,8 @@ def on_disconnect():
_LOGGER.debug('GeoRide socket disconnected')
class GeorideSocket():
"""docstring for GeorideSocket"""
class GeoRideSocket():
"""docstring for GeoRideSocket"""
def __init__(self):
self._on_message_callback = None
self._on_device_callback = None
@@ -98,14 +98,13 @@ class GeorideSocket():
""" on_locked """
_LOGGER.debug('Locked received: %s', data)
if self._on_locked_callback is not None:
self._on_locked_callback(data)
else:
self._initialised = True
self._on_locked_callback(data)
self._initialised = True
def connect(self, auth_token):
""" connect to the georide socket"""
if self._initialised is not False:
sio.connect(GEORIDE_API_HOST, headers={'token': auth_token})
sio.connect(GEORIDE_SOCKET_HOST, headers={'token': auth_token})
sio.wait()
else:
_LOGGER.error("Please call init() before")

View File

@@ -17,6 +17,11 @@ handlers=consoleHandler
qualname=simpleExample
propagate=0
[logger_engine_io]
level=ERROR
handlers=consoleHandler
qualname=engineio.client
propagate=0
[handler_consoleHandler]
class=StreamHandler

View File

@@ -1,2 +1,2 @@
[metadata]
description-file = README.md
description_file = README.md

View File

@@ -18,20 +18,20 @@ CURRENT_DIR = os.path.dirname(__file__)
# "python setup.py register sdist upload -r pypitest"
setup(
name='georideapilib',
packages=['georideapilib'], # this must be the same as the name above
version='0.4.2',
description='Lib to control georide tracker devices with their rest api',
packages=['georideapilib', 'georideapilib.objects'], # this must be the same as the name above
version='1.0.0',
description='Lib to control GeoRide tracker devices with theire rest api',
author='Matthieu DUVAL',
author_email='georideapilib@duval-dev.fr',
# use the URL to the github repo
url='https://github.com/ptimatth/pyGeoride',
download_url='https://codeload.github.com/ptimatth/pyGeoride/tar.gz/0.1.0',
keywords=['rest', 'georide', 'api', 'grutier'], # arbitrary keywords
url='https://github.com/hacf/georide-api',
download_url='https://codeload.github.com/hacf/georide-api/tar.gz/1.0.0',
keywords=['rest', 'georide', 'api', 'grutier', 'GeoRide'], # arbitrary keywords
classifiers=[],
install_requires=["python-socketio[client]"],
install_requires=["python-socketio[client]==5.8.0"],
tests_require=[
'pytest>=3.7',
'pytest-pep8',
'pytest-pep8',
'pytest-cov',
'python-coveralls',
'pylint',