Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
reefab committed Feb 9, 2018
1 parent e6555fa commit 3b38fdc
Show file tree
Hide file tree
Showing 6 changed files with 324 additions and 15 deletions.
26 changes: 12 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
foobot_async
============
Foobot async API Client
=======================

.. image:: https://img.shields.io/pypi/v/foobot_async.svg
:target: https://pypi.python.org/pypi/foobot_async
Expand All @@ -12,24 +12,22 @@ foobot_async
.. image:: https://coveralls.io/repos/github/reefab/foobot_async/badge.svg?branch=master
:target: https://coveralls.io/github/reefab/foobot_async?branch=master

API Client for Foobot Air Quality Monitoring devices
API Client for `Foobot <https://foobot.io>`_ Air Quality Monitoring devices.

.. image:: docs/foobot.jpg

Uses `aiohttp <https://aiohttp.readthedocs.io/en/stable/>`_.


Usage
-----

Installation
------------
Once you have your device setup and working, you'll need to get an API key.

Requirements
^^^^^^^^^^^^
You can register for one at their `developers site <https://api.foobot.io/apidoc/index.html>`_.

Compatibility
-------------

Licence
-------

Authors
-------

`foobot_async` was written by `Fabien Piuzzi <fabien@reefab.net>`_.
* Python 3.5
* Python 3.6
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = FoobotAPIClient
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
171 changes: 171 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Foobot API Client documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 9 12:04:32 2018.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../'))


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
# 'sphinx.ext.viewcode'
'sphinx.ext.coverage',]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'Foobot API Client'
copyright = '2018, Fabien Piuzzi'
author = 'Fabien Piuzzi'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
]
}


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'FoobotAPIClientdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'FoobotAPIClient.tex', 'Foobot API Client Documentation',
'Fabien Piuzzi', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'foobotapiclient', 'Foobot API Client Documentation',
[author], 1)
]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'FoobotAPIClient', 'Foobot API Client Documentation',
author, 'FoobotAPIClient', 'One line description of project.',
'Miscellaneous'),
]



Binary file added docs/foobot.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. Foobot API Client documentation master file, created by
sphinx-quickstart on Fri Feb 9 12:04:32 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. include:: ../README.rst

Foobot API Client documentation
===============================

.. toctree::
:maxdepth: 2
:caption: Contents:

.. automodule:: foobot_async

.. autoclass:: FoobotClient
:members:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
96 changes: 95 additions & 1 deletion foobot_async/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,25 @@
from math import trunc

class FoobotClient(object):
"""Foobot API client"""
"""
Foobot API client
:param token: API secret key used for authentication, see main doc on how
to obtain one
:type token: str
:param username: Your username for your Foobot account
:type username: str
:param session: aiohttp session to use or None
:type session: object or None
:param timeout: seconds to wait for before triggering a timeout
:type timeout: integer
"""

def __init__(self, token, username, session=None,
timeout=aiohttp.client.DEFAULT_TIMEOUT):
"""
Creates a new :class:`FoobotClient` instance.
"""
self._headers = {'X-API-KEY-TOKEN': token,
'content-type': 'application/json'}
self._username = username
Expand All @@ -25,24 +40,103 @@ def __init__(self, token, username, session=None,

@asyncio.coroutine
def get_devices(self):
"""
Get a list of devices associated with that account.
:returns: list of devices
:raises: FoobotClientError, AuthFailure, BadFormat, ForbiddenAccess,
TooManyRequests, InternalError
.. note::
each device returned will be a dictionary with the following data:
* uuid: id of the device, used for querying data from them. Not actually a UUID.
* userId: id of the user
* mac: MAC of the device, non colon seperated (eg: "013843C3C20A")
* name: Name of the device as configured in the app
"""
return (yield from self._get(DEVICE_URL.format(username= self._username)))

@asyncio.coroutine
def get_last_data(self, uuid, period=0, average_by=0):
"""
Get the data from one device for period till now.
:param uuid: Id of the device
:type uuid: str
:param period: Number of seconds between start time of search and now
:type period: integer
:param average_by: amount of seconds to average data over.
0 or 300 for no average. Use 3600 (average hourly) or a multiple for
long range requests (e.g. more than 1 day)
:type average_by: integer
:returns: list of datapoints
:raises: FoobotClientError, AuthFailure, BadFormat, ForbiddenAccess,
TooManyRequests, InternalError
.. note::
Use period = 0 and averageBy = 0 to get the very last data point.
If you only need one average for a period, the average_by needs to
be bigger than the period (eg, for a 10 minutes average: period = 600,
average_by = 601)
.. seealso:: :func:`parse_data` for return data syntax
"""
return self.parse_data((yield from self._get(
LAST_DATA_URL.format(uuid= uuid,
period= trunc(period),
average_by= trunc(average_by)))))

@asyncio.coroutine
def get_historical_data(self, uuid, start, end, average_by=0):
"""
Get the data from one device for a specified time range.
.. note::
Can fetch a maximum of 42 days of data.
To speed up query processing, you can use a combination of average factor
multiple of 1H in seconds (e.g. 3600), and o'clock start and end times
:param uuid: Id of the device
:type uuid: str
:param start: start of the range
:type start: datetime
:param end: end of the range
:type end: datetime
:param average_by: amount of seconds to average data over.
0 or 300 for no average. Use 3600 (average hourly) or a multiple for
long range requests (e.g. more than 1 day)
:type average_by: integer
:returns: list of datapoints
:raises: FoobotClientError, AuthFailure, BadFormat, ForbiddenAccess,
TooManyRequests, InternalError
.. seealso:: :func:`parse_data` for return data syntax
"""
return self.parse_data((yield from self._get(
HISTORICAL_DATA_URL.format(uuid= uuid,
start = trunc(start.replace(tzinfo=timezone.utc).timestamp()),
end = trunc(end.replace(tzinfo=timezone.utc).timestamp()),
average_by= trunc(average_by)))))

def parse_data(self, response):
"""
Convert the weird list format used for datapoints to a more usable
dictionnary one
:param response: dictionnary from API json response
:type response: dict
:returns: list of datapoints
.. note::
Datapoint content:
* time: UTC timestamp, unit: seconds
* pm: Particulate Matter, unit: ugm3
* tmp: temperature, unit: C
* hum: humidity, unit: %
* co2: Carbon Dioxide, unit: ppm
* voc: Volatile Organic Compounds, unit: ppb
* allpollu: `foobot index <https://help.foobot.io/hc/en-us/articles/204814371-What-does-central-number-mean->`_, unit: %
"""
parsed = []
items = response['sensors']
for datapoint in response['datapoints']:
Expand Down

0 comments on commit 3b38fdc

Please sign in to comment.