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.5.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.5-py3-none-any.whl (2.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 870351ea65c0f3cd269903cda736ad8b835c9f4680ce88f66de5fa4b188d2182
MD5 aedf7cbc4c25960288e9c4bbb8f6de14
BLAKE2b-256 9364d128110890425468a1d3bd2777ddf70d3005d247a2f98b414ca0b41bf8ca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 2.6 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 df77c251dd9eef051595bda4b495c39b2fea375f644795519b277a43675e3052
MD5 d360ad98721317d00e400be5bce538f1
BLAKE2b-256 533f03a958b9d860dc113b30df197c06cd59b21a91b91caa83949acd14c16e84

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