Skip to main content

A server for exposing Plover engine events and functionality

Project description

Plover WebSocket Server

A WebSocket server for exposing Plover events and controlling Plover from an external program.


Download the latest version of Plover for your operating system from the releases page. Only versions 4.0.0.dev8 and higher are supported.

  1. Open Plover
  2. Navigate to the Plugin Manager tool
  3. Select the "plover-engine-server-2" plugin entry in the list
  4. Click install
  5. Restart Plover

The same method can be used for updating and uninstalling the plugin.


To set the host name and port used, create a file named plover_engine_server_config.json inside Plover's configuration directory (same directory as plover.cfg file) with the content:

    "host": "localhost",
    "port": 8086

All fields are optional. The default is included in the example above.

How to Use

  • Enable it in Configure -> Plugins
  • Connect to http://localhost:8086/websocket with your client and get the data pushed to you as event: data formatted JSON.

Received data format: Search for occurrences of queue_message in plover_engine_server/, or write an example program (or use the existing plover_engine_server/websocket/ and observe its output.

Controlling Plover from other programs:

  • Sending 'close' disconnects you.
  • Sending a valid JSON string will execute the specified action. For example {"stroke": ["S-"]} (note that invalid keys are silently dropped), or {"translation": "abc"}.

If there's some error during the execution, it will be silently ignored and printed on stderr.

If the "force" key is true then the command will be executed even when the engine is turned off. Note that {PLOVER:RESUME} will have no effect in that case.

Because the Plover inner working is closely tied to the assumption that strokes can only come from the keyboard, when {PLOVER:RESUME} is sent and the machine is "keyboard" then some characters before the cursor will be deleted. To prevent this, set the "zero_last_stroke_length" key to true.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for plover-engine-server-2, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size plover_engine_server_2-0.0.4.tar.gz (29.7 kB) File type Source Python version None Upload date Hashes View
Filename, size plover_engine_server_2-0.0.4-py3-none-any.whl (24.6 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page