Skip to main content

Python library for accessing SensorLinx Device Data

Project description

pysensorlinx

pysensorlinx is a Python library for accessing Sensor Linx sensor data directly from their webservice. It supports logging into the service, retrieving sites list, and setting and getting device data used to control devices such as heat pumps, etc.

Features

  • Login to sensor linx account
  • retrieve the user profile
  • get the list of buildings
  • get the list of devices
  • get and set device parameters for a specific device

Install this repo

Clone the repository and install in editable mode:

git clone https://github.com/your_username/pysensorlinx.git
cd pysensorlinx

Create and activate a virtual environment

On Windows:

python -m venv .venv
.venv\Scripts\activate

On macOS/Linux:

python3 -m venv .venv
source .venv/bin/activate

Once the virtual environment is activated, install the package in editable mode:

pip install -e .

Install from pypi.org

pip install pysensorlinx

Usage

from pysensorlinx import Omnisense

async def main():
    sensorlinx = Sensorlinx()
    # Login with your credentials
    await sensorlinx.login("your_username", "your_password")
    

    
    # When done, close the session
    await sensorlinx.close()

import asyncio
asyncio.run(main())

Replace "your_username" and "your_password" with your actual Sensorlinx credentials. For more details, refer to the documentation or explore the source code.

Testing

Tests are written using pytest and pytest-asyncio. You can run tests as follows:

pip install -e .[tests]

pytest

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

pysensorlinx-0.1.3.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

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

pysensorlinx-0.1.3-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file pysensorlinx-0.1.3.tar.gz.

File metadata

  • Download URL: pysensorlinx-0.1.3.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pysensorlinx-0.1.3.tar.gz
Algorithm Hash digest
SHA256 555609261b7efa798c58e3bfaf078ec9b14dc8e142c851555dd73924494c6b2e
MD5 3915f89b7b8e3588f979bffaa4d94ef4
BLAKE2b-256 64baf2670598916c4e406e2a70389ec2d5554405ce2c2db54123b311fa528eeb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysensorlinx-0.1.3.tar.gz:

Publisher: publish_to_pypi.yml on sslivins/pysensorlinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pysensorlinx-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: pysensorlinx-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pysensorlinx-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7bb63877295c3e89ab6a8994b8beaf201bf88cad7c0a534aaf02b83fa528824b
MD5 d6fd53774ef3bf48568914284d13ee15
BLAKE2b-256 9251001587d150cdbd90741a48a01caa8f6102994bb92aa6e91896573972645c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysensorlinx-0.1.3-py3-none-any.whl:

Publisher: publish_to_pypi.yml on sslivins/pysensorlinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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