aioflo 0.1.4

A Python3, async-friendly library for Flo by Moen Smart Water Detectors

💧 aioflo: a Python3, asyncio-friendly library for Notion® Home Monitoring

aioflo is a Python 3, asyncio-friendly library for interacting with Flo by Moen Smart Water Detectors.

Python Versions

aioflo is currently supported on:

• Python 3.6
• Python 3.7
• Python 3.8

Installation

pip install aioflo

Usage

aioflo starts within an aiohttp ClientSession:

import asyncio

from aiohttp import ClientSession

from aioflo import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as websession:
        # YOUR CODE HERE


asyncio.get_event_loop().run_until_complete(main())

Create an API object, initialize it, then get to it:

import asyncio

from aiohttp import ClientSession

from aioflo import async_get_api


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as websession:
        api = await async_get_api(session, "<EMAIL>", "<PASSWORD>")

        # Get user account information:
        user_info = await api.user.get_info()
        a_location_id = user_info["locations"][0]["id"]

        # Get location (i.e., device) information:
        location_info = await api.location.get_info(a_location_id)

        # Get consumption info between a start and end datetime:
        consumption_info = await api.water.get_consumption_info(
            a_location_id,
            datetime(2020, 1, 16, 0, 0),
            datetime(2020, 1, 16, 23, 59, 59, 999000),
        )

        # Get various other metrics related to water usage:
        metrics = await api.water.get_metrics(
            "<DEVICE_MAC_ADDRESS>",
            datetime(2020, 1, 16, 0, 0),
            datetime(2020, 1, 16, 23, 59, 59, 999000),
        )

        # Set the device in "Away" mode:
        await set_mode_away(a_location_id)

        # Set the device in "Home" mode:
        await set_mode_home(a_location_id)

        # Set the device in "Sleep" mode for 120 minutes, then return to "Away" mode:
        await set_mode_sleep(a_location_id, 120, "away")

asyncio.get_event_loop().run_until_complete(main())

See the module docstrings throughout the library for full info on all parameters, return types, etc.

Contributing

1. Check for open features/bugs or initiate a discussion on one.
2. Fork the repository.
3. Install the dev environment: make init.
4. Enter the virtual environment: source .venv/bin/activate
5. Code your new feature or bug fix.
6. Write a test that covers your new functionality.
7. Run tests and ensure 100% code coverage: make coverage
8. Add yourself to AUTHORS.md.
9. Submit a pull request!