Compare commits

...

58 Commits

Author SHA1 Message Date
691b5c2475 Shipping v1.1.1 2024-11-12 20:13:47 +01:00
eea4e1bb6b update to vesion 1.1.1 2024-11-12 20:11:16 +01:00
43b578cd98 Merge pull request #9 from Sigri44/master
Add manual installation
2024-11-12 20:10:57 +01:00
f7d801e1f4 Update deprecated methods and types 2024-11-12 19:49:30 +01:00
6257b65687 Merge pull request #9 from Sigri44/master
Add manual installation
2023-10-29 13:26:04 +01:00
Sigri
cbf81d7438 Add manual installation 2023-10-25 21:19:05 +02:00
Sigri
33d8942e31 Fix syntax 2023-10-25 20:39:23 +02:00
7d08d8f9a7 Shipping v1.1.0 2023-05-24 13:03:59 +02:00
ad77edd103 Update badge and GeoRidelib version 2023-05-24 12:46:26 +02:00
be29b2d9bf Update to georideapilib 0.9.6 2023-03-24 23:17:13 +01:00
f30176cb65 Merge pull request #8 from ptimatth/develop
Shipping v1.0.0
2023-03-18 10:58:58 +01:00
aa6cf7b515 Add beacon verification from the parametter has_beacon unsted of hw version 2023-02-28 19:34:56 +01:00
fa0f67e6ec Update to latest georidelib 2023-02-28 19:23:10 +01:00
bdaccea1e1 Add devices class to better categorisation in HA 2023-02-27 21:49:14 +01:00
Matthieu DUVAL
7ea6c96331 Update to to latest georideapilib 2023-02-27 18:02:27 +01:00
e6817e174b Shipping v0.9.1 2022-04-06 17:49:26 +02:00
22047ff6be Shipping v0.9.0 2022-04-06 17:37:16 +02:00
b8c8bcba14 Update pyjwt to match with the latest version 2022-04-06 17:24:18 +02:00
d270517025 Update to georideapilib 0.8.4 2022-03-20 14:05:24 +01:00
6eebbebdfa Update to georideapilib 0.8.3 2022-03-19 21:45:17 +01:00
cb5f069aff Fix tracker asign to tracker_device 2022-03-07 12:12:03 +01:00
4384526fae Fix call on position_event 2022-03-06 19:38:51 +01:00
2bc41f43c5 Fix sensor declaration 2022-03-06 13:44:19 +01:00
118911c361 Fix tracker position, add mesuremnt for longtherme statistics 2022-03-06 13:16:44 +01:00
9719f26631 Fix update beacon, Add speedometer, Add update on tracker properties change 2022-03-06 12:46:50 +01:00
0ee5a9ad12 Fix tracker device not exti 2022-03-04 19:46:09 +01:00
e9da051fc1 Fix attribute missing _tracker_device_beacon 2022-03-04 19:43:05 +01:00
1b2776f646 Fix update method on coordinator coma 2022-03-04 19:37:06 +01:00
112cf68542 Fix update method on coordinator 2022-03-04 19:34:00 +01:00
9f70dc220f Fix 'Device' object has no attribute 'beacon' 2022-03-04 19:24:47 +01:00
7a8702d57c Fix 'DeviceBeacon' object has no attribute 'tracker_beacon' 2022-03-04 19:21:59 +01:00
7f3d5d7ec7 Fix tracker device not exist 2022-03-04 19:17:20 +01:00
bf1e138c05 Fix wrong sensor setup 2022-03-04 19:12:55 +01:00
ce06f109fe Beacon use wrong coordinator 2022-03-04 19:07:54 +01:00
e9262ff3d4 Fix coordinator device name, await on add entity 2022-03-04 19:01:22 +01:00
f36a3093bf Fix missing import beacon 2022-03-04 18:55:12 +01:00
73d15f8c9a Fix mist spelling of get_tracker_beacons 2022-03-04 18:49:55 +01:00
d326726138 Fix invalid sintax 2022-03-04 18:45:58 +01:00
3000d5588b Fix support multiple tracker beacon 2022-03-04 18:42:13 +01:00
a3c84c63fd Fix missing tracker in list 2022-03-04 18:18:46 +01:00
a37cca7902 Fix missing get_tracker_beacon_by_tracker_id 2022-03-04 18:11:28 +01:00
32db0ec42e Fix "NameError: name 'new_georide_tracker' is not defined" 2022-03-04 18:07:37 +01:00
1250dda047 Fix "list' object has no attribute 'tracker_id' " 2022-03-04 18:04:10 +01:00
759fe2d257 Fix "local variable 'tracker' referenced before assignment" 2022-03-04 18:00:03 +01:00
9e2e6e8d53 remove await on force_refresh_trackers_beacon 2022-03-04 17:56:29 +01:00
4dc091525e Fix force_refresh_trackers_beacon 2022-03-04 17:53:51 +01:00
e92ac1825d Fix siren and device unique id 2022-03-04 17:28:10 +01:00
7d809c2105 Shipping v0.8.2 2022-03-03 20:40:02 +01:00
e59c8cb195 Shipping v0.8.1 2021-10-10 13:09:57 +02:00
5af8e7dc5d Shipping v0.8.0, thx to @Inervo 2021-08-30 20:14:56 +02:00
9053f95bc1 Shipping v0.7.2 2021-07-13 20:37:32 +02:00
fc383ff373 Shipping v0.7.1 2021-07-05 18:42:57 +02:00
57abb51b13 Shipping 0.7.0 2021-07-01 11:54:45 +02:00
24180c9345 Shipping v0.6.2 2021-05-05 22:56:38 +02:00
a83bae6d3e Shipping v0.6.1 2021-04-11 18:01:27 +02:00
b84a4cfd7f Shipping v0.6.0 2021-04-11 17:27:23 +02:00
02e1656aab Merge branch 'develop' 2020-12-01 19:24:26 +01:00
9b651f933e Shipping v0.5.0 2020-05-23 15:07:27 +02:00
10 changed files with 314 additions and 114 deletions

