Skip to main content

A simple client to the XML RPC API of Homegear.

Project description

A simple client for the API of Homegear.

Look at the documentation for detailed information.

Quickstart

Install gearthonic via pip:

pip install gearthonic

Initialise the client:

from gearthonic import GearClient
# You only have to provide the host and port of the Homegear server
gc = GearClient('192.168.1.100', 2001, secure=False, verify=False)

Use the predefined methods to make requests to the API:

gc.system.list_methods()
gc.device.get_value(1, 4, 'ACTUAL_TEMPERATURE')

Alternatively you can call any method directly via the client:

gc.getValue(1, 4, 'ACTUAL_TEMPERATURE')

The default communication protocol is XML-RPC. If you want to use another protocol like JSON-RPC or a MQTT broker, see the full documentation.

Documentation

The full documentation can be found at http://gearthonic.rtfd.org.

Changelog

0.2.0 (2016-08-08)

  • Introduced different communication protocols (XML RPC and JSON RPC)

0.1.2 (2016-07-13)

  • Fixed broken setup.py.

0.1.1 (2016-07-13)

  • Added documentation.

0.1.0 (2016-07-13)

  • Initial release to pypi.

Project details


Download files

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

Source Distribution

gearthonic-0.2.0.tar.gz (8.6 kB view hashes)

Uploaded Source

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