Skip to main content

Python 3 API wrapper for Mastertherm API

Project description

MaseterTherm Connect Module

License Project Maintenance GitHub Activity

Main - workflow-main

Latest - GitHub Release workflow-latest

Stable - GitHub Release workflow-stable

About

This module provides the connection and conversion tools to the API for the Mastertherm Heatpump Products. The project was mainly built for a Plugin to Home Assistant.

There are two entry points for the Mastertherm Heat Pumps: - mastertherm.vip-it.cz - This is the server for pre 2022 heat pumps - mastertherm.online - This is the server for 2022 onward

NOTES: - materhterm.online is sensitive to too many requests, for this reason by default it defaults to updates every 10 minutes, the App updates every 2 minutes. To help the Info updates every 30 min and data can be set in the options. - if multiple requests are sent at the same time (i.e. from home assistant/ the app and web) some will be refused by the servers, its temporary. The updates have been built to report but ignore these.

Installation

Latest Release Version: python -m pip install masterthermconnect Specific Version or Pre-Release: python -m pip install masterthermconnect==1.1.0rc2

Usage

Command Line

This is used as a libary but it can also be run directly for debug purposes:

DO NOT RUN THIS TOO FREQUENTLY, the new API may lock you're IP out. The app and web app refresh every 30 seconds. I don't know how many times in succession would lock you out, probably frequent calls over a period of time such as an hour.

usage: masterthermconnect [-h] [--version] [--api-ver {v1,v2}] [--hide-sensitive] [--user USER] [--password PASSWORD] [--list-devices] [--list-device-data] [--list-device-reg]

Python Mastertherm Connect API Module, used for debug purposes.
options:
  -h, --help show this help message and exit
  --version display the Mastertherm Connect API version
  --api-ver {v1,v2} API Version to use: Default: v1 (pre 2022), v2 (post 2022)
  --hide-sensitive Hide the sensitive information, for debug information for sharing.
  --user USER login user for Mastertherm
  --password PASSWORD login password for Mastertherm
  --list-devices list the devices connected to the account
  --list-device-data list the data for each device connected to the account
  --list-device-reg LIST_DEVICE_REG list Registers e.g. A_330 or A_330,A_331 or 'all' for everything.
  ---pretty Pritify the Output in JSON Format.

API Version

TBC


Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

masterthermconnect-1.1.0rc9.tar.gz (18.3 kB view hashes)

Uploaded Source

Built Distribution

masterthermconnect-1.1.0rc9-py3-none-any.whl (18.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page