Specify broadcast address for discovery #176
Conversation
In situations such as multiple network interfaces, it may be necessary to specify the broadcast address so that the discovery message is sent to the desired local network.
Sometimes it's necessary to specify what broadcast address it should send the discovery message. For instance, there are multiple network interfaces on the host.
Since --target is a top-level option and we want to use it in subcommands, use ctx.parent.params['target'] to retrieve it.
pyHS100/discover.py
Outdated
| @@ -63,7 +65,7 @@ def discover( | |||
| if protocol is None: | |||
| protocol = TPLinkSmartHomeProtocol() | |||
|
|
|||
| target = "255.255.255.255" | |||
| #target = "255.255.255.255" | |||
There was a problem hiding this comment.
block comment should start with '# '
There was a problem hiding this comment.
That line can be deleted.
pyHS100/cli.py
Outdated
| @@ -40,12 +40,17 @@ | |||
| required=False, | |||
| help="The device name, or alias, of the device to connect to.", | |||
| ) | |||
| @click.option( | |||
| "--target", | |||
| @@ -43,6 +43,7 @@ class Discover: | |||
| @staticmethod | |||
| def discover( | |||
| protocol: TPLinkSmartHomeProtocol = None, | |||
| target: str = "255.255.255.255", | |||
There was a problem hiding this comment.
I'm not sure if that's the proper position for this in the argument list, but considering the current master has evolved and is breaking the backwards compatibility, I'd propose that we simply adjust discover to allow keyword-only arguments.
There was a problem hiding this comment.
After giving this a bit thought, I think this can be changed in a separate PR, so let's get this merged if someone is eagerly waiting for this functionality. #158 is at least partially related (there are mentions about multiple subnets in the comments).
Not sure whether this was directed at me, or @kochinc, my general preference is to deal with interfaces, rather than IP addresses - network ranges change, interfaces generally stay the same. If go for interfaces, however, how do we address the 'broadcast' since broadcast should send to all interfaces? Perhaps a |
|
Either way it's fine for me. At first I wanted to add an interface parameter. After inspected the code, I realized it's very simple to just include a broadcast target address parameter. That solved my issue with TP-Link device discovery on Home Assistant. |
|
Would it be possible to get a release with this merged so that we can get Home Assistant working with Kasa on different subnets before python-kasa is integrated? |
Sometimes it's useful to be able to specify the broadcast address for discovery. On a host with multiple network interfaces, when a discovery message is sent to 255.255.255.255:9999, the routing table decides which interface it is routed to. By specifying broadcast address, e.g. 192.168.xxx.255, the discovery message can be directed to a particular subnet only.
The modification to discover.py is very limited and shouldn't affect existing programs using the library. The cli.py is changed to include a --target option for specifying broadcast address.