Python module for interacting with the Cambium Networks cnHeat API
Project description
cnheat
Python module for interacting with the Cambium Networks cnHeat API — manage sites, radios, antennas, predictions, users, and subscriptions programmatically.
This library provides a simple and powerful Python interface to the Cambium cnHeat API, enabling you to automate RF planning, data management, and network operations with minimal effort.
🚀 Features
- 🔐 Authenticate using client ID and secret
- 🏗 Create, list, rename, and delete sites
- 📡 Add and configure radios using antenna templates
- 📊 Generate and manage heatmap predictions
- 👥 Add or remove users with permission control
- 📦 Manage subscriptions and renewal status
- 📁 Convert API responses to lists or dictionaries
- ✅ Includes helper methods for working with
site_id,antenna_id, andradio_idcleanly
📦 Installation
Install from PyPI:
pip install cnheat
🔧 Basic Usage
from cnheat import cnHeat
cn = cnHeat(client_id="your_id", client_secret="your_secret")
sites = cn.get_sites()
print(sites)
📊 Example: Create a Radio
site_id = cn.get_sites()[0]['id']
antenna_id = cn.get_antennas(3.6)[0]['id']
cn.create_radio(site_id, 3.6, antenna_id, azimuth=90)
📊 Example: Create a Prediction
radios = cn.get_site_radios(site_id)
radio_ids = [r['id'] for r in radios]
cn.create_prediction("Coverage Map", radio_ids)
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cnheat-0.1.10.tar.gz.
File metadata
- Download URL: cnheat-0.1.10.tar.gz
- Upload date:
- Size: 7.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1510d0f5f2a5cc457767100f17b187f4fb34e80ecbabdb52196934b1eed63e1b
|
|
| MD5 |
b0d8bae16ab3b03257efdc9cec412f6a
|
|
| BLAKE2b-256 |
513dbef873014b7e724b54721f20637700d4a67ace5c29709f845ac783a0f805
|
Provenance
The following attestation bundles were made for cnheat-0.1.10.tar.gz:
Publisher:
cnHeat-publish.yml on JckHamm3r/cnHeat
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cnheat-0.1.10.tar.gz -
Subject digest:
1510d0f5f2a5cc457767100f17b187f4fb34e80ecbabdb52196934b1eed63e1b - Sigstore transparency entry: 210522834
- Sigstore integration time:
-
Permalink:
JckHamm3r/cnHeat@f7f16d7f40117f25d28a0e5b6e4dd6d9cc6465bf -
Branch / Tag:
refs/tags/v0.1.10 - Owner: https://github.com/JckHamm3r
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cnHeat-publish.yml@f7f16d7f40117f25d28a0e5b6e4dd6d9cc6465bf -
Trigger Event:
release
-
Statement type:
File details
Details for the file cnheat-0.1.10-py3-none-any.whl.
File metadata
- Download URL: cnheat-0.1.10-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6e8c0e400076a93bd35cba2d68b07e5edd56e2381e6af56eab9cfcda21baa6e6
|
|
| MD5 |
0ce3324eb88d59c0d1f0cab443f77bf6
|
|
| BLAKE2b-256 |
69ce4617367a1dc49ca98961482bb910cd96f702669f6f7b2e846567c33ea0b6
|
Provenance
The following attestation bundles were made for cnheat-0.1.10-py3-none-any.whl:
Publisher:
cnHeat-publish.yml on JckHamm3r/cnHeat
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cnheat-0.1.10-py3-none-any.whl -
Subject digest:
6e8c0e400076a93bd35cba2d68b07e5edd56e2381e6af56eab9cfcda21baa6e6 - Sigstore transparency entry: 210522838
- Sigstore integration time:
-
Permalink:
JckHamm3r/cnHeat@f7f16d7f40117f25d28a0e5b6e4dd6d9cc6465bf -
Branch / Tag:
refs/tags/v0.1.10 - Owner: https://github.com/JckHamm3r
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cnHeat-publish.yml@f7f16d7f40117f25d28a0e5b6e4dd6d9cc6465bf -
Trigger Event:
release
-
Statement type: