Skip to main content

A Python wrapper around the QwikSwitch API

Project description

qwikswitch-api

A Python wrapper for the Qwikswitch API, used for remotely controlling Qwikswitch devices using the Wifi Bridge.

An alternative (local) way of controlling Qwikswitch devices is with a USB Modem. If this is the device that you have, see the pyqwikswitch library instead.

Usage

The following operations are implemented:

  • Keys - Generate API Keys (generate_api_keys)
  • Keys - Delete API Keys (delete_api_keys)
  • Control - Control a device (control_device)
  • State - Get all device status (get_all_device_status)

Device history is not implemented in this library yet as I don't have access to these devices.

If you have access to devices that record history, please open an issue detailing sample responses from get_all_device_status and the history calls.

Installation

pip install qwikswitch-api

Sample code

Sample usage to control a device:

from qwikswitch.qsapi import QSApi

api = QSApi()
api_keys = api.generate_api_keys('email', 'masterkey')
api.control_device(api_keys, '@123450', 100)

To list all current device statuses:

devices = api.get_all_device_status(api_keys)

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

qwikswitch_api-0.0.3.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

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

qwikswitch_api-0.0.3-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file qwikswitch_api-0.0.3.tar.gz.

File metadata

  • Download URL: qwikswitch_api-0.0.3.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.0

File hashes

Hashes for qwikswitch_api-0.0.3.tar.gz
Algorithm Hash digest
SHA256 b6a8011b9ce405e0d48684b1f776f9b5840d79e9b9ee8419005d3a616ee54aa1
MD5 8fa678d7348c43c763f7ed03ce24a3a9
BLAKE2b-256 38976cdaab9d55afe9841fe7dc01343855cd65cd9f6c073b25c9f66eced6e58a

See more details on using hashes here.

File details

Details for the file qwikswitch_api-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: qwikswitch_api-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.0

File hashes

Hashes for qwikswitch_api-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 406b1c30f6013253b16a695109bf3d14bb92d839c85379bd2b4c79f6205a1c58
MD5 92b7a19d1e3d49657b0b0ac2f4177843
BLAKE2b-256 158db19ecb8767677e85e84619643ab73699b76fa13773b3a103de6543570796

See more details on using hashes here.

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