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 = Qwikswitch('email', 'masterkey')
api_keys = api.generate_api_keys()
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.2.tar.gz (27.1 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.2-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.2.tar.gz
  • Upload date:
  • Size: 27.1 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.2.tar.gz
Algorithm Hash digest
SHA256 1984f24172dede7b58654beb8b0eda0c8b49baadd7180b075febb3d34689ab3b
MD5 66b3631635c22f25fe4ec2c1ed72e3fa
BLAKE2b-256 6dd73505640676870ae33b13f558665cfb4cc438ed9e23ad2ec83e43f0ceace1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 71c2ce6d040a77e499fb3eac2b9af4d59e7738ca5cfecf953604e6bea6631dd1
MD5 eb79e647d08ed381de472fe42ff92e85
BLAKE2b-256 1a6411934dbc5b42800ce841867b844431d354c0c5d4d6b2dba8a1e50eef0ca9

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