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

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.10.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for qwikswitch_api-0.0.10.tar.gz
Algorithm Hash digest
SHA256 73a552bb68f4c6ed7c0bf9f8ef2c6c69a090bf0a846ec0915e86f9afcb12ec0a
MD5 5db1d5a91bc3c15428ed4be6cb1b16eb
BLAKE2b-256 063146b4e9f4dded1be044f3f035e022c3812c18c4b6b65ecd3e8aaf8079673c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for qwikswitch_api-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 e8b9fd71e8a2552484a27c030e393389093197771afacf60dcdfc1e562e2bbfb
MD5 035523929a6c931526b148b986a3c6c8
BLAKE2b-256 5883095a6ecb1ab35f82d47740a02f8a8be3a7de6075b083cf5eebcc5ec0dc9a

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