Skip to content

Commit

Permalink
Merge pull request #731 from flash62au/sphinx
Browse files Browse the repository at this point in the history
socat option for EX-Toolbox
  • Loading branch information
flash62au authored Aug 14, 2023
2 parents 817617b + ce9b453 commit 09d4a3e
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 3 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/ex-toolbox/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ EX-Toolbox - Overview

|EX-TB| is a free, open source, Android app to help setup and configure your |EX-CS|. It is intended for setup, configuration, debugging you Command Station rather than continuous use.

It can only function if your |EX-CS| is configured with wifi (either Access Point mode or Station mode). It cannot connect to a |EX-CS| though USB, wired Ethernet or JMRI.
It is designed to function if your |EX-CS| is configured with wifi (either Access Point mode or Station mode) or Ethernet. It can't connect to a |EX-CS| though JMRI.

It can't normally connect to a |EX-CS| though USB, however there some options that can allow this to work partly. See :ref:`ex-toolbox/using:connecting via usb` for details.


.. image:: /_static/images/ex-toolbox/ex_toolbox_icon.png
:alt: EX-Toolbox
:scale: 25%
:align: right

|EX-Tb| is installed on you phone or tablet from the Play Store.
|EX-TB| is installed on you phone or tablet from the Play Store.

With |EX-TB| you can perform:

Expand Down
50 changes: 49 additions & 1 deletion docs/ex-toolbox/using.rst
Original file line number Diff line number Diff line change
Expand Up @@ -356,4 +356,52 @@ This screen displays

* Information about |EX-TB|
* Information about the |EX-CS| it is currently connected to (if any)
* A page of basic information about |EX-CS|
* A page of basic information about |EX-CS|

----

Connecting via USB
==================

|EX-TB| can't normally connect to an |EX-CS| via USB, however it is possible to temporarily create a USB to IP connection on you PC using tools like *socat* or *SerialToIPGUI* (for windows).

Using *socat* in linux:

``socat TCP4-LISTEN:2560 /dev/ttyUSB0,b115200,raw,echo=0``

or (to provide more information)

``socat -d -d -d TCP4-LISTEN:2560 /dev/ttyUSB0,b115200,raw,echo=0``

Note: Change 'dev/ttyUSB0' to the appropriate USB port that the microprocessor is connected to.

Using *socat* in Microsoft Windows:

``socat TCP-LISTEN:2560 /dev/ttyS11,b115200,raw,echo=0``

or (to provide more information)

``socat -d -d -d TCP-LISTEN:2560 /dev/ttyS11,b115200,raw,echo=0``


Note: Change S11 to the appropriate USB port. Whatever 'COM' number appears in the Device Manager, subtract 1. |BR|
i.e. 'COM12' in theDevice Manager becomes '/dev/ttyS11'


Using *SerialToIPGUI* (For Microsoft Windows) (Recommended):

.. figure:: /_static/images/SerialToIPGUI/SerialToIPGUI.png
:alt: SerialToIPGUI
:class: responsive-image

SerialToIPGUI

Enter the port of '2560' and click :guilabel:`Start`.

Once started, open |EX-TB| on you Andorid device, enter the IP address of your PC and the port of '2560' then click :guilabel:`connect`.

Downloads
---------

* *SerialToIPGUI* - https://sourceforge.net/projects/serialtoip/
* *socat* for windows requires downloading the 'cgywin' and installing the optional 'socat' package when you install - https://www.cygwin.com/

0 comments on commit 09d4a3e

Please sign in to comment.