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.2.0.tar.gz (520.1 kB view hashes)

Uploaded source

Built Distribution

aioswitcher-3.2.0-py3-none-any.whl (558.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page