View File

@@ -4,6 +4,7 @@
⚠️ This is not an official implementation ⚠️ This is not an official implementation
[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs) [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0)
[![install_badge](https://img.shields.io/badge/dynamic/json?color=41BDF5&logo=home-assistant&label=integration%20usage&suffix=%20installs&cacheSeconds=15600&url=https://analytics.home-assistant.io/custom_integrations.json&query=$.georide.total)](https://analytics.home-assistant.io/)
Official GeoRide website: https://georide.fr/ Official GeoRide website: https://georide.fr/
@@ -101,12 +102,21 @@ mode: single
## Installation ## Installation
### Option 1 ### Option 1
- Just folow the integration config steps. - Just follow the integration config steps.
### Option 2 ### Option 2
- Add the folowing line in your configuration.yml - Add the following line in your configuration.yml
```yaml ```yaml
georide: georide:
email: <your-email>@exmple.com email: <your-email>@exmple.com
password: <your-password> password: <your-password>
``` ```
### Option 3 (manual)
- Download .zip git repo
- Go to /config (with File Editor or SSH)
- Unzip GeorideHA.zip
- Restart Home Assistant
- Go to "Integrations"
- If GeoRide not display, choose "add integration"
- Configure GeoRide add-on

View File

@@ -25,14 +25,13 @@ import homeassistant.helpers.config_validation as cv
import homeassistant.helpers.event as ha_event import homeassistant.helpers.event as ha_event
from homeassistant.setup import async_when_setup from homeassistant.setup import async_when_setup
from homeassistant.helpers.typing import HomeAssistantType
from homeassistant.helpers.update_coordinator import ( from homeassistant.helpers.update_coordinator import (
CoordinatorEntity, CoordinatorEntity,
DataUpdateCoordinator, DataUpdateCoordinator,
) )
from .device import Device from .device import Device, DeviceBeacon
from .const import ( from .const import (
CONF_EMAIL, CONF_EMAIL,
CONF_PASSWORD, CONF_PASSWORD,
@@ -44,11 +43,8 @@ from .const import (
SIREN_ACTIVATION_DELAY SIREN_ACTIVATION_DELAY
) )
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
CONFIG_SCHEMA = vol.Schema( CONFIG_SCHEMA = vol.Schema(
{ {
vol.Required(DOMAIN, default={}): { vol.Required(DOMAIN, default={}): {
@@ -59,7 +55,6 @@ CONFIG_SCHEMA = vol.Schema(
extra=vol.ALLOW_EXTRA, extra=vol.ALLOW_EXTRA,
) )
async def async_setup(hass, config): async def async_setup(hass, config):
"""Setup GeoRide component.""" """Setup GeoRide component."""
hass.data[DOMAIN] = {"config": config[DOMAIN], "devices": {}, "unsub": None} hass.data[DOMAIN] = {"config": config[DOMAIN], "devices": {}, "unsub": None}
@@ -76,7 +71,6 @@ async def async_setup(hass, config):
# Return boolean to indicate that initialization was successful. # Return boolean to indicate that initialization was successful.
return True return True
async def async_setup_entry(hass, entry): async def async_setup_entry(hass, entry):
"""Set up GeoRide entry.""" """Set up GeoRide entry."""
config = hass.data[DOMAIN]["config"] config = hass.data[DOMAIN]["config"]
@@ -98,16 +92,7 @@ async def async_setup_entry(hass, entry):
# We add trackers to the context # We add trackers to the context
await context.init_context(hass) await context.init_context(hass)
hass.async_create_task( await hass.config_entries.async_forward_entry_setups(entry, ["device_tracker", "switch", "sensor", "binary_sensor", "siren"])
hass.config_entries.async_forward_entry_setup(entry, "device_tracker"))
hass.async_create_task(
hass.config_entries.async_forward_entry_setup(entry, "switch"))
hass.async_create_task(
hass.config_entries.async_forward_entry_setup(entry, "sensor"))
hass.async_create_task(
hass.config_entries.async_forward_entry_setup(entry, "binary_sensor"))
hass.async_create_task(
hass.config_entries.async_forward_entry_setup(entry, "siren"))
return True return True
@@ -120,12 +105,15 @@ async def async_unload_entry(hass, entry):
await hass.config_entries.async_forward_entry_unload(entry, "binary_sensor") await hass.config_entries.async_forward_entry_unload(entry, "binary_sensor")
await hass.config_entries.async_forward_entry_unload(entry, "siren") await hass.config_entries.async_forward_entry_unload(entry, "siren")
context = hass.data[DOMAIN]["context"] context = hass.data[DOMAIN]["context"]
context.socket.disconnect() context.socket.disconnect() # Disconnect only if all devices is disabled
return True return True
async def async_remove_config_entry_device(hass, config_entry, device_entry) -> bool:
"""Remove an GeoRide device entry."""
return True
class GeoRideContext: class GeoRideContext:
@@ -182,6 +170,7 @@ class GeoRideContext:
socket.subscribe_device(self.on_device_callback) socket.subscribe_device(self.on_device_callback)
socket.subscribe_position(self.on_position_callback) socket.subscribe_position(self.on_position_callback)
socket.subscribe_alarm(self.on_alarm_callback) socket.subscribe_alarm(self.on_alarm_callback)
socket.subscribe_refresh_tracker(self.on_refresh_tracker_callback)
self._socket = socket self._socket = socket
socket.init() socket.init()
@@ -220,12 +209,13 @@ class GeoRideContext:
return tracker_beacon return tracker_beacon
return {} return {}
async def get_tracker_beacon_by_tracker_id(self, tracker_id): async def get_tracker_beacons_by_tracker_id(self, tracker_id):
""" here we return last tracker_beacon by id""" """ here we return last tracker_beacon by id"""
filtered_beacon = []
for tracker_beacon in self._georide_trackers_beacon: for tracker_beacon in self._georide_trackers_beacon:
if tracker_beacon.linked_tracker_id == tracker_id: if tracker_beacon.linked_tracker_id == tracker_id:
return tracker_beacon filtered_beacon.append(tracker_beacon)
return {} return filtered_beacon
async def refresh_trackers(self): async def refresh_trackers(self):
""" here we return last tracker by id""" """ here we return last tracker by id"""
@@ -239,6 +229,10 @@ class GeoRideContext:
if time.time() - SIREN_ACTIVATION_DELAY > tracker.siren_last_on_date: if time.time() - SIREN_ACTIVATION_DELAY > tracker.siren_last_on_date:
tracker.is_siren_on = False tracker.is_siren_on = False
async def refresh_trackers_beacon(self):
""" here we return last tracker by id"""
_LOGGER.debug("Do nothing, updated by another way")
async def force_refresh_trackers(self): async def force_refresh_trackers(self):
"""Used to refresh the tracker list""" """Used to refresh the tracker list"""
_LOGGER.info("Tracker list refresh") _LOGGER.info("Tracker list refresh")
@@ -250,13 +244,12 @@ class GeoRideContext:
if tracker.tracker_id == refreshed_tracker.tracker_id: if tracker.tracker_id == refreshed_tracker.tracker_id:
tracker.update_all_data(refreshed_tracker) tracker.update_all_data(refreshed_tracker)
if tracker.version > 2: if tracker.version > 2:
await force_refresh_trackers_beacon(tracker.tracker_id) await self.force_refresh_trackers_beacon(tracker.tracker_id)
found = True found = True
if not found: if not found:
self._georide_trackers.append(refreshed_tracker) self._georide_trackers.append(refreshed_tracker)
if refreshed_tracker.version > 2: if refreshed_tracker.version > 2:
await force_refresh_trackers_beacon(tracker.tracker_id) await self.force_refresh_trackers_beacon(refreshed_tracker.tracker_id)
if not self._thread_started: if not self._thread_started:
_LOGGER.info("Start the thread") _LOGGER.info("Start the thread")
# We refresh the tracker list each hours # We refresh the tracker list each hours
@@ -266,11 +259,12 @@ class GeoRideContext:
async def force_refresh_trackers_beacon(self, tracker_id): async def force_refresh_trackers_beacon(self, tracker_id):
"""Used to refresh the tracker list""" """Used to refresh the tracker list"""
_LOGGER.info("Tracker beacon refresh") _LOGGER.info("Tracker beacon refresh")
new_georide_tracker_beacon = await self._hass.async_add_executor_job(GeoRideApi.get_tracker_beacon, new_georide_tracker_beacons = await self._hass.async_add_executor_job(GeoRideApi.get_tracker_beacons,
await self.get_token(), tracker_id) await self.get_token(), tracker_id)
for new_georide_tracker_beacon in new_georide_tracker_beacons:
found = False found = False
for tracker_beacon in self._georide_trackers_beacon: for tracker_beacon in self._georide_trackers_beacon:
if tracker_beacon.tracker_id == new_georide_tracker_beacon.beacon_id: if tracker_beacon.beacon_id == new_georide_tracker_beacon.beacon_id:
tracker_beacon.update_all_data(new_georide_tracker_beacon) tracker_beacon.update_all_data(new_georide_tracker_beacon)
found = True found = True
if not found: if not found:
@@ -281,6 +275,8 @@ class GeoRideContext:
self._thread_started = True self._thread_started = True
await self.connect_socket() await self.connect_socket()
async def init_context(self, hass): async def init_context(self, hass):
"""Used to refresh the tracker list""" """Used to refresh the tracker list"""
_LOGGER.info("Init_context") _LOGGER.info("Init_context")
@@ -300,18 +296,21 @@ class GeoRideContext:
"tracker_device": Device(tracker), "tracker_device": Device(tracker),
"coordinator": coordinator "coordinator": coordinator
} }
if tracker.version > 2: if tracker.has_beacon:
tracker_beacon = await get_tracker_beacon_by_tracker_id(tracker.tracker_id) tracker_beacons = await self.get_tracker_beacons_by_tracker_id(tracker.tracker_id)
for tracker_beacon in tracker_beacons:
beacon_coordinator = DataUpdateCoordinator[Mapping[str, Any]]( beacon_coordinator = DataUpdateCoordinator[Mapping[str, Any]](
hass, hass,
_LOGGER, _LOGGER,
name=tracker_beacon.name name=tracker_beacon.name,
update_method=self.refresh_trackers_beacon,
update_interval=update_interval
) )
coordoned_beacon = { coordoned_beacon = {
"beacon_device": DeviceBeacon(tracker_beacon), "tracker_beacon": DeviceBeacon(tracker_beacon),
"coordinator": coordinator "coordinator": beacon_coordinator
} }
self._georide_trackers_beacon_coordoned(coordoned_beacon) self._georide_trackers_beacon_coordoned.append(coordoned_beacon)
self._georide_trackers_coordoned.append(coordoned_tracker) self._georide_trackers_coordoned.append(coordoned_tracker)
@@ -380,6 +379,25 @@ class GeoRideContext:
coordinator.async_request_refresh(), self._hass.loop coordinator.async_request_refresh(), self._hass.loop
).result() ).result()
break break
@callback
def on_refresh_tracker_callback(self):
"""on device callback"""
_LOGGER.info("On refresh tracker received")
self._previous_refresh = math.floor(time.time()/60)
self.force_refresh_trackers()
for coordoned_tracker in self._georide_trackers_coordoned:
tracker_device = coordoned_tracker['tracker_device']
tracker = tracker_device.tracker
coordinator = coordoned_tracker['coordinator']
event_data = {
"device_id": tracker_device.unique_id,
"device_name": tracker_device.name,
}
self._hass.bus.async_fire(f"{DOMAIN}_refresh_tracker_event", event_data)
asyncio.run_coroutine_threadsafe(
coordinator.async_request_refresh(), self._hass.loop
).result()
@callback @callback
def on_alarm_callback(self, data): def on_alarm_callback(self, data):
@@ -437,7 +455,8 @@ class GeoRideContext:
"""on position callback""" """on position callback"""
_LOGGER.info("On position received") _LOGGER.info("On position received")
for coordoned_tracker in self._georide_trackers_coordoned: for coordoned_tracker in self._georide_trackers_coordoned:
tracker = coordoned_tracker['tracker_device'].tracker tracker_device = coordoned_tracker['tracker_device']
tracker = tracker_device.tracker
coordinator = coordoned_tracker['coordinator'] coordinator = coordoned_tracker['coordinator']
if tracker.tracker_id == data['trackerId']: if tracker.tracker_id == data['trackerId']:
tracker.latitude = data['latitude'] tracker.latitude = data['latitude']

View File

@@ -6,8 +6,7 @@ from typing import Any, Mapping
from homeassistant.core import callback from homeassistant.core import callback
from homeassistant.helpers.entity import DeviceInfo, EntityCategory from homeassistant.helpers.entity import DeviceInfo, EntityCategory
from homeassistant.components.binary_sensor import BinarySensorEntity from homeassistant.components.binary_sensor import BinarySensorEntity, BinarySensorDeviceClass, ENTITY_ID_FORMAT
from homeassistant.components.binary_sensor import ENTITY_ID_FORMAT
from homeassistant.helpers.update_coordinator import ( from homeassistant.helpers.update_coordinator import (
CoordinatorEntity, CoordinatorEntity,
DataUpdateCoordinator DataUpdateCoordinator
@@ -33,15 +32,16 @@ async def async_setup_entry(hass, config_entry, async_add_entities): # pylint: d
entities.append(GeoRideActiveSubscriptionBinarySensorEntity(coordinator, tracker_device)) entities.append(GeoRideActiveSubscriptionBinarySensorEntity(coordinator, tracker_device))
entities.append(GeoRideNetworkBinarySensorEntity(coordinator, tracker_device)) entities.append(GeoRideNetworkBinarySensorEntity(coordinator, tracker_device))
entities.append(GeoRideMovingBinarySensorEntity(coordinator, tracker_device)) entities.append(GeoRideMovingBinarySensorEntity(coordinator, tracker_device))
entities.append(GeoRideUpdatedBinarySensorEntity(coordinator, tracker_device))
hass.data[GEORIDE_DOMAIN]["devices"][tracker_device.tracker.tracker_id] = coordinator hass.data[GEORIDE_DOMAIN]["devices"][tracker_device.tracker.tracker_id] = coordinator
coordoned_beacons = georide_context.georide_trackers_beacon_coordoned coordoned_beacons = georide_context.georide_trackers_beacon_coordoned
for coordoned_beacon in coordoned_beacons: for coordoned_beacon in coordoned_beacons:
tracker_beacon = coordoned_tracker['tracker_beacon'] tracker_beacon = coordoned_beacon['tracker_beacon']
coordinator = coordoned_tracker['coordinator'] coordinator = coordoned_beacon['coordinator']
entities.append(GeoRideBeaconUpdatedBinarySensorEntity(coordinator, tracker_beacon)) entities.append(GeoRideBeaconUpdatedBinarySensorEntity(coordinator, tracker_beacon))
hass.data[GEORIDE_DOMAIN]["devices"][tracker_device.beacon.beacon_id] = coordinator hass.data[GEORIDE_DOMAIN]["devices"][tracker_beacon.beacon.beacon_id] = coordinator
async_add_entities(entities, True) async_add_entities(entities, True)
@@ -74,7 +74,7 @@ class GeoRideBeaconBinarySensorEntity(CoordinatorEntity, BinarySensorEntity):
super().__init__(coordinator) super().__init__(coordinator)
self._tracker_device_beacon = tracker_device_beacon self._tracker_device_beacon = tracker_device_beacon
self._name = tracker_device_beacon.beacon.name self._name = tracker_device_beacon.beacon.name
self.entity_id = f"{ENTITY_ID_FORMAT.format('binary_sensor')}.{tracker_device.beacon.beacon_id}"# pylint: disable=C0301 self.entity_id = f"{ENTITY_ID_FORMAT.format('binary_sensor')}.{tracker_device_beacon.beacon.beacon_id}"# pylint: disable=C0301
self._is_on = False self._is_on = False
@property @property
@@ -84,7 +84,7 @@ class GeoRideBeaconBinarySensorEntity(CoordinatorEntity, BinarySensorEntity):
@property @property
def device_info(self): def device_info(self):
"""Return the device info.""" """Return the device info."""
return self._tracker_device.device_info return self._tracker_device_beacon.device_info
class GeoRideStolenBinarySensorEntity(GeoRideBinarySensorEntity): class GeoRideStolenBinarySensorEntity(GeoRideBinarySensorEntity):
"""Represent a tracked device.""" """Represent a tracked device."""
@@ -102,7 +102,7 @@ class GeoRideStolenBinarySensorEntity(GeoRideBinarySensorEntity):
@property @property
def device_class(self): def device_class(self):
"""Return the device class.""" """Return the device class."""
return "problem" return BinarySensorDeviceClass.PROBLEM
@property @property
def is_on(self): def is_on(self):
@@ -132,7 +132,7 @@ class GeoRideCrashedBinarySensorEntity(GeoRideBinarySensorEntity):
@property @property
def device_class(self): def device_class(self):
"""Return the device class.""" """Return the device class."""
return "problem" return BinarySensorDeviceClass.PROBLEM
@property @property
def is_on(self): def is_on(self):
@@ -142,7 +142,7 @@ class GeoRideCrashedBinarySensorEntity(GeoRideBinarySensorEntity):
@property @property
def name(self): def name(self):
""" GeoRide odometer name """ """ GeoRide odometer name """
return f"{self._name} is crashed" return f"{self._name} is not crashed"
class GeoRideActiveSubscriptionBinarySensorEntity(GeoRideBinarySensorEntity): class GeoRideActiveSubscriptionBinarySensorEntity(GeoRideBinarySensorEntity):
"""Represent a tracked device.""" """Represent a tracked device."""
@@ -236,6 +236,11 @@ class GeoRideNetworkBinarySensorEntity(GeoRideBinarySensorEntity):
return True return True
return False return False
@property
def device_class(self) -> str:
"""device class"""
return BinarySensorDeviceClass.CONNECTIVITY
@property @property
def name(self): def name(self):
""" GeoRide name """ """ GeoRide name """
@@ -250,6 +255,10 @@ class GeoRideMovingBinarySensorEntity(GeoRideBinarySensorEntity):
super().__init__(coordinator, tracker_device) super().__init__(coordinator, tracker_device)
self.entity_id = f"{ENTITY_ID_FORMAT.format('moving')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301 self.entity_id = f"{ENTITY_ID_FORMAT.format('moving')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301
@property
def entity_category(self):
return EntityCategory.DIAGNOSTIC
@property @property
def unique_id(self): def unique_id(self):
"""Return the unique ID.""" """Return the unique ID."""
@@ -265,11 +274,48 @@ class GeoRideMovingBinarySensorEntity(GeoRideBinarySensorEntity):
"""state value property""" """state value property"""
return self._tracker_device.tracker.moving return self._tracker_device.tracker.moving
@property
def device_class(self) -> str:
"""device class"""
return BinarySensorDeviceClass.MOVING
@property @property
def name(self): def name(self):
""" GeoRide name """ """ GeoRide name """
return f"{self._name} is moving" return f"{self._name} is moving"
class GeoRideUpdatedBinarySensorEntity(GeoRideBinarySensorEntity):
"""Represent a tracked device."""
@property
def entity_category(self):
return EntityCategory.DIAGNOSTIC
def __init__(self, coordinator: DataUpdateCoordinator[Mapping[str, Any]],
tracker_device: Device):
"""Set up Georide entity."""
super().__init__(coordinator, tracker_device)
self.entity_id = f"{ENTITY_ID_FORMAT.format('update')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301
@property
def unique_id(self):
"""Return the unique ID."""
return f"update_{self._tracker_device.tracker.tracker_id}"
@property
def is_on(self):
"""state value property"""
return not self._tracker_device.tracker.is_up_to_date
@property
def device_class(self) -> str:
"""device class"""
return BinarySensorDeviceClass.UPDATE
@property
def name(self):
""" GeoRide name """
return f"{self._name} have an update"
class GeoRideBeaconUpdatedBinarySensorEntity(GeoRideBeaconBinarySensorEntity): class GeoRideBeaconUpdatedBinarySensorEntity(GeoRideBeaconBinarySensorEntity):
"""Represent a tracked device.""" """Represent a tracked device."""
@property @property
@@ -279,23 +325,23 @@ class GeoRideBeaconUpdatedBinarySensorEntity(GeoRideBeaconBinarySensorEntity):
def __init__(self, coordinator: DataUpdateCoordinator[Mapping[str, Any]], def __init__(self, coordinator: DataUpdateCoordinator[Mapping[str, Any]],
tracker_beacon_device: DeviceBeacon): tracker_beacon_device: DeviceBeacon):
"""Set up Georide entity.""" """Set up Georide entity."""
super().__init__(coordinator, tracker_device) super().__init__(coordinator, tracker_beacon_device)
self.entity_id = f"{ENTITY_ID_FORMAT.format('update')}.{tracker_beacon_device.tracker_beacon.beacon_id}"# pylint: disable=C0301 self.entity_id = f"{ENTITY_ID_FORMAT.format('update')}.{tracker_beacon_device.beacon.beacon_id}"# pylint: disable=C0301
@property @property
def unique_id(self): def unique_id(self):
"""Return the unique ID.""" """Return the unique ID."""
return f"update_{self._tracker_beacon_device.beacon.beacon_id}" return f"update_{self._tracker_device_beacon.beacon.beacon_id}"
@property
def device_class(self):
"""Return the device class."""
return "update"
@property @property
def is_on(self): def is_on(self):
"""state value property""" """state value property"""
return not self._tracker_beacon_device.beacon.is_updated return not self._tracker_device_beacon.beacon.is_updated
@property
def device_class(self) -> str:
"""device class"""
return BinarySensorDeviceClass.UPDATE
@property @property
def name(self): def name(self):

View File

@@ -12,7 +12,7 @@ from .const import CONF_EMAIL, CONF_PASSWORD, CONF_TOKEN, DOMAIN
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
@config_entries.HANDLERS.register("georide") @config_entries.HANDLERS.register(DOMAIN)
class GeoRideConfigFlow(config_entries.ConfigFlow, domain=DOMAIN): class GeoRideConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
"""GeoRide config flow """ """GeoRide config flow """
@@ -37,8 +37,6 @@ class GeoRideConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
vol.Required(CONF_PASSWORD): vol.All(str) vol.Required(CONF_PASSWORD): vol.All(str)
})) }))
async def async_step_georide_login(self, user_input): async def async_step_georide_login(self, user_input):
""" try to seupt GeoRide Account """ """ try to seupt GeoRide Account """

View File

@@ -10,6 +10,7 @@ class Device:
"""Initialize GeoRideTracker device.""" """Initialize GeoRideTracker device."""
self._tracker: GeoRideTracker = tracker self._tracker: GeoRideTracker = tracker
@property @property
def tracker(self): def tracker(self):
"""return the tracker""" """return the tracker"""
@@ -20,11 +21,26 @@ class Device:
"""Get the name.""" """Get the name."""
return self._tracker.tracker_name return self._tracker.tracker_name
@property
def default_manufacturer(self) -> str:
"""Get the default_manufacturer."""
return "GeoRide"
@property @property
def manufacturer(self) -> str: def manufacturer(self) -> str:
"""Get the manufacturer.""" """Get the manufacturer."""
return "GeoRide" return "GeoRide"
@property
def default_model(self) -> str:
"""Get the default model."""
return "GeoRide 1"
@property
def suggested_area(self) -> str:
"""Get the suggested_area."""
return "Garage"
@property @property
def model_name(self) -> str: def model_name(self) -> str:
"""Get the model name.""" """Get the model name."""
@@ -34,28 +50,42 @@ class Device:
elif self._tracker.version == 2: elif self._tracker.version == 2:
name = "GeoRide 2" name = "GeoRide 2"
elif self._tracker.version == 3: elif self._tracker.version == 3:
if self._tracker.model == 'georide-3':
name = "GeoRide 3" name = "GeoRide 3"
else:
name = "GeoRide Mini"
else: else:
name = "Prototype / Unknown" name = "Prototype / Unknown"
return name return name
@property
def sw_version(self) -> str:
"""Get the software version."""
return str(self._tracker.software_version)
@property
def hw_version(self) -> str:
"""Get the hardware version."""
return str(self._tracker.version)
@property
def unique_id(self) -> str:
"""Get the unique id."""
return {(GEORIDE_DOMAIN, self._tracker.tracker_id)}
@property @property
def device_info(self): def device_info(self):
"""Return the device info.""" """Return the device info."""
return { return {
"name": self.name, "name": self.name,
"identifiers": self.unique_id, "identifiers": self.unique_id,
"manufacturer": "GeoRide", "manufacturer": self.manufacturer,
"model": self.model_name, "model": self.model_name,
"suggested_area": "Garage" "suggested_area": self.suggested_area,
"sw_version" : self.sw_version,
"hw_version": self.hw_version
} }
@property
def unique_id(self) -> str:
"""Get the unique id."""
return f"{GEORIDE_DOMAIN}_{self._tracker.tracker_id}"
def __str__(self) -> str: def __str__(self) -> str:
"""Get string representation.""" """Get string representation."""
return f"GeoRide Device: {self.name}::{self.model_name}::{self.unique_id}" return f"GeoRide Device: {self.name}::{self.model_name}::{self.unique_id}"
@@ -77,34 +107,54 @@ class DeviceBeacon:
"""Get the name.""" """Get the name."""
return self._beacon.name return self._beacon.name
@property
def default_manufacturer(self) -> str:
"""Get the default_manufacturer."""
return "GeoRide"
@property @property
def manufacturer(self) -> str: def manufacturer(self) -> str:
"""Get the manufacturer.""" """Get the manufacturer."""
return "GeoRide" return "GeoRide"
@property
def default_model(self) -> str:
"""Get the default model."""
return "GeoRide Beacon"
@property
def suggested_area(self) -> str:
"""Get the suggested_area."""
return "Garage"
@property @property
def model_name(self) -> str: def model_name(self) -> str:
"""Get the model name.""" """Get the model name."""
name = "GeoRide Beacon" name = "GeoRide Beacon"
return name return name
@property
def unique_id(self) -> str:
"""Get the unique id."""
return {(GEORIDE_DOMAIN, self._beacon.beacon_id)}
@property
def via_device(self) -> str:
"""Get the unique id."""
return (GEORIDE_DOMAIN, self._beacon.linked_tracker_id )
@property @property
def device_info(self): def device_info(self):
"""Return the device info.""" """Return the device info."""
return { return {
"name": self.name, "name": self.name,
"identifiers": self.unique_id, "identifiers": self.unique_id,
"manufacturer": "GeoRide", "manufacturer": self.manufacturer,
"model": self.model_name, "model": self.model_name,
"suggested_area": "Garage" "suggested_area": self.suggested_area,
"via_device": self.via_device
} }
@property
def unique_id(self) -> str:
"""Get the unique id."""
return f"{GEORIDE_DOMAIN}_beacon_{self._tracker.tracker_id}"
def __str__(self) -> str: def __str__(self) -> str:
"""Get string representation.""" """Get string representation."""
return f"GeoRide Device: {self.name}::{self.model_name}::{self.unique_id}" return f"GeoRide Device: {self.name}::{self.model_name}::{self.unique_id}"

View File

@@ -3,7 +3,7 @@
import logging import logging
from typing import Any, Mapping from typing import Any, Mapping
from homeassistant.components.device_tracker.const import DOMAIN, SOURCE_TYPE_GPS from homeassistant.components.device_tracker.const import DOMAIN, SourceType
from homeassistant.components.device_tracker.config_entry import TrackerEntity from homeassistant.components.device_tracker.config_entry import TrackerEntity
from homeassistant.helpers.update_coordinator import ( from homeassistant.helpers.update_coordinator import (
@@ -78,7 +78,7 @@ class GeoRideTrackerEntity(CoordinatorEntity, TrackerEntity):
@property @property
def source_type(self): def source_type(self):
"""Return the source type, eg gps or router, of the device.""" """Return the source type, eg gps or router, of the device."""
return SOURCE_TYPE_GPS return SourceType.GPS
@property @property
def location_accuracy(self): def location_accuracy(self):

View File

@@ -6,10 +6,10 @@
"issue_tracker": "https://github.com/ptimatth/GeorideHA/issues", "issue_tracker": "https://github.com/ptimatth/GeorideHA/issues",
"iot_class": "cloud_polling", "iot_class": "cloud_polling",
"requirements": [ "requirements": [
"georideapilib==0.8.1", "georideapilib>=1.0.0",
"pyjwt==2.1.0" "pyjwt>=2.2.0"
], ],
"dependencies": [], "dependencies": [],
"codeowners": ["ptimatth"], "codeowners": ["ptimatth"],
"version": "0.9.0" "version": "1.1.1"
} }

View File

@@ -5,8 +5,7 @@ from typing import Any, Mapping
from homeassistant.core import callback from homeassistant.core import callback
from homeassistant.helpers.entity import DeviceInfo, EntityCategory from homeassistant.helpers.entity import DeviceInfo, EntityCategory
from homeassistant.components.sensor import SensorEntity from homeassistant.components.sensor import SensorEntity, SensorDeviceClass, ENTITY_ID_FORMAT
from homeassistant.components.sensor import ENTITY_ID_FORMAT
from homeassistant.helpers.update_coordinator import ( from homeassistant.helpers.update_coordinator import (
CoordinatorEntity, CoordinatorEntity,
DataUpdateCoordinator, DataUpdateCoordinator,
@@ -31,6 +30,7 @@ async def async_setup_entry(hass, config_entry, async_add_entities): # pylint: d
hass.data[GEORIDE_DOMAIN]["devices"][tracker_device.tracker.tracker_id] = coordinator hass.data[GEORIDE_DOMAIN]["devices"][tracker_device.tracker.tracker_id] = coordinator
entities.append(GeoRideOdometerSensorEntity(coordinator, tracker_device, hass)) entities.append(GeoRideOdometerSensorEntity(coordinator, tracker_device, hass))
entities.append(GeoRideOdometerKmSensorEntity(coordinator, tracker_device, hass)) entities.append(GeoRideOdometerKmSensorEntity(coordinator, tracker_device, hass))
entities.append(GeoRideSpeedSensorEntity(coordinator, tracker_device,hass))
entities.append(GeoRideFixtimeSensorEntity(coordinator, tracker_device)) entities.append(GeoRideFixtimeSensorEntity(coordinator, tracker_device))
if tracker_device.tracker.version > 2: if tracker_device.tracker.version > 2:
entities.append(GeoRideInternalBatterySensorEntity(coordinator, tracker_device)) entities.append(GeoRideInternalBatterySensorEntity(coordinator, tracker_device))
@@ -38,10 +38,10 @@ async def async_setup_entry(hass, config_entry, async_add_entities): # pylint: d
coordoned_beacons = georide_context.georide_trackers_beacon_coordoned coordoned_beacons = georide_context.georide_trackers_beacon_coordoned
for coordoned_beacon in coordoned_beacons: for coordoned_beacon in coordoned_beacons:
tracker_beacon = coordoned_tracker['tracker_beacon'] tracker_beacon = coordoned_beacon['tracker_beacon']
coordinator = coordoned_tracker['coordinator'] coordinator = coordoned_beacon['coordinator']
entities.append(GeoRideBeaconUpdatedBinarySensorEntity(coordinator, tracker_beacon)) entities.append(GeoRideBeaconBatterySensorEntity(coordinator, tracker_beacon))
hass.data[GEORIDE_DOMAIN]["devices"][tracker_device.beacon.beacon_id] = coordinator hass.data[GEORIDE_DOMAIN]["devices"][tracker_beacon.beacon.beacon_id] = coordinator
async_add_entities(entities) async_add_entities(entities)
@@ -108,14 +108,9 @@ class GeoRideOdometerKmSensorEntity(CoordinatorEntity, SensorEntity):
self._name = tracker_device.tracker.tracker_name self._name = tracker_device.tracker.tracker_name
self._unit_of_measurement = "km" self._unit_of_measurement = "km"
self.entity_id = f"{ENTITY_ID_FORMAT.format('odometer_km')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301 self.entity_id = f"{ENTITY_ID_FORMAT.format('odometer_km')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301
self._state = 0 self._state = 0
self._hass = hass self._hass = hass
@property
def entity_category(self):
return EntityCategory.DIAGNOSTIC
@property @property
def unique_id(self): def unique_id(self):
"""Return the unique ID.""" """Return the unique ID."""
@@ -147,6 +142,55 @@ class GeoRideOdometerKmSensorEntity(CoordinatorEntity, SensorEntity):
"""Return the device info.""" """Return the device info."""
return self._tracker_device.device_info return self._tracker_device.device_info
class GeoRideSpeedSensorEntity(CoordinatorEntity, SensorEntity):
"""Represent a tracked device."""
def __init__(self, coordinator: DataUpdateCoordinator[Mapping[str, Any]],
tracker_device:Device, hass):
"""Set up GeoRide entity."""
super().__init__(coordinator)
self._tracker_device = tracker_device
self._name = tracker_device.tracker.tracker_name
self._unit_of_measurement = "km/h"
self.entity_id = f"{ENTITY_ID_FORMAT.format('speed')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301
self._state = 0
self._hass = hass
self._state_class = "measurement"
@property
def unique_id(self):
"""Return the unique ID."""
return f"speed_{self._tracker_device.tracker.tracker_id}"
@property
def state(self):
"""state property"""
return self._tracker_device.tracker.speed
@property
def state_class(self):
return self._state_class
@property
def unit_of_measurement(self):
"""unit of mesurment property"""
return self._unit_of_measurement
@property
def name(self):
""" GeoRide odometer name """
return f"{self._name} speed"
@property
def icon(self):
"""icon getter"""
return "mdi:speedometer"
@property
def device_info(self) -> DeviceInfo:
"""Return the device info."""
return self._tracker_device.device_info
class GeoRideInternalBatterySensorEntity(CoordinatorEntity, SensorEntity): class GeoRideInternalBatterySensorEntity(CoordinatorEntity, SensorEntity):
"""Represent a tracked device.""" """Represent a tracked device."""
entity_category = EntityCategory.DIAGNOSTIC entity_category = EntityCategory.DIAGNOSTIC
@@ -159,8 +203,17 @@ class GeoRideInternalBatterySensorEntity(CoordinatorEntity, SensorEntity):
self._name = tracker_device.tracker.tracker_name self._name = tracker_device.tracker.tracker_name
self._unit_of_measurement = "V" self._unit_of_measurement = "V"
self.entity_id = f"{ENTITY_ID_FORMAT.format('internal_battery_voltage')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301 self.entity_id = f"{ENTITY_ID_FORMAT.format('internal_battery_voltage')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301
self._state = 0 self._state = 0
self._state_class = "measurement"
self._device_class = "voltage"
@property
def state_class(self):
return self._state_class
@property
def device_class(self):
return self._device_class
@property @property
def entity_category(self): def entity_category(self):
@@ -191,6 +244,11 @@ class GeoRideInternalBatterySensorEntity(CoordinatorEntity, SensorEntity):
"""icon getter""" """icon getter"""
return "mdi:battery" return "mdi:battery"
@property
def device_class(self) -> str:
"""device class"""
return SensorDeviceClass.VOLTAGE
@property @property
def device_info(self) -> DeviceInfo: def device_info(self) -> DeviceInfo:
"""Return the device info.""" """Return the device info."""
@@ -208,6 +266,16 @@ class GeoRideExternalBatterySensorEntity(CoordinatorEntity, SensorEntity):
self._unit_of_measurement = "V" self._unit_of_measurement = "V"
self.entity_id = f"{ENTITY_ID_FORMAT.format('external_battery_voltage')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301 self.entity_id = f"{ENTITY_ID_FORMAT.format('external_battery_voltage')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301
self._state = 0 self._state = 0
self._state_class = "measurement"
self._device_class = "voltage"
@property
def state_class(self):
return self._state_class
@property
def device_class(self):
return self._device_class
@property @property
def entity_category(self): def entity_category(self):
@@ -238,6 +306,11 @@ class GeoRideExternalBatterySensorEntity(CoordinatorEntity, SensorEntity):
"""icon getter""" """icon getter"""
return "mdi:battery" return "mdi:battery"
@property
def device_class(self) -> str:
"""device class"""
return SensorDeviceClass.VOLTAGE
@property @property
def device_info(self) -> DeviceInfo: def device_info(self) -> DeviceInfo:
"""Return the device info.""" """Return the device info."""
@@ -253,7 +326,6 @@ class GeoRideFixtimeSensorEntity(CoordinatorEntity, SensorEntity):
self._tracker_device = tracker_device self._tracker_device = tracker_device
self._name = tracker_device.tracker.tracker_name self._name = tracker_device.tracker.tracker_name
self.entity_id = f"{ENTITY_ID_FORMAT.format('fixtime')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301 self.entity_id = f"{ENTITY_ID_FORMAT.format('fixtime')}.{tracker_device.tracker.tracker_id}"# pylint: disable=C0301
self._state = 0 self._state = 0
self._device_class = "timestamp" self._device_class = "timestamp"
@@ -293,8 +365,8 @@ class GeoRideBeaconBatterySensorEntity(CoordinatorEntity, SensorEntity):
tracker_beacon: DeviceBeacon): tracker_beacon: DeviceBeacon):
"""Set up GeoRide entity.""" """Set up GeoRide entity."""
super().__init__(coordinator) super().__init__(coordinator)
self._tracker_device = tracker_device self._tracker_device = tracker_beacon
self._name = tracker_device.tracker.tracker_name self._name = tracker_beacon.beacon.name
self._unit_of_measurement = "%" self._unit_of_measurement = "%"
self.entity_id = f"{ENTITY_ID_FORMAT.format('battery_percent')}.{tracker_beacon.beacon.beacon_id}"# pylint: disable=C0301 self.entity_id = f"{ENTITY_ID_FORMAT.format('battery_percent')}.{tracker_beacon.beacon.beacon_id}"# pylint: disable=C0301
self._state = 0 self._state = 0
@@ -328,6 +400,11 @@ class GeoRideBeaconBatterySensorEntity(CoordinatorEntity, SensorEntity):
"""icon getter""" """icon getter"""
return "mdi:battery" return "mdi:battery"
@property
def device_class(self) -> str:
"""device class"""
return SensorDeviceClass.BATTERY
@property @property
def device_info(self) -> DeviceInfo: def device_info(self) -> DeviceInfo:
"""Return the device info.""" """Return the device info."""

View File

@@ -17,7 +17,7 @@ import georideapilib.api as GeoRideApi
from .const import DOMAIN as GEORIDE_DOMAIN from .const import DOMAIN as GEORIDE_DOMAIN
from .device import Device from .device import Device
ENTITY_ID_FORMAT: Final = GEORIDE_DOMAIN + ".{}" ENTITY_ID_FORMAT = GEORIDE_DOMAIN + ".{}"
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
@@ -31,11 +31,11 @@ async def async_setup_entry(hass, config_entry, async_add_entities): # pylint: d
for coordoned_tracker in coordoned_trackers: for coordoned_tracker in coordoned_trackers:
tracker_device = coordoned_tracker['tracker_device'] tracker_device = coordoned_tracker['tracker_device']
coordinator = coordoned_tracker['coordinator'] coordinator = coordoned_tracker['coordinator']
hass.data[GEORIDE_DOMAIN]["devices"][tracker_device.unique_id] = coordinator hass.data[GEORIDE_DOMAIN]["devices"][tracker_device.tracker.tracker_id] = coordinator
if tracker_device.tracker.version > 2: if tracker_device.tracker.version > 2:
entities.append(GeoRideSirenEntity(coordinator, tracker_device, hass)) entities.append(GeoRideSirenEntity(coordinator, tracker_device, hass))
await async_add_entities(entities) async_add_entities(entities)
return True return True

View File

@@ -4,5 +4,5 @@
"render_readme": true, "render_readme": true,
"domains": ["devices_tracker", "sensor"], "domains": ["devices_tracker", "sensor"],
"country": ["FR"], "country": ["FR"],
"homeassistant": "2022.2.0" "homeassistant": "2024.11.0"
} }