Skip to content

Commit

Permalink
fix errors in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Johan Bloemberg committed Jun 2, 2019
1 parent 330ae91 commit c78aec5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
4 changes: 4 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"python.pythonPath": ".direnv/python-3.6.5/bin/python3.6",
"restructuredtext.confPath": ""
}
19 changes: 10 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Installation
Usage of RFLink debug CLI
-------------------------

.. code-block:: none
.. code-block::
$ rflink -h
Command line interface for rflink library.
Expand All @@ -80,7 +80,7 @@ Usage of RFLink debug CLI
Intercept and display Rflink packets:

.. code-block:: none
.. code-block::
$ rflink
rflink Nodo RadioFrequencyLink RFLink Gateway V1.1 R45
Expand All @@ -92,20 +92,20 @@ Intercept and display Rflink packets:
Turn a device on or off:

.. code-block:: none
.. code-block::
$ rflink on newkaku_0000_1
$ rflink off newkaku_0000_1
Use of TCP mode instead of serial port (eg: ESP8266 serial bridge):

.. code-block:: none
.. code-block::
$ rflink --host 1.2.3.4 --port 1234
Debug logging is shown in verbose mode for debugging:

.. code-block:: none
.. code-block::
$ rflink -vv
DEBUG:asyncio:Using selector: EpollSelector
Expand All @@ -128,7 +128,8 @@ Debug logging is shown in verbose mode for debugging:
Usage of RFLinkProxy CLI
------------------------

.. code-block:: none
.. code-block::
$ rflinkproxy -h
Command line interface for rflink proxy.
Expand All @@ -151,20 +152,20 @@ Usage of RFLinkProxy CLI
Share RFLink connected to serial port /dev/ttyACM1,
the proxy will listen on port 2345:

.. code-block:: none
.. code-block::
$ rflink --port /dev/ttyACM0 --listenport 2345
Share TCP mode RFLink instead of serial port (eg: ESP8266 serial bridge),
the proxy will listen on port 2345:

.. code-block:: none
.. code-block::
$ rflink --host 1.2.3.4 --port 1234 --listenport 2345
Debug logging is shown in verbose mode for debugging:

.. code-block:: none
.. code-block::
$ rflink -vv --host 1.2.3.4 --port 1234 --listenport 2345
DEBUG:asyncio:Using selector: EpollSelector
Expand Down

0 comments on commit c78aec5

Please sign in to comment.