aioambient 1.2.4

A clean, async-friendly library for the Ambient Weather API

🌤 aioambient: An async library for Ambient Weather Personal Weather Stations

aioambient is a Python3, asyncio-driven library that interfaces with both the REST and Websocket APIs provided by Ambient Weather.

Installation

pip install aioambient

Python Versions

aioambient is currently supported on:

• Python 3.7
• Python 3.8
• Python 3.9

API and Application Keys

Utilizing aioambient requires both an Application Key and an API Key from Ambient Weather. You can generate both from the Profile page in your Ambient Weather Dashboard.

Usage

Creating a Client

An aioambient client starts with an aiohttp ClientSession:

import asyncio

from aiohttp import ClientSession

from aioambient import Client


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


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

Create a client, initialize it, then get to it:

import asyncio
from datetime import date

from aiohttp import ClientSession

from aioambient import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as session:
        client = Client("<YOUR API KEY>", "<YOUR APPLICATION KEY>", session)

        # Get all devices in an account:
        await client.api.get_devices()

        # Get all stored readings from a device:
        await client.api.get_device_details("<DEVICE MAC ADDRESS>")

        # Get all stored readings from a device (starting at a date):
        await client.api.get_device_details(
            "<DEVICE MAC ADDRESS>", end_date=date(2019, 1, 16)
        )


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

REST API

import asyncio
from datetime import date

from aiohttp import ClientSession

from aioambient import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    client = Client("<YOUR API KEY>", "<YOUR APPLICATION KEY>")

    # Get all devices in an account:
    await client.api.get_devices()

    # Get all stored readings from a device:
    await client.api.get_device_details("<DEVICE MAC ADDRESS>")

    # Get all stored readings from a device (starting at a datetime):
    await client.api.get_device_details(
        "<DEVICE MAC ADDRESS>", end_date=date(2019, 1, 16)
    )


asyncio.run(main())

By default, the library creates a new connection to Ambient Weather with each coroutine. If you are calling a large number of coroutines (or merely want to squeeze out every second of runtime savings possible), an aiohttp ClientSession can be used for connection pooling:

import asyncio
from datetime import date

from aiohttp import ClientSession

from aioambient import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as session:
        client = Client("<YOUR API KEY>", "<YOUR APPLICATION KEY>", session=session)

        # Get all devices in an account:
        await client.api.get_devices()

        # Get all stored readings from a device:
        await client.api.get_device_details("<DEVICE MAC ADDRESS>")

        # Get all stored readings from a device (starting at a datetime):
        await client.api.get_device_details(
            "<DEVICE MAC ADDRESS>", end_date=date(2019, 1, 16)
        )


asyncio.run(main())

Please be aware of Ambient Weather's rate limiting policies.

Websocket API

import asyncio

from aiohttp import ClientSession

from aioambient import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as session:
        client = Client("<YOUR API KEY>", "<YOUR APPLICATION KEY>", session)

        # Define a method that should be fired when the websocket client
        # connects:
        def connect_method():
            """Print a simple "hello" message."""
            print("Client has connected to the websocket")

        client.websocket.on_connect(connect_method)

        # Alternatively, define a coroutine handler:
        async def connect_coroutine():
            """Waits for 3 seconds, then print a simple "hello" message."""
            await asyncio.sleep(3)
            print("Client has connected to the websocket")

        client.websocket.async_on_connect(connect_coroutine)

        # Define a method that should be run upon subscribing to the Ambient
        # Weather cloud:
        def subscribed_method(data):
            """Print the data received upon subscribing."""
            print(f"Subscription data received: {data}")

        client.websocket.on_subscribed(subscribed_method)

        # Alternatively, define a coroutine handler:
        async def subscribed_coroutine(data):
            """Waits for 3 seconds, then print the incoming data."""
            await asyncio.sleep(3)
            print(f"Subscription data received: {data}")

        client.websocket.async_on_subscribed(subscribed_coroutine)

        # Define a method that should be run upon receiving data:
        def data_method(data):
            """Print the data received."""
            print(f"Data received: {data}")

        client.websocket.on_data(data_method)

        # Alternatively, define a coroutine handler:
        async def data_coroutine(data):
            """Wait for 3 seconds, then print the data received."""
            await asyncio.sleep(3)
            print(f"Data received: {data}")

        client.websocket.async_on_data(data_coroutine)

        # Define a method that should be run when the websocket client
        # disconnects:
        def disconnect_method(data):
            """Print a simple "goodbye" message."""
            print("Client has disconnected from the websocket")

        client.websocket.on_disconnect(disconnect_method)

        # Alternatively, define a coroutine handler:
        async def disconnect_coroutine(data):
            """Wait for 3 seconds, then print a simple "goodbye" message."""
            await asyncio.sleep(3)
            print("Client has disconnected from the websocket")

        client.websocket.async_on_disconnect(disconnect_coroutine)

        # Connect to the websocket:
        await client.websocket.connect()

        # At any point, disconnect from the websocket:
        await client.websocket.disconnect()


asyncio.run(main())

Contributing

1. Check for open features/bugs or initiate a discussion on one.
2. Fork the repository.
3. (optional, but highly recommended) Create a virtual environment: python3 -m venv .venv
4. (optional, but highly recommended) Enter the virtual environment: source ./venv/bin/activate
5. Install the dev environment: script/setup
6. Code your new feature or bug fix.
7. Write tests that cover your new functionality.
8. Run tests and ensure 100% code coverage: script/test
9. Update README.md with any new documentation.
10. Add yourself to AUTHORS.md.
11. Submit a pull request!