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.4.tar.gz (6.3 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.4-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cnheat-0.1.4.tar.gz
  • Upload date:
  • Size: 6.3 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.4.tar.gz
Algorithm Hash digest
SHA256 d12a977d9423c6d3ad885b70997b48432071ed7949b0227be32c2fa4195d55b9
MD5 e6bfbcafa2d1c6f70700637d11ccc23e
BLAKE2b-256 88e54dda3489f36a9272f166f23b86ef35b1667da8a57d38fb39c61a288da165

See more details on using hashes here.

Provenance

The following attestation bundles were made for cnheat-0.1.4.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.4-py3-none-any.whl.

File metadata

  • Download URL: cnheat-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 5.6 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ab7026d4e82345cf5ebcc8efc5060e78227b78663c752b584caf09894aa9232b
MD5 6d5d0d7440bd76537b53380fc6975652
BLAKE2b-256 d16ddecaf69b8caaed3004205e4ee53d221e141b8b399a9bfcb740bf91e4a009

See more details on using hashes here.

Provenance

The following attestation bundles were made for cnheat-0.1.4-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