Skip to main content

A client for the HausMon monitoring service

Project description

A thin wrapper for the HausNet monitoring service, a.k.a HausMon, in Python. HausMon is a simple monitoring service for home automation networks, e.g. a home controlled by Home Assistant.

Installation

Install the package:

pip install hausmon_client

Configuration

First, create an account at HausNet|HausMon. Then, define a device to represent your home automation controller. Also, locate your authentication token from your account. You'll need the device name and the token to use the library.

Use

The library provides access to a device's heartbeat monitor. I.e. it enables your home control system to, at a fixed interval, let the monitor know it is still alive. The heartbeat monitor should not be called more often than every 15 minutes.

from hausmon_client.client import HausMonClient

API_URL = "[Hausmon API URL]"
API_TOKEN = "[token from HausMon user account]"
DEVICE_NAME = "[device name at HausMon]"

client = HausMonClient(API_URL, API_TOKEN)
heartbeat = self._client.get_heartbeat(DEVICE_NAME)
client.send_heartbeat(heartbeat['id'])

Project details


Download files

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

Files for hausmon-client, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size hausmon_client-0.0.4-py3-none-any.whl (5.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size hausmon_client-0.0.4.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page