Skip to main content

A basic package for simplifying interactions with the Vegetronix VegeHub

Project description

Vegetronix VegeHub

This package is intended to simplify interactions with the Vegetronix VegeHub. It allows remote setup of the API key and target server address, as well as simplifying retrieval of information about the Hub, including its MAC address.

This package was written for use with the VegeHub integration for Home Assistant, but may be used in other projects as well.

Development on this library was done using Python Poetry for dependency management and building/publishing. Find more info about how to use it here.

Development

Running Unit Tests

The library includes comprehensive unit tests that use mocked HTTP responses:

poetry run pytest

Running Integration Tests

Integration tests are available to test the library against real VegeHub devices on your local network. These tests:

  • Automatically discover VegeHub devices using mDNS
  • Allow you to select which device to test
  • Optionally test actuator functionality (with safety warnings)
  • Cover all major library features

To run integration tests:

  1. Install the optional test dependency:

    poetry install  # zeroconf is included in dev dependencies
    
  2. Ensure your VegeHub device is powered on and connected to the same network

  3. Run the integration test script:

    poetry run python integration_test.py
    
  4. Or use the VS Code task: Terminal > Run Task > Run Integration Tests

The integration tests will:

  • Scan for VegeHub devices on your network
  • Let you choose which device to test
  • Ask if you want to test actuator control (optional)
  • Run comprehensive tests covering all library functionality
  • Provide a detailed report of test results

Note: Integration tests are separate from unit tests and require physical hardware. They are designed to be run manually when you have access to a VegeHub device.

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

vegehub-0.1.26.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vegehub-0.1.26-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file vegehub-0.1.26.tar.gz.

File metadata

  • Download URL: vegehub-0.1.26.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.3 Linux/6.8.0-85-generic

File hashes

Hashes for vegehub-0.1.26.tar.gz
Algorithm Hash digest
SHA256 0499680f751554b90d9edb40fbdd37123251ddbedfa8efeba683a56e55f658db
MD5 d4a09ab8a083293845dbae5a873eef16
BLAKE2b-256 d09aa70c56bbbd4b880a78ba677b1014422f0aad3f7398032e425bf2dda9de8c

See more details on using hashes here.

File details

Details for the file vegehub-0.1.26-py3-none-any.whl.

File metadata

  • Download URL: vegehub-0.1.26-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.3 Linux/6.8.0-85-generic

File hashes

Hashes for vegehub-0.1.26-py3-none-any.whl
Algorithm Hash digest
SHA256 463bfa46eb92ac6e913372777a56110803d6330323813a0b7673527ffc05b04f
MD5 1dbb47ab4f140212ec619dc861c23b8a
BLAKE2b-256 b3f8afc4bc46522f283cc29582cbf56e5754359b3fee1d1493c29a7ba4684676

See more details on using hashes here.

Supported by

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