summaryrefslogtreecommitdiffstats
path: root/CHANGELOG.rst
blob: 6e7fdf617e08ed88ad4c7a0084b2362eca80720f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
Changelog
=========

All notable changes to this project will be documented in this file.

The format is based on `Keep a
Changelog <https://keepachangelog.com/en/1.0.0/>`_, and this project
adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.

2.0.0 - 2021-04-18
------------------

**Fixed - Potential Breaking Changes**

- The ``Client``'s ``send_once`` method was sending
  an IR code twice by default. This is because the ``repeat_count`` keyword argument
  was set to 1 instead of 0, causing it to send the initial IR code and repeat it once.
  This now defaults to 0.
  
  On v1, this can be worked around by explicitly specifying the ``repeat_count`` to only send 1 IR signal by setting it to 0:
  
  .. code-block:: python
    
    import lirc
      
    client = lirc.Client()
    client.send_once('remote', 'key', repeat_count=0)

- The ``Darwin`` connection to lircd was set to default to
  ``/opt/run/var/run/lirc/lircd`` when it should have been
  ``/opt/local/var/run/lirc/lircd``. This is unlikely to have
  an impact since the previous default directory was incorrect.
  
  On v1 and on macOS, this can also be worked around by explicitly specifying the connection path rather
  than relying on the default.
  
  .. code-block:: python
  
    import lirc
    
    client = lirc.Client(
      connection=lirc.LircdConnection(
        address="/opt/local/var/run/lirc/lircd",
      )
    )

1.0.1 - 2020-12-26
------------------

**Fixed**

- PyPI is complaining that v1.0.0 is already taken, since it was
  a release that was deleted from a previous mistake.

1.0.0 - 2020-12-26
------------------

**Added**

- ``DefaultConnection.address`` and ``DefaultConnection.socket`` may raises
  an ``UnsupportedOperatingSystemError`` if the operating system you're on
  is not MacOS, Linux, or Windows.

**Changed**

- ``lirc.Client`` raises a ``TypeError`` instead of a ``ValueError`` now
  if a ``connection`` is passed in that is not an instance of ``LircdConnection``.

- ``send`` on ``lirc.Client`` is now called ``send_once``.

- ``start_repeat`` on ``lirc.Client`` is now called ``send_start``.

- ``stop_repeat`` on ``lirc.Client`` is now called ``send_stop``.

**Removed**

- ``socket`` property from ``LircdConnection``.

**Fixed**

- The ``remote`` and ``key`` optional arguments to the ``lirc.Client``'s ``stop_repeat``
  method were not overriding the last sent remote and key.

0.2.0 - 2020-12-13
------------------

**Added**

- ``LircdConnection`` to handle configuring the connection on ``Client``.

**Changed**

- ``Lirc`` is now named ``Client``.

- ``Client`` now takes in a ``connection`` as the optional argument
  to configure it's connection. That ``connection`` must be a ``LircdConnection``
  class if you would like to customize the connection. The ``LircdConnection`` takes
  in an ``address``, ``socket``, and ``timeout`` with optional keyword arguments.
  Anything not specified with use the defaults for that operating system.

**Removed**

- ``DEFAULT_SOCKET_PATH`` constant on ``Client``. It no longer makes sense with cross-platform support.

- ``ENCODING`` constant on ``Client``.

- ``socket_path`` and ``socket_timeout`` on the ``Lirc`` constructor.

0.1.0 - 2020-07-13
------------------

- Initial Release