Skip to main content

python API wrapper for foobot.io

Project description

http://foobot.io/ is awesome home air monitor solution, that helps you monitor and control your indoor air quality. Welltory integrated with foobot.io and we share our Python API wrapper with you.

Install

$ pip install foobot

Usage

from foobot.api import FoobotAPI

api = FoobotAPI(
    api_key=<YOUR_API_KEY>,
    access_token=<YOUR_ACCESS_TOKEN>,
    homehost=<YOUR_HOME_HOST>,
    username=<YOUR_USER_EMAIL,
    client_key=<YOUR_CLIENT_KEY>,
    client_secret=<YOUR_CLIENT_SECRET>,
)
devices = api.get_devices()
data_by_devices = api.get_last_day_data()

API reference

FoobotAPI

  • get_devices() return list of dict described devices connected to this accunt
  • get_last_day_data() return list of data from devices
    • raw (Default: False) - return data as a dict or as a FoobotDataItem instance
  • get_data() return list of data from devices
    • start (Default: 3600*24) - return data as a dict or as a FoobotDataItem instance
    • end (Default: “last”) - return data as a dict or as a FoobotDataItem instance
    • average_by (Default: 3600) - return data as a dict or as a FoobotDataItem instance

FoobotDataItem

  • timstamp - timestamp for measure
  • particulate_matter (ppm) - particulate matter
  • temp (C) - temperature
  • humidity (pc) - humidity
  • co2 (ppm) - CO2
  • voc (ppb) - volatile organic compounds
  • foobot_index - Internal index for Foobot

License

The MIT License (MIT)

Tests

$ python setup.py test

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
foobot-1.0.4-py2-none-any.whl (5.5 kB) Copy SHA256 hash SHA256 Wheel 2.7
foobot-1.0.4.tar.gz (5.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page