diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2020-07-15 23:08:11 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2020-07-15 23:08:11 -0500 |
| commit | 705a84f5b8908b462a0c0c98b64d5d111ec20d17 (patch) | |
| tree | ff58948fd2b3f6b287dc0c36e170e0159b3c3430 /CHANGELOG.rst | |
| parent | Run CI on macos, windows, and ubuntu (diff) | |
| download | lirc-705a84f5b8908b462a0c0c98b64d5d111ec20d17.zip | |
Change how address and socket are determined in Lirc
This is to help with making this package cross-platform.
Diffstat (limited to 'CHANGELOG.rst')
| -rw-r--r-- | CHANGELOG.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/CHANGELOG.rst b/CHANGELOG.rst index dac2803..52b74d6 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -8,6 +8,42 @@ Changelog <https://keepachangelog.com/en/1.0.0/>`_, and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_. +Unreleased +------------------ + +**Changed** + + - ``socket_path`` in ``Lirc``'s constructor is now called ``address`` to better signify + what is it for (the address to reach lircd). This allows it to make more sense in a + cross-platform context such as with WinLIRC since TCP is used there and not a socket. + + - ``address`` in ``Lirc``'s constructor is now type hinted to be a tuple or a string. + A tuple is used for a TCP connection since you'd specify it as such: ("localhost", 8765). + + - ``socket_timeout`` has been renamed to just ``timeout`` in ``Lirc``'s constructor to clarify + that it may not necessarily be a socket (in the case of being on Windows). + + - ``socket_timeout`` in ``Lirc``'s constructor is now type hinted as a float instead of an int. + This is the type that the socket will change it to anyway, and it makes more sense with time. + + - ``socket`` and ``address`` in ``Lirc``'s constructor is now defaulted to ``None`` in the ``__init__`` + method, but it does some calculations to determine the operating system that it is being run on and + sets up sensible defaults for them based on that. + + - On Linux, it is "/var/run/lirc/lircd" as the address. + On macOS, it is "/opt/run/var/run/lirc/lircd". + And on Windows, it is ("localhost", 8765) to connect to localhost:8765, which is the default address for WinLIRC. + + - On Linux and macOS, the socket would end up being socket.socket(socket.AF_UNIX, socket.SOCK_STREAM). + On Windows, the socket would end up being socket.socket(socket.AF_INET, socket.SOCK_STREAM) since it is + connected over TCP with WinLIRC. + +**Removed** + + - ``DEFAULT_SOCKET_PATH`` constant on ``Lirc``. It no longer makes sense with cross-platform support. + - ``ENCODING`` constant on ``Lirc``. It is now a private part of the class. + + 0.1.0 - 2020-07-13 ------------------ |