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

Uploaded Python 3

File details

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

File metadata

  • Download URL: qwikswitch_api-0.0.12.tar.gz
  • Upload date:
  • Size: 61.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for qwikswitch_api-0.0.12.tar.gz
Algorithm Hash digest
SHA256 d5492e4c4ec1aa8ad97f5a8ccf358a23f4bae48e4689ee53722c8c2b253c5d07
MD5 ac8d90b572d47ada412e496a6994b8e9
BLAKE2b-256 95dd05d27179157346c5cefea89de355517b39d2aaff238dd3a6d74c4989f572

See more details on using hashes here.

Provenance

The following attestation bundles were made for qwikswitch_api-0.0.12.tar.gz:

Publisher: release.yml on rhanekom/qwikswitch-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for qwikswitch_api-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 00a6bc4d480570a58ad94580739f60884b8495afe9157d6a07af32c64d0d6595
MD5 cd1b699d6667924ee37bd590423542c0
BLAKE2b-256 f57d4e9df6e56eb1d67d521a1c51e91451749b28ba0325af64a2a04bc566ac0e

See more details on using hashes here.

Provenance

The following attestation bundles were made for qwikswitch_api-0.0.12-py3-none-any.whl:

Publisher: release.yml on rhanekom/qwikswitch-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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