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.1.tar.gz (16.7 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.1-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pysensorlinx-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8e580b442dfd59d4f78332386ea513fbf0753eb815c0d8f90be8306596b17f73
MD5 65d72f53f89081f82080fca860e8bb2d
BLAKE2b-256 4113d7dc53ad8ea13b333ca0f930f87ccdcc73049be6c4b8ee0fcf86ddb98e23

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysensorlinx-0.1.1.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.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pysensorlinx-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4def387c2acc03705c2f7dacaab60242226f57cc016c3a255bbb50a4ab305f2d
MD5 13682c4cf68eb43ae05cec824662e60e
BLAKE2b-256 c089e0be8e8da6f3dc24c1ac11159d7e6027c11637928fcc7b2c1e07482483ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysensorlinx-0.1.1-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