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

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.8.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.8.tar.gz
Algorithm Hash digest
SHA256 e543042f44c443b9d2eae554cdf30f5484493de7ec15f154417af6b78df8befd
MD5 0aaf1c8cf0d56b434b05a21cec6c833e
BLAKE2b-256 1fcbf7afe083c6158a23757a888110a51f226d8aa17c9ba0ae7cec26ad9cd9cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 04676d6d1609aa239eda843d4f6eb6d617463bc23b835ad1c3d24f2eb8933f58
MD5 a379895f525f649774e43d0126bf57a7
BLAKE2b-256 cc7170e5a0cf495b7811092c7516ed6f77ed6138cd94c5c36a9eb1902fd23e99

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