Skip to main content

Switcher Python Integration.

Project description

Switcher Python Integration
pypi-version pypi-downloads license-badge

gh-build-status gh-pages-status codecov

PyPi module integrating with various Switcher devices.
Check out the wiki pages for a list of supported devices.

pip install aioswitcher
Documentation Wiki Contributing

Example Usage

State Bridge
async def print_devices(delay):
    def on_device_found_callback(device):
        # a switcher device will broadcast a state message approximately every 4 seconds
        print(asdict(device))

    async with SwitcherBridge(on_device_found_callback):
        await asyncio.sleep(delay)

# run the bridge for 60 seconds
asyncio.run(print_devices(60))
Power Plug API
async def control_power_plug(device_ip, device_id) :
    # for connecting to a device we need its id and ip address
    async with SwitcherType1Api(device_ip, device_id) as api:
        # get the device current state
        await api.get_state()
        # turn the device on
        await api.control_device(Command.ON)
        # turn the device off
        await api.control_device(Command.OFF)
        # set the device name to 'my new name'
        await api.set_device_name("my new name")

asyncio.run(control_power_plug("111.222.11.22", "ab1c2d"))
Water Heater API
async def control_water_heater(device_ip, device_id) :
    # for connecting to a device we need its id and ip address
    async with SwitcherType1Api(device_ip, device_id) as api:
        # get the device current state
        await api.get_state()
        # turn the device on for 15 minutes
        await api.control_device(Command.ON, 15)
        # turn the device off
        await api.control_device(Command.OFF)
        # set the device name to 'my new name'
        await api.set_device_name("my new name")
        # configure the device for 02:30 auto shutdown
        await api.set_auto_shutdown(timedelta(hours=2, minutes=30))
        # get the schedules from the device
        await api.get_schedules()
        # delete and existing schedule with id 1
        await api.delete_schedule("1")
        # create a new recurring schedule for 13:00-14:30
        # executing on sunday and friday
        await api.create_schedule("13:00", "14:30", {Days.SUNDAY, Days.FRIDAY})

asyncio.run(control_water_heater("111.222.11.22", "ab1c2d"))
Runner API
async def control_runner(device_ip, device_id) :
    # for connecting to a device we need its id and ip address
    async with SwitcherType2Api(device_ip, device_id) as api:
        # get the device current state
        await api.get_shutter_state()
        # open the shutter to 30%
        await api.set_position(30)
        # stop the shutter if currently rolling
        await api.stop()

asyncio.run(control_runner("111.222.11.22", "ab1c2d"))
Breeze API
async def control_breeze(device_ip, device_id, remote_manager, remote_id) :
    # for connecting to a device we need its id and ip address
    async with SwitcherType2Api(device_ip, device_id) as api:
        # get the device current state
        await api.get_breeze_state()
        # initialize the Breeze RemoteManager and get the remote
        remote = remote_manager.get_remote(remote_id)
        # prepare a control command that turns on the Breeze
        # set to 24 degree (Celsius) cooling with vertical swing
        # send command to the device
        await api.control_breeze_device(
            remote,
            DeviceState.ON,
            ThermostatMode.COOL,
            24,
            ThermostatFanLevel.MEDIUM,
            ThermostatSwing.ON,
        )

# create the remote manager outside the context for re-using
remote_manager = SwitcherBreezeRemoteManager()
asyncio.run(control_breeze("111.222.11.22", "ab1c2d", remote_manager, "DLK65863"))

Command Line Helper Scripts

Disclaimer

This is NOT an official module and it is NOT officially supported by the vendor.
That said, thanks are in order to all the people at Switcher for their cooperation and general support.

Contributors

Thanks goes to these wonderful people (emoji key):

Aviad Golan
Aviad Golan

🔣
Dolev Ben Aharon
Dolev Ben Aharon

📖
Fabian Affolter
Fabian Affolter

💻
Itzik Ephraim
Itzik Ephraim

💻
Kesav890
Kesav890

📖
Or Bin
Or Bin

💻
Shai rod
Shai rod

🔣
Shay Levy
Shay Levy

💻 🤔 🚧
dmatik
dmatik

📝 🤔 📓
jafar-atili
jafar-atili

💻 📖

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

aioswitcher-3.1.0.tar.gz (520.1 kB view details)

Uploaded Source

Built Distribution

aioswitcher-3.1.0-py3-none-any.whl (558.5 kB view details)

Uploaded Python 3

File details

Details for the file aioswitcher-3.1.0.tar.gz.

File metadata

  • Download URL: aioswitcher-3.1.0.tar.gz
  • Upload date:
  • Size: 520.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.7 Linux/5.15.0-1020-azure

File hashes

Hashes for aioswitcher-3.1.0.tar.gz
Algorithm Hash digest
SHA256 297eb011d2256eb7b37a82015b2cdecec4bbf052178e0ce717d0d3810cf01be8
MD5 f0b3f171ea54b6257242d1ef059a4720
BLAKE2b-256 e263aed41dfb281366a859f1fe8efa708439fbfbae4b99d741aa0db88d04a35b

See more details on using hashes here.

File details

Details for the file aioswitcher-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: aioswitcher-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 558.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.7 Linux/5.15.0-1020-azure

File hashes

Hashes for aioswitcher-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 29585021eea10afcaece7c7dcda4af3e611d77df187498370e963c9e40e8f953
MD5 e272fc064090403c8798e77aee812686
BLAKE2b-256 fb3d72407a6e90ec905a50ea000cb00e68ababfe1487b444c905e3ac6c233e46

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page