[#350] Merged google.fit
backend and plugin #354
|
@ -10,7 +10,6 @@ Backends
|
||||||
platypush/backend/button.flic.rst
|
platypush/backend/button.flic.rst
|
||||||
platypush/backend/camera.pi.rst
|
platypush/backend/camera.pi.rst
|
||||||
platypush/backend/chat.telegram.rst
|
platypush/backend/chat.telegram.rst
|
||||||
platypush/backend/google.fit.rst
|
|
||||||
platypush/backend/google.pubsub.rst
|
platypush/backend/google.pubsub.rst
|
||||||
platypush/backend/gps.rst
|
platypush/backend/gps.rst
|
||||||
platypush/backend/http.rst
|
platypush/backend/http.rst
|
||||||
|
|
|
@ -1,6 +0,0 @@
|
||||||
``google.fit``
|
|
||||||
================================
|
|
||||||
|
|
||||||
.. automodule:: platypush.backend.google.fit
|
|
||||||
:members:
|
|
||||||
|
|
|
@ -1,129 +0,0 @@
|
||||||
import datetime
|
|
||||||
import time
|
|
||||||
|
|
||||||
from platypush.backend import Backend
|
|
||||||
from platypush.context import get_plugin
|
|
||||||
from platypush.message.event.google.fit import GoogleFitEvent
|
|
||||||
from platypush.utils import camel_case_to_snake_case
|
|
||||||
|
|
||||||
|
|
||||||
class GoogleFitBackend(Backend):
|
|
||||||
"""
|
|
||||||
This backend will listen for new Google Fit events (e.g. new weight/height
|
|
||||||
measurements, new fitness activities etc.) on the specified data streams and
|
|
||||||
fire an event upon new data.
|
|
||||||
|
|
||||||
Requires:
|
|
||||||
|
|
||||||
* The **google.fit** plugin
|
|
||||||
(:class:`platypush.plugins.google.fit.GoogleFitPlugin`) enabled.
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
_default_poll_seconds = 60
|
|
||||||
_default_user_id = 'me'
|
|
||||||
_last_timestamp_varname = '_GOOGLE_FIT_LAST_TIMESTAMP_'
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
data_sources,
|
|
||||||
user_id=_default_user_id,
|
|
||||||
poll_seconds=_default_poll_seconds,
|
|
||||||
*args,
|
|
||||||
**kwargs
|
|
||||||
):
|
|
||||||
"""
|
|
||||||
:param data_sources: Google Fit data source IDs to monitor. You can
|
|
||||||
get a list of the available data sources through the
|
|
||||||
:meth:`platypush.plugins.google.fit.GoogleFitPlugin.get_data_sources`
|
|
||||||
action
|
|
||||||
:type data_sources: list[str]
|
|
||||||
|
|
||||||
:param user_id: Google user ID to track (default: 'me')
|
|
||||||
:type user_id: str
|
|
||||||
|
|
||||||
:param poll_seconds: How often the backend will query the data sources
|
|
||||||
for new data points (default: 60 seconds)
|
|
||||||
:type poll_seconds: float
|
|
||||||
"""
|
|
||||||
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
|
|
||||||
self.data_sources = data_sources
|
|
||||||
self.user_id = user_id
|
|
||||||
self.poll_seconds = poll_seconds
|
|
||||||
|
|
||||||
def run(self):
|
|
||||||
super().run()
|
|
||||||
self.logger.info(
|
|
||||||
'Started Google Fit backend on data sources {}'.format(self.data_sources)
|
|
||||||
)
|
|
||||||
|
|
||||||
while not self.should_stop():
|
|
||||||
try:
|
|
||||||
for data_source in self.data_sources:
|
|
||||||
varname = self._last_timestamp_varname + data_source
|
|
||||||
last_timestamp = float(
|
|
||||||
get_plugin('variable').get(varname).output.get(varname) or 0
|
|
||||||
)
|
|
||||||
|
|
||||||
new_last_timestamp = last_timestamp
|
|
||||||
self.logger.info(
|
|
||||||
'Processing new entries from data source {}, last timestamp: {}'.format(
|
|
||||||
data_source,
|
|
||||||
str(datetime.datetime.fromtimestamp(last_timestamp)),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
data_points = (
|
|
||||||
get_plugin('google.fit')
|
|
||||||
.get_data(user_id=self.user_id, data_source_id=data_source)
|
|
||||||
.output
|
|
||||||
)
|
|
||||||
new_data_points = 0
|
|
||||||
|
|
||||||
for dp in data_points:
|
|
||||||
dp_time = dp.pop('startTime', 0)
|
|
||||||
if 'dataSourceId' in dp:
|
|
||||||
del dp['dataSourceId']
|
|
||||||
|
|
||||||
if dp_time > last_timestamp:
|
|
||||||
self.bus.post(
|
|
||||||
GoogleFitEvent(
|
|
||||||
user_id=self.user_id,
|
|
||||||
data_source_id=data_source,
|
|
||||||
data_type=dp.pop('dataTypeName'),
|
|
||||||
start_time=dp_time,
|
|
||||||
end_time=dp.pop('endTime'),
|
|
||||||
modified_time=dp.pop('modifiedTime'),
|
|
||||||
values=dp.pop('values'),
|
|
||||||
**{
|
|
||||||
camel_case_to_snake_case(k): v
|
|
||||||
for k, v in dp.items()
|
|
||||||
}
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
new_data_points += 1
|
|
||||||
|
|
||||||
new_last_timestamp = max(dp_time, new_last_timestamp)
|
|
||||||
|
|
||||||
last_timestamp = new_last_timestamp
|
|
||||||
self.logger.info(
|
|
||||||
'Got {} new entries from data source {}, last timestamp: {}'.format(
|
|
||||||
new_data_points,
|
|
||||||
data_source,
|
|
||||||
str(datetime.datetime.fromtimestamp(last_timestamp)),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
get_plugin('variable').set(**{varname: last_timestamp})
|
|
||||||
except Exception as e:
|
|
||||||
self.logger.warning('Exception while processing Fit data')
|
|
||||||
self.logger.exception(e)
|
|
||||||
continue
|
|
||||||
|
|
||||||
time.sleep(self.poll_seconds)
|
|
||||||
|
|
||||||
|
|
||||||
# vim:sw=4:ts=4:et:
|
|
|
@ -1,8 +0,0 @@
|
||||||
manifest:
|
|
||||||
events:
|
|
||||||
platypush.message.event.google.fit.GoogleFitEvent: when a newdata point is received
|
|
||||||
on one of the registered streams.
|
|
||||||
install:
|
|
||||||
pip: []
|
|
||||||
package: platypush.backend.google.fit
|
|
||||||
type: backend
|
|
|
@ -26,18 +26,39 @@ class GooglePlugin(Plugin):
|
||||||
|
|
||||||
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
||||||
|
|
||||||
5 Select "Desktop app", enter whichever name you like, and click "Create".
|
5. Select "Desktop app", enter whichever name you like, and click "Create".
|
||||||
|
|
||||||
6. Click on the "Download JSON" icon next to your newly created client ID.
|
6. Click on the "Download JSON" icon next to your newly created client ID.
|
||||||
|
Save the JSON file under
|
||||||
|
``<WORKDIR>/credentials/google/client_secret.json``.
|
||||||
|
|
||||||
7. Generate a credentials file for the required scope:
|
7. If you're running the service on a desktop environment, then you
|
||||||
|
can just start the application. A browser window will open and
|
||||||
|
you'll be asked to authorize the application - you may be prompted
|
||||||
|
with a warning because you are running a personal and potentially
|
||||||
|
unverified application. After authorizing the application, the
|
||||||
|
process will save the credentials under
|
||||||
|
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
|
||||||
|
with the plugin initialization.
|
||||||
|
|
||||||
.. code-block:: bash
|
8. If you're running the service on a headless environment, or you
|
||||||
|
prefer to manually generate the credentials file before copying to
|
||||||
|
another machine, you can run the following command:
|
||||||
|
|
||||||
mkdir -p <WORKDIR>/credentials/google
|
.. code-block:: bash
|
||||||
python -m platypush.plugins.google.credentials \
|
|
||||||
'calendar.readonly' \
|
mkdir -p <WORKDIR>/credentials/google
|
||||||
<WORKDIR>/credentials/google/client_secret.json
|
python -m platypush.plugins.google.credentials \
|
||||||
|
'calendar.readonly,gmail.modify' \
|
||||||
|
[--noauth_local_webserver] \
|
||||||
|
<WORKDIR>/credentials/google/client_secret.json
|
||||||
|
|
||||||
|
When launched with ``--noauth_local_webserver``, the script will
|
||||||
|
start a local webserver and print a URL that should be opened in
|
||||||
|
your browser. After authorizing the application, you may be
|
||||||
|
prompted with a code that you should copy and paste back to the
|
||||||
|
script. Otherwise, if you're running the script on a desktop, a
|
||||||
|
browser window will be opened automatically.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
@ -69,12 +90,9 @@ class GooglePlugin(Plugin):
|
||||||
|
|
||||||
if self._scopes:
|
if self._scopes:
|
||||||
scopes = " ".join(sorted(self._scopes))
|
scopes = " ".join(sorted(self._scopes))
|
||||||
try:
|
self.credentials = {
|
||||||
self.credentials = {
|
scopes: get_credentials(scopes, secrets_file=self._secrets_path)
|
||||||
scopes: get_credentials(scopes, secrets_file=self._secrets_path)
|
}
|
||||||
}
|
|
||||||
except AssertionError as e:
|
|
||||||
self.logger.warning(str(e))
|
|
||||||
else:
|
else:
|
||||||
self.credentials = {}
|
self.credentials = {}
|
||||||
|
|
||||||
|
|
|
@ -25,18 +25,39 @@ class GoogleCalendarPlugin(GooglePlugin, CalendarInterface):
|
||||||
|
|
||||||
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
||||||
|
|
||||||
5 Select "Desktop app", enter whichever name you like, and click "Create".
|
5. Select "Desktop app", enter whichever name you like, and click "Create".
|
||||||
|
|
||||||
6. Click on the "Download JSON" icon next to your newly created client ID.
|
6. Click on the "Download JSON" icon next to your newly created client ID.
|
||||||
|
Save the JSON file under
|
||||||
|
``<WORKDIR>/credentials/google/client_secret.json``.
|
||||||
|
|
||||||
7. Generate a credentials file for the required scope:
|
7. If you're running the service on a desktop environment, then you
|
||||||
|
can just start the application. A browser window will open and
|
||||||
|
you'll be asked to authorize the application - you may be prompted
|
||||||
|
with a warning because you are running a personal and potentially
|
||||||
|
unverified application. After authorizing the application, the
|
||||||
|
process will save the credentials under
|
||||||
|
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
|
||||||
|
with the plugin initialization.
|
||||||
|
|
||||||
.. code-block:: bash
|
8. If you're running the service on a headless environment, or you
|
||||||
|
prefer to manually generate the credentials file before copying to
|
||||||
|
another machine, you can run the following command:
|
||||||
|
|
||||||
mkdir -p <WORKDIR>/credentials/google
|
.. code-block:: bash
|
||||||
python -m platypush.plugins.google.credentials \
|
|
||||||
'calendar.readonly' \
|
mkdir -p <WORKDIR>/credentials/google
|
||||||
<WORKDIR>/credentials/google/client_secret.json
|
python -m platypush.plugins.google.credentials \
|
||||||
|
'calendar.readonly' \
|
||||||
|
[--noauth_local_webserver] \
|
||||||
|
<WORKDIR>/credentials/google/client_secret.json
|
||||||
|
|
||||||
|
When launched with ``--noauth_local_webserver``, the script will
|
||||||
|
start a local webserver and print a URL that should be opened in
|
||||||
|
your browser. After authorizing the application, you may be
|
||||||
|
prompted with a code that you should copy and paste back to the
|
||||||
|
script. Otherwise, if you're running the script on a desktop, a
|
||||||
|
browser window will be opened automatically.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
|
@ -63,25 +63,21 @@ def get_credentials(scope: str, secrets_file: Optional[str] = None):
|
||||||
not os.path.isfile(credentials_file)
|
not os.path.isfile(credentials_file)
|
||||||
and secrets_file
|
and secrets_file
|
||||||
and os.path.isfile(secrets_file)
|
and os.path.isfile(secrets_file)
|
||||||
|
and (os.getenv("DISPLAY") or os.getenv("BROWSER"))
|
||||||
):
|
):
|
||||||
# If DISPLAY or BROWSER are set, then we can open the authentication URL in the browser.
|
args = []
|
||||||
# Otherwise, we'll have to use the --noauth_local_webserver flag and copy/paste the URL
|
|
||||||
args = (
|
|
||||||
["--noauth_local_webserver"]
|
|
||||||
if not (os.getenv("DISPLAY") or os.getenv("BROWSER"))
|
|
||||||
else []
|
|
||||||
)
|
|
||||||
|
|
||||||
generate_credentials(secrets_file, scope, *args)
|
generate_credentials(secrets_file, scope, *args)
|
||||||
|
|
||||||
assert os.path.isfile(credentials_file), tw.dedent(
|
assert os.path.isfile(credentials_file), tw.dedent(
|
||||||
f"""
|
f"""
|
||||||
Credentials file {credentials_file} not found. Generate it through:
|
Credentials file {credentials_file} not found. Generate it through:
|
||||||
python -m platypush.plugins.google.credentials "{','.join(scopes)}" /path/to/client_secret.json
|
python -m platypush.plugins.google.credentials "{','.join(scopes)}" {
|
||||||
[--auth_host_name AUTH_HOST_NAME]
|
secrets_file or '/path/to/client_secret.json'
|
||||||
[--noauth_local_webserver]
|
}
|
||||||
[--auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]]
|
[--auth_host_name AUTH_HOST_NAME]
|
||||||
[--logging_level [DEBUG,INFO,WARNING,ERROR,CRITICAL]]
|
[--noauth_local_webserver]
|
||||||
|
[--auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]]
|
||||||
|
[--logging_level [DEBUG,INFO,WARNING,ERROR,CRITICAL]]
|
||||||
|
|
||||||
Specify --noauth_local_webserver if you're running this script on a headless machine.
|
Specify --noauth_local_webserver if you're running this script on a headless machine.
|
||||||
You will then get an authentication URL on the logs.
|
You will then get an authentication URL on the logs.
|
||||||
|
@ -112,6 +108,10 @@ def generate_credentials(client_secret_path: str, scope: str, *args: str):
|
||||||
flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args(args) # type: ignore
|
flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args(args) # type: ignore
|
||||||
tools.run_flow(flow, store, flags)
|
tools.run_flow(flow, store, flags)
|
||||||
print("Storing credentials to", credentials_file)
|
print("Storing credentials to", credentials_file)
|
||||||
|
print(
|
||||||
|
"\nIf this is not the working directory of your Platypush instance, \n"
|
||||||
|
"then move the generated credentials file to WORKDIR/credentials/google"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
|
|
|
@ -25,18 +25,39 @@ class GoogleDrivePlugin(GooglePlugin):
|
||||||
|
|
||||||
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
||||||
|
|
||||||
5 Select "Desktop app", enter whichever name you like, and click "Create".
|
5. Select "Desktop app", enter whichever name you like, and click "Create".
|
||||||
|
|
||||||
6. Click on the "Download JSON" icon next to your newly created client ID.
|
6. Click on the "Download JSON" icon next to your newly created client ID.
|
||||||
|
Save the JSON file under
|
||||||
|
``<WORKDIR>/credentials/google/client_secret.json``.
|
||||||
|
|
||||||
7. Generate a credentials file for the required scope:
|
7. If you're running the service on a desktop environment, then you
|
||||||
|
can just start the application. A browser window will open and
|
||||||
|
you'll be asked to authorize the application - you may be prompted
|
||||||
|
with a warning because you are running a personal and potentially
|
||||||
|
unverified application. After authorizing the application, the
|
||||||
|
process will save the credentials under
|
||||||
|
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
|
||||||
|
with the plugin initialization.
|
||||||
|
|
||||||
.. code-block:: bash
|
8. If you're running the service on a headless environment, or you
|
||||||
|
prefer to manually generate the credentials file before copying to
|
||||||
|
another machine, you can run the following command:
|
||||||
|
|
||||||
mkdir -p <WORKDIR>/credentials/google
|
.. code-block:: bash
|
||||||
python -m platypush.plugins.google.credentials \
|
|
||||||
'drive,drive.appfolder,drive.photos.readonly' \
|
mkdir -p <WORKDIR>/credentials/google
|
||||||
<WORKDIR>/credentials/google/client_secret.json
|
python -m platypush.plugins.google.credentials \
|
||||||
|
'drive,drive.appfolder,drive.photos.readonly' \
|
||||||
|
[--noauth_local_webserver] \
|
||||||
|
<WORKDIR>/credentials/google/client_secret.json
|
||||||
|
|
||||||
|
When launched with ``--noauth_local_webserver``, the script will
|
||||||
|
start a local webserver and print a URL that should be opened in
|
||||||
|
your browser. After authorizing the application, you may be
|
||||||
|
prompted with a code that you should copy and paste back to the
|
||||||
|
script. Otherwise, if you're running the script on a desktop, a
|
||||||
|
browser window will be opened automatically.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,14 @@
|
||||||
from platypush.plugins import action
|
from datetime import datetime
|
||||||
|
from typing import Generator, Iterable, Optional
|
||||||
|
|
||||||
|
from platypush.context import Variable
|
||||||
|
from platypush.message.event.google.fit import GoogleFitEvent
|
||||||
|
from platypush.plugins import RunnablePlugin, action
|
||||||
from platypush.plugins.google import GooglePlugin
|
from platypush.plugins.google import GooglePlugin
|
||||||
|
from platypush.utils import camel_case_to_snake_case
|
||||||
|
|
||||||
|
|
||||||
class GoogleFitPlugin(GooglePlugin):
|
class GoogleFitPlugin(GooglePlugin, RunnablePlugin):
|
||||||
r"""
|
r"""
|
||||||
Google Fit plugin.
|
Google Fit plugin.
|
||||||
|
|
||||||
|
@ -22,25 +28,78 @@ class GoogleFitPlugin(GooglePlugin):
|
||||||
|
|
||||||
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
||||||
|
|
||||||
5 Select "Desktop app", enter whichever name you like, and click "Create".
|
5. Select "Desktop app", enter whichever name you like, and click "Create".
|
||||||
|
|
||||||
6. Click on the "Download JSON" icon next to your newly created client ID.
|
6. Click on the "Download JSON" icon next to your newly created client ID.
|
||||||
|
Save the JSON file under
|
||||||
|
``<WORKDIR>/credentials/google/client_secret.json``.
|
||||||
|
|
||||||
7. Generate a credentials file for the required scope:
|
7. If you're running the service on a desktop environment, then you
|
||||||
|
can just start the application. A browser window will open and
|
||||||
|
you'll be asked to authorize the application - you may be prompted
|
||||||
|
with a warning because you are running a personal and potentially
|
||||||
|
unverified application. After authorizing the application, the
|
||||||
|
process will save the credentials under
|
||||||
|
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
|
||||||
|
with the plugin initialization.
|
||||||
|
|
||||||
.. code-block:: bash
|
8. If you're running the service on a headless environment, or you
|
||||||
|
prefer to manually generate the credentials file before copying to
|
||||||
|
another machine, you can run the following command:
|
||||||
|
|
||||||
$ mkdir -p <WORKDIR>/credentials/google
|
.. code-block:: bash
|
||||||
$ roles="
|
|
||||||
fitness.activity.read,
|
$ mkdir -p <WORKDIR>/credentials/google
|
||||||
fitness.body.read,
|
$ roles="
|
||||||
fitness.body_temperature.read,
|
fitness.activity.read,
|
||||||
fitness.heart_rate.read,
|
fitness.body.read,
|
||||||
fitness.sleep.read,
|
fitness.body_temperature.read,
|
||||||
fitness.location.read
|
fitness.heart_rate.read,
|
||||||
"
|
fitness.sleep.read,
|
||||||
$ python -m platypush.plugins.google.credentials "$roles" \
|
fitness.location.read
|
||||||
<WORKDIR>/credentials/google/client_secret.json
|
"
|
||||||
|
$ python -m platypush.plugins.google.credentials "$roles" \
|
||||||
|
[--noauth_local_webserver] \
|
||||||
|
<WORKDIR>/credentials/google/client_secret.json
|
||||||
|
|
||||||
|
When launched with ``--noauth_local_webserver``, the script will
|
||||||
|
start a local webserver and print a URL that should be opened in
|
||||||
|
your browser. After authorizing the application, you may be
|
||||||
|
prompted with a code that you should copy and paste back to the
|
||||||
|
script. Otherwise, if you're running the script on a desktop, a
|
||||||
|
browser window will be opened automatically.
|
||||||
|
|
||||||
|
When not configured with any ``data_sources``, the plugin won't start the
|
||||||
|
event monitor and won't trigger any
|
||||||
|
:class:`platypush.message.event.google.fit.GoogleFitEvent`. You can still
|
||||||
|
fetch data points programmatically through the :meth:`.get_data` though.
|
||||||
|
|
||||||
|
If you want to monitor data sources and fire events, then you need to
|
||||||
|
explicitly define which health metrics you want to monitor through this
|
||||||
|
integration.
|
||||||
|
|
||||||
|
After starting the plugin, you can get a list of the available data sources
|
||||||
|
by running the :meth:`.get_data_sources` action. The ``dataStreamId``
|
||||||
|
fields are usually the ones you want to configure in your data sources.
|
||||||
|
|
||||||
|
Unless you are interested in monitoring data points from specific devices,
|
||||||
|
you may want to look for ``dataStreamId`` fields that match the
|
||||||
|
``derived:*:merge*`` pattern. Some popular examples include:
|
||||||
|
|
||||||
|
- ``derived:com.google.step_count.delta:merge_step_deltas``, to monitor
|
||||||
|
the number of steps taken in a given time interval.
|
||||||
|
|
||||||
|
- ``derived:com.google.active_minutes:com.google.android.gms:merge_active_minutes``,
|
||||||
|
to monitor the number of active minutes in a given time interval.
|
||||||
|
|
||||||
|
- ``derived:com.google.speed:com.google.android.gms:merge_speed``, to
|
||||||
|
monitor the speed in a given time interval.
|
||||||
|
|
||||||
|
- ``derived:com.google.calories.expended:com.google.android.gms:merge_calories_expended``,
|
||||||
|
to monitor the number of calories burned in a given time interval.
|
||||||
|
|
||||||
|
- ``derived:com.google.heart_rate.bpm:com.google.android.gms:merge_heart_rate_bpm``,
|
||||||
|
to monitor the heart rate measured in a given time interval.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
@ -53,31 +112,78 @@ class GoogleFitPlugin(GooglePlugin):
|
||||||
'https://www.googleapis.com/auth/fitness.location.read',
|
'https://www.googleapis.com/auth/fitness.location.read',
|
||||||
]
|
]
|
||||||
|
|
||||||
def __init__(self, user_id='me', *args, **kwargs):
|
_default_user_id = 'me'
|
||||||
|
_last_timestamp_varname = '_GOOGLE_FIT_LAST_TIMESTAMP_'
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
data_sources: Iterable[str] = (),
|
||||||
|
user_id: str = _default_user_id,
|
||||||
|
poll_interval: float = 120.0,
|
||||||
|
**kwargs,
|
||||||
|
):
|
||||||
"""
|
"""
|
||||||
|
:param data_sources: Google Fit data source IDs to monitor - e.g.
|
||||||
|
weight, heartbeat, steps etc. You can get a list of the available
|
||||||
|
data sources on your account through the :meth:`.get_data_sources`
|
||||||
|
action. If none is specified then no sources will be monitored.
|
||||||
:param user_id: Default Google user_id (default: 'me', default
|
:param user_id: Default Google user_id (default: 'me', default
|
||||||
configured account user)
|
configured account user)
|
||||||
:type user_id: str or int
|
:param poll_interval: How often the plugin should poll for new events
|
||||||
|
(default: 120 seconds).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
super().__init__(scopes=self.scopes, *args, **kwargs)
|
super().__init__(
|
||||||
|
scopes=self.scopes,
|
||||||
|
poll_interval=poll_interval,
|
||||||
|
disable_monitor=not data_sources,
|
||||||
|
**kwargs,
|
||||||
|
)
|
||||||
|
|
||||||
self.user_id = user_id
|
self.user_id = user_id
|
||||||
|
self.data_sources = data_sources
|
||||||
|
|
||||||
|
def _last_timestamp_var(self, data_source: str) -> Variable:
|
||||||
|
return Variable(self._last_timestamp_varname + data_source)
|
||||||
|
|
||||||
|
def _get_last_timestamp(self, data_source: str) -> float:
|
||||||
|
return float(self._last_timestamp_var(data_source).get() or 0)
|
||||||
|
|
||||||
|
def _set_last_timestamp(self, data_source: str, timestamp: float):
|
||||||
|
self._last_timestamp_var(data_source).set(timestamp)
|
||||||
|
|
||||||
@action
|
@action
|
||||||
def get_data_sources(self, user_id=None):
|
def get_data_sources(self, user_id: Optional[str] = None):
|
||||||
"""
|
"""
|
||||||
Get the available data sources for the specified user_id
|
Get the available data sources for the specified user.
|
||||||
|
|
||||||
|
:param user_id: Target user ID (default: configured user).
|
||||||
"""
|
"""
|
||||||
|
from googleapiclient.errors import HttpError
|
||||||
|
|
||||||
service = self.get_service(service='fitness', version='v1')
|
service = self.get_service(service='fitness', version='v1')
|
||||||
sources = (
|
|
||||||
service.users().dataSources().list(userId=user_id or self.user_id).execute()
|
try:
|
||||||
)
|
sources = (
|
||||||
|
service.users() # pylint: disable=no-member
|
||||||
|
.dataSources()
|
||||||
|
.list(userId=user_id or self.user_id)
|
||||||
|
.execute()
|
||||||
|
)
|
||||||
|
except HttpError as e:
|
||||||
|
err = f'Error while getting data sources: {e.status_code}: {e.reason}'
|
||||||
|
self.logger.warning(err)
|
||||||
|
raise AssertionError(err) from e
|
||||||
|
|
||||||
return sources['dataSource']
|
return sources['dataSource']
|
||||||
|
|
||||||
@action
|
@action
|
||||||
def get_data(self, data_source_id, user_id=None, limit=None):
|
def get_data(
|
||||||
|
self,
|
||||||
|
data_source_id: str,
|
||||||
|
user_id: Optional[str] = None,
|
||||||
|
limit: Optional[int] = 100,
|
||||||
|
):
|
||||||
"""
|
"""
|
||||||
Get raw data for the specified data_source_id
|
Get raw data for the specified data_source_id
|
||||||
|
|
||||||
|
@ -86,6 +192,30 @@ class GoogleFitPlugin(GooglePlugin):
|
||||||
:param user_id: Target user ID (default: configured user).
|
:param user_id: Target user ID (default: configured user).
|
||||||
:param limit: Maximum number of items to return.
|
:param limit: Maximum number of items to return.
|
||||||
"""
|
"""
|
||||||
|
return list(
|
||||||
|
self._get_data(data_source_id=data_source_id, user_id=user_id, limit=limit)
|
||||||
|
)
|
||||||
|
|
||||||
|
def _get_timestamp(self, dp: dict, prefix: str) -> Optional[float]:
|
||||||
|
basename = name = prefix + 'Time'
|
||||||
|
t = dp.pop(name, None)
|
||||||
|
if t is not None:
|
||||||
|
return float(t)
|
||||||
|
|
||||||
|
name = basename + 'Millis'
|
||||||
|
t = dp.pop(name, None)
|
||||||
|
if t is not None:
|
||||||
|
return float(t) / 1e3
|
||||||
|
|
||||||
|
name = basename + 'Nanos'
|
||||||
|
t = dp.pop(name, None)
|
||||||
|
if t is not None:
|
||||||
|
return float(t) / 1e9
|
||||||
|
|
||||||
|
def _get_data(
|
||||||
|
self, data_source_id, user_id: Optional[str] = None, limit: Optional[int] = 100
|
||||||
|
) -> Generator[dict, None, None]:
|
||||||
|
from googleapiclient.errors import HttpError
|
||||||
|
|
||||||
service = self.get_service(service='fitness', version='v1')
|
service = self.get_service(service='fitness', version='v1')
|
||||||
kwargs = {
|
kwargs = {
|
||||||
|
@ -95,45 +225,106 @@ class GoogleFitPlugin(GooglePlugin):
|
||||||
|
|
||||||
if limit:
|
if limit:
|
||||||
kwargs['limit'] = limit
|
kwargs['limit'] = limit
|
||||||
data_points = []
|
|
||||||
|
|
||||||
for data_point in (
|
try:
|
||||||
service.users()
|
for data_point in (
|
||||||
.dataSources()
|
service.users() # pylint: disable=no-member
|
||||||
.dataPointChanges()
|
.dataSources()
|
||||||
.list(**kwargs)
|
.dataPointChanges()
|
||||||
.execute()
|
.list(**kwargs)
|
||||||
.get('insertedDataPoint', [])
|
.execute()
|
||||||
|
.get('insertedDataPoint', [])
|
||||||
|
):
|
||||||
|
data_point['startTime'] = self._get_timestamp(data_point, 'start')
|
||||||
|
data_point['endTime'] = self._get_timestamp(data_point, 'end')
|
||||||
|
data_point['modifiedTime'] = self._get_timestamp(data_point, 'modified')
|
||||||
|
values = []
|
||||||
|
|
||||||
|
for value in data_point.pop('value', data_point.pop('values', [])):
|
||||||
|
if isinstance(value, (int, float, str)):
|
||||||
|
values.append(value)
|
||||||
|
continue
|
||||||
|
|
||||||
|
if value.get('intVal') is not None:
|
||||||
|
value = value['intVal']
|
||||||
|
elif value.get('fpVal') is not None:
|
||||||
|
value = value['fpVal']
|
||||||
|
elif value.get('stringVal') is not None:
|
||||||
|
value = value['stringVal']
|
||||||
|
elif value.get('mapVal'):
|
||||||
|
value = {
|
||||||
|
v['key']: v['value'].get(
|
||||||
|
'intVal',
|
||||||
|
v['value'].get('fpVal', v['value'].get('stringVal')),
|
||||||
|
)
|
||||||
|
for v in value['mapVal']
|
||||||
|
}
|
||||||
|
|
||||||
|
values.append(value)
|
||||||
|
|
||||||
|
data_point['values'] = values
|
||||||
|
yield data_point
|
||||||
|
except HttpError as e:
|
||||||
|
err = f'Error while getting data points: {e.status_code}: {e.reason}'
|
||||||
|
self.logger.warning(err)
|
||||||
|
raise AssertionError(err) from e
|
||||||
|
|
||||||
|
def _process_data_source(self, data_source: str):
|
||||||
|
last_timestamp = new_last_timestamp = self._get_last_timestamp(data_source)
|
||||||
|
|
||||||
|
self.logger.debug(
|
||||||
|
'Processing new entries from data source %s, last timestamp: %s',
|
||||||
|
data_source,
|
||||||
|
datetime.fromtimestamp(last_timestamp).isoformat(),
|
||||||
|
)
|
||||||
|
|
||||||
|
new_data_points = 0
|
||||||
|
for dp in self._get_data(
|
||||||
|
user_id=self.user_id,
|
||||||
|
data_source_id=data_source,
|
||||||
|
limit=100,
|
||||||
):
|
):
|
||||||
data_point['startTime'] = float(data_point.pop('startTimeNanos')) / 1e9
|
dp_time = dp.pop('startTime', 0)
|
||||||
data_point['endTime'] = float(data_point.pop('endTimeNanos')) / 1e9
|
dp.pop('dataStreamId', None)
|
||||||
data_point['modifiedTime'] = (
|
|
||||||
float(data_point.pop('modifiedTimeMillis')) / 1e6
|
if dp_time > last_timestamp:
|
||||||
|
self._bus.post(
|
||||||
|
GoogleFitEvent(
|
||||||
|
user_id=self.user_id,
|
||||||
|
data_source_id=data_source,
|
||||||
|
data_type=dp.pop('dataTypeName'),
|
||||||
|
start_time=dp_time,
|
||||||
|
end_time=dp.pop('endTime'),
|
||||||
|
modified_time=dp.pop('modifiedTime'),
|
||||||
|
values=dp.pop('values'),
|
||||||
|
**{camel_case_to_snake_case(k): v for k, v in dp.items()},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
new_data_points += 1
|
||||||
|
|
||||||
|
new_last_timestamp = max(dp_time, new_last_timestamp)
|
||||||
|
|
||||||
|
last_timestamp = new_last_timestamp
|
||||||
|
if new_data_points > 0:
|
||||||
|
self._set_last_timestamp(data_source, last_timestamp)
|
||||||
|
self.logger.info(
|
||||||
|
'Got %d new entries from data source %s, last timestamp: %s',
|
||||||
|
new_data_points,
|
||||||
|
data_source,
|
||||||
|
datetime.fromtimestamp(last_timestamp).isoformat(),
|
||||||
)
|
)
|
||||||
values = []
|
|
||||||
|
|
||||||
for value in data_point.pop('value'):
|
def main(self):
|
||||||
if value.get('intVal') is not None:
|
while not self.should_stop():
|
||||||
value = value['intVal']
|
try:
|
||||||
elif value.get('fpVal') is not None:
|
for data_source in self.data_sources:
|
||||||
value = value['fpVal']
|
self._process_data_source(data_source)
|
||||||
elif value.get('stringVal') is not None:
|
except Exception as e:
|
||||||
value = value['stringVal']
|
self.logger.warning('Exception while processing Fit data')
|
||||||
elif value.get('mapVal'):
|
self.logger.exception(e)
|
||||||
value = {
|
finally:
|
||||||
v['key']: v['value'].get(
|
self.wait_stop(self.poll_interval)
|
||||||
'intVal',
|
|
||||||
v['value'].get('fpVal', v['value'].get('stringVal')),
|
|
||||||
)
|
|
||||||
for v in value['mapVal']
|
|
||||||
}
|
|
||||||
|
|
||||||
values.append(value)
|
|
||||||
|
|
||||||
data_point['values'] = values
|
|
||||||
data_points.append(data_point)
|
|
||||||
|
|
||||||
return data_points
|
|
||||||
|
|
||||||
|
|
||||||
# vim:sw=4:ts=4:et:
|
# vim:sw=4:ts=4:et:
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
manifest:
|
manifest:
|
||||||
events: {}
|
events:
|
||||||
|
- platypush.message.event.google.fit.GoogleFitEvent
|
||||||
install:
|
install:
|
||||||
apk:
|
apk:
|
||||||
- py3-google-api-python-client
|
- py3-google-api-python-client
|
||||||
|
|
|
@ -34,18 +34,39 @@ class GoogleMailPlugin(GooglePlugin):
|
||||||
|
|
||||||
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
|
||||||
|
|
||||||
5 Select "Desktop app", enter whichever name you like, and click "Create".
|
5. Select "Desktop app", enter whichever name you like, and click "Create".
|
||||||
|
|
||||||
6. Click on the "Download JSON" icon next to your newly created client ID.
|
6. Click on the "Download JSON" icon next to your newly created client ID.
|
||||||
|
Save the JSON file under
|
||||||
|
``<WORKDIR>/credentials/google/client_secret.json``.
|
||||||
|
|
||||||
7. Generate a credentials file for the required scope:
|
7. If you're running the service on a desktop environment, then you
|
||||||
|
can just start the application. A browser window will open and
|
||||||
|
you'll be asked to authorize the application - you may be prompted
|
||||||
|
with a warning because you are running a personal and potentially
|
||||||
|
unverified application. After authorizing the application, the
|
||||||
|
process will save the credentials under
|
||||||
|
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
|
||||||
|
with the plugin initialization.
|
||||||
|
|
||||||
.. code-block:: bash
|
8. If you're running the service on a headless environment, or you
|
||||||
|
prefer to manually generate the credentials file before copying to
|
||||||
|
another machine, you can run the following command:
|
||||||
|
|
||||||
mkdir -p <WORKDIR>/credentials/google
|
.. code-block:: bash
|
||||||
python -m platypush.plugins.google.credentials \
|
|
||||||
'gmail.modify' \
|
mkdir -p <WORKDIR>/credentials/google
|
||||||
<WORKDIR>/credentials/google/client_secret.json
|
python -m platypush.plugins.google.credentials \
|
||||||
|
'gmail.modify' \
|
||||||
|
[--noauth_local_webserver] \
|
||||||
|
<WORKDIR>/credentials/google/client_secret.json
|
||||||
|
|
||||||
|
When launched with ``--noauth_local_webserver``, the script will
|
||||||
|
start a local webserver and print a URL that should be opened in
|
||||||
|
your browser. After authorizing the application, you may be
|
||||||
|
prompted with a code that you should copy and paste back to the
|
||||||
|
script. Otherwise, if you're running the script on a desktop, a
|
||||||
|
browser window will be opened automatically.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue