ouimeaux package

Subpackages

• ouimeaux.device package
  • Subpackages
    • ouimeaux.device.api package
      • Subpackages
        • ouimeaux.device.api.xsd package
          • Submodules
          • ouimeaux.device.api.xsd.device module
          • ouimeaux.device.api.xsd.service module
          • Module contents
      • Submodules
      • ouimeaux.device.api.service module
      • Module contents
  • Submodules
  • ouimeaux.device.insight module
  • ouimeaux.device.lightswitch module
  • ouimeaux.device.motion module
  • ouimeaux.device.switch module
  • Module contents
• ouimeaux.examples package
  • Submodules
  • ouimeaux.examples.watch module
  • Module contents
• ouimeaux.pysignals package
  • Submodules
  • ouimeaux.pysignals.dispatcher module
  • ouimeaux.pysignals.inspect module
  • ouimeaux.pysignals.weakref_backports module
  • Module contents
• ouimeaux.server package
  • Submodules
  • ouimeaux.server.settings module
  • Module contents

Submodules

ouimeaux.cli module

ouimeaux.cli.NOOP(*x)

ouimeaux.cli.light(args)

ouimeaux.cli.list_(args)

ouimeaux.cli.make_matcher(device_name)

ouimeaux.cli.maker(args)

ouimeaux.cli.scan(args, on_switch=<function <lambda>>, on_motion=<function <lambda>>, on_bridge=<function <lambda>>, on_maker=<function <lambda>>)

ouimeaux.cli.server(args)

ouimeaux.cli.status(args)

ouimeaux.cli.switch(args)

ouimeaux.cli.wemo()

ouimeaux.config module

class ouimeaux.config.WemoConfiguration(filename=None)

Bases: object

aliases

auth

bind

listen

ouimeaux.config.ensure_directory(directory)

ouimeaux.config.in_home(*path)

ouimeaux.discovery module

class ouimeaux.discovery.UPnP(mcast_ip='239.255.255.250', mcast_port=1900, bind=None)

Bases: object

Makes M-SEARCH requests, filters out non-WeMo responses, and dispatches signals with the results.

broadcast()

Send a multicast M-SEARCH request asking for devices to report in.

server

UDP server to listen for responses.

exception ouimeaux.discovery.UPnPLoopbackException

Bases: exceptions.Exception

Using loopback interface as callback IP.

ouimeaux.discovery.test()

ouimeaux.environment module

class ouimeaux.environment.Environment(switch_callback=<function <lambda>>, motion_callback=<function <lambda>>, bridge_callback=<function <lambda>>, maker_callback=<function <lambda>>, with_discovery=True, with_subscribers=True, with_cache=<object object>, bind=None, config_filename=None)

Bases: object

discover(seconds=2)

Discover devices in the environment.

@param seconds: Number of seconds to broadcast requests. @type seconds: int

get(name)

get_bridge(name)

Get a bridge by name.

get_maker(name)

Get a maker by name.

get_motion(name)

Get a motion by name.

get_switch(name)

Get a switch by name.

list_bridges()

List bridges discovered in the environment.

list_makers()

List makers discovered in the environment.

list_motions()

List motions discovered in the environment.

list_switches()

List switches discovered in the environment.

start()

Start the server(s) necessary to receive information from devices.

wait(timeout=None)

Wait for events.

exception ouimeaux.environment.StopBroadcasting

Bases: exceptions.Exception

exception ouimeaux.environment.UnknownDevice

Bases: exceptions.Exception

ouimeaux.signals module

ouimeaux.subscribe module

class ouimeaux.subscribe.SubscriptionRegistry

Bases: object

on(device, type, callback)

register(device)

server

UDP server to listen for responses.

ouimeaux.utils module

ouimeaux.utils.get_ip_address()

ouimeaux.utils.get_retries()

ouimeaux.utils.get_timesync()

ouimeaux.utils.is_dst()

ouimeaux.utils.matcher(match_string)

ouimeaux.utils.retry_with_delay(f, delay=60)

Retry the wrapped requests.request function in case of ConnectionError. Optionally limit the number of retries or set the delay between retries.

ouimeaux.utils.tz_hours()

Module contents