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)

The following devices are supported:

  • RELAY QS-D-S5 - Dimmer
  • RELAY QS-R-S5 - Relay
  • RELAY QS-R-S30 - Relay

If you have a different device than these ones, please open an issue with the device model name and type of device.

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.client import QSClient

client = QSClient('email', 'masterkey')
client.control_device('@123450', 100)

To list all current device statuses:

devices = client.get_all_device_status()

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.11.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for qwikswitch_api-0.0.11.tar.gz
Algorithm Hash digest
SHA256 af8916fee6550fd93144560df52feff4ab1cba24a5852e331976fa8cfcb08751
MD5 212b96112776fbbe8dd50804fa9ecc1a
BLAKE2b-256 be767f4b461e8078b700bc0962a2b6d004a9a8d37f5d78c2e10d92c79e6a9182

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for qwikswitch_api-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 0699062570321ea88d764ba8625f4f95f12b98bea16626233997b91f24410706
MD5 7687826f517f7693feb0b1a02be6b98f
BLAKE2b-256 5844a84264776198ee35204a843fee750f94eef0875cc29941f971bf19d00446

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