kingspan-connect-sensor
API to get oil tank from Kingspan SENSiT sensors.
To make use of the API, you will need the credentials you used to register with the App. You do not need other details such as the tank ID as these are already associated with your account. The new KNECT Pro service is supported only from version 4.0.
Installation
python3 -m pip kingspan-connect-sensor
Usage
Reading documents:
from connectsensor import SensorClient
client = SensorClient()
client.login("test@example.com", "s3cret")
tanks = client.tanks
tank_level = tanks[0].level
The tanks method returns a Tanks object which can be queried for the status of the specific tank.
Async Usage
async with AsyncSensorClient() as client:
await client.login("test@example.com", "s3cret")
tanks = await client.tanks
tank_level = await tanks[0].level
tank_capacity = await tanks[0].capacity
tank_percent = 100 * (tank_level / tank_percent)
print(f"Tank is {tank_percent:.1f}% full")
Tanks object
As of version 3.0, history no longer returns a Pandas dataframe to simplify package dependencies. Instead, an list of dicts is returned, where each list element is a sample from the web API, sorted by logging time. There should be one record per day. Each dict has the following keys:
reading_date: a datetime object indicating the time a measurement was madelevel_percent: integer percentage fulllevel_litres: number of lites in the tank
You can construct a Pandas dataframe simply using:
tanks = await client.tanks
history = await tanks[0].history()
df = pd.DataFrame(history)
The history method takes optional parameters start_date and end_date which are datetime.datetime objects specifying the range of dates to query from the API.
Supported APIs
The package supports both the new JSON API used by the KNECT Pro app introduced in February 2026, and the legacy SOAP API. You can select the appropriate API using the api_version parameter passed to the SensorClient and AsyncSensorClient constructors. Valid version options are APIVersion.CONNECT_V1 and APIVersion.KNECT_V1.
NOTE: as of March 2026, the APIVersion.KNECT_V1 API uses HTTP without any password encryption as the TLS endpoint is unavailable.
Scripts
As of version 4.0, the notifier and export script have been removed as integrations like Home Assistant provide much better functionality. Reporting on the current status of the tank can still be performed kingspan-status:
% kingspan-status --username=test@example.com --password=s3cret
Home Tank:
Capacity = 2000
Serial Number = 20001999
Model = Unknown
Level = 90% (1148 litres)
Last Read = 2021-10-09 00:42:47.947000
History:
Reading date %Full Litres
30-Jan-2021 00:29 94 1224
31-Jan-2021 00:59 80 1040
01-Feb-2021 00:29 78 1008
02-Feb-2021 00:59 76 986
1 maintainer
Metadata
1 maintainer
Release files for kingspan-connect-sensor 4.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| kingspan_connect_sensor-4.3.0.tar.gz | 16.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kingspan_connect_sensor-4.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.2 kB
Release files / kingspan_connect_sensor-4.3.0.tar.gz
| Download URL | kingspan_connect_sensor-4.3.0.tar.gz |
|---|---|
| Size | 16.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
567a5d90376ef6482de25c8846cdda855d13058c1586b091b6ee4ee09b819fc1
|
|
BLAKE2b-256 checksum How to use checksums |
f2245b3563a5e979863f99046c7ca8efdad58f79dd1b12d46eebeb14aa1b8660
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / kingspan_connect_sensor-4.3.0-py3-none-any.whl
| Download URL | kingspan_connect_sensor-4.3.0-py3-none-any.whl |
|---|---|
| Size | 13.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
941fb963d5890edeb4ffc91ddec08cd7184cc4f43134390095468ba26f6c5f4c
|
|
BLAKE2b-256 checksum How to use checksums |
128c9ff1b834b1a3c33ab8bf7fcf8c606ce0970f815ae5336b307103378a11b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for kingspan-connect-sensor 4.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
