summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/source/configuring-system-lirc.rst7
-rw-r--r--docs/source/installation.rst12
-rw-r--r--docs/source/usage.rst12
3 files changed, 15 insertions, 16 deletions
diff --git a/docs/source/configuring-system-lirc.rst b/docs/source/configuring-system-lirc.rst
index 5c9d829..e9e3ab0 100644
--- a/docs/source/configuring-system-lirc.rst
+++ b/docs/source/configuring-system-lirc.rst
@@ -50,7 +50,12 @@ the device should just work on the default driver.
Windows
-------
-The Windows setup information is a work in progress.
+You'll want to make sure you install WinLIRC at WinLIRC at http://winlirc.sourceforge.net/.
+This is the LIRC port for Windows which corresponds with version 0.9.0 of LIRC. Past that,
+you can run the WinLIRC executable file and select the "Input Plugin" for your device. Then,
+you can select the remote configuration and click OK. You should now be able to select your remote
+and send key codes. As long as the program is running in the background (it minimizes to the tray),
+this package will be able to connect to it.
macOS
-----
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
index 9a5b120..e8255de 100644
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@@ -21,10 +21,7 @@ System LIRC Package
While LIRC was originally created for Linux, there
are ports of LIRC to macOS and Windows which this
-python package is compatibile with. However, I would
-still recommend using the original Linux version if
-you can, as it generally has better maintanence,
-hardware support, etc.
+python package is compatibile with.
Linux:
@@ -39,8 +36,7 @@ Windows:
* WinLIRC at http://winlirc.sourceforge.net/ is a port for Windows.
It works a bit differently since it is just a collection of files
- in a folder that you run so you'll have to adjust the ``socket``
- and ``socket_path`` parameter. More information on that can be found
+ in a folder that you run. More information on that can be found
at `using LIRC on Windows <./using-lirc-on-windows.html>`_.
macOS:
@@ -49,6 +45,4 @@ macOS:
with it's source code on GitHub at https://github.com/andyvand/LIRC. However,
it doesn't appear to be maintained any longer and is not the latest LIRC version.
You can then run ``port install lirc`` or build the package from source using
- the instructions on the README of the GitHub repository. See
- `using LIRC on macOS <./using-lirc-on-macos.html>`_ for more information on
- getting LIRC setup on macOS and how to use this python package with it. \ No newline at end of file
+ the instructions on the README of the GitHub repository. \ No newline at end of file
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
index 9898459..b007fd0 100644
--- a/docs/source/usage.rst
+++ b/docs/source/usage.rst
@@ -17,7 +17,7 @@ Initializing Lirc
The ``Client`` class takes in one optional keyword argument: connection.
This connection must be a ``LircdConnection``. This connection, if not
-specified manuall, will have default values that depend on the operating
+specified manually, will have default values that depend on the operating
system you are on. So the simplest way to construct ``Client`` is with no
arguments at all.
@@ -65,9 +65,9 @@ on macOS will be prefixed by ``/opt/local/`` so the connection to the lircd
socket will instead be at ``/opt/local/var/run/lirc/lircd``. The socket that
is created will be the same.
-However if we are on Windows, we can't use unix domain sockets. So instead,
+However if we are on Windows, we can't use unix domain sockets. Instead,
WinLIRC uses TCP to communicate with the lirc daemon. So instead of a string
-for the address, it defaults to a tuple of ("localhost", 8765), the default on
-WinLIRC. The first part contains the address whereas the second is the port.
-Furthermore, the socket that is created uses ``AF_INET`` and ``SOCK_STREAM``
-instead so we can connect over TCP.
+for the address, it defaults to a tuple of ("localhost", 8765), which is the
+default on WinLIRC. The first part contains the address whereas the second is
+the port. Furthermore, the socket that is created uses ``AF_INET`` and
+``SOCK_STREAM`` instead so we can connect over TCP.