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.

Source Distribution

pyloxone_api-0.2.4.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

pyloxone_api-0.2.4-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file pyloxone_api-0.2.4.tar.gz.

File metadata

  • Download URL: pyloxone_api-0.2.4.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.7 Linux/5.10.79-1-MANJARO

File hashes

Hashes for pyloxone_api-0.2.4.tar.gz
Algorithm Hash digest
SHA256 ef0fccd696a4e781e60295f9801314499dc20f8a889638c73dc27a260ee8c084
MD5 047f7f5f0938efb5617f9047cc82274a
BLAKE2b-256 edccc2de72946e850f27b2c134af635c1920c934829be7e96b8976050337a9f5

See more details on using hashes here.

File details

Details for the file pyloxone_api-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: pyloxone_api-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.7 Linux/5.10.79-1-MANJARO

File hashes

Hashes for pyloxone_api-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 59cadbaf927205c41caba9e47123ce309dddc12681cc09a192b29c89a41ab99c
MD5 3bd46417af0c261ce92e05bbf1dbfcac
BLAKE2b-256 9ef1f8ec2aabba7a70dd938462ed483ea72702e07ca27e6250f27134453c4411

See more details on using hashes here.

Supported by

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