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

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 a5c2191b2e16ff84da6da465bdc4cf9d7e47c278fb6b12a83f372c61c8341bb7
MD5 54a345f7502d4c968d1435f5aede583d
BLAKE2b-256 09b7252346bc472a8d99a24f22d0aacb446af17702be2fe08400482c558a5b54

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 10.4 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3f9fa90300f3d6e676221df75daabac502f94f48eaf7ebd1f109588ed6ab9184
MD5 d1aa24368bbec115d0203850e478fcc0
BLAKE2b-256 f549c52cee6e8421451297d98fdd49e187f279e0e5c6422d10ac6e9de7fb84db

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