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

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.7.tar.gz
  • Upload date:
  • Size: 27.7 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.7.tar.gz
Algorithm Hash digest
SHA256 2ac830395ec9273b92603202fe0b631327b275841ea3b2e467b5592f4b2d107d
MD5 d702bd2e5113cf6917869619730e8dc4
BLAKE2b-256 73e7a8de9ce8dd5646ece4f253fc0b988322c4a4d1df56045c8c765d12cab650

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 10.8 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d979591e6a0ef50ba95b1a6b7e1d288c1bbedd9a186d0221498d806309f92e2b
MD5 464a17c11a7b55f93edbeae327e5085b
BLAKE2b-256 4956f23c8bdb57627f6b2552894e9326010df0331d105c86f5a3e7ab8cb743e7

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