Package: pysonofflanr3
Control Sonoff devices running original firmware, in LAN mode.To control Sonoff switches running the V3+ Itead firmware (tested on 3.0, 3.0.1, 3.1.0, 3.3.0), locally (LAN mode).This will only work for Sonoff devices running V3+ of the stock (Itead / eWeLink) firmware. For users of V1.8.0 - V2.6.1, please usePySonoffLANThis module provides a way to interface with Sonoff smart home devices,
such as smart switches (e.g. Sonoff Basic), plugs (e.g. Sonoff S20),
and wall switches (e.g. Sonoff Touch), when these devices are in LAN Mode.LAN Mode is a feature introduced by manufacturer Itead, to allow operation
locally when their servers are unavailable.
Further details can be found in theeWeLink LAN Mode guide.Since mid 2018, the firmware Itead have shipped with most Sonoff devices
has provided this feature, allowing devices to be controlled directly
on the local network using a WebSocket connection on port 8081.FeaturesDiscover all devices on local networkRead device stateSwitch device ON/OFFListen for state changes announced by the device (e.g. by physical switch)Activate inching/momentary device, with variable ON time (e.g. 1s)DocumentationDocumentation:https://pysonofflanr3.readthedocs.io.Install$ pip install pysonofflanr3Command-Line UsageUsage: pysonofflanr3 [OPTIONS] COMMAND [ARGS]...

  A cli tool for controlling Sonoff Smart Switches/Plugs in LAN Mode.

Options:
  --host TEXT          IP address or hostname of the device to connect to.
  --device_id TEXT     Device ID of the device to connect to.
  --inching TEXT       Number of seconds of "on" time if this is an
                       Inching/Momentary switch.
  -l, --level LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
  --help               Show this message and exit.
  --api_key KEY        Needed for devices not in DIY mode. See https://github.com/mattsaxon/pysonofflan/wiki/Finding-the-API__Key

Commands:
  discover  Discover devices in the network
  listen    Connect to device, print state and repeat
  off       Turn the device off.
  on        Turn the device on.
  state     Connect to device and print current state.Usage Example$ pysonofflan discover
2019-01-31 00:45:32,074 - info: Attempting to discover Sonoff LAN Mode devices on the local network, please wait...
2019-01-31 00:46:24,007 - info: Found Sonoff LAN Mode device at IP 192.168.0.77

$ pysonofflan --host 192.168.0.77 state
2019-01-31 00:41:34,931 - info: Initialising SonoffSwitch with host 192.168.0.77
2019-01-31 00:41:35,016 - info: == Device: 10006866e9 (192.168.0.77) ==
2019-01-31 00:41:35,016 - info: State: OFF

$ pysonofflan --host 192.168.0.77 on
2019-01-31 00:49:40,334 - info: Initialising SonoffSwitch with host 192.168.0.77
2019-01-31 00:49:40,508 - info:
2019-01-31 00:49:40,508 - info: Initial state:
2019-01-31 00:49:40,508 - info: == Device: 10006866e9 (192.168.0.77) ==
2019-01-31 00:49:40,508 - info: State: OFF
2019-01-31 00:49:40,508 - info:
2019-01-31 00:49:40,508 - info: New state:
2019-01-31 00:49:40,508 - info: == Device: 10006866e9 (192.168.0.77) ==
2019-01-31 00:49:40,508 - info: State: ONLibrary UsageAll common, shared functionality is available throughSonoffSwitchclass:x = SonoffSwitch("192.168.1.50")Upon instantiating the SonoffSwitch class, a connection is
initiated and device state is populated, but no further action is taken.For most use cases, you’ll want to make use of thecallback_after_updateparameter to do something with the device after a connection has been
initialised, for example:async def print_state_callback(device):
    if device.basic_info is not None:
        print("ON" if device.is_on else "OFF")
        device.shutdown_event_loop()

SonoffSwitch(
    host="192.168.1.50",
    callback_after_update=print_state_callback
)This example simply connects to the device, prints whether it is currently
“ON” or “OFF”, then closes the connection. Note, the callback must be
asynchronous.Module-specific errors are raised as Exceptions, and are expected
to be handled by the user of the library.LicenseFree software: MIT licenseCreditsThis package was created withCookiecutterand theaudreyr/cookiecutter-pypackageproject template.History1.1.4 (2020-03-29)Enabled code to work if device IP address changesFixed faulty CLI introduced with 1.1.3 (https://github.com/mattsaxon/pysonofflan/issues/65)Removed previous workaround code for earlier version of zeroconf (<=24.4)1.1.3 (2020-02-16)Fixed issue of reconnection that device remains unavailable until state changesFixed retry code for strip type devices1.1.2 (deleted release)1.1.1 (2020-02-01)Optimisations to deal with later zeroconf versions which have some different behaviourImproved error handling of unexpected errors1.1.0 (2020-01-10)First release on PyPI.Forked from PySonoffLAN package (courtesy of Andrew Beveridge)Works on V3 Itead firmware using mDNS for service discovery and REST for service invocationSupports DIY mode as well as ‘standard’ mode (for standard mode API key is needed to be obtained, e.g. by sniffing LAN)Supports all known devices for switching, although no sensors added at this point