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

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 82c805242271bbdc7d5e0532b9795ca97c111ea08a8b1392076de6cd4d0dae20
MD5 49f5eb298c84651991176995b9fc5fca
BLAKE2b-256 99862de72f213d8e4b9dde6254eac265d5dde2fbc29f91a8a08c9c09fde7f3bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 10.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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f1025417f6ad5a03f4479807486b0e0e2435f75939a475a7638cd1186526b7bb
MD5 8ff515cc81f780745b6b6a3b10a7334b
BLAKE2b-256 ce9e46fd28a1357a1f22755bb358d14b1b81323ffc466dd11120112b8d01e22d

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