Skip to content

A Python Wrapper to communicate with a Meteobridge Weather Data Logger

License

Notifications You must be signed in to change notification settings

briis/pymeteobridge

Repository files navigation

Python Wrapper for Meteobridge Datalogger

Latest PyPI version Supported Python

This module communicates with a Meteobridge Datalogger using their Template Script.

The module is primarily written for the purpose of being used in Home Assistant for the Custom Integration called meteobridge but might be used for other purposes also.

Install

pymeteobridgedata is avaible on PyPi:

pip install pymeteobridgedata

Usage

This library is primarily designed to be used in an async context.

The main interface for the library is the pymeteobridgedata.MeteobridgeApiClient. This interface takes 6 options:

  • username: (required) The username to login to your Meteobridge device. Default this meteobridge.
  • password: (required) The password for your meteobridge device.
  • ip_address: (required) IP Address of the Meteobridge device.
  • units: (optional) Valid options here are metric or imperial. Metebridge devices always deliver data in metric units, so conversion will only take place if if metric is not selected. Default value is metric
  • extra_sensors: (optional) Number of extra sensors attached to the Meteobridge Logger (Default is 0, max is 7)
  • homeassistant: (optional) Valid options are True or False. If set to True, there will be some unit types that will not be converted, as Home Assistant will take care of that. Default value is True

Example Python script

import asyncio
import logging
import time

from pymeteobridgedata import MeteobridgeApiClient, Invalid, NotAuthorized, BadRequest
from pymeteobridgedata.data import DataLoggerDescription, ObservationDescription

_LOGGER = logging.getLogger(__name__)

async def main() -> None:
    logging.basicConfig(level=logging.DEBUG)
    start = time.time()

    meteobridge = MeteobridgeApiClient(USERNAME, PASSWORD, IP_ADDRESS, homeassistant=False, units="imperial", extra_sensors=0)
    try:
        await meteobridge.initialize()

    except Invalid as err:
        _LOGGER.debug(err)
    except NotAuthorized as err:
        _LOGGER.debug(err)
    except BadRequest as err:
        _LOGGER.debug(err)

    data: DataLoggerDescription = meteobridge.device_data
    if data is not None:
        for field in data.__dataclass_fields__:
            value = getattr(data, field)
            print(field,"-", value)

    data: ObservationDescription = await meteobridge.update_observations()
    if data is not None:
        for field in data.__dataclass_fields__:
            value = getattr(data, field)
            print(field,"-", value)


    end = time.time()

    await meteobridge.req.close()

    _LOGGER.info("Execution time: %s seconds", end - start)

asyncio.run(main())

About

A Python Wrapper to communicate with a Meteobridge Weather Data Logger

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages