Auto reconnect: Difference between revisions

From Plover Wiki
VisualWikitext
(Created page with "== Background == For steno writers that use serial protocols such as Gemini PR or TX Bolt, Plover requires the user to manually press the reconnect machine button if the writer is unplugged and replugged. The <code>plover-auto-reconnect-machine</code> plugin can handle this automatically. However, if the serial port changes between plugs, please note that this plugin will not work. This can be checked by going to <code>Configure → Machine</code> and follow the instruc...")
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Background ==
For steno writers that use serial protocols such as Gemini PR or TX Bolt, Plover requires the user to manually press the reconnect machine button if the writer is unplugged and replugged. The <code>plover-auto-reconnect-machine</code> plugin can handle this automatically on some setups. However, if the serial port changes between plugs, please note that this plugin will not work.
For steno writers that use serial protocols such as Gemini PR or TX Bolt, Plover requires the user to manually press the reconnect machine button if the writer is unplugged and replugged. The <code>plover-auto-reconnect-machine</code> plugin can handle this automatically. However, if the serial port changes between plugs, please note that this plugin will not work.


This can be checked by going to <code>Configure → Machine</code> and follow the instructions below:
== Checking usability of plugin ==
To see if this plugin is usable with your setup, go to <code>Configure → Machine</code> and follow the instructions below:


# Open the <code>Port</code> drop down menu.
# Open the <code>Port</code> drop down menu.
Line 17: Line 17:
[[File:Auto-reconnect-test.png|alt=Plover configuration machine tab with refresh button highlighted. Drop down menu options highlighted.|center|thumb|708x708px|Left: <code>Refresh</code>/<code>Scan</code> button. Right: drop down menu options.]]
[[File:Auto-reconnect-test.png|alt=Plover configuration machine tab with refresh button highlighted. Drop down menu options highlighted.|center|thumb|708x708px|Left: <code>Refresh</code>/<code>Scan</code> button. Right: drop down menu options.]]


== Installing the <code>plover-auto-reconnect-machine</code> plugin ==
== Plugin installation ==


# Open the plugins manager.
# Open the plugins manager.
Line 27: Line 27:
For more detailed steps for installation, see the [[Plugins#How to Install Plugins|plugins page]].
For more detailed steps for installation, see the [[Plugins#How to Install Plugins|plugins page]].


== Setting up the <code>plover-auto-reconnect-machine</code> plugin ==
== Plugin setup ==


# In Plover's main window, go to <code>Configure → Plugins</code>.
# In Plover's main window, go to <code>Configure → Plugins</code>.
Line 43: Line 43:
# Plover's status should go from <code>Disconnected</code>[[File:State-disconnected.svg|frameless|28x28px]] to <code>Connected</code>[[File:State-enabled.svg|frameless|28x28px]]
# Plover's status should go from <code>Disconnected</code>[[File:State-disconnected.svg|frameless|28x28px]] to <code>Connected</code>[[File:State-enabled.svg|frameless|28x28px]]
# Write some words to see if it works.
# Write some words to see if it works.
[[Category:Plover]]

Latest revision as of 02:16, 26 June 2024

For steno writers that use serial protocols such as Gemini PR or TX Bolt, Plover requires the user to manually press the reconnect machine button if the writer is unplugged and replugged. The plover-auto-reconnect-machine plugin can handle this automatically on some setups. However, if the serial port changes between plugs, please note that this plugin will not work.

Checking usability of plugin

To see if this plugin is usable with your setup, go to Configure → Machine and follow the instructions below:

  1. Open the Port drop down menu.
  2. Take note of the serial port that your machine is using.
  3. Unplug your writer.
  4. Press the Refresh button (labeled as Scan on older versions of Plover).
  5. Plug in your writer.
  6. Press the Refresh button (labeled as Scan on older versions of Plover).
  7. Open the Port drop down menu.
  8. Check if the new serial port is the same.
    • If they are the same, you can proceed with this page to set up auto reconnect.
    • If they are different, auto reconnect may not work.
Plover configuration machine tab with refresh button highlighted. Drop down menu options highlighted.
Left: Refresh/Scan button. Right: drop down menu options.

Plugin installation

  1. Open the plugins manager.
  2. Find plover-auto-reconnect-machine in the list.
  3. Press Install/Update
  4. Proceed with the installation.
  5. Press Restart after it is finished.

For more detailed steps for installation, see the plugins page.

Plugin setup

  1. In Plover's main window, go to Configure → Plugins.
  2. Check the box next to plover-auto-reconnect-machine.
  3. Press Apply and then OK.
Plover plugins tab with the plover-auto-reconnect-machine plugin check box.
Check the box to enable the plover-auto-reconnect-machine plugin.

Verify it works

  1. Make sure your machine is set up correctly.
  2. Write some words to test your configuration.
  3. Unplug your writer.
  4. Plug it back in and wait a few seconds.
  5. Plover's status should go from Disconnected to Connected
  6. Write some words to see if it works.
Retrieved from "https://plover.wiki/index.php?title=Auto_reconnect&oldid=2289"