Skip to main content

A package for interacting at a low(ish) level with a Loxone miniserver via the Loxone websocket API

Project description

Pyloxone-api

A Python API for communicating with a Loxone miniserver.    

PyPI - Python Version PyPI - License PyPI      

Development

We use Poetry for package and environment management, Black and isort for code formatting, and Pytest for testing.

  • Install Poetry

  • Clone the project from Github, and use Poetry to install a virtual environment and all dependencies:

    > git clone https://github.com/jodehli/pyloxone-api
    > cd pyloxone-api
    > poetry install
    
  • Activate the virtual environment and create a shell:

    > poetry shell
    
  • To test, make sure the virtual environment is activiated, and run pytest:

    > pytest
    
  • There are some tests which require a live miniserver on the network. They are slower, and are not run by default. Be careful with these tests—they might make your miniserver behave oddly. To run them, you must specify appropriate credentials, eg:

    > pytest --host=192.168.1.100 --port=80  --username=admin --password=admin
    

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 pyloxone-api, version 0.2.4
Filename, size File type Python version Upload date Hashes
Filename, size pyloxone_api-0.2.4-py3-none-any.whl (21.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyloxone_api-0.2.4.tar.gz (19.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page