Skip to main content

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, and radio_id cleanly

📦 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

cnheat-0.1.5.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

cnheat-0.1.5-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file cnheat-0.1.5.tar.gz.

File metadata

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

File hashes

Hashes for cnheat-0.1.5.tar.gz
Algorithm Hash digest
SHA256 30a399f97ffebf50cbe1b6c60c9118e30397db1cbf878b8d3623574f73847a30
MD5 0f3d9a4ffe9ae61d3f6e3235318f362e
BLAKE2b-256 a454a9880f42116c07bce1d06ccead551be0900953990a38a12bbd30c9ce0400

See more details on using hashes here.

Provenance

The following attestation bundles were made for cnheat-0.1.5.tar.gz:

Publisher: cnHeat-publish.yml on JckHamm3r/cnHeat

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

File details

Details for the file cnheat-0.1.5-py3-none-any.whl.

File metadata

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

File hashes

Hashes for cnheat-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8ba3ef989c368fc32a9e0fb4f6440792ed57be72e92dd2da0648780698b96f1c
MD5 e1a6edc47fe13fb383e116de19d9a141
BLAKE2b-256 8e1c5eda1c4323e32c161500d0130b0c4ab8b45c8fed9d65836a8a4767788d7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for cnheat-0.1.5-py3-none-any.whl:

Publisher: cnHeat-publish.yml on JckHamm3r/cnHeat

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